For usage questions and bug reports we strongly prefer the use of StackOverflow
and Github issues over gitter chat. Github and StackOverflow are more easily
searchable by future users and so is more efficient for everyone’s time.
Gitter chat is generally reserved for community discussion.

Dask maintains code and documentation in a few git repositories hosted on the
Github dask organization, http://github.com/dask. This includes the primary
repository and several other repositories for different components. A
non-exhaustive list follows:

http://github.com/dask/dask: The main code repository holding parallel
algorithms, the single-machine scheduler, and most documentation.

The community discusses and tracks known bugs and potential features in the
Github Issue Tracker. If you have a new idea or have identified a bug then
you should raise it there to start public discussion.

If you are looking for an introductory issue to get started with development
then check out the introductory label, which contains issues that are good
for starting developers. Generally familiarity with Python, NumPy, Pandas, and
some parallel computing are assumed.

You may want to install larger dependencies like NumPy and Pandas using a
binary package manager, like conda. You can skip this step if you already
have these libraries, don’t care to use them, or have sufficient build
environment on your computer to compile them when installing with pip:

User facing functions should roughly follow the numpydoc standard, including
sections for Parameters, Examples and general explanatory prose.

By default examples will be doc-tested. Reproducible examples in documentation
is valuable both for testing and, more importantly, for communication of common
usage to the user. Documentation trumps testing in this case and clear
examples should take precedence over using the docstring as testing space.
To skip a test in the examples add the comment #doctest:+SKIP directly
after the line.

deffib(i):""" A single line with a brief explanation A more thorough description of the function, consisting of multiple lines or paragraphs. Parameters ---------- i: int A short description of the argument if not immediately clear Examples -------- >>> fib(4) 3 >>> fib(5) 5 >>> fib(6) 8 >>> fib(-1) # Robust to bad inputs ValueError(...) """

Docstrings are currently tested under Python 2.7 on travis.ci. You can test
docstrings with pytest as follows:

py.testdask--doctest-modules

Docstring testing requires graphviz to be installed. This can be done via:

Every significative code contribution should be listed in the
Changelog under the corresponding version. When submitting a Pull
Request in Github please add to that file explaining what was added/modified.

Dask uses Sphinx for documentation, hosted on http://readthedocs.org .
Documentation is maintained in the RestructuredText markup language (.rst
files) in dask/docs/source. The documentation consists both of prose
and API documentation.

To build the documentation locally, first install requirements:

cddocs/pipinstall-rrequirements-docs.txt

Then build documentation with make:

makehtml

The resulting HTML files end up in the build/html directory.

You can now make edits to rst files and run makehtml again to update
the affected pages.