Start documenting public API

runtimeverification / k

K Framework Tools 7.0

BSD 3-Clause "New" or "Revised" License

454 stars 150 forks source link

Open tothtamas28 opened 1 year ago

tothtamas28 commented 1 year ago

[x] Look into docstring formats and tools for generating documentation
[x] Set up infrastructure for generating documentation from docstrings: runtimeverification/pyk#811
[x] Set up infrastructure for deploying generated documentation: runtimeverification/pyk#814
[ ] Start adding docstrings for newly added / touched public modules, functions and classes

ehildenb commented 1 year ago

tothtamas28 commented 10 months ago

Look into docstring formats and tools for generating documentation

We'll use Sphinx with its own docstring format. This is probably the most common setup by far.