Docs++

COMSOC-Community · Feb 21, 2024 · 366b046 · 366b046
1 parent da4349a
commit 366b046
Show file tree

Hide file tree

Showing 21 changed files with 1,823 additions and 9 deletions.
diff --git a/docs-source/source/quickstart.rst b/docs-source/source/quickstart.rst
@@ -259,7 +259,7 @@ They are also all gathered in the :code:`prefsampling.CONSTANTS` enumeration.
     CONSTANTS.BUNKE_SHEARER
 
 Not that :py:class:`~prefsampling.core.euclidean.EuclideanSpace` and
-:py:class:`~prefsampling.constants` are not the same enumeration so direct comparison will fail.
+:py:class:`~prefsampling.CONSTANTS` are not the same enumeration so direct comparison will fail.
 Indeed, :code:`CONSTANTS.BALL == EuclideanSpace.BALL` is evaluated to :code:`False`. However,
 the values are the same so :code:`CONSTANTS.BALL.value == EuclideanSpace.BALL.value` is evaluated
 to :code:`True`.
diff --git a/docs-source/source/reference/constants.rst b/docs-source/source/reference/constants.rst
@@ -0,0 +1,5 @@
+Constants
+=========
+
+.. autoclass:: prefsampling.CONSTANTS
+    :members:
diff --git a/docs-source/source/reference/index.rst b/docs-source/source/reference/index.rst
@@ -8,3 +8,5 @@ Reference
     approval/index
     tree/index
     core/index
+    constants
+    inputvalidators
diff --git a/docs-source/source/reference/inputvalidators.rst b/docs-source/source/reference/inputvalidators.rst
@@ -0,0 +1,5 @@
+Input Validators
+================
+
+.. automodule:: prefsampling.inputvalidators
+    :members:
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -159,6 +159,8 @@
 <li class="toctree-l2"><a class="reference internal" href="../reference/approval/index.html">Approval</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../reference/tree/index.html">Tree</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../reference/core/index.html">Core</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/constants.html">Constants</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../reference/inputvalidators.html">Input Validators</a></li>
 </ul>
 </li>
 </ul>
@@ -279,6 +281,7 @@ <h1></h1>
                 <article class="bd-article">
 
   <h1>All modules for which code is available</h1>
+<ul><li><a href="prefsampling.html">prefsampling</a></li>
 <ul><li><a href="prefsampling/approval/euclidean.html">prefsampling.approval.euclidean</a></li>
 <li><a href="prefsampling/approval/identity.html">prefsampling.approval.identity</a></li>
 <li><a href="prefsampling/approval/impartial.html">prefsampling.approval.impartial</a></li>
@@ -289,6 +292,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="prefsampling/core/composition.html">prefsampling.core.composition</a></li>
 <li><a href="prefsampling/core/euclidean.html">prefsampling.core.euclidean</a></li>
 <li><a href="prefsampling/core/filters.html">prefsampling.core.filters</a></li>
+<li><a href="prefsampling/inputvalidators.html">prefsampling.inputvalidators</a></li>
 <li><a href="prefsampling/ordinal/didi.html">prefsampling.ordinal.didi</a></li>
 <li><a href="prefsampling/ordinal/euclidean.html">prefsampling.ordinal.euclidean</a></li>
 <li><a href="prefsampling/ordinal/groupseparable.html">prefsampling.ordinal.groupseparable</a></li>
@@ -301,7 +305,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="prefsampling/ordinal/urn.html">prefsampling.ordinal.urn</a></li>
 <li><a href="prefsampling/tree/caterpillar.html">prefsampling.tree.caterpillar</a></li>
 <li><a href="prefsampling/tree/schroeder.html">prefsampling.tree.schroeder</a></li>
-</ul>
+</ul></ul>
 
                 </article>