Commit 49b61fe4 authored by Mark Daoust's avatar Mark Daoust Committed by A. Unique TensorFlower
Browse files

Remove the docs tests.

PiperOrigin-RevId: 439396600
parent d22500b3
# Docs generation scripts for TensorFlow Models
The scripts here are used to generate api-reference pages for tensorflow.org.
The scripts require tensorflow_docs, which can be installed directly from
github:
```
$> pip install -U git+https://github.com/tensorflow/docs
$> python build_all_api_docs.py --output_dir=/tmp/tfm_docs
```
...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library. ...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library.
Example: Example:
$> pip install -U git+https://github.com/tensorflow/docs $> pip install -U git+https://github.com/tensorflow/docs
$> python build_nlp_api_docs \ $> python build_nlp_api_docs.py --output_dir=/tmp/api_docs
--output_dir=/tmp/api_docs
""" """
import pathlib import pathlib
......
# Copyright 2022 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Tests for official.tools.build_docs."""
import os
import shutil
import tensorflow as tf
from official.utils.docs import build_all_api_docs
class BuildDocsTest(tf.test.TestCase):
def setUp(self):
super(BuildDocsTest, self).setUp()
self.workdir = self.get_temp_dir()
if os.path.exists(self.workdir):
shutil.rmtree(self.workdir)
os.makedirs(self.workdir)
def test_api_gen(self):
build_all_api_docs.gen_api_docs(
code_url_prefix="https://github.com/tensorflow/models/blob/master/tensorflow_models",
site_path="tf_modeling/api_docs/python",
output_dir=self.workdir,
project_short_name="tfm",
project_full_name="TensorFlow Modeling",
search_hints=True)
# Check that the "defined in" section is working
with open(os.path.join(self.workdir, "tfm.md")) as f:
content = f.read()
self.assertIn("__init__.py", content)
if __name__ == "__main__":
tf.test.main()
...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library. ...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library.
Example: Example:
$> pip install -U git+https://github.com/tensorflow/docs $> pip install -U git+https://github.com/tensorflow/docs
$> python build_nlp_api_docs \ $> python build_nlp_api_docs.py --output_dir=/tmp/api_docs
--output_dir=/tmp/api_docs
""" """
import pathlib import pathlib
......
...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library. ...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library.
Example: Example:
$> pip install -U git+https://github.com/tensorflow/docs $> pip install -U git+https://github.com/tensorflow/docs
$> python build_orbit_api_docs \ $> python build_orbit_api_docs.py --output_dir=/tmp/api_docs
--output_dir=/tmp/api_docs
""" """
from absl import app from absl import app
from absl import flags from absl import flags
......
# Copyright 2022 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Tests for official.tools.build_docs."""
import os
import shutil
import tensorflow as tf
from official.utils.docs import build_orbit_api_docs
class BuildDocsTest(tf.test.TestCase):
def setUp(self):
super(BuildDocsTest, self).setUp()
self.workdir = self.get_temp_dir()
if os.path.exists(self.workdir):
shutil.rmtree(self.workdir)
os.makedirs(self.workdir)
def test_api_gen(self):
build_orbit_api_docs.gen_api_docs(
code_url_prefix="https://github.com/tensorflow/models/blob/master/orbit",
site_path="/api_docs/python",
output_dir=self.workdir,
project_short_name="orbit",
project_full_name="Orbit",
search_hints=True)
# Check that the "defined in" section working
with open(os.path.join(self.workdir, "orbit.md")) as f:
content = f.read()
self.assertIn("__init__.py", content)
if __name__ == "__main__":
tf.test.main()
...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library. ...@@ -17,8 +17,7 @@ r"""Tool to generate api_docs for tensorflow_models/official library.
Example: Example:
$> pip install -U git+https://github.com/tensorflow/docs $> pip install -U git+https://github.com/tensorflow/docs
$> python build_vision_api_docs \ $> python build_vision_api_docs.py --output_dir=/tmp/api_docs
--output_dir=/tmp/api_docs
""" """
import pathlib import pathlib
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment