User guide

[shariboodts]

Add Ger's user guide to the application (PDF and HTML). Wait until June after development is complete and user guide has been reviewed against most recent version of research tool.

[ErwinKomen]

Two approaches

1. We can upload the PDF and add a button (e.g. in the about section) to allow users to download it
2. it is also possible to provide for a HTML-based help system on the basis of the Word document, provided we transform it correctly into the correct markdown format. This works with Sphinx

Sphinx documentation

Recipe on how this works for passimutils:

1. Enter the virtual environment
2. Go to the directory passim/doc
3. Type make html
4. The HTML pages are created and put into directory build/html

This approach could be used for the Passim documentation too. Start it with sphinx-quickstart and then specify a project root directory. Optionally specify author, version, language etc (use --help). Also see the sphinx help.

[ErwinKomen]

User guide via Sphinx

Okay, I started out with this a little bit. What I've done:

1. Created a Sphinx project under directory userguide
2. Added the introduction as a separate rst file
3. Figured out how to add images and size them
4. Created a first version (dev env)

[ErwinKomen]

A link to the PDF has now been added (by TH)