Commits

Artur Barseghyan  committed 7caf555 Draft

updated docs

  • Participants
  • Parent commits e837c6a

Comments (0)

Files changed (4)

File docs/_static/sirep_report.png

Added
New image

File docs/conf.py

 # built documents.
 #
 # The short X.Y version.
-version = '2.0'
+version = '0.4'
 # The full version, including alpha/beta/rc tags.
-release = '2.0'
+release = '0.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

File docs/index.rst

 
 Usage examples
 --------------------
+It might be just as easy to check the source code (example directory), since it works out of the box (to get
+an idea of what it is):
+
+    https://bitbucket.org/barseghyanartur/sirep/src
+
+Sample report view:
+
+.. image:: _static/sirep_report.png
+    :width: 960px
+    :align: center
+
 Sample model module (file `test_package/models.py`):
 
     >>> class TestModel(models.Model):
 static_dir = "src/sirep/static"
 static_files = [os.path.join(static_dir, f) for f in os.listdir(static_dir)]
 
-version = '0.3'
+version = '0.4'
 
 setup(
     name='sirep',