[Docs] Resolve warnings in sphinx build #915

C1rN09 · 2023-02-08T07:06:00Z

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:

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

After this PR:

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

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

…nings

codecov · 2023-02-08T09:40:29Z

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.

HAOCHENYE · 2023-02-08T10:28:28Z

docs/en/migration/runner.md

docs/en/migration/transform.md

docs/en/tutorials/runner.md

docs/zh_cn/tutorials/evaluation.md

docs/zh_cn/migration/model.md

mmengine/dataset/base_dataset.py

mmengine/visualization/visualizer.py

C1rN09 added 11 commits February 7, 2023 17:14

add ZeroOptimizer to optim

230ff6c

resolve duplicate label warnings

47c433b

upgrade docutils && shpinx to resolve unknown directive or role war…

fcaacb1

…nings

fix typo

40b2a99

resolve literal_block && heading warnings

258fcbf

resolve json literal_block warnings

5b881ca

resolve python literal_block warnings

9b27334

resolve bunches of reference warnings

2220769

resolve bunches of docstring warnings

f0ea058

resolve warnings in autosummary

a32bba5

resolve remaining warnings in en docs

7276940

C1rN09 requested review from Harold-lkk, HAOCHENYE, zhouzaida and RangiLyu as code owners February 8, 2023 07:06

mm-assistant bot assigned C1rN09 Feb 8, 2023

C1rN09 added 2 commits February 8, 2023 16:32

resolve heading warnings in zh_cn docs

7bc5155

resolve remaining warnings in zh_cn docs

2752584

C1rN09 changed the title ~~[WIP] Resolve warnings in sphinx build~~ [Docs] Resolve warnings in sphinx build Feb 8, 2023