openstack/taskflow
Code Issues Proposed changes

docs: Add inheritance diagram to exceptions documentation

Browse Source 
In light of exception hierarchy adjustments currently in progress
(I0e1e81b513fbbc7adb8bfaa1244993e345ab70d3) it becomes really helpful to
have inheritance diagram for exceptions in documentation.

Change-Id: Ie8f7b160de08fa8a91499cac2f94a76aff186e67
This commit is contained in:
Ivan A. Melnikov
2014-03-17 12:29:34 +04:00
parent f1eea7197e
commit 0c72f19d97
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@@ -11,6 +11,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.doctest', 'sphinx.ext.doctest',
'sphinx.ext.inheritance_diagram',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'oslosphinx' 'oslosphinx'

4
doc/source/exceptions.rst
View File

@@ -2,4 +2,8 @@
Exceptions Exceptions
---------- ----------
.. inheritance-diagram::
taskflow.exceptions
:parts: 1
.. automodule:: taskflow.exceptions .. automodule:: taskflow.exceptions