Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.09 KB

index.rst

File metadata and controls

40 lines (30 loc) · 1.09 KB

sampledoc tutorial

This is a tutorial introduction to quickly get you up and running with your own sphinx documentation system. We'll cover installing sphinx, customizing the look and feel, using custom extensions for embedding plots, inheritance diagrams, syntax highlighted ipython sessions and more. If you follow along the tutorial, you'll start with nothing and end up with this site -- it's the bootstrapping documentation tutorial that writes itself!

The source code for this tutorial lives in mpl git (see :ref:`fetching-the-data`).

.. only:: html

    You can also grab a hardcopy of the `sampledoc PDF <sampledoc.pdf>`_

.. toctree::
   :maxdepth: 2

   getting_started.rst
   custom_look.rst
   extensions.rst
   ipython_directive.rst
   cheatsheet.rst
   emacs_help.rst

Indices and tables