[MOAB-dev] r2911 - MOAB/trunk/tools/iMesh/python/doc
jvporter at wisc.edu
jvporter at wisc.edu
Tue May 26 18:24:45 CDT 2009
Author: jvporter
Date: 2009-05-26 18:24:44 -0500 (Tue, 26 May 2009)
New Revision: 2911
Added:
MOAB/trunk/tools/iMesh/python/doc/Makefile
MOAB/trunk/tools/iMesh/python/doc/build.rst
MOAB/trunk/tools/iMesh/python/doc/conf.py
MOAB/trunk/tools/iMesh/python/doc/index.rst
Removed:
MOAB/trunk/tools/iMesh/python/doc/index.rst
Log:
* Added more documentation for Python interfaces
* Moved to Sphinx documentation for consistency with core Python docs
Added: MOAB/trunk/tools/iMesh/python/doc/Makefile
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/Makefile (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/Makefile 2009-05-26 23:24:44 UTC (rev 2911)
@@ -0,0 +1,88 @@
+# 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/PyTAPS.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile _build/qthelp/PyTAPS.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."
Copied: MOAB/trunk/tools/iMesh/python/doc/build.rst (from rev 2904, MOAB/trunk/tools/iMesh/python/doc/index.rst)
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/build.rst (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/build.rst 2009-05-26 23:24:44 UTC (rev 2911)
@@ -0,0 +1,24 @@
+=================
+ Building PyTAPS
+=================
+
+Like most Python packages, PyTAPS uses Distutils for installation, so in general
+setup consists simply of typing ``python setup.py install`` at the root
+directory for PyTAPS. However, certain iMesh interfaces may require some
+additional setup.
+
+With MOAB
+=========
+
+Since Python modules are loaded as shared libraries, MOAB's iMesh library needs
+to be built with position-independent code. When configuring MOAB, specify
+``--with-pic`` on the command line.
+
+Non-standard Library Locations
+==============================
+
+In some cases, required objects for building PyTAPS aren't in the expected
+directories. One solution to this is to include the appropriate directories in
+the environment variables ``CPATH`` and ``PYTHONPATH``. Another, more flexible
+method is to use the ``setup.cfg`` file. Information on how to use this file can
+be found in the official Python `documentation <http://docs.python.org/install/index.html#distutils-configuration-files>`_.
\ No newline at end of file
Property changes on: MOAB/trunk/tools/iMesh/python/doc/build.rst
___________________________________________________________________
Name: svn:mergeinfo
+
Added: MOAB/trunk/tools/iMesh/python/doc/conf.py
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/conf.py (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/conf.py 2009-05-26 23:24:44 UTC (rev 2911)
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# PyTAPS documentation build configuration file, created by
+# sphinx-quickstart on Tue May 26 17:50:11 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 extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path 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('.'))
+
+# -- 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 = []
+
+# 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'PyTAPS'
+copyright = u'2009, James Porter'
+
+# 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 = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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 = 'PyTAPSdoc'
+
+
+# -- 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', 'PyTAPS.tex', u'PyTAPS Documentation',
+ u'James Porter', '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
Deleted: MOAB/trunk/tools/iMesh/python/doc/index.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/index.rst 2009-05-26 22:08:01 UTC (rev 2910)
+++ MOAB/trunk/tools/iMesh/python/doc/index.rst 2009-05-26 23:24:44 UTC (rev 2911)
@@ -1,25 +0,0 @@
-========
- PyTAPS
-========
-
-About PyTAPS
-============
-
-PyTAPS is a Python package designed to interface with ITAPS, focusing on the
-iMesh interface.
-
-Building PyTAPS
-===============
-
-Like most Python packages, PyTAPS uses Distutils for installation, so in general
-setup consists simply of typing ``python setup.py install`` at the root
-directory for PyTAPS. However, certain iMesh interfaces may require some
-additional setup.
-
-With MOAB
----------
-
-Since Python modules are loaded as shared libraries, MOAB's iMesh library needs
-to be built with position-independent code. When configuring MOAB, specify
-``--with-pic`` on the command line.
-
Added: MOAB/trunk/tools/iMesh/python/doc/index.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/index.rst (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/index.rst 2009-05-26 23:24:44 UTC (rev 2911)
@@ -0,0 +1,11 @@
+========
+ PyTAPS
+========
+
+PyTAPS is a Python package designed to interface with ITAPS, focusing on the
+iMesh interface.
+
+.. toctree::
+ :maxdepth: 2
+
+ build
\ No newline at end of file
More information about the moab-dev
mailing list