currently we have unupdated READMEs spread out thru the monorepo and also some outdated slides in software drive, which is a hassle to maintain.
Should move all of our documentation to self hosted website on github pages.
Current choices:
MkDocs:
- Good support for Python, C++
- Autodoc API generation
- Uses markdowns to render, so integrates well with our current readmes
GitBook:
- No Autodoc generation
- more of a hassle to set up CI/CD
- Best looking themes
Sphinx:
- MkDocs but worse for our case.
currently we have unupdated READMEs spread out thru the monorepo and also some outdated slides in software drive, which is a hassle to maintain.
Should move all of our documentation to self hosted website on github pages.
Current choices:
MkDocs:
GitBook:
Sphinx: