diff --git a/doc/source/conf.py b/doc/source/conf.py index 877e89d..19fce4e 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,12 +23,12 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx', + 'openstackdocstheme', 'yasfb', ] # Feed configuration for yasfb -feed_base_url = 'http://specs.openstack.org/openstack/openstack-specs' +feed_base_url = 'https://specs.openstack.org/openstack/openstack-specs' feed_author = 'OpenStack Development Team' exclude_patterns = [ @@ -67,6 +67,11 @@ add_module_names = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +# -- openstackdocstheme configuration ----------------------------------------- + +repository_name = 'openstack/openstack-specs' +html_theme = 'openstackdocs' + # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with diff --git a/requirements.txt b/requirements.txt index bf63030..325073d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ -pbr>=0.6,<1.0 -oslosphinx -sphinx>=1.1.2,<1.2 +pbr!=2.1.0,>=2.0.0 # Apache-2.0 +openstackdocstheme>=2.0 yasfb>=0.5.1 diff --git a/setup.cfg b/setup.cfg index a600bc5..41413de 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,21 +4,10 @@ summary = OpenStack Cross-Project Specifications and Policies description-file = README.rst author = OpenStack -author-email = openstack-dev@lists.openstack.org +author-email = openstack-discuss@lists.openstack.org home-page = http://www.openstack.org/ classifier = Environment :: OpenStack Intended Audience :: Developers License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux - -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[pbr] -warnerrors = True - -[upload_sphinx] -upload-dir = doc/build/html diff --git a/tox.ini b/tox.ini index 70c8aa5..187313a 100644 --- a/tox.ini +++ b/tox.ini @@ -4,20 +4,20 @@ envlist = docs skipsdist = True [testenv] +basepython = python3 usedevelop = True -install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt [testenv:venv] -basepython = python3 commands = {posargs} [testenv:docs] -basepython = python3 -commands = python setup.py build_sphinx +commands = + sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html + [testenv:spelling] deps = @@ -25,6 +25,3 @@ deps = sphinxcontrib-spelling PyEnchant commands = sphinx-build -b spelling doc/source doc/build/spelling - -[pbr] -warnerrors = true