From 14ac1e5ffe594bba08574cf7715657dddccfc57b Mon Sep 17 00:00:00 2001 From: Michael Broughton Date: Tue, 7 Jun 2022 16:53:31 -0700 Subject: [PATCH 1/2] Add private_map to cirq api docs gen. --- dev_tools/docs/build_api_docs.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/dev_tools/docs/build_api_docs.py b/dev_tools/docs/build_api_docs.py index 46e7f70b56b..e9b25d6a453 100644 --- a/dev_tools/docs/build_api_docs.py +++ b/dev_tools/docs/build_api_docs.py @@ -107,6 +107,30 @@ def generate_cirq(): filter_type_checking, ], extra_docs=_doc.RECORDED_CONST_DOCS, + + # Submodules that we do not wish to document. + private_map={ + 'cirq': [ + 'circuits', + 'devices', + 'experiments', + 'interop', + 'linalg', + 'ops', + 'optimizers', + 'transformers', + 'qis', + 'sim', + 'study', + 'value', + 'protocols', + 'ion', + 'neutral_atoms', + 'vis', + 'work', + 'json_resolver_cache', + ] + } ) doc_controls.decorate_all_class_attributes( doc_controls.do_not_doc_inheritable, networkx.DiGraph, skip=[] From 5ebf680334069413f4e6a066de5790e87fe30028 Mon Sep 17 00:00:00 2001 From: Michael Broughton Date: Tue, 7 Jun 2022 16:55:27 -0700 Subject: [PATCH 2/2] format. --- dev_tools/docs/build_api_docs.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/dev_tools/docs/build_api_docs.py b/dev_tools/docs/build_api_docs.py index e9b25d6a453..456ed8c2e03 100644 --- a/dev_tools/docs/build_api_docs.py +++ b/dev_tools/docs/build_api_docs.py @@ -107,7 +107,6 @@ def generate_cirq(): filter_type_checking, ], extra_docs=_doc.RECORDED_CONST_DOCS, - # Submodules that we do not wish to document. private_map={ 'cirq': [ @@ -130,7 +129,7 @@ def generate_cirq(): 'work', 'json_resolver_cache', ] - } + }, ) doc_controls.decorate_all_class_attributes( doc_controls.do_not_doc_inheritable, networkx.DiGraph, skip=[]