Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.29 KB

README.md

File metadata and controls

26 lines (16 loc) · 1.29 KB

Documentation

This is the main repository for general documentation for Platypus products.

Configuration

This repository is set up to automatically build using ReadTheDocs.org, which pushes it through the Sphinx Document Generator. The generator converts reStructuredText (.rst) files into HTML, PDF, and EPUB documentation, which is then republished on the Platypus web site.

Usage

To edit documentation, simply create or modify .rst files in this repository and push the changes to GitHub. When pushed, the documentation will automatically be rebuilt and served within ~10 minutes. You can check the progress of this build on ReadTheDocs.org.

Remember, everything that is published to this repository is public. Only commit public documentation to this repository!

Links