IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: make looks understandable

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-01-13 11:09:27 +09:00
parent 76c5395c5b
commit 12a8d5c0bd
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/ext/inheritance.rst
View File

@ -74,9 +74,8 @@ It adds this directive:
If you have specified a module in the inheritance diagram like this::
.. inheritance-diagram::
dummy.test
:top-classes: dummy.test.B, dummy.test.C
.. inheritance-diagram:: dummy.test
:top-classes: dummy.test.B, dummy.test.C
any base classes which are ancestors to ``top-classes`` and are also defined
in the same module will be rendered as stand alone nodes. In this example
@ -86,11 +85,8 @@ It adds this directive:
If you don't want class A (or any other ancestors) to be visible then specify
only the classes you would like to generate the diagram for like this::
.. inheritance-diagram::
dummy.test.D
dummy.test.E
dummy.test.F
:top-classes: dummy.test.B, dummy.test.C
.. inheritance-diagram:: dummy.test.D dummy.test.E dummy.test.F
:top-classes: dummy.test.B, dummy.test.C
.. versionchanged:: 1.7
Added ``top-classes`` option to limit the scope of inheritance graphs.