Skip to content

Conversation

@lukeroantreeONS
Copy link
Collaborator

πŸ“Œ Quarto-generated Documentation for the package

✨ Summary

DRAFT

This PR uses Quarto and Quartodoc to build a documentation website for the package, based on the package docstrings, as well as the markdown and notebook files.

πŸ“œ Changes Introduced

  • feat: quarto-generated documentation site (overall)
  • feat: sidebar with sections for different components, and the demos
  • fix: make it consistently direct to the landing page (index.qmd) on opening
  • chore: make sidebar collapsed by default
  • ci: integrate into CICD pipeline, make / update github.io site

βœ… Checklist

Please confirm you've completed these checks before requesting a review.

  • Code passes linting with Ruff
  • Security checks pass using Bandit
  • API and Unit tests are written and pass using pytest
  • Terraform files (if applicable) follow best practices and have been validated (terraform fmt & terraform validate)
  • DocStrings follow Google-style and are added as per Pylint recommendations
  • Documentation has been updated if needed

πŸ” How to Test

  1. Install Quarto locally.
  2. Run uv sync to get the additional packages required
  3. Run quartodoc build
  4. Run quarto preview to render & locally host the documentation site

@lukeroantreeONS lukeroantreeONS linked an issue Dec 14, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Set up MVP of Quarto documentation

2 participants