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

Jump to bottom

[qpolish] dev-site & readthedocs hybrid #3227

Merged
merged 28 commits into from
Aug 20, 2020
Merged

[qpolish] dev-site & readthedocs hybrid #3227

merged 28 commits into from
Aug 20, 2020

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Aug 18, 2020 •
edited

Adds a hybrid solution where now the docs folder is the source of truth for devsite, our new documentation platform that will go live in a couple of months. This contains the current version of the docs-site branch.

ReadTheDocs specific files now live in rtd-docs that should be rarely (if ever) modified.
After spending a day on researching possible ways to do this I settled with a simple "copy" approach and re-referencing the "new docs" structure from the ReadTheDocs rst files.

This will make some maintenance tasks like restructuring ReadTheDocs a bit tricky, but the situation is temporary and regular docs updates should be okay.

MichaelBroughton and others added 5 commits August 18, 2020 15:55
@MichaelBroughton @mpharrigan
@AnimeshSinha1309 @maffoo @dabacon @balopat
Added api docs gen (copy from TFQ). (quantumlib#3089)
39cbd1c 
* [SVG] Noise hack and font fix (quantumlib#3076)

 - Specify the font. This should not be a change for viewing in Jupyter notebook but fixes opening the svg data in e.g. inkscape where the default font is different and the boxes aren't the right size
 - Don't display virtual tags (for noise) xref quantumlib#2905

* Support multi-qubit measurement in plot_state_histogram (quantumlib#3054)

* Add generated code for batch.proto (quantumlib#3086)

Review: @dstrain115

* Fix flakes in random_circuit_test (quantumlib#3084)

* Added api docs gen (copy from TFQ).

* updated site_path prefix.

* removed pre-built.

* rename.

* move to dev_tools.

* removed __future__ and formatting.

* yet more formatting.

Co-authored-by: Matthew Harrigan <mpharrigan@google.com>
Co-authored-by: Animesh Sinha <AnimeshSinha1309@gmail.com>
Co-authored-by: Matthew Neeley <maffoo@google.com>
Co-authored-by: Dave Bacon <dabacon@gmail.com>
@lamberta @mpharrigan
@AnimeshSinha1309 @maffoo @dabacon @matpompili @MichaelBroughton @balopat
Docs site setup (quantumlib#3085)
fbc35e2 
* [SVG] Noise hack and font fix (quantumlib#3076)

 - Specify the font. This should not be a change for viewing in Jupyter notebook but fixes opening the svg data in e.g. inkscape where the default font is different and the boxes aren't the right size
 - Don't display virtual tags (for noise) xref quantumlib#2905

* Support multi-qubit measurement in plot_state_histogram (quantumlib#3054)

* Add generated code for batch.proto (quantumlib#3086)

Review: @dstrain115

* Fix flakes in random_circuit_test (quantumlib#3084)

* Fix Quirk import extra gates bug

* Move image files to docs/images/

* Move unneeded site assets

* Move Sphinx templates, Makefile, conf, and init

* Added api docs gen (copy from TFQ). (quantumlib#3089)

* [SVG] Noise hack and font fix (quantumlib#3076)

 - Specify the font. This should not be a change for viewing in Jupyter notebook but fixes opening the svg data in e.g. inkscape where the default font is different and the boxes aren't the right size
 - Don't display virtual tags (for noise) xref quantumlib#2905

* Support multi-qubit measurement in plot_state_histogram (quantumlib#3054)

* Add generated code for batch.proto (quantumlib#3086)

Review: @dstrain115

* Fix flakes in random_circuit_test (quantumlib#3084)

* Added api docs gen (copy from TFQ).

* updated site_path prefix.

* removed pre-built.

* rename.

* move to dev_tools.

* removed __future__ and formatting.

* yet more formatting.

Co-authored-by: Matthew Harrigan <mpharrigan@google.com>
Co-authored-by: Animesh Sinha <AnimeshSinha1309@gmail.com>
Co-authored-by: Matthew Neeley <maffoo@google.com>
Co-authored-by: Dave Bacon <dabacon@gmail.com>

* Move doc tools to /dev_tools/docs/

* Move examples index into tutorials/

* Move basics tutorial into tutorials/

* Encode URL bracket so not mistaken for template.

* Update references to moves docs and image files.

* Update references to docs_coverage_test.py

* Format py with check/format-incremental --apply

* Move Sphinx RST files

* Add _index.yaml for site

* Add initial _book.yaml for leftnav

* Manually format docs/_sphinx/conf.py for CI

* Update references to moved api.rst file

* Move docs/_sphinx to dev_tools/docs/sphinx

* Update README.rst path for snippets_test.py

* Move run_doctest to dev_tools/docs/

* Move build-docs.sh to dev_tools/docs/sphinx/

* Update references to build-docs.sh

* Remove build_docs CI test

Co-authored-by: Matthew Harrigan <mpharrigan@google.com>
Co-authored-by: Animesh Sinha <AnimeshSinha1309@gmail.com>
Co-authored-by: Matthew Neeley <maffoo@google.com>
Co-authored-by: Dave Bacon <dabacon@gmail.com>
Co-authored-by: Matteo Pompili <matpompili@gmail.com>
Co-authored-by: MichaelBroughton <MichaelBroughton@users.noreply.github.com>
@lamberta @balopat
Add all symbols link for API reference (quantumlib#3092)
64c2d18
@lamberta @balopat
Docs site rebase (quantumlib#3209)
35b22bc
@balopat
devsite now lives in docs and ReadTheDocs in rtd-docs
498882d
@googlebot
Copy link

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@balopat balopat added the cla: yes Makes googlebot stop complaining. label Aug 18, 2020
@googlebot
Copy link

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

@googlebot googlebot removed the cla: no label Aug 18, 2020
@googlebot
Copy link

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: no and removed cla: yes Makes googlebot stop complaining. labels Aug 18, 2020
@balopat balopat marked this pull request as draft August 18, 2020 23:25
@balopat balopat added the cla: yes Makes googlebot stop complaining. label Aug 19, 2020
@googlebot
Copy link

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

@googlebot googlebot removed the cla: no label Aug 19, 2020
@balopat balopat marked this pull request as ready for review August 19, 2020 00:11
@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Aug 20, 2020

Automerge cancelled: "automerge" label was never added.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@googlebot
Copy link

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: no and removed cla: yes Makes googlebot stop complaining. labels Aug 20, 2020
@balopat balopat added cla: yes Makes googlebot stop complaining. automerge Tells CirqBot to sync and merge this PR. (If it's running.) labels Aug 20, 2020
@googlebot
Copy link

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

@googlebot googlebot removed the cla: no label Aug 20, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Aug 20, 2020

Automerge cancelled: "automerge" label was never added.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Aug 20, 2020

Automerge cancelled: "automerge" label was never added.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Aug 20, 2020

Automerge cancelled: "automerge" label was never added.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Aug 20, 2020

Automerge cancelled: "automerge" label was never added.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Aug 20, 2020

Automerge cancelled: "automerge" label was never added.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 20, 2020
@balopat
Copy link
Contributor Author

balopat commented Aug 20, 2020

It seems that Github is inconsistent - https://api.github.com/repos/quantumlib/cirq/issues/3227/events doesn't contain any of the events for labelling with automerge - but CirqBot expects it - maybe we can improve the error message here.

Merging manually.

@balopat balopat merged commit 826db47 into quantumlib:master Aug 20, 2020
@balopat balopat mentioned this pull request Aug 20, 2020
Closed
tonybruguier pushed a commit to tonybruguier/Cirq that referenced this pull request Aug 23, 2020
@balopat @mpharrigan
@AnimeshSinha1309 @maffoo @dabacon @matpompili @MichaelBroughton
[qpolish] dev-site & readthedocs hybrid (quantumlib#3227)
a5b2385 
Adds a hybrid solution for devsite and readthedocs. 

Adds a hybrid solution where now the `docs` folder is the source of truth for devsite, our new documentation platform that will go live in a couple of months. This contains the current version of the `docs-site` branch. 

ReadTheDocs specific files now live in `rtd-docs` that should be rarely (if ever) modified. 
After spending a day on researching possible ways to do this I settled with a simple "copy" approach and re-referencing the "new docs" structure from the ReadTheDocs rst files. 

This will make some maintenance tasks like restructuring ReadTheDocs a bit tricky, but the situation is temporary and regular docs updates should be okay. 

* Docs site setup (quantumlib#3085)
* Move examples index into tutorials/
* Move basics tutorial into tutorials/
* Add _index.yaml for site
* Add initial _book.yaml for leftnav

Co-authored-by: Matthew Harrigan <mpharrigan@google.com>
Co-authored-by: Animesh Sinha <AnimeshSinha1309@gmail.com>
Co-authored-by: Matthew Neeley <maffoo@google.com>
Co-authored-by: Dave Bacon <dabacon@gmail.com>
Co-authored-by: Matteo Pompili <matpompili@gmail.com>
Co-authored-by: MichaelBroughton <MichaelBroughton@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lamberta lamberta lamberta approved these changes

@dstrain115 dstrain115 dstrain115 approved these changes

Assignees
No one assigned
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@balopat @googlebot @CirqBot @lamberta @dstrain115 @MichaelBroughton