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

[Enhance] update building docs #2419

Merged
merged 6 commits into from
Apr 25, 2023

Conversation

Xiangxu-0103
Copy link
Collaborator

@Xiangxu-0103 Xiangxu-0103 commented Apr 8, 2023

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Reference: https://github.com/open-mmlab/mmocr/blob/dev-1.x/docs/en/conf.py

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the back-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@codecov
Copy link

codecov bot commented Apr 8, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (aa10365) 46.99% compared to head (dfcea44) 46.99%.

❗ Current head dfcea44 differs from pull request most recent head dfc2f52. Consider uploading reports for the commit dfc2f52 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           dev-1.x    #2419   +/-   ##
========================================
  Coverage    46.99%   46.99%           
========================================
  Files          275      275           
  Lines        22904    22904           
  Branches      3566     3566           
========================================
  Hits         10763    10763           
  Misses       11455    11455           
  Partials       686      686           
Flag Coverage Δ
unittests 46.99% <ø> (ø)

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

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

@JingweiZhang12 JingweiZhang12 left a comment

Choose a reason for hiding this comment

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

Please check the influence of all modifications. The examples of mmdet may not be suitable, For example, we'd better keep the links of 'upstream' in readthedocs.

docs/en/stat.py Outdated Show resolved Hide resolved
docs/en/conf.py Show resolved Hide resolved
docs/en/conf.py Show resolved Hide resolved
@JingweiZhang12 JingweiZhang12 merged commit 47635c3 into open-mmlab:dev-1.x Apr 25, 2023
@Xiangxu-0103 Xiangxu-0103 deleted the build_doc branch May 11, 2023 14:20
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.

2 participants