Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 585 Bytes

README.md

File metadata and controls

22 lines (14 loc) · 585 Bytes

Marina docs

Written in reStructuredText and Markdown, built using Sphinx and hosted on Read The Docs.

Setup

pip install -r requirements.txt

Build locally

make html
open _build/html/index.html

Test that links work before deploying

make linkcheck

To deploy, just commit your change (or send a pull request) and, once pushed to master, it will be deployed automatically to our Documentation page