Skip to content

Add 'sphinx.ext.coverage' to the 'tox -e docs' build. #1156

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

Closed
tseaver wants to merge 1 commit into from
Closed

Add 'sphinx.ext.coverage' to the 'tox -e docs' build. #1156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
Expand Down Expand Up @@ -294,3 +295,15 @@
'oauth2client': ('http://oauth2client.readthedocs.org/en/latest/', None),
'python': ('https://docs.python.org/', None),
}

# Configuration for coverage:
# See: http://sphinx-doc.org/ext/coverage.html

coverage_ignore_modules = ['test_.*.py', '.*_pb2.py']
#coverage_ignore_functions = ()
#coverage_ignore_classes = ()
coverage_c_path = ['../gcloud/*.py', '../gcloud/*/*.py']
#coverage_c_regexes
#coverage_ignore_c_items
#coverage_write_headline
coverage_skip_undoc_in_source = True
1 change: 1 addition & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ basepython =
commands =
python -c "import shutil; shutil.rmtree('docs/_build', ignore_errors=True)"
sphinx-build -W -b html -d docs/_build/doctrees docs docs/_build/html
sphinx-build -W -E -b coverage -d docs/_build/doctrees docs docs/_build/coverage
deps =
Sphinx
passenv = {[testenv:system-tests]passenv} SPHINX_RELEASE READTHEDOCS LOCAL_RTD
Expand Down