a little bit of documentation for text_to_cell

timo · Oct 2, 2012 · 1543e05 · 1543e05
1 parent d8cc469
commit 1543e05
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -136,6 +136,7 @@ API Documentation
    cagen
    gui
    elementarytools
+   zacformat
 
 Indices and tables
 ==================

diff --git a/docs/zacformat.rst b/docs/zacformat.rst
@@ -0,0 +1,14 @@
+:mod:`zasim.zacformat` - text_to_cell Interop
+=============================================
+
+`Text to Cell <http://github.com/timo/text_to_cell/>`_ is a piece of Software
+developed by Tobias Maier. It takes a high-level description of a cellular
+automaton as input and outputs different formats. One of them is made for
+interoperability with zasim. It can be loaded and simulated with a
+`~zasim.zacformat.ZacSimulator` and its data can be displayed with a
+`~zasim.zacformat.ZacConsoleDisplay`.
+
+.. inheritance-diagram:: zasim.zacformat
+    :parts: 2
+
+.. automodule:: zasim.zacformat