Start documentation

alfred82santa · Aug 13, 2014 · ee0eeb6 · ee0eeb6
1 parent 73d117c
commit ee0eeb6
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,6 +21,9 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
 
+dirty_filters_path = os.path.join(os.path.dirname(__file__), '..', '..')
+sys.path.insert(0, dirty_filters_path)
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -340,3 +343,6 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
+
+autodoc_member_order = 'bysource'
+
diff --git a/docs/source/dirty_filters.rst b/docs/source/dirty_filters.rst
@@ -0,0 +1,12 @@
+Dirty Filters package
+====================
+
+Main filters
+
+Filters
+-------
+
+.. automodule:: dirty_filters
+    :members:
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,6 +11,10 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   dirty_filters.rst
+
+.. include:: ../../README.rst
+
 
 
 Indices and tables