mirror of
https://github.com/ROCm/ROCm.git
synced 2026-01-10 07:08:08 -05:00
Add building doc section (#3873)
(cherry picked from commit abc0e6a087)
This commit is contained in:
@@ -7,17 +7,14 @@
|
||||
|
||||
# Building documentation
|
||||
|
||||
You can build our documentation via GitHub (in a pull request) or locally (using the command line or
|
||||
Visual Studio (VS) Code.
|
||||
|
||||
## GitHub
|
||||
|
||||
If you open a pull request on the `develop` branch of a ROCm repository and scroll to the bottom of
|
||||
the page, there is a summary panel. Next to the line
|
||||
`docs/readthedocs.com:advanced-micro-devices-demo`, there is a `Details` link. If you click this, it takes
|
||||
you to the Read the Docs build for your pull request.
|
||||
If you open a pull request and scroll down to the summary panel,
|
||||
there is a commit status section. Next to the line
|
||||
`docs/readthedocs.com:advanced-micro-devices-demo`, there is a `Details` link.
|
||||
If you click this, it takes you to the Read the Docs build for your pull request.
|
||||
|
||||

|
||||

|
||||
|
||||
If you don't see this line, click `Show all checks` to get an itemized view.
|
||||
|
||||
|
||||
BIN
docs/data/contribute/commit-status.png
Normal file
BIN
docs/data/contribute/commit-status.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
@@ -179,9 +179,8 @@ subtrees:
|
||||
- file: contribute/doc-structure.md
|
||||
title: Documentation structure
|
||||
- file: contribute/toolchain.md
|
||||
title: Documentation toolchain
|
||||
title: ROCm documentation toolchain
|
||||
- file: contribute/building.md
|
||||
title: Build our documentation
|
||||
- file: contribute/feedback.md
|
||||
title: Provide feedback
|
||||
- file: about/license.md
|
||||
|
||||
Reference in New Issue
Block a user