Skip to content

Commit 5cd6b76

Browse files
committed
Draw inheritance diagram
1 parent 7851c19 commit 5cd6b76

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

doc/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
extensions = [
99
'sphinx.ext.todo',
1010
'sphinx.ext.autodoc',
11+
'sphinx.ext.inheritance_diagram',
1112
]
1213
templates_path = [] # ['_templates']
1314
source_suffix = '.rst'
@@ -77,3 +78,7 @@
7778
u'Takafumi Arakaki', 'orgparse', 'One line description of project.',
7879
'Miscellaneous'),
7980
]
81+
82+
83+
# -- Options for extensions -----------------------------------------------
84+
inheritance_graph_attrs = dict(rankdir="TB")

doc/source/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Tree structure interface
1212

1313
.. py:module:: orgparse.node
1414
15+
.. inheritance-diagram::
16+
orgparse.node.OrgBaseNode
17+
orgparse.node.OrgRootNode
18+
orgparse.node.OrgNode
19+
:parts: 1
20+
1521
.. autoclass:: OrgBaseNode
1622
:members:
1723

@@ -32,6 +38,16 @@ Date interface
3238

3339
.. py:module:: orgparse.date
3440
41+
.. inheritance-diagram::
42+
orgparse.date.OrgDate
43+
orgparse.date.OrgDateSDCBase
44+
orgparse.date.OrgDateScheduled
45+
orgparse.date.OrgDateDeadline
46+
orgparse.date.OrgDateClosed
47+
orgparse.date.OrgDateClock
48+
orgparse.date.OrgDateRpeatedTask
49+
:parts: 1
50+
3551
.. autoclass:: OrgDate
3652
:members:
3753

0 commit comments

Comments
 (0)