Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate md documentation #64

Open
e-lo opened this issue Jun 12, 2023 · 1 comment
Open

Auto-generate md documentation #64

e-lo opened this issue Jun 12, 2023 · 1 comment

Comments

@e-lo
Copy link
Contributor

e-lo commented Jun 12, 2023

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
Copy link
Contributor Author

e-lo commented Jun 12, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant