Skip to content

Commit

Permalink
fix(doc): reorder chapters, changes at the bottom, ...
Browse files Browse the repository at this point in the history
+ homegine titles
+ fix: autodoc renders nothing without :special-members:
  • Loading branch information
ankostis committed Oct 11, 2019
1 parent 3089071 commit 88c68e9
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
##################
Graphkit Changelog
##################
#########
Changelog
#########

v1.3.0 (Oct 2019): New DAG solver, better plotting & "sideffect"
================================================================
Expand Down
5 changes: 3 additions & 2 deletions docs/source/graph_composition.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/source/operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 88c68e9

Please sign in to comment.