Skip to content

Commit

Permalink
auto-generate python docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
mjansen4857 committed Dec 6, 2023
1 parent f87b398 commit 2980f22
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
24 changes: 23 additions & 1 deletion .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,34 @@ jobs:
with:
working-directory: pathplannerlib

- name: Move to docs dir
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"

- name: Install python dependencies
working-directory: ./pathplannerlib-python
run: |
python -m pip install --upgrade pip
pip install build handsdown mkdocs mkdocs-material
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Generate python docs
working-directory: ./pathplannerlib-python
run: |
handsdown --external https://github.com/mjansen4857/pathplanner.git -o docsmd -n pathplannerlib --theme=material --create-configs include pathplannerlib
python -m mkdocs build
- name: Move java/cpp to docs dir
working-directory: pathplannerlib/build/docs
run: |
mkdir docs
sudo mv javadoc docs/java
sudo mv cpp/html docs/cpp
- name: Move python to docs dir
run: |
sudo mv pathplannerlib-python/docs pathplannerlib/build/docs/docs/python
- name: Deploy generated documentation to GitHub Pages
uses: s0/[email protected]
Expand Down
4 changes: 3 additions & 1 deletion pathplannerlib-python/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
/dist
/*.egg-info
/*.egg-info
/docs
/docsmd

0 comments on commit 2980f22

Please sign in to comment.