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

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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: Iccb449e20174b973f83924659e1ee2db592a326f
This commit is contained in:
Andreas Jaeger 2020-05-21 20:33:31 +02:00
parent 5abd97149c
commit 288d663912
3 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,3 +1,3 @@
sphinx>=1.8.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
reno!=2.3.1,>=1.8.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
openstackdocstheme>=1.20.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0

18
doc/source/conf.py
View File

@ -26,8 +26,9 @@ try:
except ImportError: except ImportError:
openstackdocstheme = None openstackdocstheme = None
repository_name = 'openstack/tenks' openstackdocs_repo_name = 'openstack/tenks'
use_storyboard = True openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -44,19 +45,8 @@ master_doc = 'index'
# General information about the project. # General information about the project.
copyright = u'OpenStack Foundation' copyright = u'OpenStack Foundation'
# 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.
#
# The short X.Y version.
from tenks import version as tenks_version
# The full version, including alpha/beta/rc tags.
release = tenks_version.version_info.release_string()
# The short X.Y version.
version = tenks_version.version_info.version_string()
# 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'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.

6
releasenotes/source/conf.py
View File

@ -58,6 +58,10 @@ master_doc = 'index'
project = u'Tenks Release Notes' project = u'Tenks Release Notes'
copyright = u'{year}, The Tenks team'.format(year=datetime.date.today().year) copyright = u'{year}, The Tenks team'.format(year=datetime.date.today().year)
openstackdocs_repo_name = 'openstack/tenks'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
@ -97,7 +101,7 @@ exclude_patterns = []
# show_authors = False # show_authors = False
# 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'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []