GitHub user cocoatomo opened a pull request:
https://github.com/apache/spark/pull/2653
[SPARK-3773][PySpark][Doc] Sphinx build warning
When building Sphinx documents for PySpark, we have 12 warnings.
Their causes are almost docstrings in broken ReST format.
To reproduce this issue, we should run following commands on the commit:
6e27cb630de69fa5acb510b4e2f6b980742b1957.
```bash
$ cd ./python/docs
$ make clean html
...
/Users/<user>/MyRepos/Scala/spark/python/pyspark/__init__.py:docstring of
pyspark.SparkContext.sequenceFile:4: ERROR: Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/__init__.py:docstring of
pyspark.RDD.saveAsSequenceFile:4: ERROR: Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring
of pyspark.mllib.classification.LogisticRegressionWithSGD.train:14: ERROR:
Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring
of pyspark.mllib.classification.LogisticRegressionWithSGD.train:16: WARNING:
Definition list ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring
of pyspark.mllib.classification.LogisticRegressionWithSGD.train:17: WARNING:
Block quote ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring
of pyspark.mllib.classification.SVMWithSGD.train:14: ERROR: Unexpected
indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring
of pyspark.mllib.classification.SVMWithSGD.train:16: WARNING: Definition list
ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring
of pyspark.mllib.classification.SVMWithSGD.train:17: WARNING: Block quote ends
without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/docs/pyspark.mllib.rst:50:
WARNING: missing attribute mentioned in :members: or __all__: module
pyspark.mllib.regression, attribute RidgeRegressionModelLinearRegressionWithSGD
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/tree.py:docstring of
pyspark.mllib.tree.DecisionTreeModel.predict:3: ERROR: Unexpected indentation.
...
checking consistency...
/Users/<user>/MyRepos/Scala/spark/python/docs/modules.rst:: WARNING: document
isn't included in any toctree
...
copying static files... WARNING: html_static_path entry
u'/Users/<user>/MyRepos/Scala/spark/python/docs/_static' does not exist
...
build succeeded, 12 warnings.
```
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/cocoatomo/spark
issues/3773-sphinx-build-warnings
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/2653.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 #2653
----
commit 6f656618d7a6fe3f9977f6a1fb15350577388f06
Author: cocoatomo <[email protected]>
Date: 2014-10-04T14:07:20Z
[SPARK-3773][PySpark][Doc] Sphinx build warning
Remove all warnings on document building
----
---
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]
