Docs: Fix layout with sub-section (#3710)

This commit is contained in:
Chayenne
2025-02-19 15:44:30 -08:00
committed by GitHub
parent bb121214c2
commit 3c7bfd7eab
18 changed files with 78 additions and 72 deletions

View File

@@ -20,19 +20,16 @@ Update your Jupyter notebooks in the appropriate subdirectories under `docs/`. I
# 1) Compile all Jupyter notebooks
make compile
# 2) Generate static HTML
make html
# 3) Preview documentation locally
# 2) Compile and Preview documentation locally
# Open your browser at the displayed port to view the docs
bash serve.sh
# 4) Clean notebook outputs
# 3) Clean notebook outputs
# nbstripout removes notebook outputs so your PR stays clean
pip install nbstripout
find . -name '*.ipynb' -exec nbstripout {} \;
# 5) Pre-commit checks and create a PR
# 4) Pre-commit checks and create a PR
# After these checks pass, push your changes and open a PR on your branch
pre-commit run --all-files
```