Skip to content

Updates docs for release#936

Merged
yunchu merged 1 commit intoopen-edge-platform:releases/1.2.0from
yunchu:update-toxevn-for-docs-build
Apr 17, 2023
Merged

Updates docs for release#936
yunchu merged 1 commit intoopen-edge-platform:releases/1.2.0from
yunchu:update-toxevn-for-docs-build

Conversation

@yunchu
Copy link
Copy Markdown
Contributor

@yunchu yunchu commented Apr 14, 2023

Summary

  • Added docs workflow for stable release
  • Updated some docstrings
  • Fixed some docs build errors

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

@yunchu yunchu requested review from a team as code owners April 14, 2023 09:52
@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@yunchu yunchu force-pushed the update-toxevn-for-docs-build branch from cfb48db to c04984a Compare April 14, 2023 09:55
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 14, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.28 🎉

Comparison is base (37b62bb) 78.78% compared to head (c04984a) 79.06%.

Additional details and impacted files
@@                Coverage Diff                 @@
##           releases/1.2.0     #936      +/-   ##
==================================================
+ Coverage           78.78%   79.06%   +0.28%     
==================================================
  Files                 218      231      +13     
  Lines               25575    27271    +1696     
  Branches             5100     5611     +511     
==================================================
+ Hits                20148    21563    +1415     
- Misses               4262     4479     +217     
- Partials             1165     1229      +64     
Flag Coverage Δ
macos-11_Python-3.8 78.11% <100.00%> (+0.33%) ⬆️
ubuntu-20.04_Python-3.8 79.04% <100.00%> (?)
windows-2019_Python-3.8 78.95% <100.00%> (+0.23%) ⬆️

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

Impacted Files Coverage Δ
datumaro/cli/util/project.py 33.67% <ø> (ø)
...ugins/data_formats/common_semantic_segmentation.py 82.02% <ø> (ø)
datumaro/plugins/data_formats/imagenet.py 91.76% <ø> (ø)
datumaro/plugins/sampler/random_sampler.py 79.62% <ø> (ø)
...ns/data_formats/datumaro_binary/mapper/__init__.py 100.00% <100.00%> (ø)

... and 28 files with indirect coverage changes

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.

@yunchu yunchu changed the base branch from develop to releases/1.2.0 April 17, 2023 00:03
Comment on lines +28 to +34
# - name: Deploy
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./public
# destination_dir: ${{ env.RELEASE_VERSION }}
# force_orphan: true
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do you have a plan to use this in the near future?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes. once it merged, I can trigger this wf to check whether current docs build env can work on the GH actions-runner instance. after checking it, I will enable this job.

Copy link
Copy Markdown
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.

@yunchu yunchu merged commit f640c2c into open-edge-platform:releases/1.2.0 Apr 17, 2023
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.

4 participants