-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
Conversation
Note that from md files we shouldn't use file extensions, but from notebooks we should - this inconsistency is weird, but that's how sphinx, recommonmark and nbsphinx work - I hope that this works with devsite as well, @lamberta? |
Since we try to make the OSS GitHub browsing experience as pleasant as possible, include file extensions for everything ( The exception is the |
docs/tutorials/examples.md
Outdated
@@ -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) |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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...
We should not refer to readthedocs.io from our docs for content, unless it's absolutely necessary.
This removes the last readthedocs.io references.