From 8f8a4ea4ecd21371c22e5d11017f67f94ef8881e Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 23 May 2020 17:46:50 +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. Disable openstackdocs_auto_name to use 'project' variable 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. 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: I9f2636a01516ae757b17d47081c890f855c3eb5d --- doc/source/conf.py | 11 ++++++----- lower-constraints.txt | 6 +++--- releasenotes/source/conf.py | 14 +++++--------- test-requirements.txt | 6 +++--- 4 files changed, 17 insertions(+), 20 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index b2bb5883..331f015e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,9 +31,11 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/neutron-dynamic-routing' -bug_project = 'neutron' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/neutron-dynamic-routing' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'doc' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -57,7 +59,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- @@ -68,7 +70,6 @@ pygments_style = 'sphinx' html_theme = 'openstackdocs' html_static_path = ['_static'] -html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/lower-constraints.txt b/lower-constraints.txt index 00c3c82c..51a4a7ae 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -54,7 +54,7 @@ netaddr==0.7.18 netifaces==0.10.4 neutron==14.0.0.0b1 neutron-lib==1.26.0 -openstackdocstheme==1.18.1 +openstackdocstheme==2.2.1 openstacksdk==0.11.2 os-client-config==1.28.0 os-ken==0.3.0 @@ -113,7 +113,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 @@ -122,7 +122,7 @@ Routes==2.3.1 simplejson==3.5.1 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.5 +Sphinx==2.0.0 sphinxcontrib-svg2pdfconverter==0.1.0 # BSD sphinxcontrib-websupport==1.0.1 SQLAlchemy==1.2.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 77346e1b..cf6458ae 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -42,9 +42,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'neutron-dynamic-routing' -bug_project = 'neutron' -bug_tag = 'doc' +openstackdocs_repo_name = 'neutron-dynamic-routing' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'doc' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -98,7 +99,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 = [] @@ -147,11 +148,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' -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 1a87d66b..f9d7b3d7 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,9 +8,9 @@ fixtures>=3.0.0 # Apache-2.0/BSD flake8-import-order==0.12 # LGPLv3 mock>=2.0.0 # BSD python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 oslo.concurrency>=3.26.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 testresources>=2.0.0 # Apache-2.0/BSD @@ -19,5 +19,5 @@ testscenarios>=0.4 # Apache-2.0/BSD WebOb>=1.7.1 # MIT WebTest>=2.0.27 # MIT oslotest>=3.2.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 tempest>=17.1.0 # Apache-2.0