[python-control-discuss] SF.net SVN: python-control:[163] trunk

[<mur...@us...>]

Revision: 163
          http://python-control.svn.sourceforge.net/python-control/?rev=163&view=rev
Author:   murrayrm
Date:     2011-06-22 18:59:13 +0000 (Wed, 22 Jun 2011)

Log Message:
-----------
Small modifications to sphinx documentation:
* Updated intro material and added link to wiki
* Added version information to doc/conf.py
* Got rid of path dependency for sphinx (requires proper path)

Documentation for 0.4d is now posted at http://python-control.sf.net/manual

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/Makefile
    trunk/doc/conf.py
    trunk/doc/intro.rst

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2011-06-22 06:02:02 UTC (rev 162)
+++ trunk/ChangeLog	2011-06-22 18:59:13 UTC (rev 163)
@@ -1,3 +1,13 @@
+2011-06-22  Richard Murray  <murray@malabar.local>
+
+	* doc/intro.rst: Added a slightly more general introduction, with a
+	pointer to the python-control wiki (on sf.net)
+
+	* doc/Makefile: Changed path to sphinx-build to assume it is in the
+	users path (as opposed to an explicit path)
+
+	* doc/conf.py: Added release information into documentation file
+
 2011-06-21  Richard Murray  <murray@malabar.local>
 
 	* src/statesp.py (_mimo2siso): Moved function from matlab.py.

Modified: trunk/doc/Makefile
===================================================================
--- trunk/doc/Makefile	2011-06-22 06:02:02 UTC (rev 162)
+++ trunk/doc/Makefile	2011-06-22 18:59:13 UTC (rev 163)
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = /Applications/Sphinx-1.0.6/sphinx-build.py
+SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
 

Modified: trunk/doc/conf.py
===================================================================
--- trunk/doc/conf.py	2011-06-22 06:02:02 UTC (rev 162)
+++ trunk/doc/conf.py	2011-06-22 18:59:13 UTC (rev 163)
@@ -57,9 +57,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.0'
+version = '0.4d'
 # The full version, including alpha/beta/rc tags.
-release = '0.0'
+release = '0.4d'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Modified: trunk/doc/intro.rst
===================================================================
--- trunk/doc/intro.rst	2011-06-22 06:02:02 UTC (rev 162)
+++ trunk/doc/intro.rst	2011-06-22 18:59:13 UTC (rev 163)
@@ -3,15 +3,26 @@
 ============
 
 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:
+The python-control package is a set of python classes and functions
+that implement common operations for the analysis and design of
+feedback control systems.  The initial goal is to implement all of the
+functionality required to work through the examples in the textbook
+Feedback Systems by \xC5str\xF6m and Murray. A MATLAB compatibility package
+(control.matlab) is available that provides functions corresponding to
+the commands available in the MATLAB Control Systems Toolbox.
 
-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.
+In addition to the documentation here, there is a project wiki that
+contains some addional informaiton about how to use the package
+(including some detailed worked examples):
 
+  http://python-control.sourceforge.net
 
+Some 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.


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