openstack/diskimage-builder
Code Issues Proposed changes

Fix sphinx-build to not depend on diskimage-builder

Browse Source 
Currently, running sphinx_build fails for us because we depend on
diskimage-builder in our sphinx conf.py. This causes doc generation
on sites like rtfd to fail unless they install the diskimage-builder
module beforehand. We can, alternatively, import pbr directly and not
require the module as part of doc generation.

Change-Id: I41f222ff9c67950fc30841935a6a603f5718395e
This commit is contained in:
Gregory Haynes 2016-06-20 18:36:42 -07:00
parent abe666f17e
commit 8b3419b0a9
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -27,11 +27,13 @@ copyright = u'2015, OpenStack Foundation'
# built documents. # built documents.
# #
from diskimage_builder import version as dib_version import pbr.version
version_info = pbr.version.VersionInfo('diskimage-builder')
# The short X.Y version. # The short X.Y version.
release = dib_version.version_info.release_string() release = version_info.release_string()
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
version = dib_version.version_info.version_string() version = version_info.version_string()
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

1
requirements.txt
View File

@ -7,3 +7,4 @@ pbr>=1.6 # Apache-2.0
PyYAML>=3.1.0 # MIT PyYAML>=3.1.0 # MIT
flake8<2.6.0,>=2.5.4 # MIT flake8<2.6.0,>=2.5.4 # MIT
six>=1.9.0 # MIT six>=1.9.0 # MIT
oslosphinx>=2.5.0,!=3.4.0 # Apache-2.0