search

kartoza / geodata-mart

Geoprocessing as a Service
https://data.kartoza.com
2 stars 3 forks source link

Create project documentation framework #29

Closed zacharlie closed 2 years ago

zacharlie commented 2 years ago

An effective way to document project details for developers and users must be configured

zacharlie commented 2 years ago

This has been partially implemented in line with issues #5 and #3, as it includes a "developer documentation" service with sphinx, which is capable of scraping the codebase and producing documentation from available methods and docstrings etc.

In addition, the django rest framework includes it's own auto-documenting api, and a swagger-ui component is provided from drf-spectacular. As such robust methods for creating developer documentation are available (albeit a little fragmented).

User documentation, however, I think should likely be kept distinct from the developer documentation, and may leverage the material-mkdocs strategy used in the Kartoza Handbook