Skip to content

Commit

Permalink
docs: use github actions for generating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
oreo639 committed Jul 29, 2023
1 parent 02acc0e commit ba70b26
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
37 changes: 37 additions & 0 deletions .github/workflows/doxygen.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Deploy site

on:
push:
branches: [ c3d-docs ]

jobs:
doc-deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
with:
persist-credentials: false

- name: Set up Doxygen
run: sudo apt install doxygen

- name: Display Doxygen version
run: echo "Doxygen version $(doxygen -v)"

- name: Generate libctru tags
run: |
git clone --branch=master --single-branch --depth 1 https://github.com/devkitPro/libctru
cd libctru/libctru
doxygen
- name: Build documentation
run: CTRU_DOCPATH="https://libctru.devkitpro.org/" doxygen

- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs/html # The folder the action should deploy.
CLEAN: true # Automatically remove deleted files from the deploy branch
2 changes: 1 addition & 1 deletion include/c3d/base.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ void C3D_BindProgram(shaderProgram_s* program);

/**
* @brief Sets the viewport for the current framebuffer.
* @note This value is modified by \ref C3D_FrameDrawOn(). (using values specified by \ref C3D_RenderTargetSetOutput())
* @note This function is called by \ref C3D_FrameDrawOn(). (using values specified by \ref C3D_RenderTargetCreate())
* @note When using this with a rendertarget intended for display, keep in mind the orientation of the screens.
* @param[in] x X offset from the origin of the viewport in pixels.
* @param[in] y Y offset from the origin of the viewport in pixels.
Expand Down

0 comments on commit ba70b26

Please sign in to comment.