Skip to content

Commit

Permalink
Try to publish mcdocs automatically
Browse files Browse the repository at this point in the history
  • Loading branch information
manuelgloeckler committed Feb 4, 2024
1 parent 57eb77d commit 537fb71
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions .github/workflows/test_run_push_to_overleaf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,16 @@ jobs:
git commit -m "Update figures automatically"
git push
fi
# New step to build the MkDocs site
- name: Build MkDocs Site
run: |
cd ${{ github.workspace }}
mkdocs build
# New step to deploy to GitHub Pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Develop code in your desired way, e.g. in local notebooks (you don't commit, the

Once you want other people to see your figure/experiment, add them to `plotting.py` and `experiments.py` and call the corresponding functions in `run.py`.

After committing and pushing your changes, GitHub will execute `run.py` and update the figures in Overleaf.
After committing and pushing your changes, GitHub will execute every `run_*.py` and update the figures in Overleaf.

You can obviously also run it yourself with `python labproject/run.py`.

Expand Down

0 comments on commit 537fb71

Please sign in to comment.