Skip to content

marinaio/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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