Merge branch 'fix/docs-nav' of github.com:tensorflow/java into fix/docs-nav

Craigacp · Craigacp · commit 85e905d338f9 · 2025-12-12T15:07:36.000-05:00
diff --git a/docs/legacy/requirements.txt b/docs/legacy/requirements.txt
diff --git a/docs/legacy_tools/build_java_api_docs.py b/docs/legacy_tools/build_java_api_docs.py
@@ -13,6 +13,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
+
+######################################################################################################################
+# IMPORTANT: tools under this folder are used anymore to generate the Java API docs, as there are unfixed issues for
+#      generating, the docs using DocLava. We are keeping it here for reference, in case we want to revisit it later.
+######################################################################################################################
+
 """Generate TensorFlow Java reference docs for TensorFlow.org."""
 from __future__ import absolute_import
 from __future__ import division
diff --git a/docs/legacy_tools/requirements.txt b/docs/legacy_tools/requirements.txt
@@ -0,0 +1,7 @@
+######################################################################################################################
+# IMPORTANT: tools under this folder are used anymore to generate the Java API docs, as there are unfixed issues for
+#      generating, the docs using DocLava. We are keeping it here for reference, in case we want to revisit it later.
+######################################################################################################################
+GitPython
+requests
+tensorflow-docs
diff --git a/docs/legacy_tools/run-javadoc-for-tf-local.sh b/docs/legacy_tools/run-javadoc-for-tf-local.sh
@@ -1,4 +1,10 @@
 #!/bin/bash
+
+######################################################################################################################
+# IMPORTANT: tools under this folder are used anymore to generate the Java API docs, as there are unfixed issues for
+#      generating, the docs using DocLava. We are keeping it here for reference, in case we want to revisit it later.
+######################################################################################################################
+
 set -ex
 
 export JAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-11.jdk/Contents/Home # Or change to any JDK 11 home path
