RippeR37/libbase

Documentation

RippeR37 opened this issue · 2 comments

Write/improve documentation.

  • Decide on and setup documentation framework
  • Hook it to CMake for local builds (on-demand)
  • Hook it to CI (GitHub Actions) for continuous building and deployment
  • Add versioning system for documentation (branches, tags, etc.)
  • Add custom/manual documentation content
  • (Optional) Add in-source documentation to be picked-up by Doxygen

Basic documentation system added, along with the CI integration for building documentation for all branches/tags.

Documentation added. There will be many improvements (e.g. all code examples will be sourced from the actual examples built on CI, or add in-source documentation to be picked-up by the doxygen) but they will target later releases.