Add documentation

[balbasty]

We should add an autodoc for the CLI, and maybe also for the internal API?

I like material-mkdocs + mkdocstrings, but open to other things.

Is there something for CLIs? I see that there's something for click and typer so maybe we should swotch to one of them (although I much much prefer the cyclopts syntax)

[kabilar]

I like material-mkdocs + mkdocstrings, but open to other things.

+1

We could additionally use mike to allow users to view the documentation for different versions of the package.

Is there something for CLIs? I see that there's something for click and typer so maybe we should swotch to one of them (although I much much prefer the cyclopts syntax)

I am not familiar with these tools.

Once these API docs are deployed, we should add them to the LINC Docs under the API section.