Skip to content

Update README.md

Update README.md #98

Workflow file for this run

name: Docs
on: [push, pull_request]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install Python dependencies
run: |
pip install -r docs/requirements.txt
pip install ipykernel
pip install .
- name: Prepare static path
run: mkdir -p docs/_static
- name: Auto-generate .rst files for new modules
run: |
sphinx-apidoc -o docs/ src/PTLF/ --force --no-toc
- name: Build docs
run: |
sphinx-build -b html docs docs/_build/html