search

ckoerber / lsqfit-gui

Graphical user interface for performing Bayesian Inference (Bayesian fits).
https://lsqfitgui.readthedocs.io
MIT License
1 stars 0 forks source link

[WIP] Documentation #18

Closed ckoerber closed 2 years ago

ckoerber commented 2 years ago

I have started to work on the documentation using spinx.

This is not finalized yet...

To compile the docs, run

pip install -r requirements-dev.txt
cd doc
make html

and open build/html/index.html.

From my point, there still needs to be more detail in the example section.

ckoerber commented 2 years ago

I have added a first draft for the doc. It should be checked by someone who has not yet worked to closely with the app to see if it is understandable :)