Automatically deploy extensive documentation#11
Automatically deploy extensive documentation#11amgebauer wants to merge 1 commit intoTUM-LNM:mainfrom
Conversation
amgebauer
force-pushed
the
automatically-create-dos-via-pdoc
branch
from
7e4db8b to
56ef116
Compare
amgebauer
force-pushed
the
automatically-create-dos-via-pdoc
branch
from
56ef116 to
7b33c6d
Compare
There was a problem hiding this comment.
Pull request overview
This PR sets up automated documentation generation and deployment using GitHub Actions and GitHub Pages. The documentation is generated from the Python source code using pdoc and deployed to GitHub Pages whenever changes are pushed to the main branch. The version is bumped from 0.6.0 to 0.6.1, and a link to the hosted documentation is added to the README.
- Automated documentation generation using pdoc on every push and pull request
- Automated deployment to GitHub Pages when documentation builds successfully on main branch
- Documentation URL added to README for user reference
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Version bump from 0.6.0 to 0.6.1 |
| README.md | Added link to hosted documentation at GitHub Pages |
| .gitignore | Excluded locally generated docs/ directory from version control |
| .github/workflows/documentation.yml | New workflow to build documentation using pdoc and upload as artifact |
| .github/workflows/deploy_pages.yml | New workflow to deploy documentation artifact to GitHub Pages |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
amgebauer
force-pushed
the
automatically-create-dos-via-pdoc
branch
2 times, most recently
from
79e8b87 to
c3558f1
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
amgebauer
force-pushed
the
automatically-create-dos-via-pdoc
branch
2 times, most recently
from
1c49b3f to
996766f
Compare
|
Full credit to @davidrudlstorfer, he showed it to me |
amgebauer
force-pushed
the
automatically-create-dos-via-pdoc
branch
from
996766f to
5055ef4
Compare
|
I tested it on my fork. Deployment of the documentation to Github pages works as expected. @davidrudlstorfer @gilrrei Thanks for your hints. Ready for review. |
davidrudlstorfer
left a comment
davidrudlstorfer
left a comment
There was a problem hiding this comment.
Nice :) Thanks for the tagging!
| pip install -r requirements-dev.txt | ||
| pip install -e . | ||
| - name: Create documentation | ||
| run: pdoc biomesh -o docs --docformat google |
There was a problem hiding this comment.
What's often helpful is to add --math, then Latex stuff is rendered correctly if it appears somewhere in the docstrings
Thank you @gilrrei for the hint.