Skip to content

Commit 11403ea

Browse files
committed
Modified paths in documentation
1 parent 5d346ad commit 11403ea

File tree

2 files changed

+22
-14
lines changed

2 files changed

+22
-14
lines changed

docs/README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,11 @@ python -m tensorflow_docs.tools.nbfmt {path to notebook file or directory}
2121

2222

2323

24-
## 2. Generated API docs
2524

26-
[tensorflow.org/addons/api_docs/python/tfa](https://tensorflow.org/addons/api_docs/python/tfa)
2725

28-
`build_docs.py` controls executed this docs generation. To test-run it:
2926

30-
```bash
31-
# Install dependencies:
32-
pip install -r tools/install_deps/doc_requirements.txt
3327

34-
# Build tool:
35-
bazel build docs:build_docs
3628

37-
# Generate API doc:
38-
# Use current branch
39-
bazel-bin/docs/build_docs --git_branch=$(git rev-parse --abbrev-ref HEAD)
40-
# or specified explicitly
41-
bazel-bin/docs/build_docs --git_branch=master --output_dir=/tmp/tfa_api
42-
```
29+
30+
31+

tools/docs/Readme.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## 1. Generated API docs
2+
3+
[tensorflow.org/addons/api_docs/python/tfa](https://tensorflow.org/addons/api_docs/python/tfa)
4+
5+
`build_docs.py` controls executed this docs generation. To test-run it:
6+
7+
```bash
8+
# Install dependencies:
9+
pip install -r tools/install_deps/doc_requirements.txt
10+
11+
# Build tool:
12+
bazel build //tools/docs:build_docs
13+
14+
# Generate API doc:
15+
# Use current branch
16+
bazel-bin/tools/docs/build_docs --git_branch=$(git rev-parse --abbrev-ref HEAD)
17+
# or specified explicitly
18+
bazel-bin/tools/docs/build_docs --git_branch=master --output_dir=/tmp/tfa_api
19+
```

0 commit comments

Comments
 (0)