Skip to content

add docs compilation - #68

Merged
Ikreb1 merged 2 commits into
mainfrom
docs-build-infrastructure
Aug 20, 2026
Merged

add docs compilation#68
Ikreb1 merged 2 commits into
mainfrom
docs-build-infrastructure

Conversation

@Ikreb1

@Ikreb1 Ikreb1 commented Aug 19, 2026

Copy link
Copy Markdown
Member

Copied docs setup from carbon-mesh and adjusted where necessary

@Ikreb1
Ikreb1 requested review from filipppavlov and a lite review from Copilot August 19, 2026 11:50

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 a BUILD_DOCUMENTATION option (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_ENV is 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 the cmake -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.

Comment thread cmake/CcpDocsGenerator.cmake
Comment thread doc/source/index.rst
Comment thread doc/source/conf.py Outdated
Comment thread CMakeLists.txt Outdated
@Ikreb1
Ikreb1 requested a review from CCPNobody August 19, 2026 11:55
@Ikreb1
Ikreb1 merged commit 0318ea5 into main Aug 20, 2026
22 checks passed
@Ikreb1
Ikreb1 deleted the docs-build-infrastructure branch August 20, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants