From 7ab56fd07858d224c8bbb12c26b74caf6012cd17 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Sat, 29 Oct 2011 13:58:49 +0200 Subject: [PATCH] Add README. --- README | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..1989f25 --- /dev/null +++ b/README @@ -0,0 +1,11 @@ +To generate the html doc from the .rst files, run `make html`. You need the +Sphinx documentation generator to do that. +A generated doc is available at . + +The .rst files in use/plugins/ has been generate *once* by +`generate_plugin_doc.py` and `append_config_doc.py` (I may have modified them +temporaly to match my file hierarchy). +All of them has been reviewed *and* modified by hand: include unofficial.inc +if needed, and the second-level titles, sort commands by type, ... Don't +even think about running that scripts again on a generated doc, it would +overwrite it.