From 503b0868dfdf87dd723cef3fa8c71701d22af64b Mon Sep 17 00:00:00 2001 From: Abe Asfaw Date: Sun, 13 Feb 2022 13:02:09 -0800 Subject: [PATCH 1/5] update doc development instructions --- docs/dev/development.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/dev/development.md b/docs/dev/development.md index 0a627492875..25d59d3b3a5 100644 --- a/docs/dev/development.md +++ b/docs/dev/development.md @@ -303,8 +303,7 @@ def some_method(a: int, b: str) -> float: """ ``` -Currently the docs folder serves two sites: the new site that is under construction and the current site that is deployed to readthedocs.io. -The new site is currently not available for preview just yet. For the current site, documentation is generated automatically by readthedocs when pushing to `master`, but you can also generate a local copy by running: +The docs folder is used to automatically generate the documentation on our website at [quantumai.google/cirq](https://quantumai.google/cirq) from the `master` branch. You can also generate a local copy by running: ```bash dev_tools/docs/build-rtd-docs.sh From b793842ee42f58b3f45ef52b77846c0433f6295a Mon Sep 17 00:00:00 2001 From: Abe Asfaw Date: Sun, 13 Feb 2022 13:31:24 -0800 Subject: [PATCH 2/5] Add @aasfaw to docs maintainers --- .github/CODEOWNERS | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 6314ac6e30c..70a680d64ca 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -24,35 +24,35 @@ cirq-rigetti/**/*.* @erichulburd @kalzoo @dbanty @quantumlib/cirq-maintainers @v cirq-core/cirq/experiments/**/*.* @mrwojtek @quantumlib/cirq-maintainers @vtomole @cduck -########################################### -# docs maintainers: maintainers + @rmlarose -########################################### +##################################################### +# docs maintainers: maintainers + @aasfaw + @rmlarose +##################################################### -docs/**/*.* @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/**/*.* @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -########################################################## -# vendor docs maintainers: vendor maintainers + @rmlarose -############################################################ +################################################################### +# vendor docs maintainers: vendor maintainers + @aasfaw + @rmlarose +################################################################### -docs/google/**/*.* @wcourtney @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult -docs/tutorials/google/**/*.* @wcourtney @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult +docs/google/**/*.* @wcourtney @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult +docs/tutorials/google/**/*.* @wcourtney @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult -docs/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -docs/tutorials/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/tutorials/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -docs/aqt/**/*.* @ma5x @pschindler @alfrisch @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -docs/tutorials/aqt/**/*.* @ma5x @pschindler @alfrisch @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/tutorials/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -docs/pasqal/**/*.* @HGSilveri @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -docs/tutorials/pasqal/**/*.* @HGSilveri @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +docs/tutorials/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck -docs/rigetti/**/*.* @erichulburd @kalzoo @dbanty @quantumlib/cirq-maintainers @vtomole @cduck -docs/tutorials/rigetti/**/*.* @erichulburd @kalzoo @dbanty @quantumlib/cirq-maintainers @vtomole @cduck +docs/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck +docs/tutorials/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck -docs/azure-quantum/**/*.* @guenp @anpaz @quantumlib/cirq-maintainers @vtomole @cduck -docs/tutorials/azure-quantum/**/*.* @guenp @anpaz @quantumlib/cirq-maintainers @vtomole @cduck +docs/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck +docs/tutorials/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck -##################################################### -# qcvv docs maintainers: docs maintainers + mrwojtek -##################################################### -docs/qcvv/**/*.* @mrwojtek @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck +############################################################# +# qcvv docs maintainers: docs maintainers + mrwojtek + aasfaw +############################################################# +docs/qcvv/**/*.* @mrwojtek @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck From 6e09c90c8feea4414a26884bd4b821a5c20c8dd8 Mon Sep 17 00:00:00 2001 From: Abe Asfaw Date: Mon, 14 Feb 2022 06:58:16 -0800 Subject: [PATCH 3/5] Update codeowners_test_py dstrain feedback --- dev_tools/codeowners_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev_tools/codeowners_test.py b/dev_tools/codeowners_test.py index 2326e89f9bb..e2ade43a4a0 100644 --- a/dev_tools/codeowners_test.py +++ b/dev_tools/codeowners_test.py @@ -19,7 +19,7 @@ BASE_MAINTAINERS = {CIRQ_MAINTAINERS, ('USERNAME', "@vtomole"), ('USERNAME', "@cduck")} -DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@rmlarose')}) +DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@aasfaw')}) GOOGLE_TEAM = {('USERNAME', "@wcourtney"), ('USERNAME', "@verult")} From 2d5f474a745ac8823ca90ac91c235bb4f1f39854 Mon Sep 17 00:00:00 2001 From: Abe Asfaw Date: Mon, 14 Feb 2022 11:30:01 -0800 Subject: [PATCH 4/5] Fix breaks in codeowners_test.py --- dev_tools/codeowners_test.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dev_tools/codeowners_test.py b/dev_tools/codeowners_test.py index e2ade43a4a0..16312263567 100644 --- a/dev_tools/codeowners_test.py +++ b/dev_tools/codeowners_test.py @@ -19,7 +19,8 @@ BASE_MAINTAINERS = {CIRQ_MAINTAINERS, ('USERNAME', "@vtomole"), ('USERNAME', "@cduck")} -DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@aasfaw')}) +DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@aasfaw'), + ('USERNAME', '@rmlarose')}) GOOGLE_TEAM = {('USERNAME', "@wcourtney"), ('USERNAME', "@verult")} From 07bcbdb9ab3c4557406f94a49b26dcaa3193c618 Mon Sep 17 00:00:00 2001 From: Abe Asfaw Date: Mon, 14 Feb 2022 11:34:02 -0800 Subject: [PATCH 5/5] Fix formatting in codeowners_test.py --- dev_tools/codeowners_test.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/dev_tools/codeowners_test.py b/dev_tools/codeowners_test.py index 16312263567..98f6710837c 100644 --- a/dev_tools/codeowners_test.py +++ b/dev_tools/codeowners_test.py @@ -19,8 +19,7 @@ BASE_MAINTAINERS = {CIRQ_MAINTAINERS, ('USERNAME', "@vtomole"), ('USERNAME', "@cduck")} -DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@aasfaw'), - ('USERNAME', '@rmlarose')}) +DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@aasfaw'), ('USERNAME', '@rmlarose')}) GOOGLE_TEAM = {('USERNAME', "@wcourtney"), ('USERNAME', "@verult")}