platypush/docs/README.md

512 B

Platypush self-generated reference

====================================

This directory contains the Sphinx self-generated documentation for Platypush.

Dependencies required to generate the documentation:

$ [sudo] pip install sphinx 'git+https://github.com/bashtage/sphinx-material.git'

To generate the HTML documentation:

$ make html

The output will be generated under build/html.

Type make with no additional arguments to get a full list of the supported output formats.