Add doc previewing instructions #31905
Conversation
|
|
||
| ```bash | ||
| cd your_github_pages_repo | ||
| cp -r ~/my_pytorch_path/docs/build/html/* . |
There was a problem hiding this comment.
I've always previewed documentation by just opening files from this directory. Is that something we could recommend as well?
There was a problem hiding this comment.
Do you mean opening it on GitHub with GitHub's rst rendering (e.g. this page)? I've found that that doesn't always match the website since most directives aren't followed (e.g. automodule/autofunction)
There was a problem hiding this comment.
No, I mean opening ~/my_pytorch_path/docs/build/html/index.html in my local browser
There was a problem hiding this comment.
This is more for reviewing so other people can see it, I think the section titles were a little confusing so I've split them up
There was a problem hiding this comment.
from offline: the instructions recommended starting an http server but that's not necessary since you can open the files in a browser, so the latest commit removes that and recommends just opening the files
CONTRIBUTING.md
Outdated
| #### Submitting changes for review | ||
|
|
||
| It is helpful when submitting a PR that changes the docs to provide a rendered | ||
| version of the result. You can do this by using GitHub pages to host the docs |
There was a problem hiding this comment.
It is nice to have a rendered result. I'd also add that a screenshot of the rendered result would be fine as well (it depends on how much the user is editing). Most users will end up modifying a single function's docstring and I want to lower the barrier for them to contribute.
Summary: Stacked PRs * **#31908 - Remove C++ docs contributing page** * #31905 - Add doc previewing instructions We should have 1 source of truth for contribution instructions (CONTRIBUTING.md). This PR moves the instructions from the C++ doc pages there instead of having its own separate page. Pull Request resolved: #31908 Pulled By: driazati Differential Revision: D19296366 fbshipit-source-id: c1daf004259342bd09e09dea3b80e34db47066ec
Summary: Stacked PRs * pytorch#31908 - Remove C++ docs contributing page * **pytorch#31905 - Add doc previewing instructions** This adds some instructions on how to get started with Github pages you can show reviewers your documentation changes. Hopefully we can delete this eventually and build docs automatically on relevant PRs in CI. ](https://our.intern.facebook.com/intern/diff/19296364/) Pull Request resolved: pytorch#31905 Pulled By: driazati Differential Revision: D19296364 fbshipit-source-id: df47fa1a8d7be029c3efcf6521298583ad9f7a95
Summary: Stacked PRs * **pytorch#31908 - Remove C++ docs contributing page** * pytorch#31905 - Add doc previewing instructions We should have 1 source of truth for contribution instructions (CONTRIBUTING.md). This PR moves the instructions from the C++ doc pages there instead of having its own separate page. Pull Request resolved: pytorch#31908 Pulled By: driazati Differential Revision: D19296366 fbshipit-source-id: c1daf004259342bd09e09dea3b80e34db47066ec
Stacked PRs
This adds some instructions on how to get started with Github pages you can show reviewers your documentation changes. Hopefully we can delete this eventually and build docs automatically on relevant PRs in CI.
Differential Revision: D19296364