From 5cd82ebdad34a0cc789774faf82df2a1c295544a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 19 May 2020 10:57: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_auto_name to use 'project' as name. 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. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: If718e3d21c682dd3a3d297cfa9cebb333d59aef3 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 9 ++++----- releasenotes/source/conf.py | 10 ++++++++-- 3 files changed, 15 insertions(+), 10 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 9f38ada..e788495 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,7 +1,7 @@ # 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 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 1c262a7..56cf692 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,9 +31,9 @@ extensions = ['sphinx.ext.autodoc', ] # openstackdocstheme options -repository_name = 'openstack/devstack-tools' -bug_project = 'devstack-tools' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/devstack-tools' +openstackdocs_bug_project = 'devstack-tools' +openstackdocs_bug_tag = 'doc' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -46,7 +46,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'devstack-tools' copyright = u'2016, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -57,7 +56,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/releasenotes/source/conf.py b/releasenotes/source/conf.py index a53f04f..77f4352 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -42,6 +42,12 @@ extensions = [ 'reno.sphinxext', ] +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/devstack-tools' +openstackdocs_bug_project = 'devstack-tools' +openstackdocs_bug_tag = 'doc' +openstackdocs_auto_name = False + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -55,7 +61,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'devstack Release Notes' +project = u'devstack-tools Release Notes' copyright = u'2016, OpenStack Foundation' # The version info for the project you're documenting, acts as replacement for @@ -98,7 +104,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 = []