Autodoc touchups #113
Merged
Autodoc touchups #113
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
- I'm still reasonably unhappy with what's happening, but it's probably the best I've achieved yet
- At this point I've gone through this tutorial: https://bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
I have finally settled on a sphinx doc setup that I'm happy-ish with. It's all thanks to this article: https://bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi/#autodoc_typehints (thanks @abey79)
Of course, there's always stuff to be unhappy about. The biggest problem is the lack of support for attrs classes. Maybe in time.
Now it's time to make the docs