Merge pull request #106 from blues/devin/1744842338-api-md-generation

Add Makefile target for generating api.md documentation

Author: Bucknalla

Makefile

@@ -28,4 +28,8 @@ run_build:
 deploy:
 	pipenv run python -m twine upload -r "pypi" --config-file .pypirc 'dist/*'
 
-.PHONY: precommit test coverage run_build deploy
+generate-api-docs:
+	doxygen Doxyfile
+	moxygen --output docs/api.md docs/xml
+
+.PHONY: precommit test coverage run_build deploy generate-api-docs

Pipfile

@@ -23,3 +23,4 @@ build = "*"
 twine = "*"
 pre-commit = "*"
 exceptiongroup = "*"  # Python 3.9 & 3.10 compatibility with pytest
+doxypypy = "*"  # For generating API documentation