Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3c5889b

Browse files
committed
Readme
1 parent 76e0f51 commit 3c5889b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This extension was forked from the Astropy project for use with the `proplot <ht
1515

1616
* Adds ``__getitem__``, ``__getattr__``, ``__setitem__``, and ``__setattr__`` to the list of builtin methods that are *not* ignored by the documentation generator.
1717
* Skips over class methods that are public, but do *not* have their own ``__doc__`` attributes, to prevent inheriting and displaying documentation from external projects.
18-
* Gives class methods and attributes their own stub pages, instead of putting all class methods and attributes on a single page. This also requires reordering the event hooks so ``sphinx_automodapi`` is called before ``autosummary``, so that ``autosummary`` detects the automatically generated class pages.
18+
* Gives class methods and attributes their own stub pages, instead of putting all class methods and attributes on a single page. This also requires adding the new files to ``env.found_docs`` and reordering the event hooks so ``sphinx_automodapi`` is called before ``autosummary``. This way ``autosummary`` will read the automatically generated class pages and generate the corresponding stubs.
1919

2020

2121
Running tests

0 commit comments

Comments
 (0)