Update CONTRIBUTING.md for building docs from a GPU env. - #9374
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/9374
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit af19a51 with merge base 91b3aa6 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
NicolasHug
left a comment
NicolasHug
left a comment
There was a problem hiding this comment.
Thanks @zy1git , this LGTM but before merging, make sure the line length sticks to <80 characters like in the rest of the file. It makes it easier to review and edit, and more consistent with the rest of the file. There are options in your IDE for that.
(this file in TV doesn't always strictly follow 80 character width, unlike in TC, but we should still try to preserve that).
| for formatting docstrings. Length of line inside docstrings block must be limited to 120 characters. | ||
|
|
||
| Please, follow the instructions to build and deploy the documentation locally. | ||
| All documentation is built for each PR and contains a preview on the PR. However, this takes a while (~8 minutes) and you should first build docs from your local machine. Please, follow the instructions to build and deploy the documentation locally. |
There was a problem hiding this comment.
I think we should avoid asking users to build locally all the time, because this is a bit more nuanced. Something along those lines could work:
All documentation is built for each PR and contains a preview on the PR. However, it is often useful to build the docs locally when making a lot of documentation changes.
|
Hey @NicolasHug! You merged this PR, but no labels were added. |
2 participants
Added the procedure on how to build docs on a remote server and visualize the docs on local computer.