SF.net SVN: matplotlib: [5438] trunk/toolkits/basemap

[<js...@us...>]

Revision: 5438
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5438&view=rev
Author:   jswhit
Date:     2008-06-09 11:10:36 -0700 (Mon, 09 Jun 2008)

Log Message:
-----------
add stub files for future sphinx docs.

Added Paths:
-----------
    trunk/toolkits/basemap/doc/
    trunk/toolkits/basemap/doc/README.txt
    trunk/toolkits/basemap/doc/api/
    trunk/toolkits/basemap/doc/api/index.rst
    trunk/toolkits/basemap/doc/conf.py
    trunk/toolkits/basemap/doc/index.rst
    trunk/toolkits/basemap/doc/make.py
    trunk/toolkits/basemap/doc/users/
    trunk/toolkits/basemap/doc/users/figures/
    trunk/toolkits/basemap/doc/users/index.rst

Added: trunk/toolkits/basemap/doc/README.txt
===================================================================
--- trunk/toolkits/basemap/doc/README.txt	                        (rev 0)
+++ trunk/toolkits/basemap/doc/README.txt	2008-06-09 18:10:36 UTC (rev 5438)
@@ -0,0 +1,2 @@
+* make _static and sphinxext symlinks here that point to the corresponding
+  directories in the matplotlib doc tree.

Added: trunk/toolkits/basemap/doc/api/index.rst
===================================================================
--- trunk/toolkits/basemap/doc/api/index.rst	                        (rev 0)
+++ trunk/toolkits/basemap/doc/api/index.rst	2008-06-09 18:10:36 UTC (rev 5438)
@@ -0,0 +1,10 @@
+.. _api-index:
+
+####################################
+  The Matplotlib Basemap Toolkit API
+####################################
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::

Added: trunk/toolkits/basemap/doc/conf.py
===================================================================
--- trunk/toolkits/basemap/doc/conf.py	                        (rev 0)
+++ trunk/toolkits/basemap/doc/conf.py	2008-06-09 18:10:36 UTC (rev 5438)
@@ -0,0 +1,165 @@
+# -*- coding: utf-8 -*-
+#
+# Basemap 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'))
+
+# Import support for ipython console session syntax highlighting (lives
+# in the sphinxext directory defined above)
+import ipython_console_highlighting
+
+# 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 = ['mathpng', 'sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General substitutions.
+project = 'Basemap Basemap Toolkit'
+copyright = '2008, Jeffrey Whitaker'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '0.99'
+# The full version, including alpha/beta/rc tags.
+release = '0.99'
+
+# 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 = 'matplotlib.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 = 'logo.png'
+
+# 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 = '.xhtml'
+
+# 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 = 'Basemapdoc'
+
+
+# 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', 'Basemap.tex', 'Basemap', 'Jeffrey Whitaker', '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
+
+# Show both class-level docstring and __init__ docstring in class
+# documentation
+autoclass_content = 'both'

Added: trunk/toolkits/basemap/doc/index.rst
===================================================================
--- trunk/toolkits/basemap/doc/index.rst	                        (rev 0)
+++ trunk/toolkits/basemap/doc/index.rst	2008-06-09 18:10:36 UTC (rev 5438)
@@ -0,0 +1,19 @@
+.. basemap documentation master file
+
+Welcome to the Matplotlib Basemap Toolkit documentation!
+========================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   users/index.rst
+   api/index.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

Added: trunk/toolkits/basemap/doc/make.py
===================================================================
--- trunk/toolkits/basemap/doc/make.py	                        (rev 0)
+++ trunk/toolkits/basemap/doc/make.py	2008-06-09 18:10:36 UTC (rev 5438)
@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+import fileinput
+import glob
+import os
+import shutil
+import sys
+
+def check_build():
+    build_dirs = ['build', 'build/doctrees', 'build/html', 'build/latex',
+                  '_static', '_templates']
+    for d in build_dirs:
+        try:
+            os.mkdir(d)
+        except OSError:
+            pass
+
+def figs():
+    #os.system('cd users/figures/ && python make.py')
+    os.system('cd users/figures')
+
+def html():
+    check_build()
+    figs()
+    os.system('sphinx-build -b html -d build/doctrees . build/html')
+
+def latex():
+    check_build()
+    figs()
+    if sys.platform != 'win32':
+        # LaTeX format.
+        os.system('sphinx-build -b latex -d build/doctrees . build/latex')
+
+        # Produce pdf.
+        os.chdir('build/latex')
+
+        # Copying the makefile produced by sphinx...
+        os.system('pdflatex Basemap.tex')
+        os.system('pdflatex Basemap.tex')
+        os.system('makeindex -s python.ist Basemap.idx')
+        os.system('makeindex -s python.ist modBasemap.idx')
+        os.system('pdflatex Basemap.tex')
+
+        os.chdir('../..')
+    else:
+        print 'latex build has not been tested on windows'
+
+def clean():
+    shutil.rmtree('build')
+
+def all():
+    figs()
+    html()
+    latex()
+
+
+funcd = {'figs':figs,
+         'html':html,
+         'latex':latex,
+         'clean':clean,
+         'all':all,
+         }
+
+
+if len(sys.argv)>1:
+    for arg in sys.argv[1:]:
+        func = funcd.get(arg)
+        if func is None:
+            raise SystemExit('Do not know how to handle %s; valid args are'%(
+                    arg, funcd.keys()))
+        func()
+else:
+    all()


Property changes on: trunk/toolkits/basemap/doc/make.py
___________________________________________________________________
Name: svn:executable
   + *

Added: trunk/toolkits/basemap/doc/users/index.rst
===================================================================
--- trunk/toolkits/basemap/doc/users/index.rst	                        (rev 0)
+++ trunk/toolkits/basemap/doc/users/index.rst	2008-06-09 18:10:36 UTC (rev 5438)
@@ -0,0 +1,10 @@
+.. _users-guide-index:
+
+#############################################
+  The Matplotlib Basemap Toolkit User's Guide
+#############################################
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::


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