Merge pull request #250 from ajhynes7/improve_docs

Delete "Computations" section from docs and add Cylinder to API reference
ajhynes7 · Feb 15, 2021 · efd5129 · efd5129
2 parents a3c2b4e + 0cd2fff
commit efd5129
Show file tree

Hide file tree

Showing 12 changed files with 3 additions and 110 deletions.
diff --git a/docs/source/api_reference/skspatial.objects.Cylinder.rst b/docs/source/api_reference/skspatial.objects.Cylinder.rst
@@ -15,4 +15,5 @@ Methods
    ~skspatial.objects.Cylinder.length
    ~skspatial.objects.Cylinder.plot_3d
    ~skspatial.objects.Cylinder.to_mesh
+   ~skspatial.objects.Cylinder.to_points
    ~skspatial.objects.Cylinder.volume
diff --git a/docs/source/api_reference/skspatial.objects.rst b/docs/source/api_reference/skspatial.objects.rst
@@ -12,3 +12,4 @@ skspatial.objects
    skspatial.objects.Circle
    skspatial.objects.Sphere
    skspatial.objects.Triangle
+   skspatial.objects.Cylinder
diff --git a/docs/source/computations/comparison.rst b/docs/source/computations/comparison.rst
diff --git a/docs/source/computations/fitting.rst b/docs/source/computations/fitting.rst
diff --git a/docs/source/computations/intersection.rst b/docs/source/computations/intersection.rst
diff --git a/docs/source/computations/measurement.rst b/docs/source/computations/measurement.rst
diff --git a/docs/source/computations/projection.rst b/docs/source/computations/projection.rst
diff --git a/docs/source/computations/toc.rst b/docs/source/computations/toc.rst
diff --git a/docs/source/computations/transformation.rst b/docs/source/computations/transformation.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -118,7 +118,6 @@
     'globaltoc_depth': -1,
     'navbar_links': [
         ('Objects', 'objects/toc'),
-        ('Computations', 'computations/toc'),
         ('Plotting', 'plotting'),
         ('Gallery', 'gallery/index'),
         ('API', 'api_reference/toc'),

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -58,7 +58,6 @@ Contents
    :maxdepth: 1
 
    objects/toc
-   computations/toc
    plotting
    gallery/index
    api_reference/toc
diff --git a/docs/source/objects/toc.rst b/docs/source/objects/toc.rst
@@ -12,3 +12,4 @@ Spatial Objects
    circle
    sphere
    triangle
+   cylinder