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

removing readthedocs.io references #3294

Merged
merged 2 commits into from
Sep 3, 2020
Merged

removing readthedocs.io references #3294

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e59015e
removing readthedocs.io references
balopat Sep 2, 2020
44f1835
switching over to myst-parser
balopat Sep 3, 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
10 changes: 5 additions & 5 deletions docs/tutorials/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,22 +100,22 @@ Quantum circuit to prepare the BCS ground states for superconductors/superfluids

## Advanced Tutorials

* [Variational Algorithm](https://cirq.readthedocs.io/en/latest/tutorials/variational_algorithm.html)
* [Variational Algorithm](./variational_algorithm)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need an extension for this (ipynb)? Same with below. Your comment suggests we should add it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. You can test this in the github preview. This link doesn't work in GitHub unless you add variational_algorithm.ipynb
It will work on the site since we strip extensions anyway, but, as a general style, using the extension means the link works everywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, thanks for the input - I agree, I'll change this back to .ipynb.
However, this will need a bit more work due to a bug in recommonmark - I'm running into readthedocs/recommonmark#130.

The current version of this page https://cirq.readthedocs.io/en/latest/docs/tutorials/examples.html is broken both on RTD and in devsite. I'm having promising results with myst...

Case study demonstrating construction of an ansatz for a two-dimensional Ising
model and how to simulate and optimize it.

* [QAOA](https://cirq.readthedocs.io/en/latest/tutorials/QAOA_Demo.html)
* [QAOA](./QAOA_Demo)
Demonstration of optimizing cost of a max-cut problem using quantum
approximation optimization algorithm (QAOA)

* [Hidden Linear Function](https://cirq.readthedocs.io/en/latest/tutorials/hidden_linear_function.html)
* [Hidden Linear Function](./hidden_linear_function)
Demonstration of a problem similar to Bernstein-Vazirani that uses a hidden
function rather than using an Oracle.

* [Quantum Walk](https://cirq.readthedocs.io/en/latest/tutorials/Quantum_Walk.html)
* [Quantum Walk](./Quantum_Walk)
Demonstration of both classical and quantum random walks that shows their
similarities and differences.

* [Rabi Oscillations](https://cirq.readthedocs.io/en/latest/tutorials/Rabi_Demo.html)
* [Rabi Oscillations](./Rabi_Demo)
Example of using sweeps and symbols to show rotation of a qubit by different
angles.
2 changes: 1 addition & 1 deletion docs/tutorials/variational_algorithm.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"\n",
"In this tutorial, we will create a [quantum variational algorithm](https://arxiv.org/abs/1304.3061) using cirq and show how it can optimize a simple Ising model.\n",
"\n",
"To begin, please follow the instructions for [installing Cirq](https://cirq.readthedocs.io/en/latest/install.html)."
"To begin, please follow the instructions for [installing Cirq](../install.md)."
]
},
{
Expand Down