clean up

keeeal · Apr 19, 2024 · 84ef5f9 · 84ef5f9
1 parent 835c7fb
commit 84ef5f9
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -70,7 +70,6 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/apidocs/
 
 # PyBuilder
 .pybuilder/

diff --git a/Makefile b/Makefile
@@ -2,16 +2,22 @@
 
 pip-compile-options = --quiet --upgrade --no-emit-index-url
 
-# Install package. Usage: make install [dev=true]
+# Usage: make install [dev=true]
 install:
 	pip install --upgrade pip pip-tools
 	pip install -r requirements$(if $(dev),-dev,).txt
 	pip install -e .
 
-# Format code. Usage: make format [check=true]
+# Format code
 format:
-	isort $(if $(check),--check,) .
-	black $(if $(check),--check,) .
+	isort .
+	black .
+
+# Lint code
+lint:
+	isort --check .
+	black --check .
+	mypy .
 
 # Run unit tests
 test:

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,15 @@
-Welcome to bd-extrusions's documentation!
-=========================================
+bd-extrusions
+=============
+
+A collection of extrusions modelled using the `Build123d`_ CAD library.
+
+#################
+Table of Contents
+#################
 
 .. toctree::
+    :maxdepth: 2
 
     vslot
-    apidocs/index
+
+.. _Build123d: https://build123d.readthedocs.io/
diff --git a/docs/vslot.rst b/docs/vslot.rst
@@ -1,7 +1,7 @@
 V-Slot
 ======
 
-.. autodoc2-object:: bd_extrusions.vslot
-
-    render_plugin = "rst"
-    no_index = true
+.. automodule:: bd_extrusions.vslot
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/test.py b/test.py