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.

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_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.

Depends-On: https://review.opendev.org/729744
Change-Id: I4c81bec463bb61a559ee8941545c16a08b7041f9
tags/3.2.0^0
Andreas Jaeger 1 month ago
parent
commit
c2eb453deb
3 changed files with 11 additions and 23 deletions
  1. +3
    -3
      doc/requirements.txt
  2. +4
    -15
      doc/source/conf.py
  3. +4
    -5
      releasenotes/source/conf.py

+ 3
- 3
doc/requirements.txt View File

@@ -1,6 +1,6 @@
# 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.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD

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

@@ -15,7 +15,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

import subprocess
import sys

import os
@@ -44,10 +43,9 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
'openstackdocstheme']

# openstackdocstheme options
repository_name = 'openstack/python-saharaclient'
bug_project = '934'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/python-saharaclient'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -65,15 +63,6 @@ master_doc = 'index'
project = u'Sahara Client'
copyright = u'2013, 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 saharaclient.version import version_info as saharaclient_version
release = saharaclient_version.release_string()
# The short X.Y version.
version = saharaclient_version.version_string()

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -104,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 = []


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

@@ -20,10 +20,9 @@ extensions = [
]

# openstackdocstheme options
repository_name = 'openstack/python-saharaclient'
bug_project = '934'
bug_tag = 'releasenotes'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/python-saharaclient'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -49,7 +48,7 @@ version = ''
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'


# -- Options for HTML output ----------------------------------------------


Loading…
Cancel
Save