DOC: Update some Sphinx doc files:

* Include a file for release notes.
* Change the name of the rst files for the individual functions.
* Use autosummary, and add a hidden toctree to prevent Sphinx warnings.

Author: WarrenWeckesser

doc/source/conf.py

@@ -50,11 +50,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'alabaster'
-# html_theme = 'pyramid'
-# html_theme = 'nature'
 html_theme = 'bizstyle'
-# html_theme = 'classic'
 html_copy_source = False
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -66,5 +62,5 @@
 html_favicon = "_static/numpy_financial_favicon.png"
 
 html_sidebars = {
-    '**': ['globaltoc.html', 'searchbox.html'],
+    '**': ['localtoc.html', 'searchbox.html'],
 }

doc/source/numpy_financial.fv.rst renamed to doc/source/fv.rst

@@ -11,7 +11,7 @@
 def generate_rst_function_files():
     names = [name for name in dir(nf) if not name.startswith('_')]
     for name in names:
-        with open('numpy_financial.' + name + '.rst', 'w') as f:
+        with open(name + '.rst', 'w') as f:
             f.write('''{name}
 {underline}
 

doc/source/generate_rst_function_files.py

@@ -1,12 +1,8 @@
-.. numpy-financial documentation master file, created by
-   sphinx-quickstart on Tue Oct  1 23:15:00 2019.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
 numpy-financial |version|
 =========================
 
-The `numpy-financial` package contains a collection of elementary financial
+The `numpy-financial` package is a collection of elementary financial
 functions.
 
 The `financial functions in NumPy <https://numpy.org/doc/1.17/reference/routines.financial.html>`_
@@ -32,21 +28,40 @@ Functions
 
 .. toctree::
    :maxdepth: 4
-   :caption: Contents:
 
 .. autosummary::
-   :toctree: .
-
-   numpy_financial.fv
-   numpy_financial.ipmt
-   numpy_financial.irr
-   numpy_financial.mirr
-   numpy_financial.nper
-   numpy_financial.npv
-   numpy_financial.pmt
-   numpy_financial.ppmt
-   numpy_financial.pv
-   numpy_financial.rate
+
+   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:
+
+   fv
+   ipmt
+   irr
+   mirr
+   nper
+   npv
+   pmt
+   ppmt
+   pv
+   rate
+
+
+.. include:: release-notes.rst
+
 
 
 Index and Search