From e7b3618303bd347a8c44de38a2f1f9209d18e8fe Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Thu, 13 May 2010 06:31:56 -0400 Subject: [PATCH] Split out "Troubleshooting" into doc/bugs.txt. This section will probably grow ;). + other textual cleanups. --- doc/bugs.txt | 15 +++++++++++++++ doc/index.txt | 31 +++++++------------------------ 2 files changed, 22 insertions(+), 24 deletions(-) create mode 100644 doc/bugs.txt diff --git a/doc/bugs.txt b/doc/bugs.txt new file mode 100644 index 0000000..9279923 --- /dev/null +++ b/doc/bugs.txt @@ -0,0 +1,15 @@ +Troubleshooting +=============== + +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`_. +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: + http://code.google.com/p/hooke/wiki/TroubleShooting +.. _discussion group: http://groups.google.com/group/hookesoftware diff --git a/doc/index.txt b/doc/index.txt index 140c38d..99919a5 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,5 +1,5 @@ -Welcome to the Hooke documentation! -=================================== +Welcome +======= Hooke_ is software for the (semiautomatic) analysis and filtering of force curves. Force curves are the output of an analytical technique @@ -20,7 +20,8 @@ Features: * Handles force-clamp force experiments (experimental) * Extensible by users by mean of plugins and drivers -Contents: +Contents +======== .. toctree:: :maxdepth: 2 @@ -28,12 +29,13 @@ Contents: install tutorial config + bugs hacking hooke/hooke doc Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` @@ -51,29 +53,10 @@ know, and we'll link to your paper! Bioinformatics, 2009. doi: `10.1093/bioinformatics/btp180 `_ - -Troubleshooting -=============== - -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`_. -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: - http://code.google.com/p/hooke/wiki/TroubleShooting -.. _discussion group: http://groups.google.com/group/hookesoftware - - Disclaimer ========== Remember that Hooke is still experimental software! It has been mostly done to fit the needs of its authors, and there is no guarantee it will do what you need. However, you can write us/help us improve -it so that it does. We aim to make of Hooke a little, universal tool -that can help your research. +it so that it does. -- 2.26.2