Merge branch 'Doxygen' of github.com:EXP-code/EXP-docs into Doxygen #3
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
| name: Build and Deploy Docs | |
| on: | |
| push: | |
| branches: | |
| - Doxygen # Trigger on pushes to the main branch | |
| jobs: | |
| build: | |
| runs-on: ubuntu-24.04 # Specify the operating system | |
| steps: | |
| - uses: actions/checkout@v4 # Checkout the repository | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' # Specify your Python version | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y build-essential libeigen3-dev libfftw3-dev libhdf5-dev libopenmpi-dev libomp-dev python3-numpy python3-venv python3-ipython ipython3 doxygen graphviz cmake make pandoc | |
| python3 -m venv .venv # Create a virtual environment | |
| source .venv/bin/activate # Activate the environment | |
| pip install sphinx sphinx-rtd-theme # Install Sphinx and theme | |
| pip install -r requirements.txt # Install any additional dependencies (optional) | |
| - name: Build Sphinx documentation | |
| run: | | |
| source .venv/bin/activate # Activate the environment | |
| make html # Build the HTML documentation | |
| - name: Upload built documentation (optional) | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-docs | |
| path: _build/html # Path to your built documentation | |
| - name: Deploy to github pages | |
| uses: peaceiris/actions-gh-pages@v3 # Or other suitable deploy action | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: _build/html |