Skip to content

Commit d7dc3d8

Browse files
NeoZhangJianyuguizili0
authored andcommitted
Update docs_build_tips.md (#2322)
1 parent 26ab537 commit d7dc3d8

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/build_docs/docs_build_tips.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -18,35 +18,40 @@ If the PR doesn't impact documentation (for example, it only contains code chang
1818

1919
When releasing a new product version, a git tag must be added to main branch. The release version will be the same as the `tag` name.
2020

21-
It needs to be triggered and commit to branch `gh-pages` manually.
21+
Generating the publishing the documentation for a release must be triggered manually, and the resulting HTML content committed to the `gh-pages` branch manually. (The github.io site will be updated automatically when this `gh-pages` branch is updated.)
2222

23-
`
23+
Note: Only GitHub users with write permission to the repo are able to update the `gh-pages` branch content.
24+
25+
```
2426
git clone https://github.com/intel/intel-extension-for-tensorflow.git
25-
git checkout tag??
27+
git checkout <release tag name>
2628
cd intel-extension-for-tensorflow/docs/build_docs
2729
./build.sh version
2830
2931
cd ../../build_tmp/gh-pages
3032
git add .
31-
git commit -m "add version ???"
33+
git commit -m "add version <release tag name>"
3234
git push
33-
`
35+
```
3436

3537
## Build to Local Test
3638

39+
Before submitting a PR that modifies documentation, you should test
40+
your changes by building the documentation locally.
41+
3742
```
3843
git clone https://github.com/intel/intel-extension-for-tensorflow.git
39-
change code??
44+
# make your documentation changes
4045
cd intel-extension-for-tensorflow/docs/build_docs
4146
4247
./build.sh local
4348
cd ../../build_tmp/draft/latest
4449
python3 -m http.server 9000
4550
```
4651

47-
Use Chrome to open '127.0.0.1:9000' to check the latest version documents.
52+
Use your web browser (e.g., Chrome) to open `127.0.0.1:9000` or `localhost:9000` to check your locally generated HTML content.
4853

49-
Note, the 'version.html' is not present in this case for latest version.
54+
Note, the `version.html` version picker is not functional for locally generated documentation.
5055

5156
If you want to test version switching functionality using `version.html`, build for `version`:
5257

0 commit comments

Comments
 (0)