From e086878fae7dcf2a923fb638f886b25bcd9d2f14 Mon Sep 17 00:00:00 2001 From: Carsten Teibes Date: Wed, 17 Jun 2020 20:44:01 +0200 Subject: [PATCH 1/2] Generate doxygen documentation --- .github/workflows/doxygen.yml | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/doxygen.yml diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml new file mode 100644 index 00000000..0bde451a --- /dev/null +++ b/.github/workflows/doxygen.yml @@ -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 From c526f5629c8608602217a0d9f4c64986b8ab1c31 Mon Sep 17 00:00:00 2001 From: Carsten Teibes Date: Wed, 17 Jun 2020 20:49:39 +0200 Subject: [PATCH 2/2] Mention dox in README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 4c47ecdc..ebbe4a13 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,12 @@ bug. ## Resources +### Official Source Documentation + +This is generated automatically from the repository `master` branch: +https://pspdev.github.io/pspsdk/ + + ### Internet Relay Chat (IRC) The PSPSDK developers can sometimes be found hanging out in the #pspdev channel