Merge pull request #109 from drammock/docs-fixup

DOC: Docs fixup

Author: Kai-Striega

.gitignore

@@ -111,3 +111,4 @@ poetry.lock
 
 # Things specific to this project #
 ###################################
+doc/source/_api_stubs

doc/source/release-notes.rst renamed to doc/source/_includes/release-notes.rst

@@ -0,0 +1,18 @@
+API Documentation
+=================
+
+.. currentmodule:: numpy_financial
+
+.. autosummary::
+   :toctree: _api_stubs/
+
+   fv
+   ipmt
+   irr
+   mirr
+   nper
+   npv
+   pmt
+   ppmt
+   pv
+   rate

doc/source/api.rst

@@ -61,7 +61,3 @@
 
 html_logo = "_static/numpy_financial_logov.svg"
 html_favicon = "_static/numpy_financial_favicon.png"
-
-html_sidebars = {
-    '**': ['localtoc.html', 'searchbox.html'],
-}

doc/source/conf.py

@@ -0,0 +1,12 @@
+Development
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   getting_the_code.md
+   building_with_poetry.md
+   running_the_benchmarks.md
+
+
+.. include:: ../_includes/release-notes.rst

doc/source/dev/index.rst

@@ -20,60 +20,16 @@ alias is `npf`.  For example,
 >>> npf.irr([-250000, 100000, 150000, 200000, 250000, 300000])
 0.5672303344358536
 
-
-Functions
----------
-
-.. currentmodule:: numpy_financial
-
-.. toctree::
-   :maxdepth: 4
-
-.. autosummary::
-
-   fv
-   ipmt
-   irr
-   mirr
-   nper
-   npv
-   pmt
-   ppmt
-   pv
-   rate
-
-.. The following "hidden" toctree is a hack to prevent Sphinx warnings
-   about "document isn't included in any toctree"
-
 .. toctree::
    :hidden:
+   :maxdepth: 4
 
-   fv
-   ipmt
-   irr
-   mirr
-   nper
-   npv
-   pmt
-   ppmt
-   pv
-   rate
-
-Development
-===========
-
-.. toctree::
-   :maxdepth: 1
-
-   dev/getting_the_code.md
-   dev/building_with_poetry.md
-   dev/running_the_benchmarks.md
-
-.. include:: release-notes.rst
+   api
+   dev/index
 
 
 Index and Search
-================
+----------------
 
 * :ref:`genindex`
 * :ref:`search`