1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2025-02-26 18:46:04 +01:00

Setup GH Pages

This commit is contained in:
peteGSX 2025-02-03 08:25:15 +10:00
parent fa246446f2
commit 338b918d57
4 changed files with 2853 additions and 0 deletions

26
.github/workflows/docs.yml vendored Normal file
View File

@ -0,0 +1,26 @@
name: Docs
on:
push:
branches: [ master-exraildoc ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4.1.1
- name: Requirements
run: |
sudo apt-get install doxygen
- name: Build docs
run: |
cd docs
# touch _build/html/.nojekyll
doxygen DoxyfileEXRAIL
- name: Deploy
uses: JamesIves/github-pages-deploy-action@ba1486788b0490a235422264426c45848eac35c6
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages # The branch the action should deploy to.
folder: docs/_build/html # The folder the action should deploy.

1
.gitignore vendored
View File

@ -15,3 +15,4 @@ my*.h
compile_commands.json
newcode.txt.old
UserAddin.txt
_build

View File

@ -26,6 +26,19 @@
// Doxygen comments in this file are intended for the EXRAIL end user.
/**
* @file EXRAIL2MacroReset.h
* @mainpage EXRAIL Language Reference
*
* @section introduction Introduction
* EXRAIL - Extended Railroad Automation Instruction Language
*
* This page is a reference to all EXRAIL commands available with EX-CommandStation.
*
* - @ref ACTIVATE
* - @ref ACTIVATEL
*/
// Undefine all RMFT macros
#undef ACTIVATE
#undef ACTIVATEL

2813
docs/DoxyfileEXRAIL Normal file

File diff suppressed because it is too large Load Diff