diff --git a/docs/README.md b/docs/README.md index ce58a5056f..9ce374aaff 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 -``` + + + diff --git a/tools/docker/sanity_check.Dockerfile b/tools/docker/sanity_check.Dockerfile index 68393a9705..9300da5a6d 100644 --- a/tools/docker/sanity_check.Dockerfile +++ b/tools/docker/sanity_check.Dockerfile @@ -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 # ------------------------------- diff --git a/docs/BUILD b/tools/docs/BUILD similarity index 100% rename from docs/BUILD rename to tools/docs/BUILD diff --git a/tools/docs/Readme.md b/tools/docs/Readme.md new file mode 100644 index 0000000000..7c574e5ad8 --- /dev/null +++ b/tools/docs/Readme.md @@ -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 +``` diff --git a/docs/build_docs.py b/tools/docs/build_docs.py similarity index 100% rename from docs/build_docs.py rename to tools/docs/build_docs.py