Skip to content

Commit

Permalink
Added github workflows
Browse files Browse the repository at this point in the history
Signed-off-by: Pagadarai <[email protected]>
  • Loading branch information
SrikanthPagadarai committed Dec 4, 2023
1 parent fd23e62 commit bd8543a
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation

on: [push, pull_request]

jobs:
BuildDocs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.7
uses: actions/setup-python@v2
with:
python-version: 3.7

- name: Install dependencies
run: |
sudo apt install -y python3-numpy
pip install -r requirements_doc.txt
- name: Check doc build
run: |
make -C CI/gen_doc doc
- name: Publish master doc
if: github.ref == 'refs/heads/master'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc
destination_dir: master
7 changes: 7 additions & 0 deletions requirements_doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
numpy
mkdocs
mkdocs-material
mkdocs-awesome-pages-plugin
mkdocs-mermaid2-plugin
mkdocs-plugin-inline-svg
jinja2

0 comments on commit bd8543a

Please sign in to comment.