From 81b93f03871c893667298c33a9f98096c9ee5ef7 Mon Sep 17 00:00:00 2001 From: Nichts Hsu Date: Thu, 1 Feb 2024 17:42:22 +0800 Subject: [PATCH] doc: generate document to github pages --- .github/workflows/build-tests.yml | 18 +++++++-------- .github/workflows/gen-docs.yml | 37 +++++++++++++++++++++++++++++++ Doxyfile | 2 +- 3 files changed, 47 insertions(+), 10 deletions(-) create mode 100644 .github/workflows/gen-docs.yml diff --git a/.github/workflows/build-tests.yml b/.github/workflows/build-tests.yml index d16d3fb..7ed5323 100644 --- a/.github/workflows/build-tests.yml +++ b/.github/workflows/build-tests.yml @@ -12,12 +12,12 @@ jobs: runs-on: ubuntu-latest steps: - - name: Install just - run: | - sudo apt update - sudo apt install cargo - cargo install just - - uses: actions/checkout@v3 - - name: Build and Run tests - run: | - just t + - name: Install just + run: | + sudo apt update + sudo apt install cargo + cargo install just + - uses: actions/checkout@v4 + - name: Build and Run tests + run: | + just t diff --git a/.github/workflows/gen-docs.yml b/.github/workflows/gen-docs.yml new file mode 100644 index 0000000..42c1ebe --- /dev/null +++ b/.github/workflows/gen-docs.yml @@ -0,0 +1,37 @@ +name: Generate Documents + +on: + push: + branches: [ "master" ] + +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - uses: mattnotmitt/doxygen-action@v1.9.5 + - name: Upload Pages + uses: actions/upload-pages-artifact@v1 + with: + path: ./html + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + \ No newline at end of file diff --git a/Doxyfile b/Doxyfile index bec68bb..a70a37e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1996,7 +1996,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of