Revision: 7458
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=7458&view=rev
Author: jdh2358
Date: 2009-08-11 11:24:27 +0000 (Tue, 11 Aug 2009)
Log Message:
-----------
rename extensions
Modified Paths:
--------------
trunk/py4science/examples/sphinx_qs/index.rst
Added Paths:
-----------
trunk/py4science/examples/sphinx_qs/extensions.rst
Removed Paths:
-------------
trunk/py4science/examples/sphinx_qs/sphinx_extensions.rst
Copied: trunk/py4science/examples/sphinx_qs/extensions.rst (from rev 7457,
trunk/py4science/examples/sphinx_qs/sphinx_extensions.rst)
===================================================================
--- trunk/py4science/examples/sphinx_qs/extensions.rst
(rev 0)
+++ trunk/py4science/examples/sphinx_qs/extensions.rst 2009-08-11 11:24:27 UTC
(rev 7458)
@@ -0,0 +1,154 @@
+.. _extensions:
+
+
+****************************************************
+Sphinx extensions for embedded plots, math and more
+****************************************************
+
+Sphinx is written in python, and supports the ability to write custom
+extensions. We've written a few for the matplotlib documentation,
+some of which are part of matplotlib itself in the
+matplotlib.sphinxext module, some of which are included only in the
+sphinx doc directory, and there are other extensions written by other
+groups, eg numpy and ipython. We're collecting these in this tutorial
+and showing you how to install and use them for your own project.
+First let's grab the python extension files from the :file:`sphinxext`
+directory from svn (see :ref:`getting-the-data`, and install them in
+our :file:`py4sci` project :file:`sphinxext` directory::
+
+ home:~/tmp/py4sci> mkdir sphinxext
+ home:~/tmp/py4sci> cp ../sphinx_qs/sphinxext/*.py sphinxext/
+ home:~/tmp/py4sci> ls sphinxext/
+ apigen.py inheritance_diagram.py
+ docscrape.py ipython_console_highlighting.py
+ docscrape_sphinx.py numpydoc.py
+
+In addition to the builtin matplotlib extensions for embedding pyplot
+plots and rendering math with matplotlib's native math engine, we also
+have extensions for syntax highlighting ipython sessions, making
+inhertiance diagrams, and more.
+
+We need to inform sphinx of our new extensions in the :file:`conf.py`
+file by adding the following. First we tell it where to find the extensions::
+
+ # If your extensions are in another directory, add it here. If the
+ # directory is relative to the documentation root, use
+ # os.path.abspath to make it absolute, like shown here.
+ sys.path.append(os.path.abspath('sphinxext'))
+
+And then we tell it what extensions to load::
+
+ # Add any Sphinx extension module names here, as strings. They can
+ # be extensions coming with Sphinx (named 'sphinx.ext.*') or your
+ # custom ones.
+ extensions = ['matplotlib.sphinxext.mathmpl',
+ 'matplotlib.sphinxext.only_directives',
+ 'matplotlib.sphinxext.plot_directive',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'ipython_console_highlighting',
+ 'inheritance_diagram',
+ 'numpydoc']
+
+
+Now let's look at some of these in action. You can see the literal
+source for this file at :ref:`extensions-literal`.
+
+
+.. _ipython-highlighting:
+
+ipython sessions
+================
+
+Michael Droettboom contributed a sphinx extension which does pygments
+syntax highlighting on ipython sessions
+
+.. sourcecode:: ipython
+
+ In [69]: lines = plot([1,2,3])
+
+ In [70]: setp(lines)
+ alpha: float
+ animated: [True | False]
+ antialiased or aa: [True | False]
+ ...snip
+
+This support is included in this template, but will also be included
+in a future version of Pygments by default.
+
+.. _using-math:
+
+Using math
+==========
+
+In sphinx you can include inline math :math:`x\leftarrow y\ x\forall
+y\ x-y` or display math
+
+.. math::
+
+ W^{3\beta}_{\delta_1 \rho_1 \sigma_2} = U^{3\beta}_{\delta_1 \rho_1} +
\frac{1}{8 \pi 2} \int^{\alpha_2}_{\alpha_2} d \alpha^\prime_2 \left[\frac{
U^{2\beta}_{\delta_1 \rho_1} - \alpha^\prime_2U^{1\beta}_{\rho_1 \sigma_2}
}{U^{0\beta}_{\rho_1 \sigma_2}}\right]
+
+This documentation framework includes a Sphinx extension,
+:file:`sphinxext/mathmpl.py`, that uses matplotlib to render math
+equations when generating HTML, and LaTeX itself when generating a
+PDF. This can be useful on systems that have matplotlib, but not
+LaTeX, installed. To use it, add ``mathmpl`` to the list of
+extensions in :file:`conf.py`.
+
+Current SVN versions of Sphinx now include built-in support for math.
+There are two flavors:
+
+ - pngmath: uses dvipng to render the equation
+
+ - jsmath: renders the math in the browser using Javascript
+
+To use these extensions instead, add ``sphinx.ext.pngmath`` or
+``sphinx.ext.jsmath`` to the list of extensions in :file:`conf.py`.
+
+All three of these options for math are designed to behave in the same
+way.
+
+.. _emacs-helpers:
+
+Inserting matplotlib plots
+==========================
+
+Inserting automatically-generated plots is easy. Simply put the
+script to generate the plot in the :file:`pyplots` directory, and
+refer to it using the ``plot`` directive. To include the source code
+for the plot in the document, pass the ``include-source`` parameter::
+
+ .. plot:: ../pyplots/ellipses.py
+ :include-source:
+
+In the HTML version of the document, the plot includes links to the
+original source code, a high-resolution PNG and a PDF. In the PDF
+version of the document, the plot is included as a scalable PDF.
+
+.. plot:: pyplots/elegant.py
+ :include-source:
+
+Inheritance diagrams
+====================
+
+Inheritance diagrams can be inserted directly into the document by
+providing a list of class or module names to the
+``inheritance-diagram`` directive.
+
+For example::
+
+ .. inheritance-diagram:: codecs
+
+produces:
+
+.. inheritance-diagram:: codecs
+
+
+.. _extensions-literal:
+
+This file
+=========
+
+.. literalinclude:: extensions.rst
+
+
Modified: trunk/py4science/examples/sphinx_qs/index.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/index.rst 2009-08-11 11:22:28 UTC
(rev 7457)
+++ trunk/py4science/examples/sphinx_qs/index.rst 2009-08-11 11:24:27 UTC
(rev 7458)
@@ -13,7 +13,7 @@
getting_started.rst
custom_look.rst
- sphinx_extensions.rst
+ extensions.rst
Indices and tables
==================
Deleted: trunk/py4science/examples/sphinx_qs/sphinx_extensions.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/sphinx_extensions.rst 2009-08-11
11:22:28 UTC (rev 7457)
+++ trunk/py4science/examples/sphinx_qs/sphinx_extensions.rst 2009-08-11
11:24:27 UTC (rev 7458)
@@ -1,154 +0,0 @@
-.. _extensions:
-
-
-****************************************************
-Sphinx extensions for embedded plots, math and more
-****************************************************
-
-Sphinx is written in python, and supports the ability to write custom
-extensions. We've written a few for the matplotlib documentation,
-some of which are part of matplotlib itself in the
-matplotlib.sphinxext module, some of which are included only in the
-sphinx doc directory, and there are other extensions written by other
-groups, eg numpy and ipython. We're collecting these in this tutorial
-and showing you how to install and use them for your own project.
-First let's grab the python extension files from the :file:`sphinxext`
-directory from svn (see :ref:`getting-the-data`, and install them in
-our :file:`py4sci` project :file:`sphinxext` directory::
-
- home:~/tmp/py4sci> mkdir sphinxext
- home:~/tmp/py4sci> cp ../sphinx_qs/sphinxext/*.py sphinxext/
- home:~/tmp/py4sci> ls sphinxext/
- apigen.py inheritance_diagram.py
- docscrape.py ipython_console_highlighting.py
- docscrape_sphinx.py numpydoc.py
-
-In addition to the builtin matplotlib extensions for embedding pyplot
-plots and rendering math with matplotlib's native math engine, we also
-have extensions for syntax highlighting ipython sessions, making
-inhertiance diagrams, and more.
-
-We need to inform sphinx of our new extensions in the :file:`conf.py`
-file by adding the following. First we tell it where to find the extensions::
-
- # If your extensions are in another directory, add it here. If the
- # directory is relative to the documentation root, use
- # os.path.abspath to make it absolute, like shown here.
- sys.path.append(os.path.abspath('sphinxext'))
-
-And then we tell it what extensions to load::
-
- # Add any Sphinx extension module names here, as strings. They can
- # be extensions coming with Sphinx (named 'sphinx.ext.*') or your
- # custom ones.
- extensions = ['matplotlib.sphinxext.mathmpl',
- 'matplotlib.sphinxext.only_directives',
- 'matplotlib.sphinxext.plot_directive',
- 'sphinx.ext.autodoc',
- 'sphinx.ext.doctest',
- 'ipython_console_highlighting',
- 'inheritance_diagram',
- 'numpydoc']
-
-
-Now let's look at some of these in action. You can see the literal
-source for this file at :ref:`sphinx-extensions-literal`.
-
-
-.. _ipython-highlighting:
-
-ipython sessions
-================
-
-Michael Droettboom contributed a sphinx extension which does pygments
-syntax highlighting on ipython sessions
-
-.. sourcecode:: ipython
-
- In [69]: lines = plot([1,2,3])
-
- In [70]: setp(lines)
- alpha: float
- animated: [True | False]
- antialiased or aa: [True | False]
- ...snip
-
-This support is included in this template, but will also be included
-in a future version of Pygments by default.
-
-.. _using-math:
-
-Using math
-==========
-
-In sphinx you can include inline math :math:`x\leftarrow y\ x\forall
-y\ x-y` or display math
-
-.. math::
-
- W^{3\beta}_{\delta_1 \rho_1 \sigma_2} = U^{3\beta}_{\delta_1 \rho_1} +
\frac{1}{8 \pi 2} \int^{\alpha_2}_{\alpha_2} d \alpha^\prime_2 \left[\frac{
U^{2\beta}_{\delta_1 \rho_1} - \alpha^\prime_2U^{1\beta}_{\rho_1 \sigma_2}
}{U^{0\beta}_{\rho_1 \sigma_2}}\right]
-
-This documentation framework includes a Sphinx extension,
-:file:`sphinxext/mathmpl.py`, that uses matplotlib to render math
-equations when generating HTML, and LaTeX itself when generating a
-PDF. This can be useful on systems that have matplotlib, but not
-LaTeX, installed. To use it, add ``mathmpl`` to the list of
-extensions in :file:`conf.py`.
-
-Current SVN versions of Sphinx now include built-in support for math.
-There are two flavors:
-
- - pngmath: uses dvipng to render the equation
-
- - jsmath: renders the math in the browser using Javascript
-
-To use these extensions instead, add ``sphinx.ext.pngmath`` or
-``sphinx.ext.jsmath`` to the list of extensions in :file:`conf.py`.
-
-All three of these options for math are designed to behave in the same
-way.
-
-.. _emacs-helpers:
-
-Inserting matplotlib plots
-==========================
-
-Inserting automatically-generated plots is easy. Simply put the
-script to generate the plot in the :file:`pyplots` directory, and
-refer to it using the ``plot`` directive. To include the source code
-for the plot in the document, pass the ``include-source`` parameter::
-
- .. plot:: ../pyplots/ellipses.py
- :include-source:
-
-In the HTML version of the document, the plot includes links to the
-original source code, a high-resolution PNG and a PDF. In the PDF
-version of the document, the plot is included as a scalable PDF.
-
-.. plot:: pyplots/elegant.py
- :include-source:
-
-Inheritance diagrams
-====================
-
-Inheritance diagrams can be inserted directly into the document by
-providing a list of class or module names to the
-``inheritance-diagram`` directive.
-
-For example::
-
- .. inheritance-diagram:: codecs
-
-produces:
-
-.. inheritance-diagram:: codecs
-
-
-.. _sphinx-extensions-literal:
-
-This file
-=========
-
-.. literalinclude:: sphinx_extensions.rst
-
-
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now. http://p.sf.net/sfu/bobj-july
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
