-
Notifications
You must be signed in to change notification settings - Fork 128
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
Use autosummary for fully-automatic Python module docs generation #973
Merged
vinnamkim
merged 4 commits into
openvinotoolkit:develop
from
vinnamkim:docs/fix-autosummary
Apr 27, 2023
Merged
Use autosummary for fully-automatic Python module docs generation #973
vinnamkim
merged 4 commits into
openvinotoolkit:develop
from
vinnamkim:docs/fix-autosummary
Apr 27, 2023
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
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## develop #973 +/- ##
========================================
Coverage 78.72% 78.72%
========================================
Files 231 231
Lines 26454 26454
Branches 5261 5261
========================================
+ Hits 20825 20826 +1
Misses 4404 4404
+ Partials 1225 1224 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
wonjuleee
previously approved these changes
Apr 26, 2023
LGTM, could you resolve conflicts? |
@wonjuleee @JihwanEom |
JihwanEom
approved these changes
Apr 27, 2023
wonjuleee
approved these changes
Apr 27, 2023
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.
Summary
Ticket no. 109037
Our auto API docs have been broken for long time. This is because the rst files generated by sphinx.ext.autodoc – Include documentation from docstrings — Sphinx documentation (sphinx-doc.org) are not updated according to the code changes. sphinx.ext.autodoc is semi-automatic way, so that we have to update it mannually at some extent. We need to fix this by replacing it with sphinx.ext.autosummary – Generate autodoc summaries — Sphinx documentation (sphinx-doc.org) to achieve fullly-automatic pipeline for this.
Remove all files under
docs/source/reference
and leave two files only. One of them is datumaro_module.rst which auto-generates all*.rst
file for Python module docs atdocs/source/reference/_autosummary
whenever executingmake html
.How to test
Checklist
License
Feel free to contact the maintainers if that's a concern.