Skip to content

Commit 10348d9

Browse files
committed
Document automodule and autosummary directives
1 parent 1779cbd commit 10348d9

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,23 @@ And then, in the docs::
357357

358358
.. autoattribute:: Bing#bong
359359

360+
automodule
361+
----------
362+
363+
This directive documents all exports on a module. For example::
364+
365+
.. js:automodule:: package.submodule
366+
367+
368+
autosummary
369+
-----------
370+
371+
This directive should be paired with an automodule directive (which may occur in
372+
a distinct rst file). It makes a summary table with links to the entries
373+
generated by the automodule directive. Usage::
374+
375+
.. js:automodule:: package.submodule
376+
360377
Dodging Ambiguity With Pathnames
361378
--------------------------------
362379

0 commit comments

Comments
 (0)