169 improve apidoc generation #342
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
surgura
force-pushed
the
169-improve-apidoc-generation
branch
from
837a860 to
d03d13d
Compare
surgura
commented
Oct 23, 2023
There was a problem hiding this comment.
fyi api reference is programmatically added by autoapi
surgura
commented
Oct 23, 2023
There was a problem hiding this comment.
this file was missing but we didn't see it until now
surgura
commented
Oct 23, 2023
There was a problem hiding this comment.
changed the generic parameters so they don't class with the Individual class in the docs
surgura
commented
Oct 23, 2023
There was a problem hiding this comment.
very similar to the default used by autoapi, just added that module names don't include their complete path package1.package2.module adn just module. it's implicit anyway wrt to where you are in the docs
oliverweissl
approved these changes
Oct 23, 2023
not intentional, i'll fix it before merging |
surgura
added a commit
that referenced
this pull request
Oct 31, 2023
* Remove autodoc and apidoc in favor of autoapi. * No need to manually edit api documentation ever again. * Display not perfect but reasonable for now. See #341
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.
closes #169