Menu
▾
▴
SF.net SVN: matplotlib:[7473] trunk/sampledoc_tut
|
From: <jd...@us...> - 2009-08-11 19:28:15
|
Revision: 7473
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=7473&view=rev
Author: jdh2358
Date: 2009-08-11 19:28:09 +0000 (Tue, 11 Aug 2009)
Log Message:
-----------
add some links
Modified Paths:
--------------
trunk/sampledoc_tut/custom_look.rst
trunk/sampledoc_tut/extensions.rst
trunk/sampledoc_tut/getting_started.rst
trunk/sampledoc_tut/index.rst
Modified: trunk/sampledoc_tut/custom_look.rst
===================================================================
--- trunk/sampledoc_tut/custom_look.rst 2009-08-11 18:01:00 UTC (rev 7472)
+++ trunk/sampledoc_tut/custom_look.rst 2009-08-11 19:28:09 UTC (rev 7473)
@@ -1,62 +1,62 @@
-.. _custom_look:
-
-
-******************************************
-Customizing the look and feel of the site
-******************************************
-
-The `sphinx <http://sphinx.pocoo.org/>`_ site itself looks better than
-the sites created with the default css, so here we'll invoke TS Elliots'
-maxim "Talen imitates, but genius steals" and grab their css
-and part of their layout. As before, you can either get the required
-files :file:`_static/default.css`, :file:`_templates:layout.html` and
-:file:`_static\logo.png` from the website or svn (see
-:ref:`fetching-the-data`). Since I did a svn checkout before, I will
-just copy the stuff I need from there::
-
- home:~/tmp/sampledoc> cp ../sampledoc_tut/_static/default.css _static/
- home:~/tmp/sampledoc> cp ../sampledoc_tut/_templates/layout.html _templates/
- home:~/tmp/sampledoc> cp ../sampledoc_tut/_static/logo.png _static/
- home:~/tmp/sampledoc> ls _static/ _templates/
- _static/:
- basic_screenshot.png default.css logo.png
-
- _templates/:
- layout.html
-
-Sphinx will automatically pick up the css and layout html files since
-we put them in the default places with the default names, but we have
-to manually include the logo in our :file:`layout.html`. Let's take a
-look at the layout file: the first part puts a horizontal navigation
-bar at the top of our page, like you see on the `sphinx
-<http://sphinx.pocoo.org>`_ and `matplotlib
-<http://matplotlib.sourceforge.net/>`_ sites, the second part includes
-a logo that when we click on it will take us `home` and the last part
-moves the vertical navigation panels to the right side of the page::
-
- {% extends "!layout.html" %}
-
-
- {% block rootrellink %}
- <li><a href="{{ pathto('index') }}">home</a>| </li>
- <li><a href="{{ pathto('search') }}">search</a>| </li>
- <li><a href="{{ pathto('contents') }}">documentation </a> »</li>
- {% endblock %}
-
-
- {% block relbar1 %}
-
- <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
- <a href="{{ pathto('index') }}"><img src="{{
- pathto("_static/logo.png", 1) }}" border="0" alt="sampledoc"/></a>
- </div>
- {{ super() }}
- {% endblock %}
-
- {# put the sidebar before the body #}
- {% block sidebar1 %}{{ sidebar() }}{% endblock %}
- {% block sidebar2 %}{% endblock %}
-
-Once you rebuild the site with a ``make html`` and reload the page in your browser, you should see a fancier site that looks like this
-
-.. image:: _static/fancy_screenshot.png
+.. _custom_look:
+
+
+******************************************
+Customizing the look and feel of the site
+******************************************
+
+The `sphinx <http://sphinx.pocoo.org/>`_ site itself looks better than
+the sites created with the default css, so here we'll invoke TS Elliots'
+maxim "Talent imitates, but genius steals" and grab their css
+and part of their layout. As before, you can either get the required
+files :file:`_static/default.css`, :file:`_templates:layout.html` and
+:file:`_static/logo.png` from the website or svn (see
+:ref:`fetching-the-data`). Since I did a svn checkout before, I will
+just copy the stuff I need from there::
+
+ home:~/tmp/sampledoc> cp ../sampledoc_tut/_static/default.css _static/
+ home:~/tmp/sampledoc> cp ../sampledoc_tut/_templates/layout.html _templates/
+ home:~/tmp/sampledoc> cp ../sampledoc_tut/_static/logo.png _static/
+ home:~/tmp/sampledoc> ls _static/ _templates/
+ _static/:
+ basic_screenshot.png default.css logo.png
+
+ _templates/:
+ layout.html
+
+Sphinx will automatically pick up the css and layout html files since
+we put them in the default places with the default names, but we have
+to manually include the logo in our :file:`layout.html`. Let's take a
+look at the layout file: the first part puts a horizontal navigation
+bar at the top of our page, like you see on the `sphinx
+<http://sphinx.pocoo.org>`_ and `matplotlib
+<http://matplotlib.sourceforge.net/>`_ sites, the second part includes
+a logo that when we click on it will take us `home` and the last part
+moves the vertical navigation panels to the right side of the page::
+
+ {% extends "!layout.html" %}
+
+
+ {% block rootrellink %}
+ <li><a href="{{ pathto('index') }}">home</a>| </li>
+ <li><a href="{{ pathto('search') }}">search</a>| </li>
+ <li><a href="{{ pathto('contents') }}">documentation </a> »</li>
+ {% endblock %}
+
+
+ {% block relbar1 %}
+
+ <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
+ <a href="{{ pathto('index') }}"><img src="{{
+ pathto("_static/logo.png", 1) }}" border="0" alt="sampledoc"/></a>
+ </div>
+ {{ super() }}
+ {% endblock %}
+
+ {# put the sidebar before the body #}
+ {% block sidebar1 %}{{ sidebar() }}{% endblock %}
+ {% block sidebar2 %}{% endblock %}
+
+Once you rebuild the site with a ``make html`` and reload the page in your browser, you should see a fancier site that looks like this
+
+.. image:: _static/fancy_screenshot.png
Modified: trunk/sampledoc_tut/extensions.rst
===================================================================
--- trunk/sampledoc_tut/extensions.rst 2009-08-11 18:01:00 UTC (rev 7472)
+++ trunk/sampledoc_tut/extensions.rst 2009-08-11 19:28:09 UTC (rev 7473)
@@ -13,7 +13,7 @@
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:`fetching-the-data`, and install them in
+directory from svn (see :ref:`fetching-the-data`), and install them in
our :file:`sampledoc` project :file:`sphinxext` directory::
home:~/tmp/sampledoc> mkdir sphinxext
@@ -60,9 +60,10 @@
ipython sessions
================
-Michael Droettboom contributed a sphinx extension which does pygments
-syntax highlighting on ipython sessions. Just use ipython as the
-language in the sourcecode directive::
+Michael Droettboom contributed a sphinx extension which does `pygments
+<http://pygments.org>`_ syntax highlighting on `ipython
+<http://ipython.scipy.org>`_ sessions. Just use ipython as the
+language in the ``sourcecode`` directive::
.. sourcecode:: ipython
@@ -135,6 +136,10 @@
All three of these options for math are designed to behave in the same
way.
+See the matplotlib `mathtext guide
+<http://matplotlib.sourceforge.net/users/mathtext.html>`_ for lots
+more information on writing mathematical expressions in matplotlib.
+
.. _pyplots:
Inserting matplotlib plots
@@ -183,6 +188,10 @@
plt.show()
+See the matplotlib `pyplot tutorial
+<http://matplotlib.sourceforge.net/users/pyplot_tutorial.html>`_ and
+the `gallery <http://matplotlib.sourceforge.net/gallery.html>`_ for
+lots of examples of matplotlib plots.
Inheritance diagrams
====================
Modified: trunk/sampledoc_tut/getting_started.rst
===================================================================
--- trunk/sampledoc_tut/getting_started.rst 2009-08-11 18:01:00 UTC (rev 7472)
+++ trunk/sampledoc_tut/getting_started.rst 2009-08-11 19:28:09 UTC (rev 7473)
@@ -55,8 +55,9 @@
we'll just grab them one at a time, so you can learn what needs to be
changed where. Since we have more files to come, I'm going to grab
the whole svn directory and just copy the files I need over for now.
-First, I'll cd to the directory containing my project, and get the
-"finished" product, and then copy in just the files I need::
+First, I'll cd up back into the directory containing my project, check
+out the "finished" product from svn, and then copy in just the files I
+need into my :file:`sampledoc` directory::
home:~/tmp/sampledoc> pwd
/Users/jdhunter/tmp/sampledoc
@@ -78,8 +79,8 @@
sampledoc/_static/
The last step is to modify :file:`index.rst` to include the
-getting_started file (be careful with the indentation, the
-"getting_started" should line up with the ':' in ``:maxdepth``::
+:file:`getting_started.rst` file (be careful with the indentation, the
+"g" in "getting_started" should line up with the ':' in ``:maxdepth``::
Contents:
Modified: trunk/sampledoc_tut/index.rst
===================================================================
--- trunk/sampledoc_tut/index.rst 2009-08-11 18:01:00 UTC (rev 7472)
+++ trunk/sampledoc_tut/index.rst 2009-08-11 19:28:09 UTC (rev 7473)
@@ -7,18 +7,17 @@
==================
This is a tutorial introduction to quickly get you up and running with
-your own sphinx documentation system. We'll cover everything from
-installing sphinx, to customizing the look and feel, to 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!
+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 svn (see
-:ref:`fetching-the-data`) and the `sampledoc PDF <sampledoc.pdf>`_
+:ref:`fetching-the-data`) and you can grab a harcopy of the the
+`sampledoc PDF <sampledoc.pdf>`_
-Contents:
-
.. toctree::
:maxdepth: 2
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
