first addition of tutorials folder

pllim · Apr 27, 2017 · a0afff3 · a0afff3
1 parent 8149536
commit a0afff3
Show file tree

Hide file tree

Showing 5 changed files with 364 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,9 +30,7 @@
 ################
 # setup.py working directory
 build
-# sphinx build directory
-doc/_build
-doc/gallery
+
 # setup.py dist directory
 dist
 # Egg metadata
@@ -58,9 +56,13 @@ lib/matplotlib/mpl-data/matplotlibrc
 
 # Documentation generated files #
 #################################
+# sphinx build directory
+doc/_build
 doc/api/_as_gen
-doc/examples
 # autogenerated by sphinx-gallery
+doc/examples
+doc/gallery
+doc/tutorials
 doc/modules
 doc/pyplots/tex_demo.png
 doc/users/installing.rst

diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -39,6 +39,7 @@ <h3>{{ _('Navigation') }}</h3>
 
         <li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
         <li><a href="{{ pathto('gallery/index') }}">examples</a>|&nbsp;</li>
+        <li><a href="{{ pathto('tutorials/index') }}">tutorials</a>|&nbsp;</li>
         <li><a href="{{ pathto('api/pyplot_summary') }}">pyplot</a>|&nbsp;</li>
         <li><a href="{{ pathto('contents') }}">docs</a> &raquo;</li>
 

diff --git a/doc/conf.py b/doc/conf.py
@@ -105,9 +105,9 @@
 
 # Sphinx gallery configuration
 sphinx_gallery_conf = {
-    'examples_dirs': '../examples',
+    'examples_dirs': ['../examples', '../tutorials'],
     'filename_pattern': '^((?!sgskip).)*$',
-    'gallery_dirs': 'gallery',
+    'gallery_dirs': ['gallery', 'tutorials'],
     'doc_module': ('matplotlib',),
     'reference_url': {'matplotlib': None,
                       'numpy': 'http://docs.scipy.org/doc/numpy/reference',

diff --git a/tutorials/README.txt b/tutorials/README.txt
@@ -0,0 +1,8 @@
+.. _tutorials:
+
+Tutorials
+=========
+
+These tutorials cover the basics of creating visualizations with
+Matplotlib, as well as some best-practices in using the package
+effectively.