Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
chenpangpang
transformers
Commits
2d372a99
"git@developer.sourcefind.cn:modelzoo/cirideep_tensorflow.git" did not exist on "bf02ba36a925487e4554d23286ea0fad2210f97c"
Unverified
Commit
2d372a99
authored
Jun 05, 2020
by
Sylvain Gugger
Committed by
GitHub
Jun 05, 2020
Browse files
Explain how to preview the docs in a PR (#4795)
parent
56d5d160
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
0 deletions
+12
-0
docs/README.md
docs/README.md
+12
-0
No files found.
docs/README.md
View file @
2d372a99
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment