docs: improve sphinx docs and add favicon #70
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 | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
pull_request: | |
types: [opened, reopened, synchronize] | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -e .[docs] | |
- name: Build documentation | |
run: | | |
make -C docs clean && make -C docs html SPHINXOPTS="-W --keep-going" | |
- name: Notice | |
run: | | |
echo "Documentation build successful!" | |
echo "After merging this PR, you can view the latest documentation at:" | |
echo "- Public docs: https://camtools.readthedocs.io/en/latest/" | |
echo "- Admin panel: https://app.readthedocs.org/projects/camtools/" |