The Lamdbapi user manual concerns mainly people who want to develop proofs or
encodings of logics using Lambdapi. People who want to use Lambdapi as an API
for proof interoperability should consult the OCaml documentation generated with
make odoc at the root of the git repository.
The documentation is available at https://lambdapi.readthedocs.io.
It can also be generated from the sources and browsed locally using any web browser.
To generate the documentation, Sphinx
and sphinx_rtd_theme are required. They can be installed using
pip as follows:
sudo apt install python3-pip
pip install -U sphinx sphinx_rtd_themeChange to directory docs/ from the root of the sources
and use make html to generate html files into docs/_build/html.
The entry point of the documentation is docs/_build/html/index.html.
We will gladly accept any contribution to the documentation. If something is unclear, please tell us using the issue tracker, using the "documentation" tag.
To write documentation, open a pull request. We have a few guidelines on writing restructured text:
- even though any kind of underlining can be used to establish title hierarchy
(hierarchy is established by order of appearance), we favour, in decreasing
order of importance (from top title to paragraph),
====----^^^^''''
- for lists, use stars
*.
Note: BNF grammars are auto generated using Obelisk. They should not be edited directly.