openstack/os-traits
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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: Id6a7a465630647382de63be64fc16f6e4f52912d
This commit is contained in:
Andreas Jaeger 2020-06-01 15:27:01 +02:00
parent 066a2a972d
commit e32a13f13c
3 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,5 +1,5 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes # releasenotes
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0

8
doc/source/conf.py
View File

@ -21,8 +21,10 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/os-traits' openstackdocs_repo_name = 'openstack/os-traits'
bug_project = 'os-traits' openstackdocs_pdf_link = True
openstackdocs_auto_name = False
openstackdocs_bug_project = 'os-traits'
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@ -42,7 +44,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------

7
releasenotes/source/conf.py
View File

@ -28,8 +28,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/os-traits' openstackdocs_repo_name = 'openstack/os-traits'
bug_project = 'os-traits' openstackdocs_auto_name = False
openstackdocs_bug_project = 'os-traits'
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@ -56,7 +57,7 @@ version = ''
exclude_patterns = [] exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------