version bump v2.5.5 #29
Workflow file for this run
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: Pdoc | |
| on: | |
| push: | |
| tags: | |
| - v*.*.* | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install Poetry | |
| uses: snok/[email protected] | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| - name: Install hyperscan | |
| run: sudo apt-get install libhyperscan-dev | |
| - name: Load cached venv | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}-v2021-09-23 | |
| - name: Install dependencies | |
| run: poetry install | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| - name: Activate venv | |
| run: | | |
| echo "VIRTUAL_ENV=$GITHUB_WORKSPACE/.venv" >> $GITHUB_ENV | |
| echo "PYTHONPATH=$GITHUB_WORKSPACE" >> $GITHUB_ENV | |
| echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH | |
| - name: Run pdoc | |
| working-directory: ./api_documentation | |
| run: | | |
| pdoc --html ./../eyecite --output-dir . --force | |
| - name: Run sed # Removes insanely-long parameter definition from docs | |
| working-directory: ./api_documentation | |
| run: | | |
| sed -i 's/AhocorasickTokenizer(.*\]))/AhocorasickTokenizer()/' ./eyecite/find.html | |
| sed -i 's/AhocorasickTokenizer(.*\]))/AhocorasickTokenizer()/' ./eyecite/index.html | |
| - name: Deploy 🚀 | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| folder: api_documentation/eyecite |