peek-doc-dev

Peek Platform - Developer Documentation


Keywords
Peek, Python, Platform, synerty
License
MIT
Install
pip install peek-doc-dev==2.5.6

Documentation

Peek Platform - Dev Doc Service

The Peek Dev Doc service contains the developer documentation container.

Developer documentation from other plugins are linked in to this container, this will be RST text files and images.

A sphinx build is then run to generate the HTML and PDF documentation

Manual Builds

Builds are performed by either the peek-server service much the same way the builds are performed for the mobile-web frontends.

Manual builds can be performed by running the following :

cd <project dir>/peek_doc_dev
build_html_docs.sh