zhongjin
/
cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
cartodb/doc/manual/README.md

624 B
Raw Permalink Blame History

platform docs

How to generate

pip install Sphinx
pip install sphinx_rtd_theme

If previous commands trigger Permission denied error try with sudo.

make html

How to contribute

Documentation uses Sphinx, an easy way to create structured documentation based on rst. Start with this tutorial

Why not markdown?

markdown is nice but rst has the same features, it's really similar but allow to have cross references. It also allow to use Sphinx which create TOC, generate different formats (pdf, epub) and allow to change themes.