Instructions for generating API docs.

PiperOrigin-RevId: 305105972

Author: alanchiao

build_docs.py

@@ -12,7 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-"""Tool to generate external api_docs for tensorflow_model_optimization.
+"""Tool to generate open source api_docs for tensorflow_model_optimization.
+
+To use, you must first install the tensorflow docs package:
+
+  pip install git+https://github.com/tensorflow/docs
+
 
 Note:
   If duplicate or spurious docs are generated (e.g. internal names), consider
@@ -32,7 +37,6 @@
 
 import tensorflow_model_optimization as tfmot
 
-
 flags.DEFINE_string("output_dir", "/tmp/model_optimization_api",
                     "Where to output the docs")
 

tensorflow_model_optimization/BUILD

@@ -25,3 +25,13 @@ py_library(
         "//tensorflow_model_optimization/python/core/sparsity",
     ],
 )
+
+py_binary(
+    name = "build_docs",
+    srcs = ["build_docs.py"],
+    python_version = "PY3",
+    deps = [
+        # tensorflow_docs/api_generator:generate_lib dep1,
+        "//third_party/tensorflow_model_optimization",
+    ],
+)