From 5d346adaaf90b64f48eb3e1590591d57f57191ed Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Wed, 16 Sep 2020 01:27:08 +0530 Subject: [PATCH 1/7] Moved build_docs.py and BUILD into /tools/docs/ --- {docs => tools/docs}/BUILD | 0 {docs => tools/docs}/build_docs.py | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename {docs => tools/docs}/BUILD (100%) rename {docs => tools/docs}/build_docs.py (100%) diff --git a/docs/BUILD b/tools/docs/BUILD similarity index 100% rename from docs/BUILD rename to tools/docs/BUILD 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 From 11403ea4e1b801d6d0fbbd63f7265b562de5b17a Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Thu, 17 Sep 2020 20:12:34 +0530 Subject: [PATCH 2/7] Modified paths in documentation --- docs/README.md | 17 +++-------------- tools/docs/Readme.md | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+), 14 deletions(-) create mode 100644 tools/docs/Readme.md 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/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 +``` From 3967d141219ba22b82de54209ba9b84eaa49d1bc Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Thu, 17 Sep 2020 20:45:31 +0530 Subject: [PATCH 3/7] removing build_docs.py from BUILD --- tools/docs/BUILD | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/tools/docs/BUILD b/tools/docs/BUILD index d0761a3729..e1ae42ff8a 100644 --- a/tools/docs/BUILD +++ b/tools/docs/BUILD @@ -10,9 +10,5 @@ package( ) py_binary( - name = "build_docs", - srcs = ["build_docs.py"], - deps = [ - "//tensorflow_addons", - ], + ) From f97c2ad76052b2f561b31bd09a62302e2fc02257 Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Thu, 17 Sep 2020 20:48:08 +0530 Subject: [PATCH 4/7] updating to bazel code format --- tools/docs/BUILD | 3 --- 1 file changed, 3 deletions(-) diff --git a/tools/docs/BUILD b/tools/docs/BUILD index e1ae42ff8a..dbca70b8bd 100644 --- a/tools/docs/BUILD +++ b/tools/docs/BUILD @@ -9,6 +9,3 @@ package( default_visibility = ["//tensorflow_addons:__subpackages__"], ) -py_binary( - -) From cc1312dae5e823a3bb66022c38f47961f64844e0 Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Thu, 17 Sep 2020 22:38:37 +0530 Subject: [PATCH 5/7] Revert "updating to bazel code format" This reverts commit f97c2ad76052b2f561b31bd09a62302e2fc02257. --- tools/docs/BUILD | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tools/docs/BUILD b/tools/docs/BUILD index dbca70b8bd..e1ae42ff8a 100644 --- a/tools/docs/BUILD +++ b/tools/docs/BUILD @@ -9,3 +9,6 @@ package( default_visibility = ["//tensorflow_addons:__subpackages__"], ) +py_binary( + +) From 2ce501609a368df57979937bfb5be647b82a0934 Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Thu, 17 Sep 2020 22:41:06 +0530 Subject: [PATCH 6/7] Revert "removing build_docs.py from BUILD" This reverts commit 3967d141219ba22b82de54209ba9b84eaa49d1bc. --- tools/docs/BUILD | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tools/docs/BUILD b/tools/docs/BUILD index e1ae42ff8a..d0761a3729 100644 --- a/tools/docs/BUILD +++ b/tools/docs/BUILD @@ -10,5 +10,9 @@ package( ) py_binary( - + name = "build_docs", + srcs = ["build_docs.py"], + deps = [ + "//tensorflow_addons", + ], ) From 3d6968ef02f298d990b6a3eaa90d5a2588971a5a Mon Sep 17 00:00:00 2001 From: hp77-creator Date: Thu, 17 Sep 2020 22:45:04 +0530 Subject: [PATCH 7/7] Updated sanity_check.dockerfile with new path --- tools/docker/sanity_check.Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 # -------------------------------