From a71980b5acdd5674fe05520d5c6e72f5c0843fd2 Mon Sep 17 00:00:00 2001 From: Chris Chen Date: Wed, 24 Jan 2024 17:14:56 +0800 Subject: [PATCH 1/5] Update doxygen.yml --- .github/workflows/doxygen.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 24fc2478..1a871233 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -14,7 +14,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 # fetch all commits/branches for gitversion @@ -34,7 +34,7 @@ jobs: # Deploy the generated HTML files to the gh-pages branch - name: Deploy to gh-pages - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v3.9.3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ${{ env.BRANCH_NAME }}/html From b2cc77b047a8b9d1e95e690d3a6e12d227e108dc Mon Sep 17 00:00:00 2001 From: Chris Chen Date: Wed, 24 Jan 2024 17:25:31 +0800 Subject: [PATCH 2/5] Update doxygen.yml --- .github/workflows/doxygen.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 1a871233..c9d465b2 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -34,11 +34,11 @@ jobs: # Deploy the generated HTML files to the gh-pages branch - name: Deploy to gh-pages - uses: peaceiris/actions-gh-pages@v3.9.3 + uses: JamesIves/github-pages-deploy-action@v4 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ${{ env.BRANCH_NAME }}/html - destination_dir: ${{ env.BRANCH_NAME }} + token: ${{ secrets.GITHUB_TOKEN }} + folder: ${{ env.BRANCH_NAME }}/html + target-folder: ${{ env.BRANCH_NAME }} # - name: show gh-pages branch # run: | From 0c626c7c3167ec2eba581e33f2ce4b27d7f7cdc5 Mon Sep 17 00:00:00 2001 From: Chris Chen Date: Wed, 24 Jan 2024 17:41:22 +0800 Subject: [PATCH 3/5] Update doxygen.yml --- .github/workflows/doxygen.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index c9d465b2..bf9edafb 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -36,7 +36,6 @@ jobs: - name: Deploy to gh-pages uses: JamesIves/github-pages-deploy-action@v4 with: - token: ${{ secrets.GITHUB_TOKEN }} folder: ${{ env.BRANCH_NAME }}/html target-folder: ${{ env.BRANCH_NAME }} From 2bb77ea51d5585e9d0f4e16d6a087e3417a0f3f2 Mon Sep 17 00:00:00 2001 From: Chris Chen Date: Wed, 24 Jan 2024 18:01:18 +0800 Subject: [PATCH 4/5] Update doxygen-config --- doxygen-config | 1 - 1 file changed, 1 deletion(-) diff --git a/doxygen-config b/doxygen-config index 11e4be40..9e05ad1f 100644 --- a/doxygen-config +++ b/doxygen-config @@ -2887,4 +2887,3 @@ MSCGEN_TOOL = MSCFILE_DIRS = -# \ No newline at end of file From 5b33a608b7fd001577254659cac1431a62da4b79 Mon Sep 17 00:00:00 2001 From: Chris Chen Date: Fri, 28 Nov 2025 11:17:15 +0800 Subject: [PATCH 5/5] Update doxygen.yml --- .github/workflows/doxygen.yml | 74 ++++++++++++----------------------- 1 file changed, 24 insertions(+), 50 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index bf9edafb..9a195fc3 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -1,73 +1,47 @@ name: Generate API reference via Doxygen and push to GitHub Pages -env: - # Specify the doc version to which the API reference belongs - doc_version: 3.6.0 + on: - push: - branches: - # Remember to update the branch name when you create a new branch - - master + workflow_dispatch: + inputs: + branch_name: + description: 'Which git branch should I check out?' + required: true + + python_version: + description: 'Python SDK version to use for documentation' + required: true + jobs: build: runs-on: ubuntu-latest + env: + BRANCH_NAME: ${{ github.event.inputs.branch_name }} + PYTHON_VERSION: ${{ github.event.inputs.python_version }} steps: - name: Checkout code uses: actions/checkout@v4 with: + ref: ${{ github.event.inputs.branch_name }} fetch-depth: 0 # fetch all commits/branches for gitversion - - - name: Extract branch name - run: echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/})" >> $GITHUB_ENV - name: Install Doxygen run: | sudo apt-get update sudo apt-get install -y doxygen graphviz - # Generate HTML files - - name: Generate Documentation + # Generate Python API reference + - name: Generate Documentation for Python run: | - echo "OUTPUT_DIRECTORY=$BRANCH_NAME" >> doxygen-config - doxygen doxygen-config - + echo "PROJECT_NUMBER=${PYTHON_VERSION}" >> doxygen/python-config + mkdir -p "${PYTHON_VERSION}" + echo "OUTPUT_DIRECTORY=${PYTHON_VERSION}" >> doxygen/python-config + doxygen doxygen/python-config + # Deploy the generated HTML files to the gh-pages branch - name: Deploy to gh-pages uses: JamesIves/github-pages-deploy-action@v4 with: - folder: ${{ env.BRANCH_NAME }}/html - target-folder: ${{ env.BRANCH_NAME }} - - # - name: show gh-pages branch - # run: | - # git branch - # git checkout . - # git checkout gh-pages - - # # Compresses HTML files into a tar.gz file - # - name: compress api reference - # run: | - # tar -zcvf $BRANCH_NAME.tar.gz $BRANCH_NAME - - # - name: transfer api reference - # uses: appleboy/scp-action@master - # with: - # host: 20.163.77.63 - # username: azureuser - # password: ${{ secrets.ENSITE_PASSWORD }} - # port: 404 - # source: $BRANCH_NAME.tar.gz - # # Return error if the target doc version does not already exist - # target: /var/www/ent-docs/${{ env.doc_version }}/ - - # - name: uncompress ap reference - # uses: appleboy/ssh-action@master - # with: - # host: 20.163.77.63 - # username: azureuser - # password: ${{ secrets.ENSITE_PASSWORD }} - # port: 404 - # script: | - # mkdir -p /var/www/ent-docs/${{ env.doc_version}}/api/python/ - # tar -zxf /var/www/ent-docs/${{ env.doc_version}}/$BRANCH_NAME.tar.gz -C /var/www/ent-docs/${{ env.doc_version}}/api/python/ \ No newline at end of file + folder: ${PYTHON_VERSION}/html + target-folder: ${PYTHON_VERSION} \ No newline at end of file