openstack
/
sphinx-feature-classification
Code Issues Proposed changes

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_version to not auto-version the documents.

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: I68f27622bc107b956556128b5808e15325e639f9
This commit is contained in:
Andreas Jaeger 2020-06-02 13:47:43 +02:00
parent e941f13f08
commit 623f5bbe77
3 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -40,6 +40,10 @@ master_doc = 'index'
project = u'sphinx-feature-classification'
copyright = u'2017, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/sphinx-feature-classification'
openstackdocs_use_storyboard = True
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -48,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 --------------------------------------------------

7
releasenotes/source/conf.py
View File

@ -29,6 +29,11 @@ master_doc = 'index'
project = u'sphinx_feature_classification Release Notes'
copyright = u'2016, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/sphinx-feature-classification'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# 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.
@ -40,7 +45,7 @@ release = ''
version = ''
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output ----------------------------------------------

6
test-requirements.txt
View File

@ -4,13 +4,13 @@
hacking>=3.0,<3.1.0 # Apache-2.0
coverage>=4.0,!=4.4 # Apache-2.0
openstackdocstheme>=1.17.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
ddt>=1.0.1 # MIT
python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.6.8 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
# releasenotes
reno>=1.8.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0