Changeset 226

Timestamp:

07/16/2010 03:52:03 PM (13 years ago)

Author:

marcus

Message:

Working on documentation.

Location:

SHX/trunk/src/docs

Files:

• conf.py (modified) (1 diff)
• index.rst (modified) (1 diff)

SHX/trunk/src/docs/conf.py

@@ -25 +25 @@
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage',
-'sphinx.ext.pngmath', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig',
-'numpydoc']
+'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'numpydoc',
+'sphinx.ext.autosummary']
 
 # Add any paths that contain templates here, relative to this directory.

SHX/trunk/src/docs/index.rst

@@ -1 @@
-.. Seismic Handler eXtended documentation master file, created by
-   sphinx-quickstart on Fri Jul  9 13:07:08 2010.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Welcome to Seismic Handler's documentation!
+===========================================
 
-Welcome to Seismic Handler eXtended's documentation!
-====================================================
+.. warning::
+    This documentation is automatically generated. Since Seismic Handler
+    is under heavy development, anything can change now and then without
+    notice.
+
+.. note::
+    Please subscribe to the `developer mailing list
+    <http://list.seismic-handler.org/mailman/listinfo/devel>`_ for
+    contacting the developers.
 
 Contents:
+---------
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 1
+
+.. automodule:: SeismicHandler.commands.echo
+
+.. autoclass:: echo
+    :members:
 
 Indices and tables