doc: Add mktestdocs, and tutorial for snippets. Fixes #219 #223
Conversation
This file contains 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
|
This looks good! So essentially the docs code becomes part of the tests so we can see if future releases change the code somehow right ? |
Sidhant29
approved these changes
Mar 19, 2024
cjrh
pushed a commit
to cjrh/tantivy-py
that referenced
this pull request
Sep 3, 2024
…d8e74c90db1873d07 to 21dc36fb71dd22e3317045c0c31a3f4249868b17 (quickwit-oss#223) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.
Quite a nice feature. The
mktestdocspackage automates running all the code in the mkdocs documentation. This means we can keep our docs having actually working code. I found a couple bugs while setting this up.I've also added a short tutorial for snippets, using the existing test as an example.