Skip to content

Commit a0afff3

Browse files
committed
first addition of tutorials folder
1 parent 8149536 commit a0afff3

File tree

5 files changed

+364
-6
lines changed

5 files changed

+364
-6
lines changed

.gitignore

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@
3030
################
3131
# setup.py working directory
3232
build
33-
# sphinx build directory
34-
doc/_build
35-
doc/gallery
33+
3634
# setup.py dist directory
3735
dist
3836
# Egg metadata
@@ -58,9 +56,13 @@ lib/matplotlib/mpl-data/matplotlibrc
5856

5957
# Documentation generated files #
6058
#################################
59+
# sphinx build directory
60+
doc/_build
6161
doc/api/_as_gen
62-
doc/examples
6362
# autogenerated by sphinx-gallery
63+
doc/examples
64+
doc/gallery
65+
doc/tutorials
6466
doc/modules
6567
doc/pyplots/tex_demo.png
6668
doc/users/installing.rst

doc/_templates/layout.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ <h3>{{ _('Navigation') }}</h3>
3939

4040
<li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
4141
<li><a href="{{ pathto('gallery/index') }}">examples</a>|&nbsp;</li>
42+
<li><a href="{{ pathto('tutorials/index') }}">tutorials</a>|&nbsp;</li>
4243
<li><a href="{{ pathto('api/pyplot_summary') }}">pyplot</a>|&nbsp;</li>
4344
<li><a href="{{ pathto('contents') }}">docs</a> &raquo;</li>
4445

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@
105105

106106
# Sphinx gallery configuration
107107
sphinx_gallery_conf = {
108-
'examples_dirs': '../examples',
108+
'examples_dirs': ['../examples', '../tutorials'],
109109
'filename_pattern': '^((?!sgskip).)*$',
110-
'gallery_dirs': 'gallery',
110+
'gallery_dirs': ['gallery', 'tutorials'],
111111
'doc_module': ('matplotlib',),
112112
'reference_url': {'matplotlib': None,
113113
'numpy': 'http://docs.scipy.org/doc/numpy/reference',

tutorials/README.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _tutorials:
2+
3+
Tutorials
4+
=========
5+
6+
These tutorials cover the basics of creating visualizations with
7+
Matplotlib, as well as some best-practices in using the package
8+
effectively.

0 commit comments

Comments
 (0)