From d46228b0b35757b69bf65617c9fce8b2b64210b1 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 20 May 2020 22:04:41 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Set openstackdocs_auto_name to use 'project' as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I780eea00c9c47f52dcc7928546fd22dec5d145b4 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 26 +++++++------------------- lower-constraints.txt | 5 +---- releasenotes/source/conf.py | 13 +++++-------- test-requirements.txt | 2 +- 5 files changed, 17 insertions(+), 35 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 2d070e19eb0..1b9cb86202d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,8 +1,8 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinx>=2.0.0,!=2.1.0 # BSD sphinx_feature_classification>=1.0.0 # Apache-2.0 -openstackdocstheme>=1.30.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 85e17297e5e..a9250c1ef43 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -65,15 +65,17 @@ extensions = [ ] # Project cross-reference roles -openstack_projects = [ +openstackdocs_projects = [ 'neutron', 'nova', ] # openstackdocstheme options -repository_name = 'openstack/neutron' -bug_project = 'neutron' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/neutron' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'doc' +openstackdocs_auto_name = False todo_include_todos = True @@ -93,16 +95,6 @@ master_doc = 'index' project = u'Neutron' copyright = u'2011-present, OpenStack Foundation.' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# Version info -from neutron.version import version_info as neutron_version -release = neutron_version.release_string() -# The short X.Y version. -version = neutron_version.version_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -135,7 +127,7 @@ exclude_trees = [] show_authors = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['neutron.'] @@ -177,10 +169,6 @@ html_theme = 'openstackdocs' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True diff --git a/lower-constraints.txt b/lower-constraints.txt index a6e9a37786a..d2d41ab2e8a 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -52,7 +52,6 @@ munch==2.1.0 netaddr==0.7.18 netifaces==0.10.4 neutron-lib==2.3.0 -openstackdocstheme==1.30.0 openstacksdk==0.31.2 os-client-config==1.28.0 os-ken==0.3.0 @@ -110,7 +109,7 @@ python-novaclient==9.1.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 +reno==3.1.0 repoze.lru==0.7 requests==2.14.2 requestsexceptions==1.2.0 @@ -120,8 +119,6 @@ simplejson==3.5.1 six==1.10.0 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.6.5 -sphinxcontrib-websupport==1.0.1 sqlalchemy-migrate==0.11.0 SQLAlchemy==1.2.0 sqlparse==0.2.2 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3c9dd6e210f..2eb357ee04a 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -42,9 +42,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/neutron' -bug_project = 'neutron' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/neutron' +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'doc' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -100,7 +101,7 @@ exclude_patterns = [] # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -149,10 +150,6 @@ html_theme = 'openstackdocs' # 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 = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True diff --git a/test-requirements.txt b/test-requirements.txt index 6a8a310089c..3622b7f2d4b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -13,7 +13,7 @@ testscenarios>=0.4 # Apache-2.0/BSD WebTest>=2.0.27 # MIT oslotest>=3.2.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 ddt>=1.0.1 # MIT astroid==1.6.5;python_version<"3.0" # LGPLv2.1 astroid==2.1.0;python_version>="3.0" # LGPLv2.1