File 0001-Switch-from-oslosphinx-to-openstackdocstheme.patch of Package python-scciclient
From c707305e94b7ba269d17fc86d24013ec43231247 Mon Sep 17 00:00:00 2001
From: Thomas Bechtold <tbechtold@suse.com>
Date: Mon, 7 Oct 2019 15:03:53 +0200
Subject: [PATCH] Switch from oslosphinx to openstackdocstheme
That's what the OpenStack community is using today. Also with newer
Sphinx versions, the current approach does no longer build.
---
doc/source/conf.py | 6 +++++-
test-requirements.txt | 5 +++--
tox.ini | 3 ++-
3 files changed, 10 insertions(+), 4 deletions(-)
Index: python-scciclient-0.8.1/doc/source/conf.py
===================================================================
--- python-scciclient-0.8.1.orig/doc/source/conf.py
+++ python-scciclient-0.8.1/doc/source/conf.py
@@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../.
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
- 'oslosphinx'
+ 'openstackdocstheme'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -57,6 +57,7 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
+html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
@@ -73,3 +74,6 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
+
+# openstackdocstheme options
+repository_name = 'openstack/python-scciclient'
Index: python-scciclient-0.8.1/test-requirements.txt
===================================================================
--- python-scciclient-0.8.1.orig/test-requirements.txt
+++ python-scciclient-0.8.1/test-requirements.txt
@@ -14,6 +14,7 @@ testtools>=2.2.0 # MIT
requests-mock>=1.2.0 # Apache-2.0
# Doc requirements
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD
+openstackdocstheme # Apache-2.0
Index: python-scciclient-0.8.1/tox.ini
===================================================================
--- python-scciclient-0.8.1.orig/tox.ini
+++ python-scciclient-0.8.1/tox.ini
@@ -33,7 +33,8 @@ commands =
[testenv:docs]
basepython = python3
-commands = python setup.py build_sphinx
+commands =
+ sphinx-build -b html doc/source doc/build/html
[flake8]
# E123, E125 skipped as they are invalid PEP-8.