mirror of
https://github.com/pspdev/pspsdk.git
synced 2025-10-04 17:09:09 +00:00
Merge pull request #36 from pspdev/feature/doxygen-action
Generate doxygen documentation
This commit is contained in:
33
.github/workflows/doxygen.yml
vendored
Normal file
33
.github/workflows/doxygen.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: doxygen on github pages
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Prepare Doxyfile
|
||||||
|
run: |
|
||||||
|
sed -e 's/\$(PROJECT)/PSPSDK/' \
|
||||||
|
-e 's/\$(VERSION)/'`cat VERSION | xargs echo -n`'/' \
|
||||||
|
-e 's/\$(SRCDIR)/src/g' \
|
||||||
|
-e 's/\$(GENERATE_LATEX)/NO/' \
|
||||||
|
-e 's/\$(HAVE_DOT)/YES/' \
|
||||||
|
-e 's/Helvetica/FreeSans/' \
|
||||||
|
-i Doxyfile
|
||||||
|
|
||||||
|
- name: Doxygen documentation generation
|
||||||
|
uses: mattnotmitt/doxygen-action@v1
|
||||||
|
|
||||||
|
- name: Deploy
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
publish_dir: ./doc/html
|
||||||
|
force_orphan: true
|
@@ -168,6 +168,12 @@ bug.
|
|||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
|
### Official Source Documentation
|
||||||
|
|
||||||
|
This is generated automatically from the repository `master` branch:
|
||||||
|
https://pspdev.github.io/pspsdk/
|
||||||
|
|
||||||
|
|
||||||
### Internet Relay Chat (IRC)
|
### Internet Relay Chat (IRC)
|
||||||
|
|
||||||
The PSPSDK developers can sometimes be found hanging out in the #pspdev channel
|
The PSPSDK developers can sometimes be found hanging out in the #pspdev channel
|
||||||
|
Reference in New Issue
Block a user