Add autoapi to crawl our modules and populate the docs, closes #14 #36
+167
−12
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
Uses the docstrings of our code to generate documentation.
salomaestro
changed the title
|
PS: If you want to work on this draft PR simultaneously, here is a quick guide: git fetch origin pull/36/head:some-branch-name # 36 is the number of the PR
git switch some-branch-name
... # Make your changes to the code and commit them
git push origin christian/sphinx-autoapiI think this should do it. It could be that instead of pushing to Also, remember that to host the documentation locally, run |
Added a bit more information to some of the docstrings, but there is still a lot of room for improvement ;)
salomaestro
changed the title
salomaestro
commented
Feb 5, 2025
There was a problem hiding this comment.
@hzavadil98 I took the liberty here to edit your docstring.
There was a problem hiding this comment.
Thanks, I had copilot do it and didn't really check the result properly 🙈
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.
Uses the docstrings of our code to generate documentation.