I am having my first go at trying to document an application with Sphinx, the application is a framework I try to learn which has no searchable documentation, so I thought I might as well learn how to document it with Sphinx.

I am running into a problem that super classes contained in top level .py files (the ones at the package folder) don't get linked correctly.

For example:

foo.py contains class foo and foo.py is in package x

In the code some other class inherits from class foo by doing

from x.foo import foo

class anotherClass(foo):

Now when documenting anotherClass I get for the super class "x.foo.foo" but when documenting foo I get "foo.foo" i.e. without the top level package.

I hope I am explaining this well enough.

I guess I need to somehow tell Sphinx that class x.foo.foo is documented as class foo.foo to make sure that e.g. Inheritance diagrams can link to the correct class documentation etc.

Can someone give me some hints on what I need to do.
Werner



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

Reply via email to