3

How do we use autodoc?

I did python setup.py for both my of projects and their namespaces are importable..

I tried:

.. automodule:: project.backend

.. automodule:: project.api

But I am only getting

project.backend

     alias of project.backend

What did I do wrong?

bad_coder
  • 11,289
  • 20
  • 44
  • 72
User007
  • 1,519
  • 6
  • 22
  • 35
  • Does it work if you use the `members` option to [automodule](http://sphinx-doc.org/ext/autodoc.html#directive-automodule)? – mzjn Aug 06 '13 at 13:03
  • @mzjn I am afraid that;s a no :( – User007 Aug 06 '13 at 13:24
  • 1
    also add `:undoc-members:` and see what you see. But a big-picture warning: sphinx isn't a auto-generated-doc tool like doxygen/etc, if these dotted paths are actually packages with inner modules, `.. automodule::` won't recurse into them. Sphinx doesn't try (very hard) to solve the larger API auto-doccing problem, it's fundamentally oriented around human-written and maintained doc files with a structure that often diverges from the package paths. Take a look at Python's stdlib or Django docs - there's a lot of cruft/scaffolding, but that's OK. docs != code, shouldn't be organized identically. – AdamKG Aug 07 '13 at 13:06
  • Is `project` a namespace package? – Kevin Horn Dec 05 '13 at 22:48

0 Answers0