added package api

chrisjsewell · Jul 2, 2016 · 34b7ecd · 34b7ecd
1 parent 64146b5
commit 34b7ecd
Show file tree

Hide file tree

Showing 9 changed files with 182 additions and 1 deletion.
diff --git a/docs/source/api/Makefile b/docs/source/api/Makefile
@@ -0,0 +1 @@
+sphinx-apidoc --force -o . ../../../ipymd/
diff --git a/docs/source/api/ipymd.chemlab_patch.rst b/docs/source/api/ipymd.chemlab_patch.rst
@@ -0,0 +1,46 @@
+ipymd.chemlab_patch package
+===========================
+
+Submodules
+----------
+
+ipymd.chemlab_patch.atom module
+-------------------------------
+
+.. automodule:: ipymd.chemlab_patch.atom
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.chemlab_patch.box module
+------------------------------
+
+.. automodule:: ipymd.chemlab_patch.box
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.chemlab_patch.hexagon module
+----------------------------------
+
+.. automodule:: ipymd.chemlab_patch.hexagon
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.chemlab_patch.triangle module
+-----------------------------------
+
+.. automodule:: ipymd.chemlab_patch.triangle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ipymd.chemlab_patch
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/ipymd.data_input.rst b/docs/source/api/ipymd.data_input.rst
@@ -0,0 +1,46 @@
+ipymd.data_input package
+========================
+
+Submodules
+----------
+
+ipymd.data_input.base module
+----------------------------
+
+.. automodule:: ipymd.data_input.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.data_input.cif module
+---------------------------
+
+.. automodule:: ipymd.data_input.cif
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.data_input.crystal module
+-------------------------------
+
+.. automodule:: ipymd.data_input.crystal
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.data_input.lammps module
+------------------------------
+
+.. automodule:: ipymd.data_input.lammps
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ipymd.data_input
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/ipymd.rst b/docs/source/api/ipymd.rst
@@ -0,0 +1,63 @@
+ipymd package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ipymd.chemlab_patch
+    ipymd.data_input
+    ipymd.test_data
+
+Submodules
+----------
+
+ipymd.atom_analysis module
+--------------------------
+
+.. automodule:: ipymd.atom_analysis
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.atom_manipulation module
+------------------------------
+
+.. automodule:: ipymd.atom_manipulation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.data_output module
+------------------------
+
+.. automodule:: ipymd.data_output
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.plotting module
+---------------------
+
+.. automodule:: ipymd.plotting
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ipymd.visualise_sim module
+--------------------------
+
+.. automodule:: ipymd.visualise_sim
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ipymd
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/ipymd.test_data.rst b/docs/source/api/ipymd.test_data.rst
@@ -0,0 +1,10 @@
+ipymd.test_data package
+=======================
+
+Module contents
+---------------
+
+.. automodule:: ipymd.test_data
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
@@ -0,0 +1,7 @@
+ipymd
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   ipymd
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -363,7 +363,7 @@ def __mul__(self, other):
     'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
     'IPython': ('http://ipython.org/ipython-doc/stable/', None),
     'PIL': ('http://pillow.readthedocs.org/', None),
-    #'pygauss' : ('http://ipymd.readthedocs.org/en/stable/', None)
+    'ipymd' : ('http://ipymd.readthedocs.org/en/latest/', None)
     }
 autoclass_content = 'init'
 # Napoleon settings

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,6 +19,7 @@ Contents
    :maxdepth: 2
 
    tutorial
+   user_api
 
 License
 -------

diff --git a/docs/source/user_api.rst b/docs/source/user_api.rst
@@ -0,0 +1,7 @@
+User API
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   api/ipymd