Initial commit #1
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: documentation | |
| on: [push, pull_request, workflow_dispatch] | |
| permissions: | |
| contents: write | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Install dependencies | |
| run: | | |
| pip install sphinx sphinx_rtd_theme myst_parser sphinxcontrib-bibtex sphinx-gallery matplotlib | |
| - name: Install package | |
| run: cd rbms && pip install . | |
| - name: Get data for example | |
| run: | |
| cd examples && wget https://github.com/nbereux/data_test/raw/refs/heads/main/dummy.zip | |
| - name: Get RBM for example | |
| run: | |
| cd examples && wget https://github.com/nbereux/data_test/raw/refs/heads/main/RBM.zip | |
| - name: Extract binary data | |
| run: | |
| cd examples && unzip dummy.zip | |
| - name: Extract binary data | |
| run: | |
| cd examples && unzip RBM.zip | |
| - name: Sphinx build | |
| run: | | |
| cd docs | |
| make html | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html | |
| force_orphan: true |