Add dev version in README and slightly improve supported algorithms writing #5121
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: docs_test | |
on: | |
pull_request: | |
branches: | |
- main | |
push: | |
branches: | |
- main | |
jobs: | |
test-ubuntu: | |
name: "docs on ${{ matrix.python-version }} on ${{ matrix.os }}" | |
runs-on: "${{ matrix.os }}" | |
strategy: | |
matrix: | |
python-version: [3.9] | |
os: [ubuntu-latest] | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r docs/requirements-docs.txt | |
- name: Print installed dependencies | |
run: | | |
pip freeze | |
- name: Make Sphinx Docs to HTML (Test) | |
run: | | |
cd docs | |
bash ./generate_docs.sh html | |
- name: Documentation Test (Test) | |
run: | | |
cd docs | |
bash ./generate_docs.sh doctest | |