added search to docs and removed usage/example from README #6
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
| on: | |
| push: | |
| branches: [ main ] | |
| jobs: | |
| build: | |
| name: Deploy docs | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install Package | |
| run: | | |
| python3 -m pip install --upgrade pip | |
| python3 -m pip install -e . | |
| - name: Deploy docs | |
| uses: afritzler/mkdocs-gh-pages-action@main | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| REQUIREMENTS: docs/requirements.txt |