This repository has been archived by the owner on Sep 20, 2021. It is now read-only.
Use Kitab for doctests #88
Merged
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 is the first patch of a small serie. Next step is to introduce Kitab, our home tool to generate the documentation in addition to execute it.
This is another step in this serie of using Kitab.
Use the Kitab API to compile the documentation into doctests. Then, continue the pipeline with our existing atoum configuration. The goal of this patch is to just insert Kitab compilation in the `test:run` pipeline. We are not relying on the `kitab` binary.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR removes the existing code introduced to address RFC 52: Compile documentation examples into integration test suites, and execute them. It is replaced by Kitab (see RFC 53): Our tool to compile doc examples into integration test suites, and execute them (in addition to render them).
We are not relying on the atoum's configuration of Kitab, we are using our existing configuration. It's Kitab++ in some way because we have all the atoum extensions used inside
hoa/testfor our documentation now.I recommend you to read commit messages. They are short, but it might provide more insights.
It's cool to use Kitab programmatically.
Thoughts?