-
Notifications
You must be signed in to change notification settings - Fork 54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automatically generate API References #731
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
9b8f1cd
generate all api reference automatically
linshokaku 097ee71
onnx mock import
linshokaku b789032
remove mock imports
linshokaku c047ecc
fix indent
linshokaku e0d1d14
bump up docs build environment
linshokaku 98c1adb
modify sphinx version
linshokaku c181c4b
rename templates directory
linshokaku 1aaf646
use currentmodule for simplify docs
linshokaku File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| sphinx==4.1.0 | ||
| pydata_sphinx_theme==0.6.3 | ||
| myst-parser==0.15.1 | ||
| sphinx==5.3.0 | ||
| pydata_sphinx_theme==0.11.0 | ||
| myst-parser==1.0.0 | ||
|
|
||
| # TODO: #204 | ||
| onnx |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| {{ fullname | escape | underline}} | ||
|
|
||
| .. currentmodule:: {{ module }} | ||
|
|
||
| .. autoclass:: {{ objname }} | ||
| :members: | ||
| :special-members: __init__, __call__ | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| {% block methods %} | ||
| {% if methods %} | ||
| .. rubric:: {{ _('Methods') }} | ||
|
|
||
| .. autosummary:: | ||
| {% for item in methods %} | ||
| ~{{ name }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block attributes %} | ||
| {% if attributes %} | ||
| .. rubric:: {{ _('Attributes') }} | ||
|
|
||
| .. autosummary:: | ||
| {% for item in attributes %} | ||
| ~{{ name }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| {{ fullname | escape | underline}} | ||
|
|
||
| .. automodule:: {{ fullname }} | ||
|
|
||
| {% block attributes %} | ||
| {% if attributes %} | ||
| .. rubric:: {{ _('Module Attributes') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: . | ||
|
|
||
| {% for item in attributes %} | ||
| {{ fullname }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block functions %} | ||
| {% if functions %} | ||
| .. rubric:: {{ _('Functions') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: . | ||
|
|
||
| {% for item in functions %} | ||
| {{ fullname }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block classes %} | ||
| {% if classes %} | ||
| .. rubric:: {{ _('Classes') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: . | ||
|
|
||
| {% for item in classes %} | ||
| {{ fullname }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block exceptions %} | ||
| {% if exceptions %} | ||
| .. rubric:: {{ _('Exceptions') }} | ||
|
|
||
| .. autosummary:: | ||
| :toctree: . | ||
|
|
||
| {% for item in exceptions %} | ||
| {{ fullname }}.{{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block modules %} | ||
| {% if modules %} | ||
| .. rubric:: Modules | ||
|
|
||
| .. autosummary:: | ||
| :toctree: . | ||
| :recursive: | ||
| {% for item in modules %} | ||
| {{ item }} | ||
| {%- endfor %} | ||
| {% endif %} | ||
| {% endblock %} |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the module directive, as it impacts the links to the pytorch_pfn_extras package