Dash Docs

Dash User Documentation

The official Dash documentation is oriented towards the average user and serves to describe all aspects of the Dash ecosystem, ranging from information for new users through to guides on more difficult tasks such as maintaining a masternode. User documentation (this repository) is hosted at https://docs.dash.org. Core developer documentation is found at https://docs.dash.org/core (source repository) and Platform developer documentation is at https://docs.dash.org/platform (source repository).

Usage

If you have Python installed, you can download this repository and build the documentation locally. Python 3.13 is recommended since the hosted documentation is built with that version. The following instructions are based on Ubuntu 22.04.

1. Set up and activate a Python virtual environment to isolate the documentation by running this command from the root of the project:

   python3.13 -m venv venv/
   source ./venv/bin/activate

2. Install the dependencies need to build the documentation:

   pip install -r requirements.txt

3. Build the documentation:

   make html

4. If you modify any pages, rebuild the documentation before attempting to preview the changes:

   rm -r _build/ || true && make html

The documentation will be located in the _build/html directory and can be viewed by opening _build/html/index.html in a browser. Note: the standard search functionality is not available for locally built documentation.

Contributing

This documentation is written in reStructuredText and is designed to be built with Sphinx and hosted by Read the Docs. Feel free to open an issue or submit PRs modifying the English source text in this repository. Contributions to translations of the source text are welcomed on Transifex.

Package management

Packages are managed using pip-tools. Install it using:

pip install pip-tools

Add packages

To include a new package:

1. Add the package to requirements.in
2. Run pip-compile to update requirements.txt
3. Run pip install -r requirements.txt to install all packages

Update packages

Specific packages can be updated using pip-compile --upgrade-package <package name>. To update all packages:

1. Run pip-compile --upgrade

License

MIT © Dash Core Group, Inc.