mirror of
https://github.com/pmret/papermario.git
synced 2024-11-08 12:02:30 +01:00
82b09bd69e
* support modded NPC sprites - improve compatibility with Star Rod SpriteSheet.xml files - SR's intention is to move to the decomp xml but the current release of SR emitted incompatible xml - use npc.xml instead of npc_sprite_names.yaml to generate linker entries. this allows mods to add new sprites * black why does it want two spaces before line comments!? * Doxygen (#1142) * use doxygen * add documenting guide based on https://github.com/zeldaret/oot/blob/main/docs/Documenting.md * exclude stdlib readme from doxygen * refuse to configure matching iQue on macOS (EGCS compiler is not built for macOS, so iQue won't build. We still enable iQue builds on macOS by using gcc-papermario via --non-matching.) * use proper doxygen bug comment style * document common EVT API funcs nicely * add doxygen ci * add \vars command * s/master/main * use Doxygen 1.10.0 * fix doxygen ci * fix doxygen ci * fix doxygen (final) * fix doxygen (final real) * Fix Doxygen CI (#1147) * remove old doxygen ci line * fix warns Thanks @Ponmander for reporting this
35 lines
1.1 KiB
YAML
35 lines
1.1 KiB
YAML
name: Docs
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
jobs:
|
|
doxygen:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Install Doxygen
|
|
run: |
|
|
# doxygen on apt is too old
|
|
curl -L https://www.doxygen.nl/files/doxygen-1.10.0.linux.bin.tar.gz | tar xz
|
|
sudo mv doxygen-*/bin/doxy* /usr/local/bin
|
|
- name: Generate docs
|
|
run: doxygen
|
|
# deploy to gh pages if repo is pmret/papermario
|
|
- name: Deploy to gh-pages
|
|
if: github.repository != 'pmret/papermario'
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./docs/doxygen/html
|
|
- name: Deploy to papermar.io
|
|
if: github.repository == 'pmret/papermario'
|
|
uses: appleboy/scp-action@master
|
|
with:
|
|
host: ${{ secrets.HOST }}
|
|
username: ${{ secrets.USERNAME }}
|
|
password: ${{ secrets.PASSWORD }}
|
|
source: docs/doxygen/html/
|
|
target: "/var/www/papermar.io/html/docs/"
|
|
strip_components: 3
|