From a7f2e2102d8a9ee5e364afc94e5a007d4fe9dbb4 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 21 May 2020 16:13:00 +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. 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: Ic07c726697a8ed7d0a837bf0d16feec222e805f1 --- api-ref/source/conf.py | 6 +++--- doc/requirements.txt | 6 +++--- doc/source/conf.py | 7 ++++--- lower-constraints.txt | 4 ---- releasenotes/source/conf.py | 6 +++--- test-requirements.txt | 2 +- 6 files changed, 14 insertions(+), 17 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index c215c71989..4e67555193 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -88,11 +88,11 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # openstackdocstheme options -repository_name = 'openstack/magnum' -use_storyboard = True +openstackdocs_repo_name = 'openstack/magnum' +openstackdocs_use_storyboard = True # -- Options for man page output ---------------------------------------------- diff --git a/doc/requirements.txt b/doc/requirements.txt index 7612e709c4..2d7f0410a7 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. -openstackdocstheme>=1.20.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -sphinx>=1.8.0,!=2.1.0 # BSD -reno>=2.5.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index b1120da6fa..41dd01862b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,8 +30,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/magnum' -use_storyboard = True +openstackdocs_repo_name = 'openstack/magnum' +openstackdocs_pdf_link = True +openstackdocs_use_storyboard = True config_generator_config_file = '../../etc/magnum/magnum-config-generator.conf' sample_config_basename = '_static/magnum' @@ -60,7 +61,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 -------------------------------------------------- diff --git a/lower-constraints.txt b/lower-constraints.txt index 2993bf91ff..fdee35c371 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -65,7 +65,6 @@ netaddr==0.7.18 netifaces==0.10.6 networkx==1.11 oauthlib==2.0.6 -openstackdocstheme==1.20.0 openstacksdk==0.12.0 os-api-ref==1.4.0 os-client-config==1.29.0 @@ -123,7 +122,6 @@ python-subunit==1.0.0 python-swiftclient==3.5.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 repoze.lru==0.7 requests-oauthlib==0.8.0 requests-toolbelt==0.8.0 @@ -139,8 +137,6 @@ simplejson==3.13.2 six==1.10.0 smmap2==2.0.3 snowballstemmer==1.2.1 -Sphinx==1.8.0 -sphinxcontrib-websupport==1.0.1 sqlalchemy-migrate==0.11.0 SQLAlchemy==1.0.10 sqlparse==0.2.4 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 315c71702f..ef30515978 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -45,8 +45,8 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/magnum' -use_storyboard = True +openstackdocs_repo_name = 'openstack/magnum' +openstackdocs_use_storyboard = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -99,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 = [] diff --git a/test-requirements.txt b/test-requirements.txt index 79f32d9eb3..e07448d8b8 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -14,9 +14,9 @@ hacking>=3.0.1,<3.1.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 +Pygments>=2.2.0 # BSD license python-subunit>=1.0.0 # Apache-2.0/BSD pytz>=2013.6 # MIT -sphinx>=1.8.0,!=2.1.0 # BSD testrepository>=0.0.18 # Apache-2.0/BSD stestr>=2.0.0 # Apache-2.0 testscenarios>=0.4 # Apache-2.0/BSD