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.

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

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Sep 2, 2020

We should not refer to readthedocs.io from our docs for content, unless it's absolutely necessary.
This removes the last readthedocs.io references.

@googlebot googlebot added the cla: yes Makes googlebot stop complaining. label Sep 2, 2020
@balopat
Copy link
Contributor Author

balopat commented Sep 2, 2020

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?

@lamberta
Copy link
Contributor

lamberta commented Sep 3, 2020

we shouldn't use file extensions, but from notebooks we should

Since we try to make the OSS GitHub browsing experience as pleasant as possible, include file extensions for everything (.md and .ipynb). Should work in Colab, as well. These extensions are stripped when imported into the site.

The exception is the _book.yaml nav file. No extension there since it's for the site only.

@@ -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...

@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Sep 3, 2020
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Sep 3, 2020
@CirqBot CirqBot merged commit a62ed8b into quantumlib:master Sep 3, 2020
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants