Skip to content

Commit

Permalink
doc: generate document to github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
NichtsHsu committed Feb 1, 2024
1 parent c138b68 commit 81b93f0
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 10 deletions.
18 changes: 9 additions & 9 deletions .github/workflows/build-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
37 changes: 37 additions & 0 deletions .github/workflows/gen-docs.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
- 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

2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 81b93f0

Please sign in to comment.