From 7ba5f553f8344edb31a72576d5fbade55516e9b4 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Sun, 9 May 2010 12:26:19 -0400 Subject: [PATCH] A number of minor documentation cleanups. --- doc/conf.py | 3 ++- doc/config.txt | 6 +++--- doc/gui.txt | 16 ++++++++++------ doc/hacking.txt | 11 ++++++++--- doc/index.txt | 5 +++-- doc/install.txt | 10 +++++----- doc/tutorial.txt | 11 ++++++++++- hooke/__init__.py | 2 +- 8 files changed, 42 insertions(+), 22 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index d469d8b..43786fd 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -25,7 +25,8 @@ import hooke # 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', 'sphinx.ext.doctest', 'sphinx.ext.coverage', +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'numpydoc'] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/config.txt b/doc/config.txt index 6f0359b..c5d594f 100644 --- a/doc/config.txt +++ b/doc/config.txt @@ -30,9 +30,9 @@ To print a well commented example config file to stdout. Finding configuration files --------------------------- -The default search path follows the `Filesystem Hierarchy -Standard`_, and so will probably need adjustment for non-*nix systems. -The default path list is +The default search path follows the `Filesystem Hierarchy Standard`_, +and so will probably need adjustment for non-*nix systems. The +default path list is * /usr/share/hooke/hooke.cfg * /etc/hooke/hooke.cfg diff --git a/doc/gui.txt b/doc/gui.txt index a22c719..25c0f48 100644 --- a/doc/gui.txt +++ b/doc/gui.txt @@ -1,4 +1,7 @@ -# Interface +***************** +The GUI interface +***************** + by Rolf Schmidt You can dock/undock all windows except for plot tab (I would like to @@ -16,11 +19,12 @@ In the 'Folders' pane you can double-click playlists (with hkp extension) to open them (you cannot double-click curves to open them) Commands in the 'Commands'-pane that work -- autopeak (only partially, everything that has to do with clicking on the plot does not work) -- genlist -- loadlist -- convfilt -- flatfilt + +* autopeak (only partially, everything that has to do with clicking on the plot does not work) +* genlist +* loadlist +* convfilt +* flatfilt When you open or generate a playlist, Hooke seems to hang. This is actually not the case, just wait. Hooke loads all the curves into diff --git a/doc/hacking.txt b/doc/hacking.txt index 86e969b..ab8d9dc 100644 --- a/doc/hacking.txt +++ b/doc/hacking.txt @@ -2,14 +2,18 @@ Hacking Hooke ************* +.. toctree:: + :maxdepth: 2 + + testing.txt Architecture ============ To clean up the internals, were going to go crazy on the object-oriented front, and try to keep the core functionality free of -any dependencies other than the `Python Standard Library`_ and `Numpy`_ -/ `Scipy`_. +any dependencies other than the `Python Standard Library`_ and Numpy_ +/ Scipy_. .. _Python Standard Library: http://docs.python.org/library/ .. _Numpy: http://numpy.scipy.org/ @@ -29,6 +33,7 @@ files. On the testing side, the need to stick to the standard library relaxes (developers can install extra packages), so we can use nose_. See -the `Testing`_ section for more information. +the Testing_ section for more information. +.. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.3/ .. _Testing: testing.txt diff --git a/doc/index.txt b/doc/index.txt index cb6b97b..3e88c31 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -27,6 +27,7 @@ Contents: install.txt tutorial.txt + config.txt hacking.txt hooke/hooke.txt doc.txt @@ -59,8 +60,8 @@ If you have troubles in using Hooke: 1. Search the `issue tracker`_. 2. Look at the `trouble shooting wiki page`_. 3. Search the `discussion group`_. -3. Ask a question in the discussion group. -4. File a bug on the issue tracker. +4. Ask a question in the discussion group. +5. File a bug on the issue tracker. .. _issue tracker: http://code.google.com/p/hooke/issues/list .. _trouble shooting wiki page: diff --git a/doc/install.txt b/doc/install.txt index a8b754c..96d07d0 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -17,11 +17,11 @@ You'll need the following Python modules: * Matplotlib_ (for generating plots) * wxPython_ (for the GUI) -.. Numpy: http://numpy.scipy.org/ -.. Scipy: http://www.scipy.org/ -.. Python: http://www.python.org/ -.. Matplotlib: http://matplotlib.sourceforge.net/ -.. wxPython: http://www.wxpython.org/ +.. _Numpy: http://numpy.scipy.org/ +.. _Scipy: http://www.scipy.org/ +.. _Python: http://www.python.org/ +.. _Matplotlib: http://matplotlib.sourceforge.net/ +.. _wxPython: http://www.wxpython.org/ Getting the source ================== diff --git a/doc/tutorial.txt b/doc/tutorial.txt index 1158aad..8f68f90 100644 --- a/doc/tutorial.txt +++ b/doc/tutorial.txt @@ -8,6 +8,11 @@ Benedetti, EPFL, Lausanne) .. _A short video showing Hooke in action: https://documents.epfl.ch/users/f/fb/fbenedet/www/hooke_short_demostration.ogv +.. toctree:: + :maxdepth: 2 + + gui.txt + Introduction ============ @@ -44,6 +49,8 @@ Installation_), the equivalent command is:: You may need to give the full path for Python on Windows systems. +.. _plugins: hooke/hooke.plugin.txt + As Hooke launches, you should see something like the following in your terminal:: @@ -218,9 +225,11 @@ TODO: multiple cycles? Solution: blank lines for "breaks", add option to extract specific sections using Python's slice notation. -Interacting with the plot (no plots in command line mode...) +Interacting with the plot ------------------------- +(no plots in command line mode...) + Measuring distances and forces ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/hooke/__init__.py b/hooke/__init__.py index 7a2af6c..b90ff3d 100644 --- a/hooke/__init__.py +++ b/hooke/__init__.py @@ -1,6 +1,6 @@ # COPYRIGHT -"""The hooke module does all the legwork for Hooke_ (BE). +"""The hooke module does all the legwork for Hooke_. .. _hooke: http://code.google.com/p/hooke/ -- 2.26.2