docs: add Sourcey C++ API reference - #241
Conversation
MatthieuDartiailh
left a comment
There was a problem hiding this comment.
It is unfortunate the docs are built as separate pages. It would be much nicer to embed the doxigen generated docs into the sphinx docs. A quick search suggest breathe and doxisphinx could be two possible paths.
|
Thanks for the suggestion. I updated the PR to use Breathe so the Doxygen XML is rendered directly inside the existing Sphinx C++ API page instead of appearing as a separate top-level docs section. Doxygen now runs in Read the Docs' pre-build phase, and the same XML still feeds the searchable Sourcey reference. I verified the change locally with python -m sphinx -W -b html docs/source build/sphinx-113-breathe; the build completes without warnings. |
|
Looks better. Could you remove the hardcoded URL to the C++ API docs and met sphinx build that link ? |
Summary
/cpp-api/Verification
doxygen Doxyfile.sourceysourcey build --output sourcey-preview-113b(18 pages generated)python -m sphinx -W -b html docs/source build/sphinx-113The Sourcey config pins source links to commit
e8acf1e0eb8c21c6193d7dd621e3f03b7277f122. Generated HTML is not committed; Read the Docs builds it after the Sphinx build.Closes #60.
AI assistance disclosure: OpenAI Codex assisted with generation, configuration, and testing; the resulting files and public output were reviewed and verified locally.