use sphinx autosummary

Author: wholmgren

.gitignore

@@ -36,7 +36,7 @@ pvlib/spa_c_files/spa.h
 pvlib/spa_c_files/spa_tester.c
 
 # generated documentation
-# pvlib/sphinx/Docs/build/
+docs/sphinx/source/generated/
 
 # Installer logs
 pip-log.txt

docs/sphinx/source/_templates/autosummary/class.rst

@@ -0,0 +1,31 @@
+{{ fullname }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: {{ objname }}
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: {{ objname }}
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/sphinx/source/_templates/autosummary/module.rst

@@ -0,0 +1,40 @@
+{{ fullname }}
+{{ underline }}
+
+.. automodule:: {{ fullname }}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: {{ objname }}
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: {{ objname }}
+      :template: autosummary/class.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   .. autosummary::
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/sphinx/source/conf.py

@@ -123,6 +123,7 @@ def __getattr__(cls, name):
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
 
+autosummary_generate = True
 
 # -- Options for HTML output ----------------------------------------------
 

docs/sphinx/source/index.rst

@@ -66,7 +66,7 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
    package_overview
    whatsnew

docs/sphinx/source/modules.rst

@@ -1,83 +1,17 @@
 Modules
 =======
 
-atmosphere
------------------
-
-.. automodule:: pvlib.atmosphere
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-clearsky
-----------------
-
-.. automodule:: pvlib.clearsky
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-irradiance
------------------
-
-.. automodule:: pvlib.irradiance
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-location
----------------
-
-.. automodule:: pvlib.location
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-modelchain
-----------
-
-.. automodule:: pvlib.modelchain
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pvsystem
----------------
-
-.. automodule:: pvlib.pvsystem
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-solarposition
---------------------
-
-.. automodule:: pvlib.solarposition
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    
-tmy
---------------------
-
-.. automodule:: pvlib.tmy
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-tracking
---------------------
-
-.. automodule:: pvlib.tracking
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-tools
---------------------
-
-.. automodule:: pvlib.tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    
+.. autosummary::
+    :toctree: generated
+    :template: autosummary/module.rst
+
+    pvlib.atmosphere
+    pvlib.clearsky
+    pvlib.irradiance
+    pvlib.location
+    pvlib.modelchain
+    pvlib.pvsystem
+    pvlib.solarposition
+    pvlib.tmy
+    pvlib.tools
+    pvlib.tracking