GitHub user holdenk opened a pull request:
https://github.com/apache/spark/pull/11109
[SPARK-13154][PYTHON][BLOCKED] Add linting for pydocs
We should have lint rules using sphinx to automatically catch the pydoc
issues that are sometimes introduced.
Note: this is blocked on SPARK-12986 /
https://github.com/apache/spark/pull/11025 to fix the outstanding issues.
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.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/holdenk/spark
SPARK-13154-add-pydoc-lint-for-docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/11109.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #11109
----
commit e6d0e643dfeef6885c4bcefd04dc45dc235d137e
Author: Holden Karau <[email protected]>
Date: 2016-02-07T03:38:26Z
Gracefully skip doc checks if sphinx build isn't installed
commit 9c83ff26bb3fdfc4be8c3c4aff3b8f775f69f882
Author: Holden Karau <[email protected]>
Date: 2016-02-07T07:02:50Z
Skip our sample kinses URL when validating links in pydoc
commit 0a79ffdf1716681425f2270ba31733d79920617d
Author: Holden Karau <[email protected]>
Date: 2016-02-07T07:37:34Z
Comment out SPHINXOPTS which was overriding options set on the command line
commit 4e02a67c6fb2ea145403d232993562c7b5729441
Author: Holden Karau <[email protected]>
Date: 2016-02-07T07:39:04Z
Run pydoc checks if sphynx is installed. For links check in warning mode
(e.g. redirects are OK but missing links no) & for documentation its self treat
warning as errors. If we have an error re-run make html since with as error
mode it stops at the first error
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
