Add API docs

vivekjoshy · Jan 21, 2022 · 2001f83 · 2001f83
1 parent 907fc9b
commit 2001f83
Show file tree

Hide file tree

Showing 3 changed files with 121 additions and 0 deletions.
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+openskill
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   openskill
diff --git a/docs/api/openskill.models.rst b/docs/api/openskill.models.rst
@@ -0,0 +1,53 @@
+openskill.models package
+========================
+
+Submodules
+----------
+
+openskill.models.bradley\_terry\_full module
+--------------------------------------------
+
+.. automodule:: openskill.models.bradley_terry_full
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.models.bradley\_terry\_part module
+--------------------------------------------
+
+.. automodule:: openskill.models.bradley_terry_part
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.models.plackett\_luce module
+--------------------------------------
+
+.. automodule:: openskill.models.plackett_luce
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.models.thurstone\_mosteller\_full module
+--------------------------------------------------
+
+.. automodule:: openskill.models.thurstone_mosteller_full
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.models.thurstone\_mosteller\_part module
+--------------------------------------------------
+
+.. automodule:: openskill.models.thurstone_mosteller_part
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openskill.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/openskill.rst b/docs/api/openskill.rst
@@ -0,0 +1,61 @@
+openskill package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   openskill.models
+
+Submodules
+----------
+
+openskill.constants module
+--------------------------
+
+.. automodule:: openskill.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.ordinal module
+------------------------
+
+.. automodule:: openskill.ordinal
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.rate module
+---------------------
+
+.. automodule:: openskill.rate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.statistics module
+---------------------------
+
+.. automodule:: openskill.statistics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openskill.util module
+---------------------
+
+.. automodule:: openskill.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openskill
+   :members:
+   :undoc-members:
+   :show-inheritance: