Docs: Update Sphinx and make some fixes/improvements

ajhynes7 · Dec 29, 2022 · 4772143 · 4772143
1 parent 94a9ae8
commit 4772143
Show file tree

Hide file tree

Showing 14 changed files with 11 additions and 35 deletions.
diff --git a/docs/source/api_reference/skspatial.objects.Circle.rst b/docs/source/api_reference/skspatial.objects.Circle.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Circle
 ========================
 
-.. autoclass:: skspatial.objects.Circle
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Cylinder.rst b/docs/source/api_reference/skspatial.objects.Cylinder.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Cylinder
 ==========================
 
-.. autoclass:: skspatial.objects.Cylinder
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Line.rst b/docs/source/api_reference/skspatial.objects.Line.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Line
 ======================
 
-.. autoclass:: skspatial.objects.Line
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.LineSegment.rst b/docs/source/api_reference/skspatial.objects.LineSegment.rst
@@ -2,9 +2,6 @@
 skspatial.objects.LineSegment
 =============================
 
-.. autoclass:: skspatial.objects.LineSegment
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Plane.rst b/docs/source/api_reference/skspatial.objects.Plane.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Plane
 =======================
 
-.. autoclass:: skspatial.objects.Plane
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Point.rst b/docs/source/api_reference/skspatial.objects.Point.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Point
 =======================
 
-.. autoclass:: skspatial.objects.Point
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Points.rst b/docs/source/api_reference/skspatial.objects.Points.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Points
 ========================
 
-.. autoclass:: skspatial.objects.Points
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Sphere.rst b/docs/source/api_reference/skspatial.objects.Sphere.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Sphere
 ========================
 
-.. autoclass:: skspatial.objects.Sphere
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Triangle.rst b/docs/source/api_reference/skspatial.objects.Triangle.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Triangle
 ==========================
 
-.. autoclass:: skspatial.objects.Triangle
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/api_reference/skspatial.objects.Vector.rst b/docs/source/api_reference/skspatial.objects.Vector.rst
@@ -2,9 +2,6 @@
 skspatial.objects.Vector
 ========================
 
-.. autoclass:: skspatial.objects.Vector
-
-
 Methods
 -------
 .. autosummary::

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -87,7 +87,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -1,4 +1,4 @@
-Sphinx==5.3.0
-numpydoc==1.1.0
+Sphinx==6.0.0
+numpydoc==1.5.0
 sphinx-bootstrap-theme==0.8.1
 sphinx-gallery==0.9.0
diff --git a/src/skspatial/objects/circle.py b/src/skspatial/objects/circle.py
@@ -340,8 +340,8 @@ def best_fit(cls, points: array_like) -> Circle:
             If there are fewer than three points.
             If the points are collinear.
 
-        Reference
-        ---------
+        References
+        ----------
         https://meshlogic.github.io/posts/jupyter/curve-fitting/fitting-a-circle-to-cluster-of-3d-points/
 
         Examples

diff --git a/tox.ini b/tox.ini
@@ -37,3 +37,9 @@ commands =
 commands =
     poetry install --with base_test
     poetry run pytest tests/unit/ --cov=skspatial --cov-report=xml
+
+# For local development only.
+[testenv:docs]
+commands =
+    pip install -r docs/source/requirements.txt
+    sphinx-build docs/source/ docs/build/