Browse Source

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: I54eee940d3c787fddc1278619981d7a90310fbd0
changes/21/732021/1
Andreas Jaeger 11 months ago
parent
commit
5da8cf6ad0
3 changed files with 11 additions and 15 deletions
  1. +2
    -2
      doc/requirements.txt
  2. +5
    -5
      doc/source/conf.py
  3. +4
    -8
      releasenotes/source/conf.py

+ 2
- 2
doc/requirements.txt View File

@ -1,6 +1,6 @@
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0

+ 5
- 5
doc/source/conf.py View File

@ -36,13 +36,13 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'openstack'
project = u'magnum-tempest-plugin'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/openstack'
bug_project = 'magnum_tempest_plugin'
bug_tag = ''
openstackdocs_repo_name = 'openstack/magnum-tempest-plugin'
openstackdocs_bug_project = 'magnum_tempest_plugin'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -52,7 +52,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 --------------------------------------------------


+ 4
- 8
releasenotes/source/conf.py View File

@ -55,9 +55,9 @@ master_doc = 'index'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/openstack'
bug_project = 'magnum_tempest_plugin'
bug_tag = ''
openstackdocs_repo_name = 'openstack/magnum-tempest-plugin'
openstackdocs_bug_project = 'magnum_tempest_plugin'
openstackdocs_bug_tag = ''
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -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 = []
@ -148,10 +148,6 @@ html_static_path = ['_static']
# 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 = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True


Loading…
Cancel
Save