From f11933239038dbf856c1e6413f3a06f28a1cde57 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 15:55:07 +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. 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: I626737549ce3aeff0eeef63c42e6330d70192a63 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 18 ++++-------------- releasenotes/source/conf.py | 9 ++++----- 3 files changed, 11 insertions(+), 22 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index ec6ce76f..f93a0671 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,6 +2,6 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.11.0 # Apache-2.0 -reno!=2.3.1,>=1.8.0 # Apache-2.0 -sphinx>=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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 185b622a..3626dfac 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,10 +29,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/sahara-tests' -bug_project = '940' -bug_tag = 'doc' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/sahara-tests' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -50,15 +49,6 @@ master_doc = 'index' project = u'sahara-tests' copyright = u'2015, Sahara team' -# 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. -# -# The short X.Y version. -version = '0.0.1' -# The full version, including alpha/beta/rc tags. -release = '0.0.1' - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -88,7 +78,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/releasenotes/source/conf.py b/releasenotes/source/conf.py index 62ba7201..3ebde8ab 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -20,10 +20,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/sahara-tests' -bug_project = '940' -bug_tag = 'releasenotes' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/sahara-tests' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -78,7 +77,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 = []