summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-05-18 22:41:31 +0200
committerAndreas Jaeger <aj@suse.com>2020-05-20 21:52:50 +0200
commitc2eb453deb9aae28a9892f63a30d8d34763a4c97 (patch)
tree2144a1f209cb0e3e94876eedee55045f5d99bd5d
parent7ac9d1b3242444a3d2ceed075816bfcf726608a0 (diff)
downloadpython-saharaclient-c2eb453deb9aae28a9892f63a30d8d34763a4c97.tar.gz
Switch to newer openstackdocstheme and reno versions3.2.0
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
-rw-r--r--doc/requirements.txt6
-rw-r--r--doc/source/conf.py19
-rw-r--r--releasenotes/source/conf.py9
3 files changed, 11 insertions, 23 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 12d1957..0673b3d 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -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
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f49cb92..15fdc68 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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 = []
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index fd1f2e4..1c413dc 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -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 ----------------------------------------------