Skip to content
This repository has been archived by the owner on Jul 19, 2022. It is now read-only.

Need a documentation solution #154

Open
mormj opened this issue Nov 12, 2021 · 0 comments
Open

Need a documentation solution #154

mormj opened this issue Nov 12, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mormj
Copy link
Contributor

mormj commented Nov 12, 2021

Since so much of the code is generated, including the public header files, doxygen doesn't make as much sense anymore

Seems it would be feasible to:

  1. have a docs/ directory in-tree
  2. put all the usage guides there (what is currently in gh-pages)
  3. automatically generated block docs from the yml

The yml could have a block level description, and then a doc attribute for each parameter

sphinx/readthedocs

@mormj mormj added the documentation Improvements or additions to documentation label Nov 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant