From 0ea80db1ea1a5475f9735124c5b9341586fd3216 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 4 Jun 2020 14:31:36 +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: I04a417a96daffaa5bb6570130545bc66527896d6 --- api-ref/source/conf.py | 10 ++++++---- doc/requirements.txt | 6 +++--- doc/source/conf.py | 13 +++++-------- releasenotes/source/conf.py | 12 +++++------- 4 files changed, 19 insertions(+), 22 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 6dc28d90..317faba8 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -41,10 +41,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = 'openstack/stx-metal' project = u'StarlingX Metal' -bug_project = 'starlingx' -bug_tag = 'stx.metal' + +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/metal' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # If true, the current module name will be prepended to all description # unit titles (such as .. function::). @@ -55,7 +57,7 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass diff --git a/doc/requirements.txt b/doc/requirements.txt index 1dbfc445..f704abc9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,8 +1,8 @@ -sphinx>=1.6.2 -openstackdocstheme>=1.26.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 # Release Notes -reno>=0.1.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 # API Reference Guide os-api-ref>=1.4.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 52b23edf..155772fc 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,11 +24,6 @@ project = u'StarlingX Metal' copyright = u'2018, StarlingX' author = u'StarlingX' -# The short X.Y version -version = u'' -# The full version, including alpha/beta/rc tags -release = u'0.1' - # -- General configuration --------------------------------------------------- @@ -55,8 +50,10 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -bug_project = 'starlingx' -bug_tag = 'stx.metal' +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/metal' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -71,7 +68,7 @@ language = None exclude_patterns = [] # 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 9001e4ce..797d268e 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -31,8 +31,10 @@ extensions = [ 'reno.sphinxext', ] -bug_project = 'starlingx' -bug_tag = 'stx.metal' +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/metal' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -83,7 +85,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 = [] @@ -132,10 +134,6 @@ html_theme = 'starlingxdocs' # 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 = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True