We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 1779cbd commit 10348d9Copy full SHA for 10348d9
1 file changed
README.rst
@@ -357,6 +357,23 @@ And then, in the docs::
357
358
.. autoattribute:: Bing#bong
359
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
376
377
Dodging Ambiguity With Pathnames
378
--------------------------------
379
0 commit comments