File 0001-Make-openstackdocstheme-an-optional-doc-de... of Package python-stevedore

Overview Repositories Revisions Requests Users Attributes Meta

File 0001-Make-openstackdocstheme-an-optional-doc-dependency.patch of Package python-stevedore (Revision 29952d34e50ab56d22497016f3be99ba)

Currently displaying revision 29952d34e50ab56d22497016f3be99ba , Show latest

From f9503f1a3069c4a151c8f35f942f892f09451263 Mon Sep 17 00:00:00 2001
From: Thomas Bechtold <tbechtold@suse.com>
Date: Wed, 23 Aug 2017 08:30:23 +0200
Subject: [PATCH 1/2] Make openstackdocstheme an optional doc dependency

stevedore is a library that is used outside of OpenStack, too. Having
a build requirement that needs something OpenStack specific makes
life in cases (eg. for downstream packagers) more difficult.
So let's make openstackdocstheme an optional requirement.

Change-Id: Ic8cc577e617e5da699f9dc43830183005bd2ee66
---
 doc/source/conf.py    | 16 ++++++++++++++--
 setup.cfg             |  8 ++++++++
 test-requirements.txt |  1 -
 tox.ini               |  1 +
 4 files changed, 23 insertions(+), 3 deletions(-)

Index: stevedore-1.25.0/doc/source/conf.py
===================================================================
--- stevedore-1.25.0.orig/doc/source/conf.py
+++ stevedore-1.25.0/doc/source/conf.py
@@ -14,6 +14,16 @@
 import datetime
 import subprocess
 
+# make openstackdocstheme an optional dependency. stevedore is a low level lib
+# that is used outside of OpenStack. Not having something OpenStack specific
+# as build requirement is a good thing.
+try:
+    import openstackdocstheme
+except ImportError:
+    has_openstackdocstheme = False
+else:
+    has_openstackdocstheme = True
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -31,9 +41,10 @@ extensions = [
     'sphinx.ext.todo',
     'sphinx.ext.graphviz',
     'sphinx.ext.extlinks',
-    'openstackdocstheme',
     'stevedore.sphinxext',
 ]
+if has_openstackdocstheme:
+    extensions.append('openstackdocstheme')
 
 # openstackdocstheme options
 repository_name = 'openstack/stevedore'
@@ -108,7 +119,8 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #html_theme = 'default'
-html_theme = 'openstackdocs'
+if has_openstackdocstheme:
+    html_theme = 'openstackdocs'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
Index: stevedore-1.25.0/setup.cfg
===================================================================
--- stevedore-1.25.0.orig/setup.cfg
+++ stevedore-1.25.0/setup.cfg
@@ -16,6 +16,14 @@ classifier =
 	Intended Audience :: Developers
 	Environment :: Console
 
+[extras]
+docs =
+    # make openstackdocstheme an optional dependency. stevedore is a low level
+    # lib that is used outside of OpenStack. Not having something OpenStack
+    # specific as build requirement is a good thing.
+    openstackdocstheme>=1.16.0 # Apache-2.0
+
+
 [global]
 setup-hooks = 
 	pbr.hooks.setup_hook
Index: stevedore-1.25.0/test-requirements.txt
===================================================================
--- stevedore-1.25.0.orig/test-requirements.txt
+++ stevedore-1.25.0/test-requirements.txt
@@ -7,5 +7,4 @@ sphinx>=1.6.2 # BSD
 mock>=2.0 # BSD
 coverage!=4.4,>=4.0 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
-openstackdocstheme>=1.11.0 # Apache-2.0
 reno!=2.3.1,>=1.8.0 # Apache-2.0
Index: stevedore-1.25.0/tox.ini
===================================================================
--- stevedore-1.25.0.orig/tox.ini
+++ stevedore-1.25.0/tox.ini
@@ -10,6 +10,7 @@ setenv =
 install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
 deps =
   -r{toxinidir}/test-requirements.txt
+  .[docs]
 distribute = False
 commands = python setup.py testr --testr-args='{posargs}'

Places

File 0001-Make-openstackdocstheme-an-optional-doc-dependency.patch of Package python-stevedore (Revision 29952d34e50ab56d22497016f3be99ba)

Places