Skip to content

Commit 063798b

Browse files
authored
Merge branch 'master' into fix-templates
2 parents c8fe37a + 6914e83 commit 063798b

26 files changed

+2482
-2307
lines changed

Diff for: MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
global-include **/templates/*
2-
global-include *.sh
2+
global-include *.sh

Diff for: tools/tensorflow_docs/api_generator/__init__.py

-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
from tensorflow_docs.api_generator import doc_generator_visitor
2020
from tensorflow_docs.api_generator import generate_lib
2121
from tensorflow_docs.api_generator import parser
22-
from tensorflow_docs.api_generator import pretty_docs
2322
from tensorflow_docs.api_generator import public_api
2423
from tensorflow_docs.api_generator import traverse
2524
from tensorflow_docs.api_generator import utils

Diff for: tools/tensorflow_docs/api_generator/generate_lib.py

+12-11
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,14 @@
2929
from tensorflow_docs.api_generator import doc_controls
3030
from tensorflow_docs.api_generator import doc_generator_visitor
3131
from tensorflow_docs.api_generator import parser
32-
from tensorflow_docs.api_generator import pretty_docs
3332
from tensorflow_docs.api_generator import public_api
33+
from tensorflow_docs.api_generator import reference_resolver as reference_resolver_lib
3434
from tensorflow_docs.api_generator import signature
3535
from tensorflow_docs.api_generator import traverse
36+
from tensorflow_docs.api_generator.pretty_docs import base_page
37+
38+
from tensorflow_docs.api_generator.pretty_docs import docs_for_object
39+
3640
from tensorflow_docs.api_generator.report import utils
3741

3842
import yaml
@@ -433,7 +437,8 @@ def generate(self) -> Dict[str, Any]:
433437
return {'toc': toc}
434438

435439

436-
def _get_headers(page_info: parser.PageInfo, search_hints: bool) -> List[str]:
440+
def _get_headers(page_info: base_page.PageInfo,
441+
search_hints: bool) -> List[str]:
437442
"""Returns the list of header lines for this page."""
438443
hidden = doc_controls.should_hide_from_search(page_info.py_object)
439444
brief_no_backticks = page_info.doc.brief.replace('`', '').strip()
@@ -558,8 +563,8 @@ def write_docs(
558563

559564
# Generate docs for `py_object`, resolving references.
560565
try:
561-
page_info = parser.docs_for_object(full_name, py_object, parser_config,
562-
extra_docs)
566+
page_info = docs_for_object.docs_for_object(full_name, py_object,
567+
parser_config, extra_docs)
563568
if gen_report and not full_name.startswith(
564569
('tf.compat.v', 'tf.keras.backend', 'tf.numpy',
565570
'tf.experimental.numpy')):
@@ -571,7 +576,7 @@ def write_docs(
571576
path = output_dir / parser.documentation_path(full_name)
572577

573578
content = _get_headers(page_info, search_hints)
574-
content.append(pretty_docs.build_md_page(page_info))
579+
content.append(page_info.build())
575580
text = '\n'.join(content)
576581
try:
577582
path.parent.mkdir(exist_ok=True, parents=True)
@@ -804,7 +809,7 @@ def __init__(
804809
self._extra_docs = extra_docs
805810

806811
def make_reference_resolver(self, visitor):
807-
return parser.ReferenceResolver.from_visitor(
812+
return reference_resolver_lib.ReferenceResolver.from_visitor(
808813
visitor, py_module_names=[self._short_name])
809814

810815
def make_parser_config(self, visitor, reference_resolver):
@@ -870,11 +875,7 @@ def build(self, output_dir):
870875
str(work_py_dir / self._short_name.replace('.', '/') /
871876
'_api_cache.json'))
872877

873-
try:
874-
os.makedirs(output_dir)
875-
except OSError as e:
876-
if e.strerror != 'File exists':
877-
raise
878+
os.makedirs(output_dir, exist_ok=True)
878879

879880
# Typical results are something like:
880881
#

Diff for: tools/tensorflow_docs/api_generator/generate_lib_test.py

+5-3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
from tensorflow_docs.api_generator import doc_controls
2929
from tensorflow_docs.api_generator import generate_lib
3030
from tensorflow_docs.api_generator import parser
31+
from tensorflow_docs.api_generator import reference_resolver as reference_resolver_lib
32+
from tensorflow_docs.api_generator.pretty_docs import function_page
3133

3234
import yaml
3335

@@ -115,7 +117,7 @@ def get_test_objects(self):
115117

116118
visitor = DummyVisitor(index, duplicate_of)
117119

118-
reference_resolver = parser.ReferenceResolver.from_visitor(
120+
reference_resolver = reference_resolver_lib.ReferenceResolver.from_visitor(
119121
visitor=visitor, py_module_names=['tf'], link_prefix='api_docs/python')
120122

121123
parser_config = config.ParserConfig(
@@ -186,9 +188,9 @@ def test_write(self):
186188
self.assertTrue((output_dir / 'tf/TestModule/test_function.md').exists())
187189

188190
def _get_test_page_info(self):
189-
page_info = parser.FunctionPageInfo(
191+
page_info = function_page.FunctionPageInfo(
190192
full_name='abc', py_object=test_function)
191-
docstring_info = parser._DocstringInfo(
193+
docstring_info = parser.DocstringInfo(
192194
brief='hello `tensorflow`',
193195
docstring_parts=['line1', 'line2'],
194196
compatibility={})

0 commit comments

Comments
 (0)