Why are docs for the API not public?

[eavilaes]

Hi everyone! I've been checking Koalas docs and I'd like to contribute on few things I've found to be incorrect, but this is not letting me help 😥:

koalas/docs/.gitignore

Line 1 in e971d6f

source/reference/api

Any hints on why this part of the docs is not public to contribute?
Thanks!🙌🏼

[itholic]

Thanks for your contribution!!

Koalas use sphinx to build the docs.

So if you want to fix some API documents, you can fix the docstring in source codes.

For example, if you want to fix DataFrame.astype API documents, fix the below docstring:

koalas/databricks/koalas/frame.py

Lines 8185 to 8238 in e971d6f

	def astype(self, dtype) -> "DataFrame":
	"""
	Cast a Koalas object to a specified dtype ``dtype``.
	Parameters
	----------
	dtype : data type, or dict of column name -> data type
	Use a numpy.dtype or Python type to cast entire Koalas object to
	the same type. Alternatively, use {col: dtype, ...}, where col is a
	column label and dtype is a numpy.dtype or Python type to cast one
	or more of the DataFrame's columns to column-specific types.
	Returns
	-------
	casted : same type as caller
	See Also
	--------
	to_datetime : Convert argument to datetime.
	Examples
	--------
	>>> df = ks.DataFrame({'a': [1, 2, 3], 'b': [1, 2, 3]}, dtype='int64')
	>>> df
	a b
	0 1 1
	1 2 2
	2 3 3
	Convert to float type:
	>>> df.astype('float')
	a b
	0 1.0 1.0
	1 2.0 2.0
	2 3.0 3.0
	Convert to int64 type back:
	>>> df.astype('int64')
	a b
	0 1 1
	1 2 2
	2 3 3
	Convert column a to float type:
	>>> df.astype({'a': float})
	a b
	0 1.0 1
	1 2.0 2
	2 3.0 3
	"""

After fix the docstring, you can check after building documents: https://koalas.readthedocs.io/en/latest/development/contributing.html#building-documentation

Btw, Koalas is ported into PySpark from Apache Spark 3.2.

So, if you're also interested in contributing to Apache Spark, you can contribute to PySpark side after the 3.2 release.

[eavilaes]

Thank you! I managed to make it work :)

I appreciate your time! 😄

[itholic]

No problem! :-)