Doc improvements #969
Doc improvements #969
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 5 files with indirect coverage changes 🚀 New features to boost your workflow:
|
|
Drops the comparing with Also possibly time to update those comparisons to ryp |
This commit overhauls the Quarto documentation generation and CI process. - Automates the documentation build and deployment via GitHub Actions. - Implements Quarto's 'freeze' feature to significantly speed up builds by caching computational results. - Adds a markdown linting job to the CI to ensure documentation quality. - Fixes numerous docstrings and cross-reference links in the API documentation. - Updates the Quarto configuration to correctly build the reference documentation and ignore build artifacts (, ).
|
I actually think all the docs are building on the CI, it's just that I think the folder is deleted straight away? Else I couldn't explain why the docs CI step usually takes 20 minutes or so? It's usually painfully slow ... |
|
yeah it takes well over an hour on my local machine; i think the github action is doing some fiddly caching. I'll dig into the logs on a flight tomorrow. |
Docs currently only build on Alex's personal laptop (the quarto file points to
python.exe) which is not a great state of affairs. I'm going to work on a setup so we have documentation deployment and preview in each branch.[likely ugly, WIP]