README.md refer to the present courses #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Creates the Sphinx website | |
name: Create website | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
create_website: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/[email protected] | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
# Install plantuml | |
- name: Install OS package dependencies | |
run: | | |
sudo apt update | |
sudo apt install plantuml | |
#sudo apt install npm | |
#npm install mermaid | |
npm install -g @mermaid-js/mermaid-cli | |
#npm install markmap | |
- name: Install dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Install sphinx-design, from https://sphinx-design.readthedocs.io/en/latest/get_started.html | |
run: pip install sphinx-design | |
- name: remove unused folders | |
run: | | |
rm -rf docs/julia/not_used | |
rm -rf docs/r/not_used | |
rm -rf docs/python/not_used | |
rm -rf docs/matlab/not_used | |
rm -rf docs/matlab/README.md | |
rm -rf docs/not_used | |
- name: Sphinx builds in nitpicky mode | |
run: sphinx-build -n docs _build | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v4 | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: _build/ | |
force_orphan: true | |