From 88c68e9259e7bc99384a52f8fa04a5f4d1921b04 Mon Sep 17 00:00:00 2001 From: Kostis Anagnostopoulos Date: Fri, 11 Oct 2019 06:55:26 +0300 Subject: [PATCH] fix(doc): reorder chapters, changes at the bottom, ... + homegine titles + fix: autodoc renders nothing without :special-members: --- CHANGES.rst | 6 +++--- docs/source/graph_composition.rst | 5 +++-- docs/source/index.rst | 2 +- docs/source/operations.rst | 1 + 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 9fb59db2..381f3338 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,6 @@ -################## -Graphkit Changelog -################## +######### +Changelog +######### v1.3.0 (Oct 2019): New DAG solver, better plotting & "sideffect" ================================================================ diff --git a/docs/source/graph_composition.rst b/docs/source/graph_composition.rst index 2e067130..6b7d062d 100644 --- a/docs/source/graph_composition.rst +++ b/docs/source/graph_composition.rst @@ -1,7 +1,7 @@ .. _graph-composition: -Graph Composition and Use -========================= +Graph Composition +================= GraphKit's ``compose`` class handles the work of tying together ``operation`` instances into a runnable computation graph. @@ -12,6 +12,7 @@ For now, here's the specification of ``compose``. We'll get into how to use it .. autoclass:: graphkit.compose :members: __call__ + :special-members: .. _simple-graph-composition: diff --git a/docs/source/index.rst b/docs/source/index.rst index f96b03e2..aa4b234a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,8 +28,8 @@ Such graphs are useful in computer vision, machine learning, and many other doma operations graph_composition - changes reference + changes .. _quick-start: diff --git a/docs/source/operations.rst b/docs/source/operations.rst index 0376a7a1..cde5ca42 100644 --- a/docs/source/operations.rst +++ b/docs/source/operations.rst @@ -13,6 +13,7 @@ There are many ways to instantiate an ``operation``, and we'll get into more det .. autoclass:: graphkit.operation :members: __init__, __call__ :member-order: bysource + :special-members: Operations are just functions