From 1721e2871dfe9cb96e79e65116cc472f2ce7265a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 18 May 2020 21:53:55 +0200 Subject: [PATCH] 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. 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 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I1d02403727831c29f3a38cfc11949325614ac7d0 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 13 +++++-------- lower-constraints.txt | 5 ----- releasenotes/source/conf.py | 19 +++++-------------- 4 files changed, 13 insertions(+), 30 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 7cd210dd7..7fb9aa55f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,7 +1,7 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.32.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2,!=2.1.0 # BSD -reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 sphinxcontrib-programoutput>=0.11 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 252a65fd6..d04206d18 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,8 +16,6 @@ import os import sys -import openstackdocstheme - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -43,7 +41,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'python-manilaclient' copyright = u'Rackspace, based on work by Jacob Kaplan-Moss' # List of directories, relative to source directory, that shouldn't be searched @@ -58,19 +55,19 @@ 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 -------------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'python-manilaclientdoc' html_theme = 'openstackdocs' -html_theme_path = [openstackdocstheme.get_html_theme_path()] # openstackdocstheme options -repository_name = 'openstack/python-manilaclient' -bug_project = 'python-manilaclient' -bug_tag = 'docs' +openstackdocs_repo_name = 'openstack/python-manilaclient' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'python-manilaclient' +openstackdocs_bug_tag = 'docs' # -- Options for LaTeX output ------------------------------------------------- diff --git a/lower-constraints.txt b/lower-constraints.txt index 3b7308aa9..f9030fa30 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -36,7 +36,6 @@ msgpack-python==0.4.0 munch==2.1.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.32.1 openstacksdk==0.11.2 os-client-config==1.28.0 os-service-types==1.2.0 @@ -70,16 +69,12 @@ python-openstackclient==3.12.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 requests==2.14.2 requestsexceptions==1.2.0 rfc3986==0.3.1 simplejson==3.5.1 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.5 -sphinxcontrib-websupport==1.0.1 -sphinxcontrib-programoutput==0.11 stestr==1.0.0 stevedore==1.20.0 tempest==17.1.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index c27f52c0c..fc12d4b09 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -30,8 +30,6 @@ # -- General configuration ------------------------------------------------ -import openstackdocstheme - # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' @@ -44,10 +42,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/python-manilaclient' -bug_project = 'python-manilaclient' -bug_tag = 'release notes' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/python-manilaclient' +openstackdocs_bug_project = 'python-manilaclient' +openstackdocs_bug_tag = 'release notes' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -100,7 +98,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 = [] @@ -120,9 +118,6 @@ html_theme = 'openstackdocs' # documentation. # html_theme_options = {} -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None @@ -149,10 +144,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. # html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True