update readme #11
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: Sphinx docs to gh-pages | |
| on: [push, workflow_dispatch] | |
| jobs: | |
| sphinx_docs_to_gh-pages: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10"] | |
| name: Sphinx docs to gh-pages | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Installing the Documentation requirements | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[docs] | |
| - name: Installing the library | |
| run: | | |
| python setup.py install | |
| - name: Running the Sphinx to gh-pages Action | |
| uses: uibcdf/action-sphinx-docs-to-gh-pages@v2.1.0 |