Merge pull request #125 from ycexiao/fix-docstring

style: use numpy docstring and fix documentation rendering

Author: sbillinge

CHANGELOG.rst

@@ -9,7 +9,7 @@ Release notes
 
 
 Version 3.0.0 – 2019-03-14
-==========================
+--------------------------
 
 **Added:**
 

docs/source/api/.placeholder

@@ -14,17 +14,12 @@ Subpackages
 -----------
 
 .. toctree::
-   diffpy.srfit.example_package
-
-Submodules
-----------
-
-|module|
---------
-
-.. |module| replace:: diffpy.srfit.example_submodule module
-
-.. automodule:: diffpy.srfit.example_submodule
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   diffpy.srfit.equation
+   diffpy.srfit.equation.literals
+   diffpy.srfit.equation.visitors
+   diffpy.srfit.fitbase
+   diffpy.srfit.interface
+   diffpy.srfit.pdf
+   diffpy.srfit.sas
+   diffpy.srfit.structure
+   diffpy.srfit.util

docs/source/api/diffpy.srfit.example_package.rst

@@ -52,7 +52,7 @@
     "sphinx.ext.intersphinx",
     "sphinx_rtd_theme",
     "sphinx_copybutton",
-    "m2r",
+    "m2r2",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/api/diffpy.srfit.rst

@@ -4,4 +4,4 @@
 coreshellnp.py
 ========================
 
-.. literalinclude:: ../../../examples/coreshellnp.py
+.. literalinclude:: ../../examples/coreshellnp.py

docs/source/conf.py

@@ -4,4 +4,4 @@
 crystalpdf.py
 ========================
 
-.. literalinclude:: ../../../examples/crystalpdf.py
+.. literalinclude:: ../../examples/crystalpdf.py

docs/source/examples/coreshellnp.rst

@@ -4,4 +4,4 @@
 crystalpdfall.py
 ========================
 
-.. literalinclude:: ../../../examples/crystalpdfall.py
+.. literalinclude:: ../../examples/crystalpdfall.py

docs/source/examples/crystalpdf.rst

@@ -4,4 +4,4 @@
 crystalpdfobjcryst.py
 ========================
 
-.. literalinclude:: ../../../examples/crystalpdfobjcryst.py
+.. literalinclude:: ../../examples/crystalpdfobjcryst.py

docs/source/examples/crystalpdfall.rst

@@ -4,4 +4,4 @@
 crystalpdftwodata.py
 ========================
 
-.. literalinclude:: ../../../examples/crystalpdftwodata.py
+.. literalinclude:: ../../examples/crystalpdftwodata.py