From bd8543ae2e292201c5d35fbd119e3437a8cdc663 Mon Sep 17 00:00:00 2001 From: Pagadarai Date: Mon, 4 Dec 2023 09:19:39 -0500 Subject: [PATCH] Added github workflows Signed-off-by: Pagadarai --- .github/workflows/doc.yml | 30 ++++++++++++++++++++++++++++++ requirements_doc.txt | 7 +++++++ 2 files changed, 37 insertions(+) create mode 100644 .github/workflows/doc.yml create mode 100644 requirements_doc.txt diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..b280d9c --- /dev/null +++ b/.github/workflows/doc.yml @@ -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 diff --git a/requirements_doc.txt b/requirements_doc.txt new file mode 100644 index 0000000..5e8bb2c --- /dev/null +++ b/requirements_doc.txt @@ -0,0 +1,7 @@ +numpy +mkdocs +mkdocs-material +mkdocs-awesome-pages-plugin +mkdocs-mermaid2-plugin +mkdocs-plugin-inline-svg +jinja2