-
Notifications
You must be signed in to change notification settings - Fork 10
Add Sphinx/Doxygen/Breathe documentation framework for 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
75276df
dbf55fc
b5ba110
466cbc4
9e6ef75
3b11ebf
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,28 @@ | ||
| # 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 -------------------------------------------- | ||
| INPUT = ../phlex ../form | ||
| OUTPUT_DIRECTORY = 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 |
| 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 @@ | ||
| 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 = [] | ||
|
|
||
| # -- 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" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| .. 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: Contents: | ||
|
|
||
| api/module_graph_proxy | ||
| api/source_graph_proxy | ||
| api/graph_proxy | ||
| api/framework_graph | ||
| api/registrar | ||
| api/declared_transform | ||
| api/declared_fold | ||
| api/declared_unfold | ||
| api/product_store | ||
| api/products |
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.
INPUTandOUTPUT_DIRECTORYare written as relative paths that only work if Doxygen is invoked fromdocs/(e.g.,cd docs && doxygen Doxyfile). If someone runsdoxygen docs/Doxyfilefrom the repo root (a common invocation),../phlex/../formwill point outside the repo and the XML will be written to<repo>/doxygen/, which won’t match the Sphinx Breathe path or the.gitignoreentries. Consider making these paths robust to the invocation working directory (e.g., repo-root-relative paths) or add a documented wrapper/Makefile target that enforces running fromdocs/.