From a25bdb53c5fa50c0cddcba21b9d486e7b3616902 Mon Sep 17 00:00:00 2001 From: Hiroki Date: Tue, 16 Aug 2022 16:27:02 -0700 Subject: [PATCH] T693362: Deploy doc to pyedb-docs (#77) * T693362: Deploy doc to pyedb-docs * T693362: Fix quotes --- .github/workflows/ci_cd.yml | 29 +++++++++++++++++++++++++++++ README.rst | 1 + 2 files changed, 30 insertions(+) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 54eb424af3..31a184fbfc 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -67,6 +67,35 @@ jobs: - name: Generate the documentation with tox run: tox -e doc + - name: Zip documentation + run: | + cd .tox/doc_out + zip -r pyedb_documentation.zip * + + - name: Upload HTML Documentation + uses: actions/upload-artifact@v2 + with: + name: HTML-Documentation + path: .tox/doc_out/pyedb_documentation.zip + retention-days: 7 + + - name: Get Bot Application Token + if: github.event_name == 'push' && github.ref == 'refs/heads/develop' + id: get_workflow_token + uses: peter-murray/workflow-application-token-action@v1 + with: + application_id: ${{ secrets.BOT_APPLICATION_ID }} + application_private_key: ${{ secrets.BOT_APPLICATION_PRIVATE_KEY }} + + - name: Deploy + if: github.event_name == 'push' && github.ref == 'refs/heads/develop' + uses: JamesIves/github-pages-deploy-action@4.1.4 + with: + repository-name: pyansys/pyedb-dev-docs + token: ${{ steps.get_workflow_token.outputs.token }} + branch: gh-pages + folder: .tox/doc_out + clean: true build: name: Build library diff --git a/README.rst b/README.rst index 2a2248f235..2b453d20f7 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,7 @@ Pyedb Ansys Electronics Database Python Client +.. image:: https://github.com/pyansys/pyedb/actions/workflows/ci_cd.yml/badge.svg?branch=develop How to install --------------