Readme

Readme

Readme

Minor

README.rst

@@ -9,7 +9,13 @@ available as a standalone package since it can be used for any other
 package. The documentation can be found on
 `ReadTheDocs <http://sphinx-automodapi.readthedocs.io/en/latest/>`_.
 
-This extension was forked from the Astropy project for use with the ProPlot project, in order to change a few hard-coded settings that could not be changed with the existing API. ProPlot documentation can also be found on `ReadTheDocs <https://proplot.readthedocs.io/en/latest>`_.
+Proplot modifications
+---------------------
+This extension was forked from the Astropy project for use with the `proplot <https://github.com/lukelbd/proplot>`__ project in order to add some features. The following changes were made:
+
+* Adds ``__getitem__``, ``__getattr__``, ``__setitem__``, and ``__setattr__`` to the list of builtin methods that are *not* ignored by the documentation generator.
+* Skips over class methods that are public, but do *not* have their own ``__doc__`` attributes, to prevent inheriting and displaying documentation from external projects.
+* 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.
 
 
 Running tests

sphinx_automodapi/automodsumm.py

@@ -447,7 +447,7 @@ def generate_automodsumm_docs(lines, srcfn, app=None, suffix='.rst',
     if builder is not None:
         # allow the user to override the templates
         # also add to the templates_path
-        # TODO: messes up usage for some users? for time being IDGAF
+        # TODO: messes up usage for some users?
         local_dir_full = os.path.join(local_dir, 'autosummary_core')
         templates_path = builder.config.templates_path
         if local_dir_full not in templates_path: