openstack
/
kolla
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

Update Sphinx version as well.

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.

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.

Set openstackdocs_auto_name to use 'project' as name.

Change-Id: I138d51ace230a434e76fbe9fbbe97e53212230f3
This commit is contained in:
jacky06 2020-05-21 00:06:55 +08:00 committed by Andreas Jaeger
parent 1ebb97c9f2
commit 47b51081a5
3 changed files with 11 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -3,7 +3,7 @@
# process, which may cause wedges in the gate later.
doc8>=0.6.0 # Apache-2.0
openstackdocstheme>=1.19.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

21
doc/source/conf.py
View File

@ -40,17 +40,6 @@ master_doc = 'index'
project = u'kolla'
copyright = u'2013-present, 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 kolla.version import version_info as kolla_version
# The full version, including alpha/beta/rc tags.
release = kolla_version.version_string_with_vcs()
# The short X.Y version.
version = kolla_version.canonical_version_string()
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -76,9 +65,6 @@ html_theme_options = {
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
@ -93,9 +79,10 @@ latex_documents = [
latex_use_xindy = False
# openstackdocstheme options
repository_name = 'openstack/kolla'
bug_project = 'kolla'
bug_tag = ''
openstackdocs_repo_name = 'openstack/kolla'
openstackdocs_pdf_link = True
openstackdocs_bug_project = 'kolla'
openstackdocs_bug_tag = ''
openstack_projects = [
'kolla-ansible',
'oslotest',

10
releasenotes/source/conf.py
View File

@ -111,9 +111,6 @@ html_theme = 'openstackdocs'
# "<project> v<release> documentation".
# html_title = None
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
@ -252,6 +249,7 @@ texinfo_documents = [
locale_dirs = ['locale/']
# openstackdocstheme options
repository_name = 'openstack/kolla'
bug_project = 'kolla'
bug_tag = ''
openstackdocs_repo_name = 'openstack/kolla'
openstackdocs_bug_project = 'kolla'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False