Revision: 7465
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=7465&view=rev
Author: jdh2358
Date: 2009-08-11 12:06:06 +0000 (Tue, 11 Aug 2009)
Log Message:
-----------
moving to trunk
Modified Paths:
--------------
trunk/py4science/examples/sphinx_qs/custom_look.rst
trunk/py4science/examples/sphinx_qs/extensions.rst
trunk/py4science/examples/sphinx_qs/getting_started.rst
trunk/py4science/examples/sphinx_qs/index.rst
Removed Paths:
-------------
trunk/py4science/examples/sphinx_qs/Makefile
trunk/py4science/examples/sphinx_qs/_static/
trunk/py4science/examples/sphinx_qs/_templates/
trunk/py4science/examples/sphinx_qs/cheatsheet.rst
trunk/py4science/examples/sphinx_qs/conf.py
Deleted: trunk/py4science/examples/sphinx_qs/Makefile
===================================================================
--- trunk/py4science/examples/sphinx_qs/Makefile 2009-08-11 11:58:11 UTC
(rev 7464)
+++ trunk/py4science/examples/sphinx_qs/Makefile 2009-08-11 12:06:06 UTC
(rev 7465)
@@ -1,93 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes
linkcheck doctest
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or
PAPER=letter"
- @echo " changes to make an overview of all changed/added/deprecated
items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation
(if enabled)"
-
-clean:
- -rm -rf _build/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
- @echo
- @echo "Build finished. The HTML pages are in _build/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in _build/dirhtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in _build/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the"
\
- ".qhcp project file in _build/qthelp, like this:"
- @echo "# qcollectiongenerator _build/qthelp/sampledoc.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile _build/qthelp/sampledoc.qhc"
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
- @echo
- @echo "Build finished; the LaTeX files are in _build/latex."
- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)latex."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
- @echo
- @echo "The overview file is in _build/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in _build/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in _build/doctest/output.txt."
-
-sf:
- cd _build/html; \
- rsync -avz .
jdh2358,[email protected]:/home/groups/m/ma/matplotlib/htdocs/sampledoc
-essh --cvs-exclude
-
Deleted: trunk/py4science/examples/sphinx_qs/cheatsheet.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/cheatsheet.rst 2009-08-11 11:58:11 UTC
(rev 7464)
+++ trunk/py4science/examples/sphinx_qs/cheatsheet.rst 2009-08-11 12:06:06 UTC
(rev 7465)
@@ -1,98 +0,0 @@
-.. _cheat-sheet:
-
-******************
-Sphinx cheat sheet
-******************
-
-Here is a quick and dirty cheat sheet for some common stuff you want
-to do in sphinx and ReST. You can see the literal source for this
-file at :ref:`cheatsheet
--literal`.
-
-
-.. _formatting-text:
-
-Formatting text
-===============
-
-You use inline markup to make text *italics*, **bold**, or ``monotype``.
-
-You can represent code blocks fairly easily::
-
- import numpy as np
- x = np.random.rand(12)
-
-Or literally include code:
-
-.. literalinclude:: pyplots/ellipses.py
-
-.. _making-a-list:
-
-Making a list
-=============
-
-It is easy to make lists in rest
-
-Bullet points
--------------
-
-This is a subsection making bullet points
-
-* point A
-
-* point B
-
-* point C
-
-
-Enumerated points
-------------------
-
-This is a subsection making numbered points
-
-#. point A
-
-#. point B
-
-#. point C
-
-
-.. _making-a-table:
-
-Making a table
-==============
-
-This shows you how to make a table -- if you only want to make a list see
:ref:`making-a-list`.
-
-================== ============
-Name Age
-================== ============
-John D Hunter 40
-Cast of Thousands 41
-And Still More 42
-================== ============
-
-.. _making-links:
-
-Making links
-============
-
-It is easy to make a link to `yahoo <http://yahoo.com>`_ or to some
-section inside this document (see :ref:`making-a-table`) or another
-document.
-
-You can also reference classes, modules, functions, etc that are
-documented using the sphinx `autodoc
-<http://sphinx.pocoo.org/ext/autodoc.html>`_ facilites. For example,
-see the module :mod:`matplotlib.backend_bases` documentation, or the
-class :class:`~matplotlib.backend_bases.LocationEvent`, or the method
-:meth:`~matplotlib.backend_bases.FigureCanvasBase.mpl_connect`.
-
-
-
-.. _cheatsheet-literal:
-
-This file
-=========
-
-.. literalinclude:: cheatsheet.rst
Deleted: trunk/py4science/examples/sphinx_qs/conf.py
===================================================================
--- trunk/py4science/examples/sphinx_qs/conf.py 2009-08-11 11:58:11 UTC (rev
7464)
+++ trunk/py4science/examples/sphinx_qs/conf.py 2009-08-11 12:06:06 UTC (rev
7465)
@@ -1,202 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# sampledoc documentation build configuration file, created by
-# sphinx-quickstart on Tue Aug 11 05:04:40 2009.
-#
-# This file is execfile()d with the current directory set to its containing
dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# 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'))
-
-# -- General configuration
-----------------------------------------------------
-
-# 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']
-
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'sampledoc'
-copyright = u'2009, jdh'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '1.0'
-# The full version, including alpha/beta/rc tags.
-release = '1.0'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output
---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'sampledocdoc'
-
-
-# -- Options for LaTeX output
--------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
[howto/manual]).
-latex_documents = [
- ('index', 'sampledoc.tex', u'sampledoc Documentation',
- u'jdh', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
Modified: trunk/py4science/examples/sphinx_qs/custom_look.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/custom_look.rst 2009-08-11 11:58:11 UTC
(rev 7464)
+++ trunk/py4science/examples/sphinx_qs/custom_look.rst 2009-08-11 12:06:06 UTC
(rev 7465)
@@ -14,9 +14,9 @@
: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 ../sphinx_qs/_static/default.css _static/
- home:~/tmp/sampledoc> cp ../sphinx_qs/_templates/layout.html _templates/
- home:~/tmp/sampledoc> cp ../sphinx_qs/_static/logo.png _static/
+ 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
Modified: trunk/py4science/examples/sphinx_qs/extensions.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/extensions.rst 2009-08-11 11:58:11 UTC
(rev 7464)
+++ trunk/py4science/examples/sphinx_qs/extensions.rst 2009-08-11 12:06:06 UTC
(rev 7465)
@@ -17,7 +17,7 @@
our :file:`sampledoc` project :file:`sphinxext` directory::
home:~/tmp/sampledoc> mkdir sphinxext
- home:~/tmp/sampledoc> cp ../sphinx_qs/sphinxext/*.py sphinxext/
+ home:~/tmp/sampledoc> cp ../sampledoc_tut/sphinxext/*.py sphinxext/
home:~/tmp/sampledoc> ls sphinxext/
apigen.py inheritance_diagram.py
docscrape.py ipython_console_highlighting.py
Modified: trunk/py4science/examples/sphinx_qs/getting_started.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/getting_started.rst 2009-08-11
11:58:11 UTC (rev 7464)
+++ trunk/py4science/examples/sphinx_qs/getting_started.rst 2009-08-11
12:06:06 UTC (rev 7465)
@@ -48,7 +48,7 @@
Now we will start to customize out docs. Grab a couple of files from
the `web site
-<http://matplotlib.svn.sourceforge.net/viewvc/matplotlib/trunk/py4science/examples/sphinx_qs/>`_
+<http://matplotlib.svn.sourceforge.net/viewvc/matplotlib/trunk/sampledoc_tut/>`_
or svn. You will need :file:`getting_started.rst` and
:file:`_static/basic_screenshot.png`. All of the files live in the
"completed" version of this tutorial, but since this is a tutorial,
@@ -63,19 +63,19 @@
home:~/tmp/sampledoc> cd ..
home:~/tmp> svn co
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/\
- py4science/examples/sphinx_qs
- A sphinx_qs/cheatsheet.rst
- A sphinx_qs/_static
- A sphinx_qs/_static/basic_screenshot.png
- A sphinx_qs/conf.py
- A sphinx_qs/Makefile
- A sphinx_qs/_templates
- A sphinx_qs/_build
- A sphinx_qs/getting_started.rst
- A sphinx_qs/index.rst
+ sampledoc_tut
+ A sampledoc_tut/cheatsheet.rst
+ A sampledoc_tut/_static
+ A sampledoc_tut/_static/basic_screenshot.png
+ A sampledoc_tut/conf.py
+ A sampledoc_tut/Makefile
+ A sampledoc_tut/_templates
+ A sampledoc_tut/_build
+ A sampledoc_tut/getting_started.rst
+ A sampledoc_tut/index.rst
Checked out revision 7449.
- home:~/tmp> cp sphinx_qs/getting_started.rst sampledoc/
- home:~/tmp> cp sphinx_qs/_static/basic_screenshot.png sampledoc/_static/
+ home:~/tmp> cp sampledoc_tut/getting_started.rst sampledoc/
+ home:~/tmp> cp sampledoc_tut/_static/basic_screenshot.png sampledoc/_static/
Now we are ready to rebuild the docs. We used the image directory to
include to the screenshot above with::
Modified: trunk/py4science/examples/sphinx_qs/index.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/index.rst 2009-08-11 11:58:11 UTC
(rev 7464)
+++ trunk/py4science/examples/sphinx_qs/index.rst 2009-08-11 12:06:06 UTC
(rev 7465)
@@ -11,7 +11,9 @@
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!
+tutorial, you'll start with nothing and end up with this site! The
+source code for this tutorial lives in mpl svn (see
+:ref:`fetching-the-data`)
Contents:
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
