feat(docs): Quarto-generated documentation site#96
Open
lukeroantreeONS wants to merge 3 commits intomainfrom
Open
feat(docs): Quarto-generated documentation site#96lukeroantreeONS wants to merge 3 commits intomainfrom
lukeroantreeONS wants to merge 3 commits intomainfrom
Conversation
Merge [strategy theirs] of main to bring up to date with latest codebase.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 Quarto-generated Documentation for the package
✨ Summary
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.
Scope - this PR introduces only the requirements to generate the documentation site, and some updates to typehints / docstrings to facilitate forming the documentation.
A short follow-up PR will introduce the CICD YAML changes to build and deploy to GitHub Pages as part of the release workflow.
📜 Changes Introduced
index.qmd) on opening✅ Checklist
terraform fmt&terraform validate)🔍 How to Test
uv syncto get the additional (dev) packages requiredquartodoc buildto build the quarto markdown filesquarto renderto render html documentation sitequarto previewto locally host the documentation site - explore it in a browser