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] Various sphinx related fix. #5168

Merged
merged 3 commits into from
Mar 30, 2020
Merged

[DOCS] Various sphinx related fix. #5168

merged 3 commits into from
Mar 30, 2020

Conversation

tqchen
Copy link
Member

@tqchen tqchen commented Mar 29, 2020

  • Use :ref: for reference.
  • Use :py:class: to refer to API docs.
  • Update installation guide to also refer to the download page.
  • Only move html contents in doxygen.

- Use :ref: for reference.
- Use :py:class: to refer to API docs.
- Update installation guide to also refer to the download page.
- Only move html contents in doxygen.
@tqchen
Copy link
Member Author

tqchen commented Mar 29, 2020

cc @yzhliu @ZihengJiang @zhiics


Here the image-name can be a local docker image name, e.g. `tvm.ci_cpu` after you have done
the local build. Or a pre-built third party images (`tvmai/demo-cpu` or `tvmai/ci-gpu`).
Copy link
Member

Choose a reason for hiding this comment

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

s/images/image

@@ -67,7 +65,10 @@ Note that on macOS, because we use bridge network, jupyter notebook will be repo
at an URL like ``http://{container_hostname}:8888/?token=...``. You should replace the ``container_hostname``
with ``localhost`` when pasting it into browser.

You can find some un-official prebuilt images in `<https://hub.docker.com/r/tvmai/>`_.
Note that these are convenience images are not part of the ASF release.
Copy link
Member

Choose a reason for hiding this comment

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

Seems this sentence needs to be rephrased.

@tqchen tqchen merged commit 3bab699 into apache:master Mar 30, 2020
trevor-m pushed a commit to trevor-m/tvm that referenced this pull request Apr 16, 2020
* [DOCS] Various sphinx related fix.

- Use :ref: for reference.
- Use :py:class: to refer to API docs.
- Update installation guide to also refer to the download page.
- Only move html contents in doxygen.

* Address review comments

* Update wording
zhiics pushed a commit to neo-ai/tvm that referenced this pull request Apr 17, 2020
* [DOCS] Various sphinx related fix.

- Use :ref: for reference.
- Use :py:class: to refer to API docs.
- Update installation guide to also refer to the download page.
- Only move html contents in doxygen.

* Address review comments

* Update wording
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