Skip to content

Add tutorials #8545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NelleV merged 9 commits into from
Apr 30, 2017
Merged

Add tutorials #8545

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a0afff3
first addition of tutorials folder
choldgraf Apr 27, 2017
6eb20da
converting tutorials to SG
choldgraf Apr 27, 2017
1a5f993
creating tutorials
choldgraf Apr 28, 2017
e4e1e18
numbering tutorial folders
choldgraf Apr 28, 2017
964ef5e
converting examples to tutorials and fixing numbering / links
choldgraf Apr 28, 2017
eaaa2b4
addressing comments and adding usage tutorial
choldgraf Apr 28, 2017
75a3ec7
fixing tutorial link
choldgraf Apr 28, 2017
0b2619c
adding links to rest of docs in examples/tutorials
choldgraf Apr 29, 2017
4e93fe4
adding sphinx gallery labels
choldgraf Apr 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
first addition of tutorials folder
  • Loading branch information
@choldgraf
choldgraf committed Apr 27, 2017
commit a0afff3f934838700ec2c147d7d5de14c00199a5
10 changes: 6 additions & 4 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
################
# setup.py working directory
build
# sphinx build directory
doc/_build
doc/gallery

# setup.py dist directory
dist
# Egg metadata
Expand All @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
4 changes: 2 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 8 additions & 0 deletions tutorials/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading