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

[Docs] Resolve warnings in sphinx build #915

Merged
merged 15 commits into from
Feb 8, 2023

Conversation

C1rN09
Copy link
Collaborator

@C1rN09 C1rN09 commented Feb 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

Resolve warnings in sphinx build, which are caused by docs & docstring.

Before this PR:

part-before

Only a subset of the warnings. Too many to fit in a single screen.

After this PR:

en-docs-after

zh_cn-docs-after

mmcv.transform invalid links will be resolved in a new PR in mmcv.
TODO related warnings will be preserved.

Modification

  • Upgrade docutils & sphinx version.
  • Modify mmengine/model/weight_init.py to resolve autosummary warnings
  • Add ZeroRedundancyOptimizer to mmengine/optim/__init__.py
  • Resolve heading warnings in data_element, installation, introduction, code_style, contributing && switch_language
  • Other minor fixes on docstring && references in docs (No need to pay special attention to)

BC-breaking (Optional)

NO

Use cases (Optional)

None

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, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@codecov
Copy link

codecov bot commented Feb 8, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@4749682). Click here to learn what that means.
Patch has no changes to coverable lines.

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #915   +/-   ##
=======================================
  Coverage        ?   77.90%           
=======================================
  Files           ?      133           
  Lines           ?    10086           
  Branches        ?     2010           
=======================================
  Hits            ?     7857           
  Misses          ?     1888           
  Partials        ?      341           
Flag Coverage Δ
unittests 77.90% <0.00%> (?)

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 at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@C1rN09 C1rN09 changed the title [WIP] Resolve warnings in sphinx build [Docs] Resolve warnings in sphinx build Feb 8, 2023
@HAOCHENYE
Copy link
Collaborator

image

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.

3 participants