-
Notifications
You must be signed in to change notification settings - Fork 14
Add Sphinx/Doxygen/Breathe documentation framework for phlex and phlex::experimental API #323
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
6
commits into
main
Choose a base branch
from
copilot/update-branch-with-main-again
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5bef164
feature: Add initial Sphinx, Doxygen, and Breathe documentation frame…
google-labs-jules[bot] 2680b86
Remove layer_sentry reference (class no longer exists in codebase)
Copilot 101bf0a
Add module_graph_proxy and source_graph_proxy API pages (new user-fac…
Copilot 7ab18e8
Fix Doxyfile paths for repo-root invocation; add phlex-namespace API …
Copilot 1722c43
Remove nonexistent _templates path from Sphinx conf.py
Copilot b4afc05
Remove `sphinx-quickstart` boilerplate
greenc-FNAL File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Doxyfile | ||
|
|
||
| # -- Project settings -------------------------------------------------------- | ||
| PROJECT_NAME = "Phlex" | ||
| PROJECT_BRIEF = "A framework for parallel, hierarchical, and layered execution of data-processing algorithms" | ||
| QUIET = YES | ||
|
|
||
| # -- Input and output directories -------------------------------------------- | ||
| # Paths are relative to the repository root; invoke as: doxygen docs/Doxyfile | ||
| INPUT = phlex form | ||
| OUTPUT_DIRECTORY = docs/doxygen | ||
| RECURSIVE = YES | ||
|
|
||
| # -- Output formats ---------------------------------------------------------- | ||
| GENERATE_HTML = NO | ||
| GENERATE_LATEX = NO | ||
| GENERATE_XML = YES | ||
| XML_OUTPUT = xml | ||
|
|
||
| # -- Source code parsing ----------------------------------------------------- | ||
| EXTRACT_ALL = YES | ||
| WARN_IF_UNDOCUMENTED = NO | ||
| ENABLE_PREPROCESSING = YES | ||
| MACRO_EXPANSION = YES | ||
| FILE_PATTERNS = *.hpp *.cpp | ||
| EXCLUDE_PATTERNS = */detail/* | ||
| # Help Doxygen with some of the more complex macros | ||
| PREDEFINED = "BOOST_DLL_ALIAS(a,b)=" \ | ||
| "PHLEX_DETAIL_REGISTER_PLUGIN(...)=" | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| sphinx>=9.1,<10 | ||
| breathe>=4.36,<5 | ||
| sphinx-rtd-theme>=3.1,<4 | ||
greenc-FNAL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| concurrency | ||
| ============ | ||
|
|
||
| .. doxygenstruct:: phlex::concurrency | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| configuration | ||
| ============== | ||
|
|
||
| .. doxygenclass:: phlex::configuration | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| declared_fold | ||
| ============== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::declared_fold | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| declared_transform | ||
| =================== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::declared_transform | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| declared_unfold | ||
| ================ | ||
|
|
||
| .. doxygenclass:: phlex::experimental::declared_unfold | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| framework_graph | ||
| ================ | ||
|
|
||
| .. doxygenclass:: phlex::experimental::framework_graph | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| graph_proxy | ||
| ============= | ||
|
|
||
| .. doxygenclass:: phlex::experimental::graph_proxy | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| handle | ||
| ======= | ||
|
|
||
| .. doxygenclass:: phlex::handle | ||
| :members: | ||
| :undoc-members: | ||
greenc-FNAL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| module_graph_proxy | ||
| =================== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::module_graph_proxy | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| product_store | ||
| ============== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::product_store | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| products | ||
| ========= | ||
|
|
||
| .. doxygenclass:: phlex::experimental::products | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| registrar | ||
| ========== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::registrar | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| source_graph_proxy | ||
| =================== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::source_graph_proxy | ||
| :members: | ||
| :undoc-members: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # mypy: ignore-errors | ||
| """Sphinx configuration for Phlex documentation.""" | ||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| project = "Phlex" | ||
| copyright = "2025-2026, The Phlex Developers" | ||
| author = "The Phlex Developers" | ||
| release = "0.1.0" | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
|
|
||
| extensions = [ | ||
| "breathe", | ||
| ] | ||
|
|
||
| templates_path = [] | ||
| exclude_patterns = [] | ||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
|
|
||
| html_theme = "sphinx_rtd_theme" | ||
|
|
||
| # -- Breathe configuration ------------------------------------------------- | ||
|
|
||
| breathe_projects = { | ||
| "Phlex": "../doxygen/xml/", | ||
| } | ||
greenc-FNAL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| breathe_default_project = "Phlex" | ||
greenc-FNAL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| Welcome to Phlex's documentation! | ||
| ================================== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Plugin entry points: | ||
|
|
||
| api/module_graph_proxy | ||
| api/source_graph_proxy | ||
| api/graph_proxy | ||
| api/framework_graph | ||
| api/registrar | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Algorithm nodes: | ||
|
|
||
| api/declared_transform | ||
| api/declared_fold | ||
| api/declared_unfold | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Data model: | ||
|
|
||
| api/configuration | ||
| api/handle | ||
| api/concurrency | ||
| api/product_store | ||
| api/products | ||
greenc-FNAL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.