A few more documentation/example

docs/source/conf.py

@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.spelling']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/source/index.rst

@@ -23,10 +23,11 @@ It is easy to obtain the latest released version via ``pip``::
 
     pip install steinlib
 
-Usage
-=====
+Basic Usage
+============
 
 In order to use the parsed structures, two main components are required:
+
  - A *parser*, that will be responsible for parsing the structure, and;
  - A *instance*, where the parser will invoke callbacks when known structures are found
 
@@ -35,8 +36,10 @@ So, let's see an example about how it works.
 Starting with an STP file available on Steinlib official website:
 
  .. literalinclude:: ../../examples/hello.stp
+    :linenos:
 
 It is possible to observe this file contains three main components:
+
  - a **header line**;
  - a set of delimited **sections** and;
  - the **end of file** marker.
@@ -45,4 +48,15 @@ This *parser* will identify all these small pieces of the STP file and use it to
 trigger functions on your *instance*. This is the key concept used to create
 this module.
 
+The script below provides some initial examples about how these ``callback`` methods
+works:
+
+ .. literalinclude:: ../../examples/hello_steinlib.py
+    :linenos:
+
+For each identified structure, the appropriate method will be called in the *instance*
+object, with the standard parameters:
+
+ - ``raw_args`` is the actual full line from the input stream
+ - ``list_args`` contains the extracted and converted parameters from the current line
 

examples/hello_steinlib.py

@@ -11,9 +11,12 @@ class MySteinlibInstance(SteinlibInstance):
     This is my first steinlib parser!
     """
 
-    def comment(self, raw_args, lis_args):
+    def comment(self, raw_args, list_args):
         print "Comment section found"
 
+    def comment__end(self, raw_args, list_args):
+        print "Comment section end"
+
     def coordinates(self, raw_args, list_args):
         print "Coordinates section found"
 
@@ -35,3 +38,4 @@ def terminals(self, raw_args, list_args):
     with open(sys.argv[1]) as my_file:
         my_parser = SteinlibParser(my_file, my_class)
         my_parser.parse()
+