Skip to content

Exclude TYPE_CHECKING from docs #5261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 19, 2022
Merged

Exclude TYPE_CHECKING from docs #5261

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cebf060
Exclude TYPE_CHECKING from docs
tonybruguier Apr 14, 2022
a0d0d77
Merge branch 'master' into cirq_doc_type
CirqBot Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 43 additions & 7 deletions dev_tools/docs/build_api_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,14 @@ def filter_unwanted_inherited_methods(path, parent, children):
return filtered_children


def filter_type_checking(path, parent, children):
filtered_children = []
for name, obj in children:
if name != 'TYPE_CHECKING':
filtered_children.append((name, obj))
return filtered_children


def main(unused_argv):
generate_cirq()
generate_cirq_google()
Expand All @@ -93,7 +101,11 @@ def generate_cirq():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-core/cirq",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
extra_docs=_doc.RECORDED_CONST_DOCS,
)
doc_controls.decorate_all_class_attributes(
Expand All @@ -110,7 +122,11 @@ def generate_cirq_aqt():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-aqt/cirq_aqt",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
extra_docs=_doc.RECORDED_CONST_DOCS,
)
doc_controls.decorate_all_class_attributes(
Expand All @@ -128,7 +144,11 @@ def generate_cirq_ionq():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-ionq/cirq_ionq",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
extra_docs=_doc.RECORDED_CONST_DOCS,
)
doc_controls.decorate_all_class_attributes(
Expand All @@ -146,7 +166,11 @@ def generate_cirq_pasqal():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-pasqal/cirq_pasqal",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
extra_docs=_doc.RECORDED_CONST_DOCS,
)
doc_controls.decorate_all_class_attributes(
Expand All @@ -164,7 +188,11 @@ def generate_cirq_rigetti():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-rigetti/cirq_rigetti",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
extra_docs=_doc.RECORDED_CONST_DOCS,
)
doc_controls.decorate_all_class_attributes(
Expand All @@ -182,7 +210,11 @@ def generate_cirq_google():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-google/cirq_google",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
private_map={
# Opt to not build docs for these paths for now since they error.
"cirq_google.cloud.quantum.QuantumEngineServiceClient": ["enums"],
Expand All @@ -202,7 +234,11 @@ def generate_cirq_web():
code_url_prefix=FLAGS.code_url_prefix + "/cirq-web/cirq_web",
search_hints=FLAGS.search_hints,
site_path=FLAGS.site_path,
callbacks=[public_api.local_definitions_filter, filter_unwanted_inherited_methods],
callbacks=[
public_api.local_definitions_filter,
filter_unwanted_inherited_methods,
filter_type_checking,
],
extra_docs=_doc.RECORDED_CONST_DOCS,
)
doc_controls.decorate_all_class_attributes(
Expand Down