[BangPypers] Sphinx inheritance-diagram Issue

Saju M sajuptpm at gmail.com
Mon Dec 12 13:16:28 CET 2011


Another Issue:

I am using "sphinx-apidoc" for documentation
$ sphinx-apidoc -f -F -o . /home/sam/CMS
$ make html

I want to include class 'inheritance-diagram' in all my module document page.
Right now, i have to edit all *rst file and add two lines as shown
below, for each modules.

class inheritance diagram
-------------------------
.. inheritance-diagram:: CMS.cloud.DbModel.modulename


Have any otherway to do it in single shot, like what "sphinx-apidoc"
did for documentation ???
I could not find any option in document of "sphinx-apidoc" tool
http://sphinx.pocoo.org/invocation.html#invocation-of-sphinx-apidoc




On Mon, Dec 12, 2011 at 7:15 AM, Saju M <sajuptpm at gmail.com> wrote:
> Hi,
> Issue solved by adding "sphinx.ext.inheritance_diagram" to your
> conf.py - extensions
>
> On Mon, Dec 12, 2011 at 6:05 AM, Saju M <sajuptpm at gmail.com> wrote:
>> I created complete API documentation using sphinx.
>> Command i used are:
>> $ sphinx-apidoc -f -F -o . /home/sam/CMS
>> $ make html
>>
>> Then i planned to add inheritance-diagram of classes, for that i
>> edited "provider.rst" file and added two new lines as shown below.
>>
>> provider diagram
>> ----------------
>> .. inheritance-diagram:: CMS.cloud.DbModel.CloudProvider
>>
>>
>> Then i did "$ make html" again, after that i could see the new heading
>> "provider diagram", but could not see any diagram.
>> I did not get any errors.
>>
>>
>> Note:
>> =====
>> * Here CloudProvider is a module.
>>
>>
>>
>> ############ provider.rst fiel############
>>
>> DbModel Package
>> ===============
>>
>> :mod:`CPTypes` Module
>> ---------------------
>>
>> .. automodule:: CMS.cloud.DbModel.CPTypes
>>    :members:
>>    :undoc-members:
>>    :show-inheritance:
>>
>> :mod:`CloudProvider` Module
>> ---------------------------
>>
>> .. automodule:: CMS.cloud.DbModel.CloudProvider
>>    :members:
>>    :undoc-members:
>>    :show-inheritance:
>>
>> provider diagram
>> ----------------
>>
>> .. inheritance-diagram:: CMS.cloud.DbModel.CloudProvider
>>
>>
>> :mod:`Network` Module
>> ---------------------
>>
>> .. automodule:: CMS.cloud.DbModel.Network
>>    :members:
>>    :undoc-members:
>>    :show-inheritance:


More information about the BangPypers mailing list