api docs + tests

quantumlib · CirqBot · Jun 17, 2021 · Jun 15, 2021 · Jun 15, 2021 · Jun 15, 2021
commit e98543c066a980a644ebfdfc2f01dad6b3c37ed1
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -109,6 +109,8 @@ jobs:
         with:
           python-version: '3.7'
           architecture: 'x64'
+      - name: Install requirements
+          run: pip install -r dev_tools/deps/tensorflow-docs.txt
       - name: Doc check
         run: check/nbformat
   cirq-only:

diff --git a/check/nbformat b/check/nbformat
@@ -28,6 +28,8 @@ done
 cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 cd "$(git rev-parse --show-toplevel)"
 
+pip show tensorflow-docs > /dev/null || exit 1
+
 FORMAT_CMD="python3 -m tensorflow_docs.tools.nbfmt --indent=1"
 
 # Test the notebooks

diff --git a/cirq-aqt/setup.py b/cirq-aqt/setup.py
@@ -22,10 +22,8 @@
 
 name = 'cirq-aqt'
 
-description = (
-    'A framework for creating, editing, and invoking '
-    'Noisy Intermediate Scale Quantum (NISQ) circuits.'
-)
+description = ('A Cirq package to simulate and connect to Alpine Quantum Technologies'
+               ' quantum computers')
 
 # README file as long_description.
 long_description = io.open('README.rst', encoding='utf-8').read()
@@ -38,9 +36,9 @@
 if 'CIRQ_PRE_RELEASE_VERSION' in os.environ:
     __version__ = os.environ['CIRQ_PRE_RELEASE_VERSION']
     long_description = (
-        "**This is a development version of Cirq-AQT and may be "
-        "unstable.**\n\n**For the latest stable release of Cirq-AQT "
-        "see**\n`here <https://pypi.org/project/cirq-aqt>`__.\n\n" + long_description
+            "**This is a development version of Cirq-AQT and may be "
+            "unstable.**\n\n**For the latest stable release of Cirq-AQT "
+            "see**\n`here <https://pypi.org/project/cirq-aqt>`__.\n\n" + long_description
     )
 
 # Read in requirements

diff --git a/cirq-ionq/cirq_ionq/json_test_data/__init__.py b/cirq-ionq/cirq_ionq/json_test_data/__init__.py
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# For the cirq_aqt module, this file specifies test data for JSON
+# For the cirq_ionq module, this file specifies test data for JSON
 # serialization of public objects. It is used by
 # cirq/protocols/json_serialization_test.py which checks for coverage of
 # public classes and tests the correctness of repr and json results

diff --git a/cirq-ionq/setup.py b/cirq-ionq/setup.py
@@ -23,8 +23,7 @@
 name = 'cirq-ionq'
 
 description = (
-    'A framework for creating, editing, and invoking '
-    'Noisy Intermediate Scale Quantum (NISQ) circuits.'
+    'A Cirq package to simulate and connect to IonQ quantum computers'
 )
 
 # README file as long_description.

diff --git a/dev_tools/docs/build_api_docs.py b/dev_tools/docs/build_api_docs.py
@@ -1,10 +1,10 @@
-# Copyright 2020 The Cirq Authors. All Rights Reserved.
+# Copyright 2021 The Cirq Developers
 #
 # 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
+#     https://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,
@@ -74,6 +74,7 @@ def main(unused_argv):
     generate_cirq()
     generate_cirq_google()
     generate_cirq_aqt()
+    generate_cirq_ionq()
 
 
 def generate_cirq():
@@ -99,8 +100,7 @@ def generate_cirq_aqt():
         # should be present in the nightly (pre-release) build
         import cirq_aqt
     except ImportError:
-        # as cirq.aqt is currently not being generated anyway
-        # we won't handle this case (the stable build)
+        # as cirq.aqt is under cirq, it should be generated correctly
         return
 
     doc_generator = generate_lib.DocGenerator(
@@ -126,8 +126,7 @@ def generate_cirq_ionq():
         # should be present in the nightly (pre-release) build
         import cirq_ionq
     except ImportError:
-        # TODO: somehow replace the prefix link in the generated cirq.ionq API docs to
-        #   cirq-ionq/cirq_ionq, so that links on the site don't break
+        # as cirq.ionq is under cirq, it should be generated correctly
         return
 
     doc_generator = generate_lib.DocGenerator(

diff --git a/dev_tools/requirements/deps/dev-tools.txt b/dev_tools/requirements/deps/dev-tools.txt
@@ -4,6 +4,7 @@
 -r pylint.txt
 -r protos.txt
 -r notebook.txt
+-r tensorflow-docs.txt
 
 # For testing and analyzing code.
 asv

diff --git a/dev_tools/requirements/deps/nbformat.txt b/dev_tools/requirements/deps/nbformat.txt
diff --git a/dev_tools/requirements/deps/tensorflow-docs.txt b/dev_tools/requirements/deps/tensorflow-docs.txt
@@ -0,0 +1 @@
+git+https://github.com/tensorflow/docs@3e08f1e1739dede8d9f6f283b4353bf330ca0506
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		git+https://github.com/tensorflow/docs@3e08f1e1739dede8d9f6f283b4353bf330ca0506