Documentation for Jumbo packages is written with Sphinx . A theme has been created starting cloud_sptheme and adding the header with logo and dropdown menu as in bootstrap-sphinx.
Sphinx is based on ReST (Restructured Text) from the docutils team, but adds a lot of directive that make uit’s use much more powerful and suited for large projects.
ReST User Reference: | |
---|---|
the user reference from the docutils team | |
ReST primer: | a primer from SPhinx site |
Sphinx markup constructs: | |
Sphinx constructs |
When creating a package with jmb-start the correct structure is automatically created so that:
jmb-start -t japp jmb.new
cd jmb.new
jmb-go
dj docs
Creates a perfectly working structure for the documentation with menu entry that point to Jumbo project and local docs for:
you area supposed to add any documents you consider needed for you package!
the simpler way to conver an older package is