Retire ReadTheDocs (#3587)

Creates a redirect to the new site. Of course, it should only be merged after the new site is live :) Preview: https://balopat-cirq-rtd.readthedocs.io/ Closes #3229.
quantumlib · Dec 7, 2020 · 4c98d37 · 4c98d37
1 parent a0ee113
commit 4c98d37
Show file tree

Hide file tree

Showing 19 changed files with 40 additions and 1,253 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -129,10 +129,7 @@ jobs:
           architecture: 'x64'
       - name: Install requirements
         run: |
-          pip install -r requirements.txt
-          pip install -r cirq/contrib/contrib-requirements.txt
-          pip install -r dev_tools/conf/pip-list-dev-tools.txt
-          sudo apt-get install pandoc
+          pip install -r rtd_docs/requirements.txt
       - name: Build docs
         run: dev_tools/docs/build-rtd-docs.sh
   build_protos:

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -4,8 +4,6 @@ build:
 python:
   version: 3.8
   install:
-      - requirements: requirements.txt
-      - requirements: dev_tools/conf/pip-list-dev-tools.txt
-      - requirements: cirq/contrib/contrib-requirements.txt
+      - requirements: rtd_docs/requirements.txt
 sphinx:
   configuration: rtd_docs/conf.py
diff --git a/README.rst b/README.rst
@@ -21,16 +21,16 @@ circuits and running them against quantum computers and simulators.
 Installation and Documentation
 ------------------------------
 
-Cirq documentation is available at `cirq.readthedocs.io <https://cirq.readthedocs.io>`_.
+Cirq documentation is available at `quantumai.google/cirq <https://quantumai.google/cirq>`_.
 
