Merge pull request #3 from sackh/docs_changes

Added rst files
omanges · Jul 12, 2020 · 11856c7 · 11856c7
2 parents 11e629a + 052b54d
commit 11856c7
Show file tree

Hide file tree

Showing 9 changed files with 113 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,21 @@
+.. turfpy documentation master file, created by
+   sphinx-quickstart on Sun Jul 12 11:14:48 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to turfpy's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   turfpy
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/turfpy.dev_lib.rst b/docs/turfpy.dev_lib.rst
@@ -0,0 +1,16 @@
+turfpy.dev\_lib package
+=======================
+
+.. automodule:: turfpy.dev_lib
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   turfpy.dev_lib.spline
diff --git a/docs/turfpy.dev_lib.spline.rst b/docs/turfpy.dev_lib.spline.rst
@@ -0,0 +1,8 @@
+turfpy.dev\_lib.spline module
+=============================
+
+.. automodule:: turfpy.dev_lib.spline
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/turfpy.extra.rst b/docs/turfpy.extra.rst
@@ -0,0 +1,8 @@
+turfpy.extra module
+===================
+
+.. automodule:: turfpy.extra
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/turfpy.helper.rst b/docs/turfpy.helper.rst
@@ -0,0 +1,8 @@
+turfpy.helper module
+====================
+
+.. automodule:: turfpy.helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/turfpy.measurement.rst b/docs/turfpy.measurement.rst
@@ -0,0 +1,8 @@
+turfpy.measurement module
+=========================
+
+.. automodule:: turfpy.measurement
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/turfpy.meta.rst b/docs/turfpy.meta.rst
@@ -0,0 +1,8 @@
+turfpy.meta module
+==================
+
+.. automodule:: turfpy.meta
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/turfpy.rst b/docs/turfpy.rst
@@ -0,0 +1,28 @@
+turfpy package
+==============
+
+.. automodule:: turfpy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   turfpy.dev_lib
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   turfpy.extra
+   turfpy.helper
+   turfpy.measurement
+   turfpy.meta
+   turfpy.transformation
diff --git a/docs/turfpy.transformation.rst b/docs/turfpy.transformation.rst
@@ -0,0 +1,8 @@
+turfpy.transformation module
+============================
+
+.. automodule:: turfpy.transformation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members: