Several cleanups

Switch to openstackdocstheme, use python3 everywhere, remove
old cruft in setup.cfg.

Change-Id: Ib915d26d09a59122be15a4fa726370bde56dda90
This commit is contained in:
Andreas Jaeger 2020-03-19 13:51:07 +01:00
parent ae90bfdea2
commit 70a7c6d7dd
4 changed files with 14 additions and 24 deletions

View File

@ -23,12 +23,12 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'oslosphinx', 'openstackdocstheme',
'yasfb', 'yasfb',
] ]
# Feed configuration for 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' feed_author = 'OpenStack Development Team'
exclude_patterns = [ exclude_patterns = [
@ -67,6 +67,11 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
# -- openstackdocstheme configuration -----------------------------------------
repository_name = 'openstack/openstack-specs'
html_theme = 'openstackdocs'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with

View File

@ -1,4 +1,3 @@
pbr>=0.6,<1.0 pbr!=2.1.0,>=2.0.0 # Apache-2.0
oslosphinx openstackdocstheme>=2.0
sphinx>=1.1.2,<1.2
yasfb>=0.5.1 yasfb>=0.5.1

View File

@ -4,21 +4,10 @@ summary = OpenStack Cross-Project Specifications and Policies
description-file = description-file =
README.rst README.rst
author = OpenStack author = OpenStack
author-email = openstack-dev@lists.openstack.org author-email = openstack-discuss@lists.openstack.org
home-page = http://www.openstack.org/ home-page = http://www.openstack.org/
classifier = classifier =
Environment :: OpenStack Environment :: OpenStack
Intended Audience :: Developers Intended Audience :: Developers
License :: OSI Approved :: Apache Software License License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux 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

11
tox.ini
View File

@ -4,20 +4,20 @@ envlist = docs
skipsdist = True skipsdist = True
[testenv] [testenv]
basepython = python3
usedevelop = True usedevelop = True
install_command = pip install -U {opts} {packages}
setenv = setenv =
VIRTUAL_ENV={envdir} VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/requirements.txt deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt -r{toxinidir}/test-requirements.txt
[testenv:venv] [testenv:venv]
basepython = python3
commands = {posargs} commands = {posargs}
[testenv:docs] [testenv:docs]
basepython = python3 commands =
commands = python setup.py build_sphinx sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
[testenv:spelling] [testenv:spelling]
deps = deps =
@ -25,6 +25,3 @@ deps =
sphinxcontrib-spelling sphinxcontrib-spelling
PyEnchant PyEnchant
commands = sphinx-build -b spelling doc/source doc/build/spelling commands = sphinx-build -b spelling doc/source doc/build/spelling
[pbr]
warnerrors = true