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] Use docs link of other projects and add MMCV docs. #511

Merged
merged 4 commits into from
Nov 3, 2021

Conversation

mzr1996
Copy link
Member

@mzr1996 mzr1996 commented Nov 2, 2021

Motivation

Use docs link of other projects and add MMCV docs.

Modification

  • docs/conf.py
  • docs_zh-CN/conf.py
    And fixed the misused documents, it should be documentation

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects, like MMDet or MMSeg.
  • CLA has been signed and all committers have signed the CLA in this PR.

@mzr1996 mzr1996 added the Documentation Improvements or additions to documentation label Nov 2, 2021
@mzr1996 mzr1996 requested a review from Ezra-Yu November 2, 2021 09:20
@codecov
Copy link

codecov bot commented Nov 2, 2021

Codecov Report

Merging #511 (590587f) into master (72cffac) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #511   +/-   ##
=======================================
  Coverage   79.42%   79.42%           
=======================================
  Files         106      106           
  Lines        5959     5959           
  Branches      962      962           
=======================================
  Hits         4733     4733           
  Misses       1095     1095           
  Partials      131      131           
Flag Coverage Δ
unittests 79.42% <ø> (ø)

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


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 72cffac...590587f. Read the comment docs.

docs/tutorials/config.md Outdated Show resolved Hide resolved
@mzr1996 mzr1996 requested a review from Ezra-Yu November 2, 2021 10:20
Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

LGTM.

@mzr1996 mzr1996 merged commit 82713c9 into open-mmlab:master Nov 3, 2021
mzr1996 added a commit to mzr1996/mmpretrain that referenced this pull request Nov 24, 2022
…#511)

* [Docs] Use docs link of other projects and add MMCV docs.

* Fix misused "document", and it should be "documentation"

* Fix uppercase

* Rename `Projects` to `Docs`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants