Skip to content
build

Add Sphinx documentation #471

Sign in to view logs

Add Sphinx documentation

Add Sphinx documentation #471

Workflow file for this run

.github/workflows/build.yml at a228072
name: build
on: [push, pull_request]
jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy3.9']
architecture: [x86, x64]
exclude:
- os: ubuntu-latest
architecture: x86
- os: macos-latest
architecture: x86
- os: windows-latest
python: pypy3
- os: macos-latest
python: pypy3
- os: macos-latest
python: 3.8
- os: macos-latest
python: 3.9
- os: macos-latest
python: 3.10
name: ${{ matrix.os }} Py ${{ matrix.python }} ${{ matrix.architecture }}
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python }}
architecture: ${{ matrix.architecture }}
- name: Install python dependencies
run: |
python -m pip install --upgrade pip setuptools poetry
poetry update
- name: Run pre-commit
if: "!startsWith(matrix.python, 'pypy') && !startsWith(matrix.python, '3.7') && !startsWith(matrix.python, '3.8')"
run: |
python -m pip install pre-commit
pre-commit run --all-files
- name: Run unit tests
run: poetry run pytest
build:
#needs: test
runs-on: ubuntu-latest
name: Build Python source .tar.gz
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Build source package
run: |
python -m pip install --upgrade pip setuptools poetry
poetry build
- name: Upload source package
uses: actions/upload-artifact@v4
with:
name: fido2-python-sdist
path: dist
docs:
runs-on: ubuntu-latest
name: Build sphinx documentation
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.12
- name: Install python dependencies
run: |
python -m pip install --upgrade pip
python -m pip install poetry
poetry install
- name: Build sphinx documentation
run: poetry run make -C docs/ html
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: python-fido2-docs
path: docs/_build/html
docs_win:
runs-on: windows-latest
name: Build sphinx documentation on Windows
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.12
- name: Install python dependencies
shell: bash
run: |
python -m pip install --upgrade pip
python -m pip install poetry
poetry install
- name: Build sphinx documentation
shell: bash
run: poetry run make -C docs/ html
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: python-fido2-docs-win
path: docs/_build/html