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.

Change-Id: Ibc90380a5b11a40e8f5adf171416d997f3452bed
changes/42/729042/4
Brian Haley 3 years ago committed by Maciej Józefczyk
parent 28c311ccd7
commit 52f9f82033
  1. 8
      doc/requirements.txt
  2. 11
      doc/source/conf.py
  3. 6
      lower-constraints.txt
  4. 9
      releasenotes/source/conf.py
  5. 4
      tox.ini

@ -1,9 +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.
sphinx!=1.6.6,!=1.6.7,>=1.6.2,!=2.1.0 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0

@ -30,15 +30,16 @@ extensions = [
]
# Project cross-reference roles
openstack_projects = [
openstackdocs_projects = [
'neutron',
'octavia',
]
# openstackdocstheme options
repository_name = 'openstack/ovn-octavia-provider'
bug_project = 'neutron'
bug_tag = 'ovn-octavia-provider'
openstackdocs_repo_name = 'openstack/ovn-octavia-provider'
openstackdocs_pdf_link = True
openstackdocs_bug_project = 'neutron'
openstackdocs_bug_tag = 'ovn-octavia-provider'
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -58,7 +59,7 @@ 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 --------------------------------------------------

@ -15,7 +15,6 @@ cryptography==2.1
debtcollector==1.2.0
decorator==3.4.0
deprecation==1.0
doc8==0.6.0
docutils==0.11
dogpile.cache==0.6.2
eventlet==0.18.2
@ -52,7 +51,6 @@ netifaces==0.10.4
neutron==15.0.0
neutron-lib==2.1.0
octavia-lib==1.3.1
openstackdocstheme==1.20.0
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -107,7 +105,7 @@ python-novaclient==9.1.0
python-subunit==1.0.0
pytz==2015.7
PyYAML==3.12
reno==2.5.0
reno==3.1.0
repoze.lru==0.7
requests==2.14.2
requestsexceptions==1.2.0
@ -115,8 +113,6 @@ rfc3986==0.3.1
Routes==2.3.1
simplejson==3.5.1
snowballstemmer==1.2.1
Sphinx==1.6.2
sphinxcontrib-websupport==1.0.1
SQLAlchemy==1.2.0
sqlalchemy-migrate==0.11.0
sqlparse==0.2.2

@ -43,9 +43,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/ovn-octavia-provider'
bug_project = 'neutron'
bug_tag = 'ovn-octavia-provider'
openstackdocs_repo_name = 'openstack/ovn-octavia-provider'
openstackdocs_bug_project = 'neutron'
openstackdocs_bug_tag = 'ovn-octavia-provider'
openstackdocs_auto_name = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -92,7 +93,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 = []

@ -92,10 +92,6 @@ envdir = {toxworkdir}/docs
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[doc8]
# File extensions to check
extensions = .rst
[flake8]
# W504 line break after binary operator
ignore = W504

Loading…
Cancel
Save