Skip to content

Commit 88c68e9

Browse files
committed
fix(doc): reorder chapters, changes at the bottom, ...
+ homegine titles + fix: autodoc renders nothing without :special-members:
1 parent 3089071 commit 88c68e9

File tree

4 files changed

+8
-6
lines changed

4 files changed

+8
-6
lines changed

CHANGES.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
##################
2-
Graphkit Changelog
3-
##################
1+
#########
2+
Changelog
3+
#########
44

55
v1.3.0 (Oct 2019): New DAG solver, better plotting & "sideffect"
66
================================================================

docs/source/graph_composition.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _graph-composition:
22

3-
Graph Composition and Use
4-
=========================
3+
Graph Composition
4+
=================
55

66
GraphKit's ``compose`` class handles the work of tying together ``operation`` instances into a runnable computation graph.
77

@@ -12,6 +12,7 @@ For now, here's the specification of ``compose``. We'll get into how to use it
1212

1313
.. autoclass:: graphkit.compose
1414
:members: __call__
15+
:special-members:
1516

1617

1718
.. _simple-graph-composition:

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Such graphs are useful in computer vision, machine learning, and many other doma
2828

2929
operations
3030
graph_composition
31-
changes
3231
reference
32+
changes
3333

3434

3535
.. _quick-start:

docs/source/operations.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ There are many ways to instantiate an ``operation``, and we'll get into more det
1313
.. autoclass:: graphkit.operation
1414
:members: __init__, __call__
1515
:member-order: bysource
16+
:special-members:
1617

1718

1819
Operations are just functions

0 commit comments

Comments
 (0)