Skip to content

Commit

Permalink
add the minimal tutorial and notebook parsing to the docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
pattonw committed Oct 16, 2024
1 parent a1e492a commit 0ef4f61
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ jobs:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: install dacapo
# run: pip install .[docs]
run: pip install sphinx-autodoc-typehints sphinx-autoapi sphinx-click sphinx-rtd-theme myst-parser
run: pip install sphinx-autodoc-typehints sphinx-autoapi sphinx-click sphinx-rtd-theme myst-parser jupytext ipykernel nbsphinx
- name: parse notebooks
run: jupytext --to notebook --execute ./docs/source/notebooks/*.py
- name: remove notebook scripts
run: rm ./docs/source/notebooks/*.py
- name: Build and Commit
uses: sphinx-notes/pages@v2
with:
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

overview
install
notebooks/minimal_tutorial
tutorial
docker
aws
Expand Down

0 comments on commit 0ef4f61

Please sign in to comment.