Skip to content

Commit

Permalink
Added docs.yaml github workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
otavioon committed May 29, 2024
1 parent 6c6b034 commit 0f0b98f
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: minerva documentation
on:
push:
branches:
- docs

jobs:
docs:
name: Minverva documentation
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@v2

- name: Install Python
uses: actions/setup-python@v1
with:
python-version: 3.12.1

- name: Install packages
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install requirements
run: |
pip3 install sphinx sphinx-rtd-theme sphinx-autodoc-typehints sphinx-argparse sphinx-autoapi nbsphinx pandoc Ipython
- name: Build docs
run: |
cd docs
make clean
make html
# https://github.com/peaceiris/actions-gh-pages
- name: Deploy
if: success()
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/

0 comments on commit 0f0b98f

Please sign in to comment.