add doxygen and his gh page

This commit is contained in:
coco875
2024-05-30 15:37:06 +02:00
parent 0ac73f7208
commit 96c52999e5
5 changed files with 2943 additions and 0 deletions

33
.github/workflows/docs.yml vendored Normal file
View File

@@ -0,0 +1,33 @@
name: Doxygen GitHub Pages Deploy Action
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4.1.1
with:
submodules: "true"
- name: Install Doxygen
run: |
sudo apt-get install graphviz doxygen
wget https://www.doxygen.nl/files/doxygen-1.11.0.linux.bin.tar.gz
tar -xzf doxygen-*.linux.bin.tar.gz
- name: Generate Doxygen documentation
run: |
./doxygen-*/bin/doxygen Doxyfile
- name: Create .nojekyll (ensures pages with underscores work on gh pages)
run: touch docs/html/.nojekyll
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html

1
.gitignore vendored
View File

@@ -2,3 +2,4 @@ build/
.vscode
*.exe
*.bat
docs/html

2906
Doxyfile Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -208,3 +208,6 @@ all: $(ALL_UCODES)
clean:
@printf "$(WARNING)Deleting all built microcode files$(NO_COL)\n"
@rm -rf $(ALL_OUTPUT_DIRS)
doc:
doxygen Doxyfile

0
docs/Home.md Normal file
View File