Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,11 @@ python -m tensorflow_docs.tools.nbfmt {path to notebook file or directory}



## 2. Generated API docs

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

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

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

# Build tool:
bazel build docs:build_docs

# Generate API doc:
# Use current branch
bazel-bin/docs/build_docs --git_branch=$(git rev-parse --abbrev-ref HEAD)
# or specified explicitly
bazel-bin/docs/build_docs --git_branch=master --output_dir=/tmp/tfa_api
```



2 changes: 1 addition & 1 deletion tools/docker/sanity_check.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ RUN apt-get update && apt-get install -y rsync
COPY ./ /addons
WORKDIR /addons
RUN pip install --no-deps -e .
RUN python docs/build_docs.py
RUN python tools/docs/build_docs.py
RUN touch /ok.txt

# -------------------------------
Expand Down
File renamed without changes.
19 changes: 19 additions & 0 deletions tools/docs/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## 1. Generated API docs

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

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

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

# Build tool:
bazel build //tools/docs:build_docs

# Generate API doc:
# Use current branch
bazel-bin/tools/docs/build_docs --git_branch=$(git rev-parse --abbrev-ref HEAD)
# or specified explicitly
bazel-bin/tools/docs/build_docs --git_branch=master --output_dir=/tmp/tfa_api
```
File renamed without changes.