Skip to content

Commit 267fc43

Browse files
Copilotgreenc-FNAL
andcommitted
Fix Doxyfile paths for repo-root invocation; add phlex-namespace API docs (configuration, handle, concurrency)
Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>
1 parent 8e685d3 commit 267fc43

5 files changed

Lines changed: 35 additions & 3 deletions

File tree

docs/Doxyfile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ PROJECT_BRIEF = "A framework for parallel, hierarchical, and layered executi
66
QUIET = YES
77

88
# -- Input and output directories --------------------------------------------
9-
INPUT = ../phlex ../form
10-
OUTPUT_DIRECTORY = doxygen
9+
# Paths are relative to the repository root; invoke as: doxygen docs/Doxyfile
10+
INPUT = phlex form
11+
OUTPUT_DIRECTORY = docs/doxygen
1112
RECURSIVE = YES
1213

1314
# -- Output formats ----------------------------------------------------------

docs/source/api/concurrency.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
concurrency
2+
============
3+
4+
.. doxygenstruct:: phlex::concurrency
5+
:members:
6+
:undoc-members:

docs/source/api/configuration.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
configuration
2+
==============
3+
4+
.. doxygenclass:: phlex::configuration
5+
:members:
6+
:undoc-members:

docs/source/api/handle.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
handle
2+
=======
3+
4+
.. doxygenclass:: phlex::handle
5+
:members:
6+
:undoc-members:

docs/source/index.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,28 @@ Welcome to Phlex's documentation!
88

99
.. toctree::
1010
:maxdepth: 2
11-
:caption: Contents:
11+
:caption: Plugin entry points:
1212

1313
api/module_graph_proxy
1414
api/source_graph_proxy
1515
api/graph_proxy
1616
api/framework_graph
1717
api/registrar
18+
19+
.. toctree::
20+
:maxdepth: 2
21+
:caption: Algorithm nodes:
22+
1823
api/declared_transform
1924
api/declared_fold
2025
api/declared_unfold
26+
27+
.. toctree::
28+
:maxdepth: 2
29+
:caption: Data model:
30+
31+
api/configuration
32+
api/handle
33+
api/concurrency
2134
api/product_store
2235
api/products

0 commit comments

Comments
 (0)