add docs compilation - #68
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a documentation build pipeline to the carbon-trinity project by introducing a Sphinx configuration (with Breathe + Doxygen XML) and wiring documentation generation into the CMake build.
Changes:
- Added Sphinx docs scaffold (
conf.py,index.rst) configured to consume Doxygen XML via Breathe. - Added a Doxygen configuration template (
doc/Doxyfile.in) to generate XML output for Sphinx. - Integrated doc generation into CMake via
create_carbon_docs_sphinx_target()and aBUILD_DOCUMENTATIONoption (defaulting ON in TeamCity).
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/source/index.rst | Adds the initial Sphinx landing page and a Breathe doxygenclass directive. |
| doc/source/conf.py | Adds Sphinx configuration (extensions, source suffixes, Breathe defaults, theme). |
| doc/Doxyfile.in | Adds Doxygen template configuration to produce XML for Breathe. |
| CMakeLists.txt | Adds BUILD_DOCUMENTATION option and hooks docs generation into the build. |
| cmake/CcpDocsGenerator.cmake | Updates docs generator to use a dedicated Doxygen output dir and wires Breathe to that XML path. |
Suppressed comments (1)
cmake/CcpDocsGenerator.cmake:75
PYTHONPATH_ENVis parsed as a CMake list (because it’s declared as a multi-value arg), so if it contains semicolons (common on Windows) it will be split into multiple arguments and break thecmake -E env PYTHONPATH=...invocation. Join the list back into a single string before passing it to-E env(with platform-appropriate separator).
message(STATUS "Python Path is: ${arg_PYTHONPATH_ENV}")
add_custom_target(${arg_SPHINX_TARGET_NAME} ALL
COMMAND ${CMAKE_COMMAND} -E env PYTHONPATH=${arg_PYTHONPATH_ENV} ${SPHINX_COMMAND}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${arg_VENV_NAME}
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
CCPNobody
approved these changes
Aug 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Copied docs setup from carbon-mesh and adjusted where necessary