Skip to content
This repository has been archived by the owner on Jun 28, 2021. It is now read-only.

Commit

Permalink
Merge pull request #1 from weber-s/patch-1
Browse files Browse the repository at this point in the history
Update getting_started.rst
  • Loading branch information
Chilipp committed Apr 18, 2018
2 parents 5b23cb3 + 83c3f3d commit 7512866
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,16 @@ important features since we convert the notebook to a single html page:

Choosing the examples
---------------------
The three keywords ``'examples_dirs', 'gallery_dirs'``, and ``'pattern'`` can
The three keywords ``'examples_dirs'``, ``'gallery_dirs'``, and ``'pattern'`` can
be used to select which notebooks shall be converted. The value for
``'example_dirs'`` is the path to the directory where your raw jupyter
``'examples_dirs'`` is the path to the directory where your raw jupyter
notebooks are located. The ``'gallery_dirs'`` key on the other hand will point
to the directories where the converted notebooks will be. You can also provide
a list of example directories to create multiple galleries.

Finally the ``'pattern'`` corresponds to the filename pattern for the example
notebooks. Using the default pattern (``'example_.+.ipynb'``) implies, that
all your notebooks in the ``'example_dirs'`` starts with ``'example_'``
all your notebooks in the ``'examples_dirs'`` starts with ``'example_'``


.. _preprocessing:
Expand Down

0 comments on commit 7512866

Please sign in to comment.