From 663e4206436dc1a9993cf3a43c950a22cf38c436 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 20 May 2020 08:10:03 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.0 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. Add openstackdocstheme options to api-ref. Change-Id: I0cf71327ca5d9da1d88a826225374c8801849c36 --- api-ref/source/conf.py | 11 ++++++----- doc/requirements.txt | 6 +++--- doc/source/conf.py | 10 +++++----- lower-constraints.txt | 6 ------ releasenotes/source/conf.py | 9 +++++---- 5 files changed, 19 insertions(+), 23 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 1cf3b6c53..df8098e4b 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -62,10 +62,11 @@ master_doc = 'index' project = u'Designate API Reference' copyright = u'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. -# +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/designate' +openstackdocs_bug_project = 'designate' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -94,7 +95,7 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for man page output ---------------------------------------------- diff --git a/doc/requirements.txt b/doc/requirements.txt index fbade88b4..bd423eb40 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,9 +1,9 @@ # 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 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-httpdomain>=1.3.0 # BSD sphinxcontrib-blockdiag>=1.5.4 # BSD -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -openstackdocstheme>=1.31.2 # Apache-2.0 +openstackdocstheme>=2.2.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index f3cdeb01e..4eb4c8762 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -43,9 +43,10 @@ extensions = ['sphinx.ext.autodoc', 'oslo_policy.sphinxext'] # openstackdocstheme options -repository_name = 'openstack/designate' -bug_project = 'designate' -bug_tag = '' +openstackdocs_repo_name = 'openstack/designate' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'designate' +openstackdocs_bug_tag = '' config_generator_config_file = '../../etc/designate/designate-config-generator.conf' sample_config_basename = '_static/designate' @@ -68,7 +69,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'designate' copyright = u'2012, Managed I.T.' # The language for content autogenerated by Sphinx. Refer to documentation @@ -100,7 +100,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 = ["designate."] diff --git a/lower-constraints.txt b/lower-constraints.txt index 80b37d499..f6d6657f5 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -67,7 +67,6 @@ msgpack==0.5.6 munch==2.2.0 netaddr==0.7.18 netifaces==0.10.6 -openstackdocstheme==1.31.2 openstacksdk==0.12.0 os-api-ref==1.5.0 os-client-config==1.29.0 @@ -125,7 +124,6 @@ python-neutronclient==6.7.0 python-subunit==1.2.0 pytz==2018.3 PyYAML==3.12 -reno==2.7.0 repoze.lru==0.7 requests-mock==1.2.0 requests==2.14.2 @@ -137,10 +135,6 @@ simplejson==3.13.2 six==1.10.0 smmap2==2.0.3 snowballstemmer==1.2.1 -Sphinx==1.6.5 -sphinxcontrib-blockdiag==1.5.5 -sphinxcontrib-httpdomain==1.6.1 -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 8b1de7cf3..f0dae8193 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -42,9 +42,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/designate' -bug_project = 'designate' -bug_tag = '' +openstackdocs_repo_name = 'openstack/designate' +openstackdocs_bug_project = 'designate' +openstackdocs_bug_tag = '' +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 = []