Merge pull request #15 from enthought/feature/styles

Feature/styles
enthought · Aug 7, 2015 · 37fad9b · 37fad9b
2 parents 4537fb3 + 10fb219
commit 37fad9b
Show file tree

Hide file tree

Showing 52 changed files with 1,774 additions and 1,771 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,7 +1,7 @@
 This software is OSI Certified Open Source Software.
 OSI Certified is a certification mark of the Open Source Initiative.
 
-Copyright (c) 2006, Enthought, Inc.
+Copyright (c) 2012-2014, Enthought, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/README.rst b/README.rst
@@ -20,9 +20,11 @@ Key aims of **sectiondoc** are:
 
     - Do not change the order of sections.
     - Allow sphinx directives between (and inside) section blocks.
+    - Custom rendering styles
     - Easier to debug (native support for debugging) and extend
       (future versions).
 
+
 Repository
 ----------
 
@@ -35,14 +37,18 @@ using::
 Installation
 ------------
 
-1. Install ``sectiondoc`` from pypi using pip::
+Install ``sectiondoc`` from pypi using pip::
 
     $ pip install sectiondoc
 
-2. Add sectiondoc to the extensions variable of your sphinx ``conf.py``::
+Usage
+-----
+
+
+Styles can be selected by referencing in ``conf.py`` the module they are defined::
 
     extensions = [
         ...,
-        'sectiondoc',
+        'sectiondoc.styles.legacy',
         ...,
     ]
diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst
diff --git a/docs/source/components.rst b/docs/source/components.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,10 +29,11 @@
 extensions = ['sectiondoc',
               'sphinx.ext.intersphinx',
               'sphinx.ext.todo',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode',
+              'sphinx.ext.autosummary']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = []
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -60,11 +61,14 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+autodoc_member_order = 'groupwise'
+autoclass_content = 'both'
+
 # -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'alabaster'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'SectionDocdoc'

diff --git a/docs/source/extending.rst b/docs/source/extending.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,12 +6,10 @@ Contents
 ========
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
-    usage
-    architecture
-    components
-    extending
+    rendering
+    styles
     reference
     authors
     todo
@@ -25,4 +23,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-