Skip to content
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

Fix build-doc github action failure #3082

Merged
merged 8 commits into from
Jun 9, 2020
Merged

Fix build-doc github action failure #3082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
57fa62f
only crossentropy
dabacon Jun 9, 2020
f59b186
truncate docstring
dabacon Jun 9, 2020
3e2b133
try explicit autoclass
dabacon Jun 9, 2020
2e92557
add back docstring
dabacon Jun 9, 2020
b34076b
Add back in api doc
dabacon Jun 9, 2020
3d932c5
Fix doc coverage test
dabacon Jun 9, 2020
57569a5
format
dabacon Jun 9, 2020
1cfaab4
one more
dabacon Jun 9, 2020
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
4 changes: 2 additions & 2 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ run experiments.
cirq.experiments.GRID_ALIGNED_PATTERN
cirq.experiments.GRID_STAGGERED_PATTERN
cirq.experiments.build_entangling_layers
cirq.experiments.cross_entropy_benchmarking
.. autofunction:: cirq.experiments.cross_entropy_benchmarking
cirq.experiments.get_state_tomography_data
cirq.experiments.rabi_oscillations
cirq.experiments.random_rotations_between_grid_interaction_layers_circuit
Expand Down Expand Up @@ -592,7 +592,7 @@ operation.
cirq.testing.asyncio_pending
cirq.testing.highlight_text_differences
cirq.testing.nonoptimal_toffoli_circuit
cirq.testing.random_circuit
.. autofunction:: cirq.testing.random_circuit
cirq.testing.random_density_matrix
cirq.testing.random_orthogonal
cirq.testing.random_special_orthogonal
Expand Down
4 changes: 3 additions & 1 deletion docs/docs_coverage_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ def _api_rst_fullnames_per_section() -> List[List[str]]:
if section:
result.append(section)
section = []
elif ' cirq.' in line or ' .. autoclass:: cirq.' in line:
elif (' cirq.' in line or ' .. autoclass:: cirq.' in line or
' .. autofunction:: cirq.' in line):
fullname = line[line.find('cirq'):].strip()
if fullname in seen:
# coverage: ignore
Expand All @@ -62,6 +63,7 @@ def _api_rst_fullnames_per_section() -> List[List[str]]:
return result



def test_public_values_equals_documented_values():
in_actual_api = _all_public()
in_api_reference = {
Expand Down