Skip to content

Commit 13e40e6

Browse files
authored
Moved build_docs.py and BUILD into /tools/docs/ (#2167)
* Moved build_docs.py and BUILD into /tools/docs/ * Modified paths in documentation * removing build_docs.py from BUILD * updating to bazel code format * Revert "updating to bazel code format" This reverts commit f97c2ad. * Revert "removing build_docs.py from BUILD" This reverts commit 3967d14. * Updated sanity_check.dockerfile with new path
1 parent e2006c3 commit 13e40e6

File tree

5 files changed

+23
-15
lines changed

5 files changed

+23
-15
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/docker/sanity_check.Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ RUN apt-get update && apt-get install -y rsync
9494
COPY ./ /addons
9595
WORKDIR /addons
9696
RUN pip install --no-deps -e .
97-
RUN python docs/build_docs.py
97+
RUN python tools/docs/build_docs.py
9898
RUN touch /ok.txt
9999

100100
# -------------------------------
File renamed without changes.

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+
```
File renamed without changes.

0 commit comments

Comments
 (0)