Sphinx inheritance-diagram Issue

sajuptpm

unread,

Dec 12, 2011, 6:06:27 AM12/12/11

to sphinx-dev

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:

werner

unread,

Dec 12, 2011, 6:23:26 AM12/12/11

to sphin...@googlegroups.com

On 12/12/2011 12:06 PM, sajuptpm 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

I am no Sphinx expert, but I try anyhow.

- did you add "sphinx.ext.inheritance_diagram" to your conf.py - extensions
- did you install graphviz
- see also at the end of:
http://sphinx.pocoo.org/ext/graphviz.html#module-sphinx.ext.graphviz

Werner

Saju M

unread,

Dec 12, 2011, 6:59:13 AM12/12/11

to sphin...@googlegroups.com

Hi werner,
thanks it is working now.
Issue was "sphinx.ext.inheritance_diagram" to your conf.py - extensions.

> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-dev" group.
> To post to this group, send email to sphin...@googlegroups.com.
> To unsubscribe from this group, send email to
> sphinx-dev+...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/sphinx-dev?hl=en.
>

Reply all

Reply to author

Forward