Add API to documentation

docs/_config.yml

@@ -15,3 +15,9 @@ html:
   use_edit_page_button  : true
   use_repository_button : true
   use_issues_button     : true
+
+sphinx:
+  extra_extensions          : ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
+                               'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
+                               'alabaster']   # A list of extra extensions to load by Sphinx.
+  config                    :   # key-value pairs to directly over-ride the Sphinx configuration

docs/_toc.yml

@@ -8,3 +8,6 @@
     - file: gini
     - file: income_measures
     - file: weighting
+- file: api/api
+  sections:
+  - file: api/agg

docs/api/agg.rst

@@ -0,0 +1,14 @@
+.. _agg:
+
+microdf aggregation functions
+=================================================
+
+**microdf aggregation functions**
+
+microdf.agg
+------------------------------------------
+
+.. currentmodule:: microdf.agg
+
+.. automodule:: microdf.agg
+  :members: combine_base_reform, pctchg_base_reform, agg

docs/api/api.rst

@@ -0,0 +1,12 @@
+microdf API
+=============
+
+Here we provide a view of the microdf API with links to the source code.
+Below is a list of the microdf package modules (in alphabetical order) with
+documentation about how to call each function.
+There is also a link to the source code for each documented member.
+
+.. toctree::
+   :maxdepth: 1
+
+   agg