Autopopulate API contents if none provided#425
Open
cliffckerr wants to merge 2 commits into
Open
Conversation
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.
Summary
For small Python packages, you typically want to document the entire API, and don't need to do any customization in terms of ordering. But currently,
quartodocrequires the API contents to be explicitly listed in_quarto.yml.This PR makes it so if no
contentsare provided toquartodoc, it will behave as if every source file was listed.This behavior was copied from mkdocstrings-python, since this was the only feature I could find that
mkdocstringshad thatquartodocseemed to lack :)Details
contentsfrom the configured package when none is provided, so users can omit explicit content lists for full-package documentation.*.pyfiles (excluding__init__.pyand__pycache__) and generates anAutoentry per module.validatoronPage.contentsto reject empty page contents, and re-exportsvalidatorfrom the pydantic v1/v2 compatibility shim.docs/get-started/overview.qmd.Test plan
quartodocconfig whose section omitscontentsand confirm modules are auto-discovered.contentsand confirm behavior is unchanged.Pagewith emptycontentsraises a validation error.docs/get-started/overview.qmd.(NB: feature implemented with the help of Claude)