-Documentation for the latest **pre-release** version of cirq (tracks the repository's master branch; what you get if you ``pip install --pre cirq``), is available at `cirq.readthedocs.io/latest <https://cirq.readthedocs.io/en/latest/>`_.
+Documentation for the latest **pre-release** version of cirq (tracks the repository's master branch; what you get if you ``pip install --pre cirq``), is available at `cirq.readthedocs.io/latest <https://quantumai.google/cirq/>`_.
 
-Documentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available at `cirq.readthedocs.io/stable <https://cirq.readthedocs.io/en/stable/>`_.
+Documentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available at `cirq.readthedocs.io/stable <https://quantumai.google/cirq/>`_.
 
 
-- `Installation <https://cirq.readthedocs.io/en/stable/docs/install.html>`_
-- `Documentation <https://cirq.readthedocs.io>`_
-- `Tutorial <https://cirq.readthedocs.io/en/stable/docs/tutorials/basics.html>`_
+- `Installation <https://quantumai.google/cirq/install>`_
+- `Documentation <https://quantumai.google/cirq>`_
+- `Tutorials <https://https://quantumai.google/cirq/tutorials>`_
 
 For the latest news regarding Cirq, sign up to the `Cirq-announce email list <https://groups.google.com/forum/#!forum/cirq-announce>`__!
 

diff --git a/dev_tools/conf/pip-list-dev-tools.txt b/dev_tools/conf/pip-list-dev-tools.txt
@@ -23,16 +23,7 @@ pyquil~=2.21.0
 # For verifying behavior of qasm output.
 qiskit~=0.20.0
 
-# For generating documentation.
-pypandoc
-myst-parser
-Sphinx~=3.2.0
-
-sphinx_rtd_theme
-sphinx-markdown-tables
-
 # For generating notebooks in documentation
-nbsphinx
 ipython
 ipykernel
 

diff --git a/docs/ecosystem.md b/docs/ecosystem.md
@@ -40,9 +40,9 @@ The following document provides an ecosystem overview of how the various tools c
 
 |Company|Description|
 |--- |--- |
-|[Google QCS](https://cirq.readthedocs.io/en/stable/docs/google/concepts.html)|A quantum computing service based on superconducting qubits|
-|[Alpine Quantum Technologies](https://cirq.readthedocs.io/en/latest/docs/tutorials/aqt/getting_started.html)|A quantum computing service based on ion traps|
-|[Pasqal](https://cirq.readthedocs.io/en/stable/docs/pasqal/getting_started.html)|A quantum cloud service based on neutral atoms|
+|[Google QCS](https://quantumai.google/cirq/tutorials/google/start)|A quantum computing service based on superconducting qubits|
+|[Alpine Quantum Technologies](https://quantumai.google/cirq/tutorials/aqt/start)|A quantum computing service based on ion traps|
+|[Pasqal](https://quantumai.google/cirq/tutorials/pasqal/start)|A quantum cloud service based on neutral atoms|
 
 
 

diff --git a/docs/gates.ipynb b/docs/gates.ipynb
@@ -254,11 +254,11 @@
     "\n",
     "**cirq.rz(rads)** A rotation about the Pauli 'Z' axis in terms of radians.  This is equivalent to `exp(-i Z rads / 2) = cos(rads/2) I - i sin(rads/2) Z`\n",
     "\n",
-    "**cirq.XPowGate(exponent=t)** Rotations about the Pauli ``X`` axis, equivalent to ``cirq.X**t``.  See [XPowGate](https://cirq.readthedocs.io/en/latest/generated/cirq.XPowGate.html) for its unitary matrix.  Note that this has a global phase of $e^{i·π·t/2}$ versus the traditionally defined rotation matrix, which can be modified by the optional parameter `global_shift`.\n",
+    "**cirq.XPowGate(exponent=t)** Rotations about the Pauli ``X`` axis, equivalent to ``cirq.X**t``.  See `cirq.XPowGate` for its unitary matrix.  Note that this has a global phase of e^{i·π·t/2} versus the traditionally defined rotation matrix, which can be modified by the optional parameter `global_shift`.\n",
     "\n",
-    "**cirq.YPowGate(exponent=t)** Rotations about the Pauli ``Y`` axis, equivalent to ``cirq.Y**t``.  See [YPowGate](https://cirq.readthedocs.io/en/latest/generated/cirq.YPowGate.html) for its unitary matrix.  Note that this has a global phase of $e^{i·π·t/2}$ versus the traditionally defined rotation matrix, which can be modified by the optional parameter `global_shift`.\n",
+    "**cirq.YPowGate(exponent=t)** Rotations about the Pauli ``Y`` axis, equivalent to ``cirq.Y**t``.  See `cirq.YPowGate` for its unitary matrix.  Note that this has a global phase of e^{i·π·t/2} versus the traditionally defined rotation matrix, which can be modified by the optional parameter `global_shift`.\n",
     "\n",
-    "**cirq.ZPowGate(exponent=t)** Rotations about the Pauli ``Z`` axis, equivalent to ``cirq.Z**t``.  See [ZPowGate](https://cirq.readthedocs.io/en/latest/generated/cirq.ZPowGate.html) for its unitary matrix.  Note that this has a global phase of $e^{i·π·t/2}$ versus the traditionally defined rotation matrix, which can be modified by the optional parameter `global_shift`.\n",
+    "**cirq.ZPowGate(exponent=t)** Rotations about the Pauli ``Z`` axis, equivalent to ``cirq.Z**t``.  See `cirq.ZPowGate` for its unitary matrix.  Note that this has a global phase of e^{i·π·t/2} versus the traditionally defined rotation matrix, which can be modified by the optional parameter `global_shift`.\n",
     "\n",
     "**cirq.PhasedXPowGate**\n",
     "This gate is a rotation about an axis in the XY plane of the Bloch sphere.\n",

diff --git a/docs/tutorials/educators/intro.ipynb b/docs/tutorials/educators/intro.ipynb
@@ -88,7 +88,7 @@
     "id": "rPgPbry6-mF3"
    },
    "source": [
-    "To use Cirq one first needs to install Cirq.  Installation instructions are available at [cirq.readthedocs.io under \"Installing Cirq\"](https://cirq.readthedocs.io/en/stable/docs/install.html).  For the purpose of this tutorial, we run `pip install cirq` as shown in the following code cell to install the latest release of Cirq. \n",
+    "To use Cirq one first needs to install Cirq.  Installation instructions are available at [quantumai.google/cirq under \"Installing Cirq\"](https://quantumai.google/cirq/install).  For the purpose of this tutorial, we run `pip install cirq` as shown in the following code cell to install the latest release of Cirq. \n",
     "\n",
     "> Different notebook execution systems exist, but for most part they have \"run\" button on a cell which you can click, or \"shift + enter\" is often the shortcut to run the cell. "
    ]
@@ -216,7 +216,7 @@
     "id": "03b7d753ecd5"
    },
    "source": [
-    "![Circuits, Moments, and Operations.](https://cirq.readthedocs.io/en/latest/_images/CircuitMomentOperation.png)"
+    "![Circuits, Moments, and Operations.](/cirq/images/CircuitMomentOperation.png)"
    ]
   },
   {

diff --git a/rtd_docs/404.md b/rtd_docs/404.md
@@ -0,0 +1,7 @@
+![](./Cirq_logo_color.png)
+
+# Cirq
+
+We moved to a new site: [https://quantumai.google](https://quantumai.google).
+
+You will be automatically redirected shortly...
diff --git a/rtd_docs/Cirq_logo_color.png b/rtd_docs/Cirq_logo_color.png
diff --git a/rtd_docs/Cirq_logo_notext.png b/rtd_docs/Cirq_logo_notext.png
diff --git a/rtd_docs/_static/tweak-style.css b/rtd_docs/_static/tweak-style.css
diff --git a/rtd_docs/_templates/layout.html b/rtd_docs/_templates/layout.html
@@ -2,12 +2,5 @@
 {% block extrahead %}
     {{ super() }}
 
-    <script async type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
-        MathJax.Hub.Config({
-            tex2jax: {
-                inlineMath: [['$','$']],
-                skipTags: ['script', 'style', 'textarea', 'pre']
-            },
-        });
-    </script>
+    <meta http-equiv="refresh" content="5; URL=https://quantumai.google/cirq" />
 {% endblock %}