diff options
| author | Holden Karau <holden@us.ibm.com> | 2016-02-12 02:13:06 -0800 |
|---|---|---|
| committer | Xiangrui Meng <meng@databricks.com> | 2016-02-12 02:13:06 -0800 |
| commit | 64515e5fbfd694d06fdbc28040fce7baf90a32aa (patch) | |
| tree | a32964b46a055cb373d240b1980b04fdf58e3b5c /python | |
| parent | a183dda6ab597e5b7ead58bbaa696f836b16e524 (diff) | |
| download | spark-64515e5fbfd694d06fdbc28040fce7baf90a32aa.tar.gz spark-64515e5fbfd694d06fdbc28040fce7baf90a32aa.tar.bz2 spark-64515e5fbfd694d06fdbc28040fce7baf90a32aa.zip | |
[SPARK-13154][PYTHON] Add linting for pydocs
We should have lint rules using sphinx to automatically catch the pydoc issues that are sometimes introduced.
Right now ./dev/lint-python will skip building the docs if sphinx isn't present - but it might make sense to fail hard - just a matter of if we want to insist all PySpark developers have sphinx present.
Author: Holden Karau <holden@us.ibm.com>
Closes #11109 from holdenk/SPARK-13154-add-pydoc-lint-for-docs.
Diffstat (limited to 'python')
| -rw-r--r-- | python/docs/conf.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/python/docs/conf.py b/python/docs/conf.py index 365d6af514..d35bf73c30 100644 --- a/python/docs/conf.py +++ b/python/docs/conf.py @@ -334,3 +334,6 @@ epub_exclude_files = ['search.html'] # If false, no index is generated. #epub_use_index = True + +# Skip sample endpoint link (not expected to resolve) +linkcheck_ignore = [r'https://kinesis.us-east-1.amazonaws.com'] |