[qpolish] dev-site & readthedocs hybrid #3227

balopat · 2020-08-18T23:19:50Z

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.

@dstrain115

* [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>

@dstrain115

* [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>

googlebot · 2020-08-18T23:20:19Z

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 · 2020-08-18T23:20:39Z

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 · 2020-08-18T23:22:48Z

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 · 2020-08-19T00:11:05Z

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.

CirqBot · 2020-08-20T00:14:53Z

Automerge cancelled: "automerge" label was never added.

googlebot · 2020-08-20T00:15:19Z

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 · 2020-08-20T00:15:47Z

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.

CirqBot · 2020-08-20T00:15:53Z

Automerge cancelled: "automerge" label was never added.

CirqBot · 2020-08-20T00:16:08Z

Automerge cancelled: "automerge" label was never added.

CirqBot · 2020-08-20T00:18:32Z

Automerge cancelled: "automerge" label was never added.

CirqBot · 2020-08-20T00:19:57Z

Automerge cancelled: "automerge" label was never added.

CirqBot · 2020-08-20T00:27:10Z

Automerge cancelled: "automerge" label was never added.

balopat · 2020-08-20T00:29:45Z

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.

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>

MichaelBroughton and others added 5 commits August 18, 2020 15:55

Add all symbols link for API reference (quantumlib#3092)

64c2d18

Docs site rebase (quantumlib#3209)

35b22bc

devsite now lives in docs and ReadTheDocs in rtd-docs

498882d

googlebot added the cla: no label Aug 18, 2020

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

googlebot removed the cla: no label Aug 18, 2020

Merge branch 'master' into separate_rdt

07fa5c0

balopat force-pushed the separate_rdt branch from 44dcbad to 07fa5c0 Compare August 18, 2020 23:22

googlebot added cla: no and removed cla: yes Makes googlebot stop complaining. labels Aug 18, 2020

balopat marked this pull request as draft August 18, 2020 23:25

balopat added 10 commits August 18, 2020 16:27

cleanup

9d67366

cleanups

41629c2

further cleanups

e7cf8b0

typos plus restoring css

5b47e09

restore quil_import

96bd17c

format

1123f54

moved back docs coverage file to rtd_docs

e0f72af

fix docs script

b2de271

fix bashscipt test

eaa8891

format

9b62813

balopat added the cla: yes Makes googlebot stop complaining. label Aug 19, 2020

googlebot removed the cla: no label Aug 19, 2020

balopat marked this pull request as ready for review August 19, 2020 00:11