Use jinja templates for API documentation#339
Merged
Conversation
rahulporuri
approved these changes
Oct 23, 2020
Contributor
rahulporuri
left a comment
rahulporuri
left a comment
There was a problem hiding this comment.
LGTM with one minor correction.
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
2 participants
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.
fixes #304
This PR follows the lead of traits-futures, specifically PR enthought/traits-futures#181
In doings so it adds templates and an
envisage.api.rstfile todocs/source/spi. To avoid these files being deleted when building docs, the logic for removing any previously autogenerated API documentation has been modified. The code was a bit cleaner before as we could just remove the full directory, and the logic in this PR may not be the best way to go about it.