SF.net SVN: matplotlib: [5223] trunk/matplotlib/doc/api_reference

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 5223
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5223&view=rev
Author:   dsdale
Date:     2008-05-23 06:52:26 -0700 (Fri, 23 May 2008)

Log Message:
-----------
moved api_reference docs out of source to flatten the directory structure

Modified Paths:
--------------
    trunk/matplotlib/doc/api_reference/make.py

Added Paths:
-----------
    trunk/matplotlib/doc/api_reference/_static/
    trunk/matplotlib/doc/api_reference/_templates/
    trunk/matplotlib/doc/api_reference/conf.py
    trunk/matplotlib/doc/api_reference/figures/
    trunk/matplotlib/doc/api_reference/index.txt
    trunk/matplotlib/doc/api_reference/introduction.txt
    trunk/matplotlib/doc/api_reference/latex.txt

Removed Paths:
-------------
    trunk/matplotlib/doc/api_reference/source/

Copied: trunk/matplotlib/doc/api_reference/_static (from rev 5220, trunk/matplotlib/doc/api_reference/source/_static)


Property changes on: trunk/matplotlib/doc/api_reference/_static
___________________________________________________________________
Name: svn:mergeinfo
   + 

Copied: trunk/matplotlib/doc/api_reference/_templates (from rev 5220, trunk/matplotlib/doc/api_reference/source/_templates)


Property changes on: trunk/matplotlib/doc/api_reference/_templates
___________________________________________________________________
Name: svn:mergeinfo
   + 

Copied: trunk/matplotlib/doc/api_reference/conf.py (from rev 5220, trunk/matplotlib/doc/api_reference/source/conf.py)
===================================================================

--- trunk/matplotlib/doc/api_reference/conf.py	                        (rev 0)
+++ trunk/matplotlib/doc/api_reference/conf.py	2008-05-23 13:52:26 UTC (rev 5223)
@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+#
+# Matplotlib documentation build configuration file, created by
+# sphinx-quickstart on Fri May  2 12:33:25 2008.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# All configuration values have a default value; values that are commented out
+# serve to show the default value.
+
+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 = ['mathml', 'sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General substitutions.
+project = 'Matplotlib'
+copyright = '2008, John Hunter, Darren Dale'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '0.98'
+# The full version, including alpha/beta/rc tags.
+release = '0.98pre'
+
+# 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 = []
+
+# 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'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# The name of an image file (within the static path) to place at the top of
+# the sidebar.
+#html_logo = 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 nonempty, this is the file name suffix for generated HTML files.  The
+# default is ``".html"``.
+html_file_suffix = '.xml'
+
+# 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 true, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.
+html_use_opensearch = 'False'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Matplotlib_API_doc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+latex_font_size = '11pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+latex_documents = [
+  ('index', 'Matplotlib_API_Reference.tex', 'Matplotlib API Reference', 'John Hunter, Darren Dale', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+latex_logo = None
+
+# 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
+
+latex_use_parts = True


Property changes on: trunk/matplotlib/doc/api_reference/conf.py
___________________________________________________________________
Name: svn:mergeinfo
   + 
Name: svn:eol-style
   + native

Copied: trunk/matplotlib/doc/api_reference/figures (from rev 5220, trunk/matplotlib/doc/api_reference/source/figures)


Property changes on: trunk/matplotlib/doc/api_reference/figures
___________________________________________________________________
Name: svn:mergeinfo
   + 

Copied: trunk/matplotlib/doc/api_reference/index.txt (from rev 5220, trunk/matplotlib/doc/api_reference/source/index.txt)
===================================================================
--- trunk/matplotlib/doc/api_reference/index.txt	                        (rev 0)
+++ trunk/matplotlib/doc/api_reference/index.txt	2008-05-23 13:52:26 UTC (rev 5223)
@@ -0,0 +1,14 @@
+.. Matplotlib documentation master file.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. _contents:
+
+Matplotlib API Reference
+========================
+
+.. toctree::
+   :maxdepth: 4
+
+   introduction
+   latex


Property changes on: trunk/matplotlib/doc/api_reference/index.txt
___________________________________________________________________
Name: svn:mergeinfo
   + 
Name: svn:eol-style
   + CRLF

Copied: trunk/matplotlib/doc/api_reference/introduction.txt (from rev 5220, trunk/matplotlib/doc/api_reference/source/introduction.txt)
===================================================================
--- trunk/matplotlib/doc/api_reference/introduction.txt	                        (rev 0)
+++ trunk/matplotlib/doc/api_reference/introduction.txt	2008-05-23 13:52:26 UTC (rev 5223)
@@ -0,0 +1,4 @@
+************
+Introduction
+************
+


Property changes on: trunk/matplotlib/doc/api_reference/introduction.txt
___________________________________________________________________
Name: svn:mergeinfo
   + 
Name: svn:eol-style
   + CRLF

Copied: trunk/matplotlib/doc/api_reference/latex.txt (from rev 5220, trunk/matplotlib/doc/api_reference/source/latex.txt)
===================================================================
--- trunk/matplotlib/doc/api_reference/latex.txt	                        (rev 0)
+++ trunk/matplotlib/doc/api_reference/latex.txt	2008-05-23 13:52:26 UTC (rev 5223)
@@ -0,0 +1,25 @@
+############################################
+Matplotlib Application Programming Interface
+############################################
+
+*************
+LaTeX Support
+*************
+
+:mod:`matplotlib.texmanager`
+=============================
+
+.. automodule:: matplotlib.texmanager
+   :members:
+
+:mod:`matplotlib.dviread`
+=============================
+
+.. automodule:: matplotlib.dviread
+   :members:
+
+:mod:`matplotlib.axes`
+=============================
+
+.. autoclass:: matplotlib.axes.Axes
+   :members: plot
\ No newline at end of file


Property changes on: trunk/matplotlib/doc/api_reference/latex.txt
___________________________________________________________________
Name: svn:mergeinfo
   + 
Name: svn:eol-style
   + CRLF

Modified: trunk/matplotlib/doc/api_reference/make.py
===================================================================
--- trunk/matplotlib/doc/api_reference/make.py	2008-05-23 13:49:20 UTC (rev 5222)
+++ trunk/matplotlib/doc/api_reference/make.py	2008-05-23 13:52:26 UTC (rev 5223)
@@ -7,7 +7,7 @@
 
 def check_build():
     build_dirs = ['build', 'build/doctrees', 'build/html', 'build/latex', 
-                  'source/_static', 'source/_templates']
+                  '_static', '_templates']
     for d in build_dirs:
         try:
             os.mkdir(d)
@@ -19,12 +19,12 @@
 
 def html():
     check_build()
-    os.system('sphinx-build -b html -d build/doctrees source build/html')
+    os.system('sphinx-build -b html -d build/doctrees ./ build/html')
 
 def latex():
     if sys.platform != 'win32':
         # LaTeX format.
-        os.system('sphinx-build -b latex -d build/doctrees source build/latex')
+        os.system('sphinx-build -b latex -d build/doctrees ./ build/latex')
     
         # Produce pdf.
         os.chdir('build/latex')
@@ -65,4 +65,4 @@
                     arg, funcd.keys()))
         func()
 else:
-    all()
\ No newline at end of file
+    all()


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


