PROJECT_NAME = "TPS"
PROJECT_NUMBER = 1.0.0
OUTPUT_DIRECTORY = Documentation
INPUT = Source README.md
RECURSIVE = YES
INPUT_FILTER = py devops\docs\Unreal-Engine-Doxygen-Filter\filter_ue4_macros.py
USE_MDFILE_AS_MAINPAGE = README.md
HTML_FOOTER = devops/docs/Doxygen-Dark-Theme/html_footer.html
HTML_EXTRA_STYLESHEET = devops/docs/Doxygen-Flat-Theme/src/doxygen-style.css
HTML_EXTRA_FILES = devops/docs/Doxygen-Flat-Theme/src/img/closed-folder.png \
devops/docs/Doxygen-Flat-Theme/src/img/document.png \
devops/docs/Doxygen-Flat-Theme/src/img/opened-folder.png \
devops/docs/Doxygen-Flat-Theme/src/img/off_sync.png \
devops/docs/Doxygen-Flat-Theme/src/img/on_sync.png
USE_MATHJAX = YES
GitHub workflows & actions
System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; img-src 'self'; style-src 'self' 'unsafe-inline'; font-src *; sandbox allow-forms allow-scripts allow-same-origin;");
git submodule update --init --recursive
name: Game Documentation
on:
push:
branches:
- master
pull_request:
branches:
- master
permissions:
pages: write
deployments: write
id-token: write
env:
CONAN_REVISIONS_ENABLED: 1
jobs:
docs:
runs-on: windows-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Check Installed Software
run: where git & where python & where pip
shell: cmd
- name: Checkout
uses: actions/checkout@v3
with:
submodules: 'recursive'
- name: Install Conan
run: pip install conan
- name: Install Doxygen
run: conan download doxygen/1.9.4@#2af713e135f12722e3536808017ba086:e94378795f92fbf88bb8cef7f9c2f38c4ecf9126 --remote conancenter
- name: Run Doxygen
run: doxygen devops\docs\Doxyfile
- name: Upload Docs
uses: actions/upload-pages-artifact@v1
with:
path: Documentation\html
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Deploy To GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
