Skip to content

Commit 7658e17

Browse files
committed
doc: number sections, add titles for modifiers
1 parent 313b630 commit 7658e17

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ It might be of use in computer vision, machine learning and other data science d
2525
or become the core of a custom ETL pipelne.
2626

2727
.. toctree::
28-
:maxdepth: 2
28+
:maxdepth: 3
29+
:numbered:
2930

3031
operations
3132
composition

docs/source/operations.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,5 +137,11 @@ Modifiers on ``operation`` inputs and outputs
137137

138138
Certain modifiers are available to apply to input or output values in ``needs`` and ``provides``, for example to designate an optional input. These modifiers are available in the ``graphkit.modifiers`` module:
139139

140+
141+
Optionals
142+
^^^^^^^^^
140143
.. autoclass:: graphkit.modifiers.optional
144+
145+
Sideffects
146+
^^^^^^^^^^
141147
.. autoclass:: graphkit.modifiers.sideffect

docs/source/reference.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
API Reference
33
=============
44

5+
Package: `graphkit`
6+
===================
7+
8+
.. automodule:: graphkit
9+
510
Module: `base`
611
==============
712

0 commit comments

Comments
 (0)