Update docs building, cleanup

Update docs building and cleanup a bit:
* Update requirements for Sphinx and openstackdocstheme for
  python 3, create doc/requirements.txt for these
* Remove unneeded doc and translation sections from setup.cfg
* Remove install_command, it's unneeded, the default is fine,
  move constraints into deps, use TOX_CONSTRAINTS instead of
  obsolete UPPER_CONSTRAINTS
* Use new variables from updated openstackdocstheme

Change-Id: I659a8736195ff621032b4fb3bd7a72fa616cf8c6
This commit is contained in:
Andreas Jaeger 2020-05-03 11:23:36 +02:00
parent 7814dc2034
commit fd5ab8adea
6 changed files with 19 additions and 41 deletions

5
doc/requirements.txt Normal file
View File

@ -0,0 +1,5 @@
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=3.1.0 # Apache-2.0

View File

@ -75,6 +75,6 @@ latex_documents = [
#intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/keystone-tempest-plugin'
bug_project = 'keystone'
bug_tag = 'docs'
openstackdocs_repo_name = 'openstack/keystone-tempest-plugin'
openstackdocs_bug_project = 'keystone'
openstackdocs_bug_tag = 'docs'

View File

@ -147,10 +147,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
@ -275,6 +271,7 @@ texinfo_documents = [
locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/keystone-tempest-plugin'
bug_project = 'keystone'
bug_tag = 'releasenotes'
openstackdocs_repo_name = 'openstack/keystone-tempest-plugin'
openstackdocs_bug_project = 'keystone'
openstackdocs_bug_tag = 'releasenotes'
openstackdocs_auto_name = False

View File

@ -21,29 +21,6 @@ classifier =
packages =
keystone_tempest_plugin
[build_sphinx]
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog]
directory = keystone_tempest_plugin/locale
domain = keystone_tempest_plugin
[update_catalog]
domain = keystone_tempest_plugin
output_dir = keystone_tempest_plugin/locale
input_file = keystone_tempest_plugin/locale/keystone_tempest_plugin.pot
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = keystone_tempest_plugin/locale/keystone_tempest_plugin.pot
[entry_points]
tempest.test_plugins =
keystone_tests = keystone_tempest_plugin.plugin:KeystoneTempestPlugin

View File

@ -3,9 +3,3 @@
# process, which may cause wedges in the gate later.
hacking>=3.0,<3.1.0;python_version>='3.5' # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0

View File

@ -6,11 +6,12 @@ ignore_basepython_conflict = True
[testenv]
usedevelop = True
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} {opts} {packages}
setenv =
VIRTUAL_ENV={envdir}
PYTHONWARNINGS=default::DeprecationWarning
deps = -r{toxinidir}/test-requirements.txt
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/test-requirements.txt
commands = python setup.py test --slowest --testr-args='{posargs}'
basepython = python3
@ -24,9 +25,13 @@ commands = {posargs}
commands = python setup.py test --coverage --testr-args='{posargs}'
[testenv:docs]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html -d doc/buld/doctrees doc/source doc/build/html
[testenv:releasenotes]
deps = {[testenv:docs]deps}
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html