Documentation
This moves QuaLiKiz-pythontools to readthedocs/numpy/xarray documentation style. However, I use allow google-style comments, and allow the Kwargs syntax. Summary:
- Add
docsas explicit extra for generated docs - Adds link to pages to README
- Adds API-style docs, e.g. call signatures using
autosummary - Adds shorthand notation for commonly linked locations
See:
- https://qualikiz-group.gitlab.io/QuaLiKiz-pythontools for landing page
- https://qualikiz-group.gitlab.io/QuaLiKiz-pythontools/api.html for handwritten docs
- https://qualikiz-group.gitlab.io/QuaLiKiz-pythontools/api-hidden.html for autogen docs
Edited by Karel van de Plassche