Moved readme #12
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
| name: Build and Deploy | |
| on: | |
| push: | |
| branches: | |
| - master # Trigger this workflow only for pushes to the master branch | |
| permissions: | |
| contents: write | |
| jobs: | |
| build-and-deploy: | |
| concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession. | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v4 | |
| - name: Install Dependencies 📦 | |
| run: | | |
| pip install sphinx # Install Sphinx if it's not already installed | |
| # Add any other dependencies you need for your Sphinx documentation | |
| - name: Build Documentation 📖 | |
| run: | | |
| cd docs # Change to the docs directory | |
| make html # Run make html to build the documentation | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: docs/build/html # Update to match the output folder specified in Makefile | |
| branch: gh-pages # Specify the branch to deploy to |