Open jeffa5 opened 1 year ago
Is your feature request related to a problem? Please describe.
Currently the docs are not published, we should probably publish them to github pages. Switching to .rst from .md and using sphinx would be nice too.
.rst
.md
sphinx
Describe the solution you'd like
A CI job that deploys to github pages on changes to the docs folder.
docs
Describe alternatives you've considered
Leave docs rendered by github in the repo but that makes it harder to discover.
Additional context
CCF Use sphinx for their docs so would help keep it in style.
Is your feature request related to a problem? Please describe.
Currently the docs are not published, we should probably publish them to github pages. Switching to
.rstfrom.mdand usingsphinxwould be nice too.Describe the solution you'd like
A CI job that deploys to github pages on changes to the
docsfolder.Describe alternatives you've considered
Leave docs rendered by github in the repo but that makes it harder to discover.
Additional context
CCF Use
sphinxfor their docs so would help keep it in style.