In the past I have used LaTeX, XML (docbook), and Sphinx for documentation.

I want to try and integrate the documentation of my present app into the
app itself if possible and am considering the following routes:

*  Use Markdown + Pandoc and place the pdf/html documentation in
/static/documentation
*  Use Sphinx and place the pdf/html documentation in /static/documentation
*  Create tables within the app:  a to-do-list which will also serve as
change history documentation, and another table with inter alia
 three fields: subject, keywords and comments  which can be used for
howto's for the rest of the documentation.  This can be combined with full
text searches.
*  Carry on with LaTeX and create pdf's and html's from there which will be
served from /static.

The documentation should be enough to enable somebody who knows nothing of
the specific system, to understand the logic, to get going with the
administration, to set up the server etc.

I know that markmin/markdown is available within web2py but I am not sure
how to use it in this case (unless in text fields when I use the fourth
option above).

Maybe something like the app for the official book is another option.  Is
the structure of that app available as open source?

I would like to know how the developers on this list approach their
documentation.

Regards
Johann
-- 
Because experiencing your loyal love is better than life itself,
my lips will praise you.  (Psalm 63:3)

Reply via email to