quantumlib · mpharrigan · Jan 25, 2021 · Jan 11, 2021 · Jan 11, 2021 · Jan 11, 2021
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -52,3 +52,15 @@ jobs:
       run: |
         pip install pytest
         pytest -v
+
+  nbformat:
+    name: Notebook formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.7'
+          architecture: 'x64'
+      - name: Doc check
+        run: dev_tools/nbfmt
diff --git a/.gitignore b/.gitignore
@@ -39,3 +39,6 @@ docs/generated
 
 # Default pycharm virtual env
 .venv/
+
+# Notebook formatting script.
+nbformat
diff --git a/dev_tools/nbfmt b/dev_tools/nbfmt
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+###############################################################################
+# Formats ipython notebooks with tensorflow-docs nbformat tool.
+#
+# Usage:
+#     dev_tools/nbfmt [--apply]
+#
+# Without '--apply', the diff that would be applied is printed and the exit
+# status is 1 if there are any changes or else 0 if no changes are needed.
+#
+# With '--apply', the exit status is 0 and the changed files are actually
+# reformatted.
+#
+################################################################################
+
+# Get the working directory to the repo root.
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "$(git rev-parse --show-toplevel)"
+
+# Check if cirq/check/nbformat exists, if not grab it.
+if [[ ! -f dev_tools/nbformat ]]; then
+  wget https://raw.githubusercontent.com/quantumlib/Cirq/master/check/nbformat -P dev_tools/
+  chmod u+x dev_tools/nbformat
+fi
+
+# Run the formatter.
+dev_tools/nbformat "$@"
diff --git a/docs/guide/data_analysis.ipynb b/docs/guide/data_analysis.ipynb
diff --git a/docs/guide/data_collection.ipynb b/docs/guide/data_collection.ipynb
diff --git a/docs/qaoa/example_problems.ipynb b/docs/qaoa/example_problems.ipynb
diff --git a/docs/qaoa/hardware_grid_circuits.ipynb b/docs/qaoa/hardware_grid_circuits.ipynb
diff --git a/docs/qaoa/landscape_analysis.ipynb b/docs/qaoa/landscape_analysis.ipynb
diff --git a/docs/qaoa/precomputed_analysis.ipynb b/docs/qaoa/precomputed_analysis.ipynb
diff --git a/docs/qaoa/routing_with_tket.ipynb b/docs/qaoa/routing_with_tket.ipynb
@@ -520,8 +520,7 @@
   },
   "kernelspec": {
    "display_name": "Python 3",
-      "name": "python3",
-      "language": "python"
+   "name": "python3"
   }
  },
  "nbformat": 4,

diff --git a/docs/qaoa/tasks.ipynb b/docs/qaoa/tasks.ipynb