Browse Source

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.

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.

Remove ipaddress from requirements so that requirements-check passes.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ifc6eeeb4d43dbd6c9e531d773b3320e234304ab0
changes/11/731511/2
Andreas Jaeger 1 year ago
parent
commit
d2c4881d07
4 changed files with 11 additions and 24 deletions
  1. +3
    -3
      doc/requirements.txt
  2. +4
    -17
      doc/source/conf.py
  3. +4
    -3
      releasenotes/source/conf.py
  4. +0
    -1
      requirements.txt

+ 3
- 3
doc/requirements.txt View File

@ -3,11 +3,11 @@
# process, which may cause wedges in the gate later.
sphinxcontrib-apidoc>=0.2.0 # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2,!=2.1.0; # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
# PDF Docs
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

+ 4
- 17
doc/source/conf.py View File

@ -16,8 +16,6 @@ import datetime
import os
import sys
import openstackdocstheme
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('.'))
@ -49,16 +47,6 @@ master_doc = 'index'
project = u'octavia-tempest-plugin'
copyright = u'2017-2019, 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.
#
# Version info
from octavia_tempest_plugin.version import version_info as octavia_tempest_ver
release = octavia_tempest_ver.release_string()
# The short X.Y version.
version = octavia_tempest_ver.version_string()
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -67,14 +55,14 @@ add_function_parentheses = True
add_module_names = 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 = ['octavia_tempest_plugin.']
repository_name = 'openstack/octavia-tempest-plugin'
bug_project = '910'
bug_tag = 'docs'
openstackdocs_repo_name = 'openstack/octavia-tempest-plugin'
openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
apidoc_output_dir = '_build/modules'
apidoc_module_dir = '../../octavia_tempest_plugin'
@ -90,7 +78,6 @@ apidoc_excluded_paths = []
html_theme = 'openstackdocs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project


+ 4
- 3
releasenotes/source/conf.py View File

@ -43,8 +43,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/octavia-tempest-plugin'
use_storyboard = True
openstackdocs_repo_name = 'openstack/octavia-tempest-plugin'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -102,7 +103,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 = []


+ 0
- 1
requirements.txt View File

@ -4,7 +4,6 @@
cryptography>=2.1 # BSD/Apache-2.0
python-dateutil>=2.5.3 # BSD
ipaddress>=1.0.17;python_version<'3.3' # PSF
pbr!=2.1.0,>=2.0.0 # Apache-2.0
oslo.config>=5.2.0 # Apache-2.0
oslo.log>=3.36.0 # Apache-2.0


Loading…
Cancel
Save