Refactor of FAQ to separate docutils from reStructuredText. Link bidirectionally...
[docutils.git] / sandbox / list-faq / README.rst
blobb2271d0b80b4c8a69de8e92098f630ffc2fd03de
1 Docutils Mailing List FAQ
2 =========================
4 The proposed sandbox expands the FAQ docutils to:
6 * Expand into three topics in greater depth:
8   * reST
9   * docutils
10   * docutils development
12 * breaks the FAQ.txt in the root of the docutils project into ./docs.
13 * Cover additinal questions by looking back on questions since the
14   inception of the docutils list, as well as other third party sources
15   where docutils is covered.
18 Testing flow
19 ------------
21 .. code-block:: bash
22    
23     $ firefox &
24     $ pip install watching_testrunner
25     $ watching_testrunner --basepath ./ --pattern="*.txt" \
26       'rst2html.py docs/FAQ/reST.txt /tmp/test.html && firefox /tmp/test.html'
28 .. vim: fileencoding=utf-8 filetype=rst