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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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: I301ebb5ae44e9e5f1848e59865cc1d9dcdeffd8b
changes/56/732356/2
Andreas Jaeger 11 months ago
parent
commit
f1f9e61fd4
5 changed files with 12 additions and 16 deletions
  1. +3
    -4
      api-ref/source/conf.py
  2. +3
    -3
      doc/requirements.txt
  3. +3
    -3
      doc/source/conf.py
  4. +0
    -2
      lower-constraints.txt
  5. +3
    -4
      releasenotes/source/conf.py

+ 3
- 4
api-ref/source/conf.py View File

@ -88,12 +88,11 @@ add_module_names = False
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# openstackdocstheme options
repository_name = 'openstack/qinling'
bug_project = 'qinling'
bug_tag = 'api-ref'
openstackdocs_repo_name = 'openstack/qinling'
openstackdocs_use_storyboard = True
# -- Options for man page output ----------------------------------------------


+ 3
- 3
doc/requirements.txt View File

@ -2,8 +2,8 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# this is required for the docs build jobs
sphinx>=1.6.2 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=1.8.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
os-api-ref>=1.0.0 # Apache-2.0

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

@ -47,7 +47,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 --------------------------------------------------
@ -74,5 +74,5 @@ latex_documents = [
#intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/qinling'
use_storyboard = True
openstackdocs_repo_name = 'openstack/qinling'
openstackdocs_use_storyboard = True

+ 0
- 2
lower-constraints.txt View File

@ -107,8 +107,6 @@ setproctitle==1.1.10
setuptools==21.0.0
simplegeneric==0.8.1
six==1.10.0
Sphinx==1.6.2
sphinxcontrib-websupport==1.0.1
SQLAlchemy==1.0.10
sqlalchemy-migrate==0.11.0
sqlparse==0.2.4


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

@ -43,9 +43,8 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/qinling'
bug_project = 'qinling'
bug_tag = 'release notes'
openstackdocs_repo_name = 'openstack/qinling'
openstackdocs_use_storyboard = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -92,7 +91,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 = []


Loading…
Cancel
Save