Repository navigation
Document the public API with one table and two figures - #41
Open
almogtavor wants to merge 7 commits into
Open
almogtavor wants to merge 7 commits into
almogtavor wants to merge 7 commits into
Conversation
|
The call table and the lane order sentence become two figures drawn by docs/assets/plot_api.py. The docs site now also serves docs/assets under /docs/assets, so the relative image links of the Markdown pages resolve there as they do on GitHub.
Member
Author
|
CC @ronenkat |
This branch has not been deployed
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.
Documentation only.
docs/api.mdnow opens with a short overview: a table of the five namesafdepexports and a figure of the fourBuffercalls of one exchange, with the role that makes each call and what it returns. A second figure replaces the sentence that listed the call order with two lanes.docs/assets/plot_api.pydraws both figures, in a light and a dark version.The docs site now also serves
docs/assetsunder/docs/assets, so the relative image links of the Markdown pages resolve there as they do on GitHub. This also brings back the two figures of the sparse hybrid page on the site.The contract text is unchanged, except for one sentence in "Transport and tuning" that repeated the overview.