search

callat-qcd / lattedb

Lattice QCD database interface using EspressoDB as the content manager.
https://ithems.lbl.gov/lattedb
BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Documentation #6

Closed ckoerber closed 5 years ago

ckoerber commented 5 years ago

We should provide guidelines about how to implement things such that the structure remains clean.

Where shall we put this?

A git wiki, a new doc page on the homepage as well?

ckoerber commented 5 years ago

Auto documentation was added with f2402c6e8fd0abc6670833cba6e6610a08de630a.

To generate the documentation, run

lattedb makedoc

This will generate static html pages using sphinx (in the lattedb/documentation/templates/apps directory) which are automatically linked.

For now documentation files are committed with the repository.