adding rst files for the doc

j-i-l · Dec 10, 2020 · fcd54f5 · fcd54f5
1 parent 1a9177a
commit fcd54f5
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -130,6 +130,3 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-
-# Ignoring some docs
-docs/_api/
diff --git a/readthedocs.yml → .readthedocs.yml b/readthedocs.yml → .readthedocs.yml
diff --git a/docs/_api/sospcat.compare.rst b/docs/_api/sospcat.compare.rst
@@ -0,0 +1,7 @@
+sospcat.compare 
+======================
+
+.. automodule:: sospcat.compare
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_api/sospcat.rst b/docs/_api/sospcat.rst
@@ -0,0 +1,17 @@
+sospcat 
+===============
+
+.. automodule:: sospcat
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   sospcat.compare
+   sospcat.social
+   sospcat.spatial
diff --git a/docs/_api/sospcat.social.rst b/docs/_api/sospcat.social.rst
@@ -0,0 +1,7 @@
+sospcat.social 
+=====================
+
+.. automodule:: sospcat.social
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_api/sospcat.spatial.rst b/docs/_api/sospcat.spatial.rst
@@ -0,0 +1,7 @@
+sospcat.spatial 
+======================
+
+.. automodule:: sospcat.spatial
+   :members:
+   :undoc-members:
+   :show-inheritance: