Tutorial for extending autodoc #8972
Merged
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
tk0miya
requested changes
Mar 8, 2021
| .. autointenum:: my_enums.Colors | ||
|
|
||
|
|
||
| .. todo:: Document available Documenter classes, options... |
There was a problem hiding this comment.
I think this is not a topic of tutorials. It would be better to separate class references and tutorials.
There was a problem hiding this comment.
Do you want me to remove this todo?
There was a problem hiding this comment.
After going through the autodoc source code I got a very strong urge to make changes to the code. I want to ask the mailing list first about my proposed changes. I will probably create a separated API page after making changes.
There was a problem hiding this comment.
Do you want me to remove this todo?
Yes. It's better to document it on another page.
|
@tk0miya Do you want me to push new commits or amend? |
Uses :ref: link because :doc: does not work.
Used in add_autodocumenter docstring
tk0miya
approved these changes
Mar 9, 2021
|
Thank you for update. Looks good. Can I merge this? |
|
Yes |
|
Merged! Thank you for your work! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: Tutorial for extending autodoc
Feature or Bugfix
Purpose
Detail
Relates