From 84ef5f977f40c5e54cdc489ace943f2d9262e228 Mon Sep 17 00:00:00 2001
From: keeeal <j@keal.au>
Date: Fri, 19 Apr 2024 14:25:47 +0930
Subject: [PATCH] clean up

---
 .gitignore     |  1 -
 Makefile       | 14 ++++++++++----
 docs/index.rst | 14 +++++++++++---
 docs/vslot.rst |  8 ++++----
 test.py        | 11 -----------
 5 files changed, 25 insertions(+), 23 deletions(-)
 delete mode 100644 test.py

diff --git a/.gitignore b/.gitignore
index c49ca05..68bc17f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -70,7 +70,6 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/apidocs/
 
 # PyBuilder
 .pybuilder/
diff --git a/Makefile b/Makefile
index 74a8d2c..008c0d4 100644
--- 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
index e09988f..320da5c 100644
--- 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
index 982c1ae..cb2ffdb 100644
--- 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
deleted file mode 100644
index b58cbfb..0000000
--- a/test.py
+++ /dev/null
@@ -1,11 +0,0 @@
-from time import time
-
-from ocp_vscode import show_all
-
-from bd_extrusions.vslot import VSlotProfile
-
-start = time()
-vslot = VSlotProfile.box(1, 1)
-print(f"Time: {time() - start}")
-
-show_all()