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] Fix sphinx warnings #4917

Merged
merged 3 commits into from
Feb 20, 2020
Merged

[DOCS] Fix sphinx warnings #4917

merged 3 commits into from
Feb 20, 2020

Conversation

comaniac
Copy link
Contributor

Based on #4908, this is the first PR to remove all doc warnings from Python doc strings. After this fix, total number of doc warnings is reduced to 103 on my local.

@comaniac comaniac requested a review from tqchen February 19, 2020 23:55
@tqchen tqchen changed the title Fix doc warning [DOCS] Fix sphinx warnings Feb 20, 2020
@cchung100m
Copy link
Contributor

Hi @comaniac

Thanks for submitting the PR.

I think that virtual_machine.rst and deploy_vision_on_vta.rst are not caught by this PR, but please correct me if I am wrong.

~/tvm/docs/contribute/pull_request.rst:33: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:94: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:103: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:117: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:130: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:142: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:154: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:166: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:179: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:189: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:202: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:215: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:223: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:232: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:242: WARNING: Unexpected indentation.
~/tvm/docs/dev/virtual_machine.rst:251: WARNING: Unexpected indentation.
~/tvm/docs/vta/tutorials/frontend/deploy_vision_on_vta.rst:141: WARNING: Unexpected indentation.

@comaniac
Copy link
Contributor Author

No the warnings you listed are not covered in this PR. This PR now only covers Python files. I was planning to send another PR for RST, but I can also commit to this one if you prefer.

@tqchen tqchen merged commit fd6d783 into apache:master Feb 20, 2020
@tqchen
Copy link
Member

tqchen commented Feb 20, 2020

Thanks @comaniac

@comaniac comaniac deleted the fix_doc_warning branch February 20, 2020 17:35
alexwong pushed a commit to alexwong/tvm that referenced this pull request Feb 26, 2020
* Fix Python docstrings

* More fixes

* Fix lint
alexwong pushed a commit to alexwong/tvm that referenced this pull request Feb 28, 2020
* Fix Python docstrings

* More fixes

* Fix lint
zhiics pushed a commit to neo-ai/tvm that referenced this pull request Mar 2, 2020
* Fix Python docstrings

* More fixes

* Fix lint
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