This repository was archived by the owner on Mar 21, 2024. It is now read-only.
DOC: Add part of the API to the Sphinx docs #718
Merged
Conversation
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
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
mebristo
approved these changes
Apr 19, 2022
ant0nsc
approved these changes
Apr 19, 2022
|
Thanks for approving! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
Having a nicely rendered documentation that is easy to access help understand how the framework works, encouraging usage and contributions.
This PR adds some parts of the API to the Sphinx documentation, as a starting point. More work needs to be done to improve the docstrings syntax, fix issues such as new lines missing before the parameters definitions (which breakes the rendering), and add most of the API.
Related to