-
Notifications
You must be signed in to change notification settings - Fork 33
Description
Summary
The hosted documentation at https://marinlauber.github.io/Python-VPP/ is served from pre-built HTML committed to the docs/ folder on master. This HTML was last generated in 2020 and only documents VPPMod (4 methods).
Since then, comprehensive NumPy-style docstrings have been added to all source modules (see PR #55):
- SailMod —
Sail,Main,Jib,Kite(including theI,J,LPG,HBIparameters requested in Add documentation on parameters to the documentation #53) - YachtMod —
Yacht,Keel,Rudder,Bulb,Appendage - AeroMod —
AeroMod.__init__,update(), plus typo fixes - HydroMod —
HydroMod.__init__,update(),_cf(), plus typo fixes - VPPMod — already had partial docs
The Sphinx source (sphinx/index.rst + new sphinx/modules.rst) has been updated to autodoc all 6 modules. The docs build cleanly with sphinx-build.
Problem
None of these improvements are visible on the live site because the docs/ HTML hasn't been rebuilt.
Proposal
Replace the manual build-and-commit workflow with a GitHub Actions workflow that:
- Builds Sphinx HTML on every push to
master - Deploys to GitHub Pages via
actions/deploy-pages - Removes the need to commit built HTML to the repo
This would:
- Keep docs always in sync with code
- Eliminate the stale
docs/folder from the repo - Make documentation a first-class part of the CI pipeline
Happy to implement this if you're interested — it's a ~20 line workflow file plus switching the GitHub Pages source from master:/docs to the GitHub Actions deployment.