openstack/adjutant
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.

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: Ic5488acc81538c1dbde70fcc52d9175e3b98059a
This commit is contained in:
Andreas Jaeger 2020-05-24 20:22:44 +02:00
parent 571aa70667
commit b32d0be3a0
4 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api-ref/source/conf.py
View File

@ -39,9 +39,10 @@ html_theme = "openstackdocstheme"
# html_theme_options = {} # html_theme_options = {}
# openstackdocstheme settings # openstackdocstheme settings
repository_name = "openstack/adjutant" openstackdocs_repo_name = "openstack/adjutant"
openstackdocs_auto_name = False
html_theme = "openstackdocs" html_theme = "openstackdocs"
use_storyboard = True openstackdocs_use_storyboard = True
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() # html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

4
doc/requirements.txt
View File

@ -1,4 +1,4 @@
os-api-ref>=1.6.1 # Apache-2.0 os-api-ref>=1.6.1 # Apache-2.0
openstackdocstheme>=2.0.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
reno>=2.11.3 # Apache-2.0 reno>=3.1.0 # Apache-2.0

5
doc/source/conf.py
View File

@ -36,9 +36,10 @@ extensions = ["openstackdocstheme"]
templates_path = ["_templates"] templates_path = ["_templates"]
# openstackdocstheme settings # openstackdocstheme settings
repository_name = "openstack/adjutant" openstackdocs_repo_name = "openstack/adjutant"
openstackdocs_auto_name = False
html_theme = "openstackdocs" html_theme = "openstackdocs"
use_storyboard = True openstackdocs_use_storyboard = True
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:

5
releasenotes/source/conf.py
View File

@ -55,8 +55,9 @@ project = "Adjutant Release Notes"
copyright = "2019, Adjutant Developers" copyright = "2019, Adjutant Developers"
# openstackdocstheme settings # openstackdocstheme settings
repository_name = "openstack/adjutant" openstackdocs_repo_name = "openstack/adjutant"
use_storyboard = True openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# Release notes are version independent # Release notes are version independent