From 90ecac0f337aeff3c92f7f0d74c8c2b9043877bd Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 29 Jan 2019 14:47:19 -0800 Subject: [PATCH 1/5] Add bigquery_storage to docs --- docs/bigquery_storage | 1 + docs/index.rst | 1 + 2 files changed, 2 insertions(+) create mode 120000 docs/bigquery_storage diff --git a/docs/bigquery_storage b/docs/bigquery_storage new file mode 120000 index 000000000000..6c07150ad7db --- /dev/null +++ b/docs/bigquery_storage @@ -0,0 +1 @@ +../bigquery_storage/docs/ \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 8b4627e812ee..9432c1fe2de9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ AutoML BigQuery BigQuery Data-Transfer + BigQuery Storage Bigtable Container Dataproc From 0592bffb86459f0888234ee3c0a4bef762b0ca5a Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 29 Jan 2019 14:59:11 -0800 Subject: [PATCH 2/5] Fix path to README --- bigquery_storage/docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bigquery_storage/docs/index.rst b/bigquery_storage/docs/index.rst index 1232e5865ae5..4a7d15990735 100644 --- a/bigquery_storage/docs/index.rst +++ b/bigquery_storage/docs/index.rst @@ -1,4 +1,4 @@ -.. include:: ../../bigquery_storage/README.rst +.. include:: /../bigquery_storage/README.rst API Reference ------------- From 242645f90d372e417239b131b07d247f0f740d1a Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 29 Jan 2019 15:08:28 -0800 Subject: [PATCH 3/5] Add bigquery_storage to docs/requirements.txt --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 1ff3f9b48848..06b383749ff5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -11,6 +11,7 @@ grpcio-gcp >= 0.2.2 -e automl/ -e bigquery/ -e bigquery_datatransfer/ +-e bigquery_storage/ -e bigtable/ -e container/ -e dataproc/ From 5ecd69fb2cca0174ce632b75c2faf926db526aba Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 29 Jan 2019 15:26:29 -0800 Subject: [PATCH 4/5] Remove docs session from bigquery_storage/noxfile --- bigquery_storage/noxfile.py | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/bigquery_storage/noxfile.py b/bigquery_storage/noxfile.py index e5aa557c8611..ea4e3b28bb10 100644 --- a/bigquery_storage/noxfile.py +++ b/bigquery_storage/noxfile.py @@ -125,23 +125,3 @@ def system(session): # Run py.test against the system tests. session.run('py.test', '--quiet', 'tests/system/') - - -@nox.session(python='3.6') -def docs(session): - """Build the docs.""" - - session.install('sphinx', 'sphinx_rtd_theme') - session.install('-e', '.[pandas,fastavro]') - - shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True) - session.run( - 'sphinx-build', - '-W', # warnings as errors - '-T', # show full traceback on exception - '-N', # no colors - '-b', 'html', - '-d', os.path.join('docs', '_build', 'doctrees', ''), - os.path.join('docs', ''), - os.path.join('docs', '_build', 'html', ''), - ) From da0193815d9702c2e658287ab66f79ae2703d08b Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 29 Jan 2019 16:18:09 -0800 Subject: [PATCH 5/5] Re-add bigquery_storage/noxfile docs session --- bigquery_storage/docs/README.rst | 1 + bigquery_storage/docs/index.rst | 2 +- bigquery_storage/noxfile.py | 20 ++++++++++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) create mode 120000 bigquery_storage/docs/README.rst diff --git a/bigquery_storage/docs/README.rst b/bigquery_storage/docs/README.rst new file mode 120000 index 000000000000..89a0106941ff --- /dev/null +++ b/bigquery_storage/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file diff --git a/bigquery_storage/docs/index.rst b/bigquery_storage/docs/index.rst index 4a7d15990735..473e9351bb98 100644 --- a/bigquery_storage/docs/index.rst +++ b/bigquery_storage/docs/index.rst @@ -1,4 +1,4 @@ -.. include:: /../bigquery_storage/README.rst +.. include:: README.rst API Reference ------------- diff --git a/bigquery_storage/noxfile.py b/bigquery_storage/noxfile.py index ea4e3b28bb10..e5aa557c8611 100644 --- a/bigquery_storage/noxfile.py +++ b/bigquery_storage/noxfile.py @@ -125,3 +125,23 @@ def system(session): # Run py.test against the system tests. session.run('py.test', '--quiet', 'tests/system/') + + +@nox.session(python='3.6') +def docs(session): + """Build the docs.""" + + session.install('sphinx', 'sphinx_rtd_theme') + session.install('-e', '.[pandas,fastavro]') + + shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True) + session.run( + 'sphinx-build', + '-W', # warnings as errors + '-T', # show full traceback on exception + '-N', # no colors + '-b', 'html', + '-d', os.path.join('docs', '_build', 'doctrees', ''), + os.path.join('docs', ''), + os.path.join('docs', '_build', 'html', ''), + )