Draft
Conversation
Contributor
|
@anacso17, what is missing here for merging? |
Contributor
I think we could check if the documentation generated is useful in some way and check if there is some desired docstrings missing to compose the automatic documentation. |
Contributor
|
But do you think this is something we should put some effort for now, or is it not a priority for now? |
Contributor
I think it is not a priority for now, but as far as we (also @xresende and @vellosok75 ) have time, it woud be interesting to take a look |
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
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.
This code documentation uses Sphinx. Feel free to add docstrings.
To generate the page, run: make html, inside the docs folder, and then open the index.html file inside build folder.