Skip to content

Update Sphinx/Doxygen/Breathe docs: pin latest deps, fix config, expand API coverage#323

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/update-branch-with-main-again
Draft

Update Sphinx/Doxygen/Breathe docs: pin latest deps, fix config, expand API coverage#323
Copilot wants to merge 4 commits intomainfrom
copilot/update-branch-with-main-again

Conversation

Copy link
Contributor

Copilot AI commented Feb 13, 2026

  • Analyze branch history and understand the original goal (Sphinx/Doxygen/Breathe documentation framework)
  • Reset working tree to match main exactly (per reviewer request)
  • Re-apply docs/ directory as the only addition on top of main
  • Remove files from old branch that don't exist on main
  • Fix docs for current codebase: correct version (0.1.0), class name (layer_sentry), macro (PHLEX_DETAIL_REGISTER_PLUGIN)
  • Pin latest dependency versions (sphinx 9.1, breathe 4.36, sphinx-rtd-theme 3.1)
  • Add .gitignore entries for docs build output (docs/doxygen/, docs/build/)
  • Add module docstring to conf.py for ruff D100 compliance
  • Code review
  • Security scan (8 pre-existing alerts in workflow files; none from this PR)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Update branch with latest main and enhance features Update Sphinx/Doxygen/Breathe docs: pin latest deps, fix config, expand API coverage Feb 13, 2026
Copilot AI requested a review from greenc-FNAL February 13, 2026 17:19
@greenc-FNAL
Copy link
Contributor

@copilot I think for maximum clarity, it would be better to reset this branch to upstream/main and then re-do the work following the current philosophy, functions/class structure, etc.

Copy link
Contributor Author

Copilot AI commented Feb 13, 2026

@copilot I think for maximum clarity, it would be better to reset this branch to upstream/main and then re-do the work following the current philosophy, functions/class structure, etc.

Done. In commit 412a5ec I reset the branch to main and removed all the stale files from the old base. In 0712ae9 I fixed the docs to match the current codebase (correct class names, macros, version).

The PR now shows only 13 files changed (135 additions, 0 deletions from main): the docs/ directory with Sphinx/Doxygen/Breathe configuration and API pages, plus .gitignore entries for docs build output.

@greenc-FNAL greenc-FNAL force-pushed the copilot/update-branch-with-main-again branch from 0712ae9 to 2095c80 Compare February 13, 2026 18:25
@greenc-FNAL greenc-FNAL changed the base branch from jules-feature-sphinx-doxygen-breathe-setup to main February 13, 2026 18:30
@greenc-FNAL greenc-FNAL marked this pull request as ready for review February 13, 2026 18:31
Copilot AI review requested due to automatic review settings February 13, 2026 18:31
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a Sphinx + Doxygen + Breathe documentation scaffold under docs/ to generate API reference documentation for key phlex::experimental types, along with dependency requirements and gitignore entries for generated outputs.

Changes:

  • Add Sphinx project entrypoint (index.rst) and minimal conf.py wired to Breathe.
  • Add API reference .rst pages for several phlex::experimental classes.
  • Add Doxygen configuration + Python requirements, and ignore generated docs artifacts in .gitignore.

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/source/index.rst Adds top-level Sphinx landing page and toctree for API pages.
docs/source/conf.py Adds Sphinx configuration with Breathe integration.
docs/source/api/graph_proxy.rst Adds API page for phlex::experimental::graph_proxy.
docs/source/api/framework_graph.rst Adds API page for framework_graph and layer_sentry.
docs/source/api/registrar.rst Adds API page for phlex::experimental::registrar.
docs/source/api/declared_transform.rst Adds API page for declared_transform.
docs/source/api/declared_fold.rst Adds API page for declared_fold.
docs/source/api/declared_unfold.rst Adds API page for declared_unfold.
docs/source/api/product_store.rst Adds API page for product_store.
docs/source/api/products.rst Adds API page for products.
docs/requirements.txt Adds Python dependencies for building docs.
docs/Doxyfile Adds Doxygen configuration to emit XML for Breathe.
.gitignore Ignores generated Doxygen/Sphinx build output directories.
Comments suppressed due to low confidence (1)

docs/requirements.txt:4

  • The PR description says dependencies are “pinned”, but requirements.txt uses version ranges (e.g., >=9.1,<10) which will allow new releases and can change doc build output over time. Either pin exact versions (e.g., ==...) to match the description, or update the description to reflect that these are minimum/compatible ranges. Also remove the trailing blank line at EOF to avoid generating a 4th empty requirement line.
sphinx>=9.1,<10
breathe>=4.36,<5
sphinx-rtd-theme>=3.1,<4

@greenc-FNAL
Copy link
Contributor

@phlexbot python-fix

@github-actions
Copy link
Contributor

Automatic ruff fixes pushed (commit af87c94).
⚠️ Note: Some issues may require manual review and fixing.

@codecov
Copy link

codecov bot commented Feb 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@            Coverage Diff             @@
##             main     #323      +/-   ##
==========================================
+ Coverage   82.26%   82.36%   +0.09%     
==========================================
  Files         127      127              
  Lines        3102     3102              
  Branches      547      547              
==========================================
+ Hits         2552     2555       +3     
  Misses        333      333              
+ Partials      217      214       -3     
Flag Coverage Δ
unittests 82.36% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 3 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 68c21c5...85a095f. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@greenc-FNAL greenc-FNAL force-pushed the copilot/update-branch-with-main-again branch from 824f679 to a7a5bf2 Compare February 14, 2026 00:18
@greenc-FNAL greenc-FNAL marked this pull request as draft February 14, 2026 01:19
@greenc-FNAL greenc-FNAL force-pushed the copilot/update-branch-with-main-again branch 2 times, most recently from dcbc52d to e416cbc Compare February 20, 2026 17:44
google-labs-jules bot and others added 4 commits February 24, 2026 10:32
…work

This commit introduces the foundational infrastructure for documenting the C++ codebase using a Sphinx, Doxygen, and Breathe toolchain.

Key changes include:
- A new `docs/` directory to house all documentation-related files.
- Configuration files for Sphinx (`conf.py`) and Doxygen (`Doxyfile`).
- A `requirements.txt` file listing the necessary Python dependencies for building the documentation.
- The `phlex/core/graph_proxy.hpp` header has been fully documented with Doxygen comments to serve as a style guide and working example.
- An initial Sphinx structure in `docs/source/` that integrates the Doxygen XML output via Breathe, making the `graph_proxy` documentation available on the documentation website.

Initial plan

Update docs: pin latest deps, fix version, expand API coverage, add .gitignore entries

Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>

Reset branch to main and re-apply docs-only changes

Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>

Fix docs for current codebase: correct version, class names, macros, and .gitignore

Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>
Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>
@greenc-FNAL greenc-FNAL force-pushed the copilot/update-branch-with-main-again branch from e416cbc to 85a095f Compare February 24, 2026 16:32
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