refactor: organized docs (#1596) #1096
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| on: | |
| push: | |
| paths: | |
| - .github/workflows/build_docs.yml | |
| - docs/** | |
| - src/**/*.h | |
| - Doxyfile | |
| - DoxygenLayout.xml | |
| - mkdocs.yml | |
| workflow_dispatch: | |
| jobs: | |
| build-doxygen: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| git clone --depth 1 --branch v2.3.4 https://github.com/jothepro/doxygen-awesome-css.git docs/api/doxygen-awesome-css | |
| - run : | | |
| mkdir -p site/api | |
| - uses: mattnotmitt/doxygen-action@v1 | |
| with: | |
| doxyfile-path: ./docs/api/Doxyfile | |
| - run: | | |
| tar -cvf artifact.tar -C site/ . | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: doxygen-pages | |
| path: | | |
| artifact.tar | |
| build-mkdocs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| pip install -r docs/main/requirements.txt | |
| - run: | | |
| mkdocs build -f docs/main/mkdocs.yml -d ../../site | |
| - run: | | |
| tar -cvf artifact.tar -C site/ . | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: mkdocs-pages | |
| path: | | |
| artifact.tar | |
| merge: | |
| needs: | |
| - build-doxygen | |
| - build-mkdocs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| path: artifacts/ | |
| - name: Extract artifacts | |
| run: | | |
| mkdir site | |
| tar -xvf artifacts/doxygen-pages/artifact.tar -C site/ | |
| tar -xvf artifacts/mkdocs-pages/artifact.tar -C site/ | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site/ | |
| deploy: | |
| if: github.ref == 'refs/heads/develop' && github.event_name == 'push' | |
| needs: | |
| - merge | |
| permissions: | |
| id-token: write | |
| pages: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/deploy-pages@v4 |