autosummary: improve conf.py entry.

timmie avatartimmie created an issue

Hello, It is currently not clear what values the conf.py entry for autosummary http://sphinx.pocoo.org/latest/ext/autosummary.html?highlight=autosummary#generating-stub-pages-automatically

expects as input.

The best would be a boolean value: If set to True, it would iterate over the source documents and create the stub files where the files contain a

.. autosummary:: :toctree: DIRNAME

directive.

This would be very convenient and user-friendly.

There is a discussion at: http://thread.gmane.org/gmane.comp.python.sphinx.devel/2193/focus=2251

Thanks in advance.

Comments (2)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.