"test/git@developer.sourcefind.cn:hehl2/torchaudio.git" did not exist on "5432a3f5d5a1ac346af740d9b88bd5e14db7bb5a"
Unverified Commit 2d372a99 authored by Sylvain Gugger's avatar Sylvain Gugger Committed by GitHub
Browse files

Explain how to preview the docs in a PR (#4795)

parent 56d5d160
...@@ -76,6 +76,18 @@ It should build the static app that will be available under `/docs/_build/html` ...@@ -76,6 +76,18 @@ It should build the static app that will be available under `/docs/_build/html`
Accepted files are reStructuredText (.rst) and Markdown (.md). Create a file with its extension and put it Accepted files are reStructuredText (.rst) and Markdown (.md). Create a file with its extension and put it
in the source directory. You can then link it to the toc-tree by putting the filename without the extension. in the source directory. You can then link it to the toc-tree by putting the filename without the extension.
## Preview the documentation in a pull request
Once you have made your pull request, you can check what the documentation will look like after it's merged by
following these steps:
- Look at the checks at the bottom of the conversation page of your PR (you may need to click on "show all checks" to
expand them).
- Click on "details" next to the `ci/circleci: build_doc` check.
- In the new window, click on the "Artifacts" tab.
- Locate the file "docs/_build/html/index.html" (or any specific page you want to check) and click on it to get a
preview.
## Writing Documentation - Specification ## Writing Documentation - Specification
The `huggingface/transformers` documentation follows the The `huggingface/transformers` documentation follows the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment