-
Notifications
You must be signed in to change notification settings - Fork 12
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
base: main
Are you sure you want to change the base?
Changes from all commits
afbc2a7
23f126a
ea927fb
4dc2b20
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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(...)=" | ||
| 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 | ||
|
Comment on lines
+1
to
+3
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| concurrency | ||
| ============ | ||
|
|
||
| .. doxygenstruct:: phlex::concurrency | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| configuration | ||
| ============== | ||
|
|
||
| .. doxygenclass:: phlex::configuration | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| declared_fold | ||
| ============== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::declared_fold | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| declared_transform | ||
| =================== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::declared_transform | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| declared_unfold | ||
| ================ | ||
|
|
||
| .. doxygenclass:: phlex::experimental::declared_unfold | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| framework_graph | ||
| ================ | ||
|
|
||
| .. doxygenclass:: phlex::experimental::framework_graph | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| graph_proxy | ||
| ============= | ||
|
|
||
| .. doxygenclass:: phlex::experimental::graph_proxy | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| handle | ||
| ======= | ||
|
|
||
| .. doxygenclass:: phlex::handle | ||
| :members: | ||
| :undoc-members: | ||
|
Comment on lines
+4
to
+6
|
||
| 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: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| product_store | ||
| ============== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::product_store | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| products | ||
| ========= | ||
|
|
||
| .. doxygenclass:: phlex::experimental::products | ||
| :members: | ||
| :undoc-members: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| registrar | ||
| ========== | ||
|
|
||
| .. doxygenclass:: phlex::experimental::registrar | ||
| :members: | ||
| :undoc-members: |
| 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: |
| 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 = ["_templates"] | ||
| exclude_patterns = [] | ||
|
Comment on lines
+17
to
+18
|
||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
|
|
||
| html_theme = "sphinx_rtd_theme" | ||
|
|
||
| # -- Breathe configuration ------------------------------------------------- | ||
|
|
||
| breathe_projects = { | ||
| "Phlex": "../doxygen/xml/", | ||
| } | ||
|
Comment on lines
+26
to
+28
|
||
| breathe_default_project = "Phlex" | ||
|
Comment on lines
+26
to
+29
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| .. Phlex documentation master file, created by | ||
| sphinx-quickstart on Tue Nov 15 14:29:55 2025. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
|
|
||
| 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 | ||
|
Comment on lines
+31
to
+35
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There appears to be an extra blank line at EOF in this newly added file (after the
PREDEFINEDblock). Repo text-file formatting guidelines require the file to end with exactly one newline and no trailing blank line; remove the final empty line.