Skip to content

Add Makefile target for generating api.md documentation #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bucknalla merged 4 commits into from
Apr 17, 2025
Merged

Add Makefile target for generating api.md documentation #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4b5dba9
Add Makefile target for generating api.md documentation
devin-ai-integration[bot] Apr 17, 2025
71bc0fe
Update generate-api-docs target to use pipenv
devin-ai-integration[bot] Apr 17, 2025
108097a
Add doxypypy to Pipfile for API documentation generation
devin-ai-integration[bot] Apr 17, 2025
51f6e91
fix: change to use pipenv
Bucknalla Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ build = "*"
twine = "*"
pre-commit = "*"
exceptiongroup = "*" # Python 3.9 & 3.10 compatibility with pytest
doxypypy = "*" # For generating API documentation
Loading