Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MRG: Update docs #279

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
merged 8 commits into from
Aug 3, 2017
Merged

MRG: Update docs #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8807bce
WIP: Update docs
larsoner Jul 31, 2017
3361d65
FIX: Use refs not links
larsoner Jul 31, 2017
62aeee1
FIX: Many fixes
larsoner Jul 31, 2017
f697e54
FIX: Fix typos
larsoner Jul 31, 2017
49bb6ef
FIX: Fix doc
larsoner Jul 31, 2017
ea0a6bd
ENH: Add better header doc
larsoner Aug 1, 2017
38e3cba
FIX: Add missing entry
larsoner Aug 1, 2017
6cc9718
FIX: Fix links
larsoner Aug 1, 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
35 changes: 21 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=================================
Getting Started to Sphinx-Gallery
=================================
===================================
Getting Started with Sphinx-Gallery
===================================

.. image:: https://travis-ci.org/sphinx-gallery/sphinx-gallery.svg?branch=master
:target: https://travis-ci.org/sphinx-gallery/sphinx-gallery
Expand Down Expand Up @@ -34,11 +34,14 @@ Who uses Sphinx-Gallery
* `scikit-image <http://scikit-image.org/docs/dev/auto_examples/>`_
* `Astropy <http://docs.astropy.org/en/stable/generated/examples/index.html>`_
* `SunPy <http://docs.sunpy.org/en/stable/generated/gallery/index.html>`_
* `PySurfer <https://pysurfer.github.io/>`_

Getting the package
===================

You can do a direct install via pip by using::
You can do a direct install via pip by using:

.. code-block:: bash

$ pip install sphinx-gallery

Expand All @@ -64,7 +67,9 @@ You can get the latest development source from our `Github repository

You will also need to install the dependencies listed above and `pytest`

To install everything do::
To install everything do:

.. code-block:: bash

$ git clone https://github.com/sphinx-gallery/sphinx-gallery
$ cd sphinx-gallery
Expand Down Expand Up @@ -103,9 +108,7 @@ structure you get from executing ``sphinx-quickstart``.


To get Sphinx-Gallery into your project we have to extend the Sphinx
``doc/conf.py`` file with:

.. code-block:: python
``doc/conf.py`` file with::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just curious. Why do you make bash code blocks now explicit, make the python blocks now un-explicit?


extensions = [
...
Expand All @@ -117,9 +120,7 @@ This is to load Sphinx-Gallery as one of your extensions, the ellipsis

Now to declare your project structure, we add a configuration
dictionary for Sphinx-Gallery. The examples directory ``../examples``
is declared with a relative path from the ``conf.py`` file location.

.. code-block:: python
is declared with a relative path from the ``conf.py`` file location::

sphinx_gallery_conf = {
# path to your examples scripts
Expand Down Expand Up @@ -157,15 +158,19 @@ files.
Building the documentation locally
----------------------------------

In your sphinx documentation directory, ``doc`` execute::
In your sphinx documentation directory, ``doc`` execute:

.. code-block:: bash

$ make html

This will start the build of your complete documentation including the examples
gallery. Once documentation is build, our extension will have generated an ``auto_examples``
directory and populated it with rst files containing the gallery and each example.
Sphinx gives this files its regular processing and you can enjoy your
generated gallery under the same path. That means you will find the gallery in the path::
generated gallery under the same path. That means you will find the gallery in the path:

.. code-block:: bash

_build/html/auto_examples/index.html

Expand All @@ -181,7 +186,9 @@ Extending your Makefile
-----------------------
Once your gallery is working you might need remove completely all generated files by
sphinx-gallery to have a clean build, or you might want to build the gallery without
running the examples files. For this you need to extend your ``Makefile`` with::
running the examples files. For this you need to extend your ``Makefile`` with:

.. code-block:: bash

clean:
rm -rf $(BUILDDIR)/*
Expand Down
Loading