search

zephyr-data-specs / GMNS

General Modeling Network Specification
https://zephyr-data-specs.github.io/GMNS/
104 stars 15 forks source link

Auto-generate md documentation #64

Open e-lo opened 1 year ago

e-lo commented 1 year ago

As a maintainer, I don't want to have to worry about updating the markdown documentation to be in sync with the code-based specification.

As a user, I want the certainty that the markdown documentation is the same as the code-based specification.

Proposed Solution

The markdown documentation can and should be automatically generated from the code-based documentation. This has been proven in the gmnspy package and I (@e-lo) am happy to implement here if given go-ahead by community.

e-lo commented 1 year ago

cc: @joecastiglione on if community would like me to implement.