Skip to content
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
merged 4 commits into from
Apr 27, 2023

Conversation

vinnamkim
Copy link
Contributor

@vinnamkim vinnamkim commented Apr 21, 2023

Summary

How to test

Checklist

  • I have added unit tests to cover my changes.​
  • I have added integration tests to cover my changes.​
  • I have added the description of my changes into CHANGELOG.​
  • I have updated the documentation accordingly

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below).
# Copyright (C) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT

Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
@vinnamkim vinnamkim marked this pull request as ready for review April 21, 2023 08:19
@vinnamkim vinnamkim requested review from a team as code owners April 21, 2023 08:19
@vinnamkim vinnamkim added the DOC Improvements or additions to documentation label Apr 21, 2023
@vinnamkim vinnamkim added this to the 1.3.0 milestone Apr 21, 2023
@vinnamkim vinnamkim requested a review from yunchu April 21, 2023 08:20
@codecov-commenter
Copy link

codecov-commenter commented Apr 21, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (ce714d2) 78.72% compared to head (e03e508) 78.72%.

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     
Flag Coverage Δ
macos-11_Python-3.8 77.75% <ø> (+<0.01%) ⬆️
ubuntu-20.04_Python-3.8 78.69% <ø> (+<0.01%) ⬆️
windows-2019_Python-3.8 78.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

wonjuleee
wonjuleee previously approved these changes Apr 26, 2023
@JihwanEom
Copy link
Contributor

LGTM, could you resolve conflicts?

@vinnamkim
Copy link
Contributor Author

@wonjuleee @JihwanEom
I resolved conflicts.

@vinnamkim vinnamkim merged commit 7d26a50 into openvinotoolkit:develop Apr 27, 2023
@vinnamkim vinnamkim deleted the docs/fix-autosummary branch April 27, 2023 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants