Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable offline documentation by providing docsets #510

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Enable offline documentation by providing docsets #510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db0dc54
Enable Docset generation on build
dimaguy Sep 20, 2022
1369f25
Change workflow to generate a proper docset
dimaguy Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/doxygen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
10 changes: 5 additions & 5 deletions libctru/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1200,37 +1200,37 @@ 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
# (such as a company or product suite) can be grouped.
# 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.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# 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
# string, e.g. com.mycompany.MyDocSet.documentation.
# 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
Expand Down