Skip to content
Commit 056c427d authored by Alberto Miranda's avatar Alberto Miranda
Browse files

Merge branch 'amiranda/159-generate-doxygen-documentation' into 'master'

Resolve "Automatically generate GekkoFS documentation"

This MR adds a `docs` target to the build system that can be used to automatically generate Sphinx documentation based on ReStructured Text for the project. Additionally, it also processes the source files through Doxygen to generate intermediate XML that can be passed to Sphinx extensions Breathe and Exhale so that GekkoFS classes and functions can be referenced from the Sphinx documentation.

The CI script is also extended to build this documentation and deploy it to the project's site.

Closes #159

See merge request !95
parents fd648a01 3f498869
Pipeline #2263 passed with stages
in 22 minutes and 6 seconds
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment