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

[Doc] sphinx documentation with content reformatting #917

Merged
merged 21 commits into from
Apr 6, 2023

Conversation

wonjuleee
Copy link
Contributor

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

@codecov-commenter
Copy link

codecov-commenter commented Apr 6, 2023

Codecov Report

Patch coverage: 72.07% and project coverage change: -0.02 ⚠️

Comparison is base (3e0cbf0) 78.88% compared to head (cf0c707) 78.87%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #917      +/-   ##
===========================================
- Coverage    78.88%   78.87%   -0.02%     
===========================================
  Files          210      210              
  Lines        25065    25145      +80     
  Branches      5032     5036       +4     
===========================================
+ Hits         19773    19832      +59     
- Misses        4159     4178      +19     
- Partials      1133     1135       +2     
Flag Coverage Δ
macos-11_Python-3.8 77.86% <72.07%> (-0.02%) ⬇️
ubuntu-20.04_Python-3.8 78.86% <72.07%> (-0.02%) ⬇️
windows-2019_Python-3.8 78.80% <72.07%> (-0.02%) ⬇️

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

Impacted Files Coverage Δ
datumaro/plugins/data_formats/kitti_raw/base.py 84.44% <ø> (ø)
...tumaro/plugins/data_formats/sly_pointcloud/base.py 88.99% <ø> (ø)
...ugins/data_formats/datumaro_binary/mapper/media.py 86.66% <50.00%> (-1.71%) ⬇️
datumaro/components/media.py 81.16% <72.44%> (-2.30%) ⬇️
datumaro/components/exporter.py 86.29% <100.00%> (+2.21%) ⬆️
datumaro/plugins/data_formats/datumaro/base.py 93.66% <100.00%> (ø)
datumaro/plugins/data_formats/datumaro/exporter.py 94.91% <100.00%> (-0.03%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

Copy link
Contributor

@vinnamkim vinnamkim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@wonjuleee wonjuleee merged commit 89b2111 into openvinotoolkit:develop Apr 6, 2023
chuneuny-emily and others added 18 commits April 6, 2023 21:40
To exclude 'tab-in-indent' error from whitespace checking on Makefile
<!-- Contributing guide:
https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md
-->

### Summary


![image](https://user-images.githubusercontent.com/89109581/229419480-c4835066-9253-4a48-8a98-6630e951c34b.png)

<!--
Resolves openvinotoolkit#111 and openvinotoolkit#222.
Depends on openvinotoolkit#1000 (for series of dependent commits).

This PR introduces this capability to make the project better in this
and that.

- Added this feature
- Removed that feature
- Fixed the problem openvinotoolkit#1234
-->

### How to test
<!-- Describe the testing procedure for reviewers, if changes are
not fully covered by unit tests or manual testing can be complicated.
-->

### Checklist
<!-- Put an 'x' in all the boxes that apply -->
- [ ] 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](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md).​
- [ ] I have updated the
[documentation](https://github.com/openvinotoolkit/datumaro/tree/develop/docs)
accordingly

### License

- [ ] I submit _my code changes_ under the same [MIT
License](https://github.com/openvinotoolkit/datumaro/blob/develop/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).

```python
# Copyright (C) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT
```
@yunchu yunchu mentioned this pull request Apr 10, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants