Skip to content

Commit

Permalink
Adding check that **all** setup.py README's are valid RST. (#3318)
Browse files Browse the repository at this point in the history
* Adding check that **all** setup.py README's are valid RST.

Follow up to #3316. Fixes #2446.

* Fixing duplicate reference in Logging README.

* Fixing duplicate reference in Monitoring README.
  • Loading branch information
dhermes authored Apr 20, 2017
1 parent 5d99380 commit 8a950b4
Show file tree
Hide file tree
Showing 19 changed files with 153 additions and 2 deletions.
9 changes: 9 additions & 0 deletions bigquery/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/bigquery')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions bigtable/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ def lint(session):
session.run('flake8', 'google/cloud/bigtable')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions core/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ def lint(session):
session.run('flake8', 'google/cloud/core')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions dns/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ def lint(session):
session.run('flake8', 'google/cloud/dns')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions error_reporting/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ def lint(session):
session.run('flake8', 'google/cloud/error_reporting')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions language/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/language')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
1 change: 0 additions & 1 deletion logging/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Using the API
`Stackdriver Logging`_ API (`Logging API docs`_) allows you to store, search,
analyze, monitor, and alert on log data and events from Google Cloud Platform.

.. _Stackdriver Logging: https://cloud.google.com/logging/
.. _Logging API docs: https://cloud.google.com/logging/docs/

.. code:: python
Expand Down
9 changes: 9 additions & 0 deletions logging/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ def lint(session):
session.run('flake8', 'google/cloud/logging')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
1 change: 0 additions & 1 deletion monitoring/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ insights via dashboards, charts, and alerts.
This package currently supports all Monitoring API operations other than
writing custom metrics.

.. _Stackdriver Monitoring: https://cloud.google.com/monitoring/
.. _Monitoring API docs: https://cloud.google.com/monitoring/api/ref_v3/rest/

List available metric types:
Expand Down
9 changes: 9 additions & 0 deletions monitoring/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/monitoring')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,12 @@ def docs(session):

# Build the docs!
session.run('bash', './test_utils/scripts/update_docs.sh')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')
9 changes: 9 additions & 0 deletions pubsub/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/pubsub')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions resource_manager/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ def lint(session):
session.run('flake8', 'google/cloud/resource_manager')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions runtimeconfig/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ def lint(session):
session.run('flake8', 'google/cloud/runtimeconfig')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions spanner/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/spanner')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions speech/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/speech')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions storage/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/storage')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions translate/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/translate')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down
9 changes: 9 additions & 0 deletions vision/nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ def lint(session):
session.run('flake8', 'google/cloud/vision')


@nox.session
def lint_setup_py(session):
"""Verify that setup.py is valid (including RST check)."""
session.interpreter = 'python3.6'
session.install('docutils', 'Pygments')
session.run(
'python', 'setup.py', 'check', '--restructuredtext', '--strict')


@nox.session
def cover(session):
"""Run the final coverage report.
Expand Down

0 comments on commit 8a950b4

Please sign in to comment.