Documentation for the Platypus Lutra autonomous watercraft.
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.
To edit documentation, simply create or modify .rst files in the docs/ subfolder and push the changes to GitHub. You can fine a primer on reStructuredText syntax here.
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!
- github/PlatypusLLC/Lutra - GitHub repository
- ReadTheDocs/lutra - ReadTheDocs project