From 47b51081a5eadaa6cd91afc02e1f1345acaa7465 Mon Sep 17 00:00:00 2001 From: jacky06 Date: Thu, 21 May 2020 00:06:55 +0800 Subject: 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 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 21 ++++----------------- releasenotes/source/conf.py | 10 ++++------ 3 files changed, 11 insertions(+), 26 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 7d3660476..e800e8b09 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index fbde9778e..5616d7a57 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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', diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 12dd70547..86705c7f5 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -111,9 +111,6 @@ html_theme = 'openstackdocs' # " v 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 -- cgit v1.2.3