Summary
Add auto-generated API documentation published to https://docs.northernwidget.com/Margay_Library/, following the same Doxygen → Doxybook2 → Jekyll (Minimal Mistakes) pipeline used by Apis_Library.
Files added (template ready to commit)
The following files have been prepared locally and mirror the Apis_Library setup:
doxygen_NW.cfg — Doxygen config (generates XML for Doxybook2)
.doxybook/config.json — Doxybook2 config with baseUrl: /Margay_Library/
_docs/_config.yml — Jekyll config (Minimal Mistakes theme, docs.northernwidget.com)
_docs/Gemfile — Ruby/Jekyll dependencies
_docs/_data/navigation.yml — Sidebar nav pointing to Margay class
.github/workflows/docs.yml — CI workflow: builds and deploys to gh-pages branch on every push to master
What remains before going live
- Commit and push the template files above.
- Add Doxygen doc comments to
src/Margay.h / src/Margay.cpp where missing.
- In the GitHub repository Settings → Pages, set the source to the
gh-pages branch.
- Update the
### Reference section of Project-Margay README to point to https://docs.northernwidget.com/Margay_Library/.
Reference
- Working example: Apis_Library docs
- Workflow source:
.github/workflows/docs.yml in Apis_Library
Summary
Add auto-generated API documentation published to
https://docs.northernwidget.com/Margay_Library/, following the same Doxygen → Doxybook2 → Jekyll (Minimal Mistakes) pipeline used by Apis_Library.Files added (template ready to commit)
The following files have been prepared locally and mirror the Apis_Library setup:
doxygen_NW.cfg— Doxygen config (generates XML for Doxybook2).doxybook/config.json— Doxybook2 config withbaseUrl: /Margay_Library/_docs/_config.yml— Jekyll config (Minimal Mistakes theme,docs.northernwidget.com)_docs/Gemfile— Ruby/Jekyll dependencies_docs/_data/navigation.yml— Sidebar nav pointing toMargayclass.github/workflows/docs.yml— CI workflow: builds and deploys togh-pagesbranch on every push tomasterWhat remains before going live
src/Margay.h/src/Margay.cppwhere missing.gh-pagesbranch.### Referencesection ofProject-MargayREADME to point tohttps://docs.northernwidget.com/Margay_Library/.Reference
.github/workflows/docs.ymlin Apis_Library