> If it's not clear, the goal is to avoid having to keep the class/method > documentation updated by hand, because it will easily lag behind any changes > to the upstream headers. It obviously knows about the Python class, because > it provides a link to its declaration, so how do I get Sphinx to > automatically generate method entries for the referenced class:: name?
Have you tried using the "autodoc" extension? <http://sphinx.pocoo.org/ext/autodoc.html> It can automatically extract docstrings and generate entries for methods and other members. For it to work it, sphinx must be able to find and import your package. You might need to update your "conf.py" with something like this: sys.path.insert(0, os.path.abspath('..')) extensions = ['sphinx.ext.autodoc'] Then you can document the pcore module by adding the following to your .rst file: .. automodule:: pcore :members: :undoc-members: -- Jonathan Waltman -- 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.
