Add docs for how to document only Python files #321
Merged
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.
I found the work around for how to use the
source_dir
option correctly in this old issue: #130.I didn't understand how to use it through the docs so this PR adds an example to the docs.
Not sure if it is in the right place, so feel free to move it. I found
quartodoc
really helpful and easy to use (once I managed to find the above issue) to document a Python project that didn't end up as a package.