Menu
▾
▴
[python-control-discuss] SF.net SVN: python-control:[95] branches/control-0.4a/doc
|
From: <kk...@us...> - 2011-02-08 22:17:41
|
Revision: 95
http://python-control.svn.sourceforge.net/python-control/?rev=95&view=rev
Author: kkchen
Date: 2011-02-08 22:17:34 +0000 (Tue, 08 Feb 2011)
Log Message:
-----------
Added Sphinx documentation in trunk/doc. See trunk/doc/README for install notes.
Steven Brunton <sbr...@pr...>
Added Paths:
-----------
branches/control-0.4a/doc/Makefile
branches/control-0.4a/doc/README
branches/control-0.4a/doc/bdalg_strings.rst
branches/control-0.4a/doc/class_strings.rst
branches/control-0.4a/doc/conf.py
branches/control-0.4a/doc/index.rst
branches/control-0.4a/doc/intro.rst
branches/control-0.4a/doc/matlab_strings.rst
branches/control-0.4a/doc/modsimp_strings.rst
Added: branches/control-0.4a/doc/Makefile
===================================================================
--- branches/control-0.4a/doc/Makefile (rev 0)
+++ branches/control-0.4a/doc/Makefile 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = /Users/steve/CODES/Sphinx-1.0.6/sphinx-build.py
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man 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 " singlehtml to make a single large HTML file"
+ @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 " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @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 $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonControl.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonControl.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonControl"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonControl"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Added: branches/control-0.4a/doc/README
===================================================================
--- branches/control-0.4a/doc/README (rev 0)
+++ branches/control-0.4a/doc/README 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,15 @@
+Sphinx Documentation
+--------------------
+
+Note: Sphinx actually runs and imports python code, so broken code, or code not in conf.py sys.path, cannot be documented!
+
+1. Get Sphinx [http://sphinx.pocoo.org/]
+ [python setup.py build/install]
+
+2. Install numpydoc [http://pypi.python.org/pypi/numpydoc]
+
+3. In Makefile point to your own copy of sphinx-build, e.g.
+ [SPHINXBUILD = /Users/steve/CODES/Sphinx-1.0.6/sphinx-build.py]
+
+4. >> touch *.rst
+ >> make html [or make latex]
Added: branches/control-0.4a/doc/bdalg_strings.rst
===================================================================
--- branches/control-0.4a/doc/bdalg_strings.rst (rev 0)
+++ branches/control-0.4a/doc/bdalg_strings.rst 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,7 @@
+Block Diagram Algebra Routines
+******************************
+
+The Block Diagram Algebra Module
+================================
+.. automodule:: bdalg
+ :members:
Added: branches/control-0.4a/doc/class_strings.rst
===================================================================
--- branches/control-0.4a/doc/class_strings.rst (rev 0)
+++ branches/control-0.4a/doc/class_strings.rst 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,12 @@
+Python-Control Classes
+**********************
+
+The State Space Module
+======================
+.. automodule:: statesp
+ :members:
+
+The Transfer Function Module
+============================
+.. automodule:: xferfcn
+ :members:
\ No newline at end of file
Added: branches/control-0.4a/doc/conf.py
===================================================================
--- branches/control-0.4a/doc/conf.py (rev 0)
+++ branches/control-0.4a/doc/conf.py 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,217 @@
+# -*- coding: utf-8 -*-
+#
+# Python Control documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 11 16:11:31 2011.
+#
+# 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.insert(0, os.path.abspath('.'))
+sys.path.append(os.path.abspath('../src'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc','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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Python Control'
+copyright = u'2011, Richard M. Murray et al.'
+
+# 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.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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. See the documentation for
+# a list of builtin themes.
+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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PythonControldoc'
+
+
+# -- 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', 'PythonControl.tex', u'Python Control Documentation',
+ u'Python Control Developers', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = 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_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'pythoncontrol', u'Python Control Documentation',
+ [u'Python Control Developers'], 1)
+]
Added: branches/control-0.4a/doc/index.rst
===================================================================
--- branches/control-0.4a/doc/index.rst (rev 0)
+++ branches/control-0.4a/doc/index.rst 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,25 @@
+.. Python-Control documentation master file, created by
+ sphinx-quickstart on Thu Jan 6 09:49:36 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Python-Control's documentation!
+==========================================
+
+Contents:
+
+.. toctree::
+
+ intro
+ class_strings
+ modsimp_strings
+ matlab_strings
+ bdalg_strings
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Added: branches/control-0.4a/doc/intro.rst
===================================================================
--- branches/control-0.4a/doc/intro.rst (rev 0)
+++ branches/control-0.4a/doc/intro.rst 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,17 @@
+============
+Introduction
+============
+
+Welcome to the Python-Control project.
+This is sample documentation and will include our Princeton University APC524 contribution.
+
+We can incorporate any existing documentation as well. For example from R.Murray's earlier tex document:
+
+Differences from MATLAB
+-----------------------
+* You must include commas in vectors. So [1 2 3] must be [1, 2, 3].
+* Functions that return multiple arguments use tuples
+* Can't use braces for collections; use tuples instead
+* Transfer functions are only implemented for SISO systems (due to limitations in the underlying signals.lti class); use state space representations for MIMO systems.
+
+
Added: branches/control-0.4a/doc/matlab_strings.rst
===================================================================
--- branches/control-0.4a/doc/matlab_strings.rst (rev 0)
+++ branches/control-0.4a/doc/matlab_strings.rst 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,7 @@
+Matlab-like Routines
+********************
+
+The Matlab Module
+=================
+.. automodule:: matlab
+ :members:
\ No newline at end of file
Added: branches/control-0.4a/doc/modsimp_strings.rst
===================================================================
--- branches/control-0.4a/doc/modsimp_strings.rst (rev 0)
+++ branches/control-0.4a/doc/modsimp_strings.rst 2011-02-08 22:17:34 UTC (rev 95)
@@ -0,0 +1,7 @@
+Model Simplification Tools
+**************************
+
+The modelsimp Module
+====================
+.. automodule:: modelsimp
+ :members:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
