prettyfied readme

nlgranger · Jun 19, 2018 · 81dd40a · 81dd40a
1 parent fcd3ceb
commit 81dd40a
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 12 deletions.
diff --git a/README.rst b/README.rst
@@ -84,12 +84,35 @@ Batteries included!
 -------------------
 
 The library comes with a set of helper functions to help manipulate sequences:
-`concatenation <http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.concatenate>`_,
-`batching <http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.batch>`_,
-`reindexing <http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.gather>`_,
-`interleaving <http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.interleave>`_,
-`prefetching <http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.prefetch>`_
-and others (suggestions are also welcome).
+
+.. |concatenate| image:: docs/concatenate.png
+
+.. _concatenation: http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.concatenate
+
+.. |batch| image:: docs/batch.png
+
+.. _batching: http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.batch>
+
+.. |gather| image:: docs/gather.png
+
+.. _reindexing: http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.gather
+
+.. |prefetch| image:: docs/prefetch.png
+
+.. _prefetching: http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.prefetch
+
+.. |interleaving| image:: docs/interleaving.png
+
+.. _interleaving: http://seqtools-doc.readthedocs.io/en/stable/reference.html#seqtools.interleave
+
+==================== ================= ===============
+| |concatenate|      | |batch|         | |gather|
+| `concatenation`_   | `batching`_     | `reindexing`_
+| |prefetch|         | |interleaving|
+| `prefetching`_     | `interleaving`_
+==================== ================= ===============
+
+... and others (suggestions are also welcome).
 
 
 Installation

diff --git a/docs/index.rst b/docs/index.rst
@@ -89,12 +89,35 @@ Batteries included!
 -------------------
 
 The library comes with a set of helper functions to help manipulate sequences:
-`concatenation <reference.html#seqtools.concatenate>`_,
-`batching <reference.html#seqtools.batch>`_,
-`reindexing <reference.html#seqtools.gather>`_,
-`interleaving <reference.html#seqtools.interleave>`_,
-`prefetching <reference.html#seqtools.prefetch>`_
-and others (suggestions are also welcome).
+
+.. |concatenate| image:: concatenate.png
+
+.. _concatenation: reference.html#seqtools.concatenate
+
+.. |batch| image:: batch.png
+
+.. _batching: reference.html#seqtools.batch
+
+.. |gather| image:: gather.png
+
+.. _reindexing: reference.html#seqtools.gather
+
+.. |prefetch| image:: prefetch.png
+
+.. _prefetching: reference.html#seqtools.prefetch
+
+.. |interleaving| image:: interleaving.png
+
+.. _interleaving: reference.html#seqtools.interleave
+
+==================== ================= ===============
+| |concatenate|      | |batch|         | |gather|
+| `concatenation`_   | `batching`_     | `reindexing`_
+| |prefetch|         | |interleaving|
+| `prefetching`_     | `interleaving`_
+==================== ================= ===============
+
+... and others (suggestions are also welcome).
 
 
 Similar libraries