From db0dc541a7bf8d5f2666400ecc23fee992abe474 Mon Sep 17 00:00:00 2001 From: dimaguy Date: Tue, 20 Sep 2022 22:21:41 +0000 Subject: [PATCH 1/2] Enable Docset generation on build --- libctru/Doxyfile | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/libctru/Doxyfile b/libctru/Doxyfile index c686766ed..828a8dba7 100644 --- a/libctru/Doxyfile +++ b/libctru/Doxyfile @@ -1200,7 +1200,7 @@ HTML_INDEX_NUM_ENTRIES = 100 # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_DOCSET = NO +GENERATE_DOCSET = YES # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider @@ -1208,7 +1208,7 @@ GENERATE_DOCSET = NO # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_FEEDNAME = "Doxygen libctru docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. @@ -1216,7 +1216,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs" # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_BUNDLE_ID = org.doxygen.Project +DOCSET_BUNDLE_ID = org.devkitPro.libctru # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style @@ -1224,13 +1224,13 @@ DOCSET_BUNDLE_ID = org.doxygen.Project # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_ID = org.devkitPro.libctru # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_PUBLISHER_NAME = Publisher +DOCSET_PUBLISHER_NAME = devkitPro # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The From 1369f25871a1cea8f07402bd25ac19d04ee56ad5 Mon Sep 17 00:00:00 2001 From: dimaguy Date: Tue, 20 Sep 2022 22:23:35 +0000 Subject: [PATCH 2/2] Change workflow to generate a proper docset --- .github/workflows/doxygen.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/.github/workflows/doxygen.yaml b/.github/workflows/doxygen.yaml index 57894e989..7dd4c6da8 100644 --- a/.github/workflows/doxygen.yaml +++ b/.github/workflows/doxygen.yaml @@ -29,6 +29,11 @@ jobs: git clone --branch=master --single-branch --depth 1 https://github.com/devkitPro/3ds-examples examples cd libctru CTRU_VERSION=${{ steps.vars.outputs.tag }} doxygen Doxyfile + - name: Publish docs to GH Actions + uses: actions/upload-artifact@v2 + with: + path: libctru/docs/* + name: docs - name: Deploy 🚀 uses: JamesIves/github-pages-deploy-action@3.7.1 @@ -38,3 +43,28 @@ jobs: FOLDER: libctru/docs/html CLEAN: true SINGLE_COMMIT: true + + generatedocset: + name: Generate Docset + runs-on: macos-latest + needs: build + steps: + - name: Pick up artifacts + uses: actions/download-artifact@master + with: + name: docs + path: docs + - name: Set up docsetutil + run: | + git clone https://github.com/SwiftDocOrg/DocSetUtil.git + cd DocSetUtil + make install + - name: Build Docset + run: | + cd docs/html/ + make XCODE_INSTALL=../../DocSetUtil/Developer + - name: Publish docs to GH Actions + uses: actions/upload-artifact@v2 + with: + path: docs/html/org.devkitPro.libctru.docset/ + name: org.devkitpro.libctru.docset