platypush/docs
Fabio Manganiello 3bfc5b83ef Moved to manifest files for describing plugins and backends and their dependencies 2021-09-16 17:53:40 +02:00
..
source Moved to manifest files for describing plugins and backends and their dependencies 2021-09-16 17:53:40 +02:00
Makefile Documentation v0.1 2018-06-23 01:00:43 +02:00
README.md Added README for auto-generated docs and changed theme to sphinx-material 2021-03-14 15:07:10 +01:00

README.md

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.