use auto generated doc only #94
This file contains hidden or 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
| # This workflow builds the Doxygen documentation and deploys it to GitHub Pages. | |
| # It is triggered on pushes to the development, documentation2, or main branches. | |
| name: Documentation | |
| # Controls when the action will run. Triggers the workflow on push or pull request | |
| # events but only for the master branch | |
| on: | |
| push: | |
| branches: [ development, documentation2, main ] | |
| jobs: | |
| build-documentation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Create the MD file listing the input keys | |
| - name: Create the MD file listing the input keys | |
| run: python ReadInput.py | |
| # Update Input table | |
| - name: Update Input table | |
| uses: test-room-7/action-update-file@v1 | |
| with: | |
| file-path: doc/ParametersList-py.md | |
| commit-msg: Automatic update of Input parameter list | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| # Install Doxygen | |
| - name: Install Doxygen | |
| run: sudo apt-get update && sudo apt-get install -y doxygen graphviz | |
| # Install Python and Sphinx dependencies | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install Python dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install sphinx breathe | |
| # If you have a requirements.txt, use: | |
| # pip install -r docs/requirements.txt | |
| # Build the HTML documentation | |
| # - name: Build Doxygen Documentation | |
| # run: doxygen ./Doxygenfile | |
| # Build Doxygen XML Documentation | |
| - name: Build Doxygen XML Documentation | |
| run: doxygen Doxygenfile | |
| # Build Sphinx HTML Documentation | |
| - name: Build Sphinx HTML Documentation | |
| run: | | |
| sphinx-build -b html -d doc/build/doctrees doc/ doc/source doc/html | |
| # Deploy the Sphinx HTML documentation to GitHub Pages | |
| - name: GH Pages Deployment | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./doc/_build/html/ | |
| enable_jekyll: false | |
| allow_empty_commit: false | |
| force_orphan: true | |
| publish_branch: gh-pages |