Commit Graph

5 Commits

Author SHA1 Message Date
Sebastian Spaeth
74b133c500 Revamped documentation structure and some doc fixes
`make` in the `docs` dir or `make doc` in the root dir will now
create the 1) man page and 2) the user documentation using sphinx
(requiring python-doctools, and sphinx).

The resulting user docs are in `docs/html`. You can also
only create the man pages with `make man` in the `docs` dir.

Also fixed all .rst conversion errors as requested by Gentoo downstream.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:13:27 +01:00
Nicolas Sebrecht
068df7d026 README: don't use github features for contributions
Display the warning ASAP to help not wasting time for newcomers. All kind of
contributions are expected at the mailing lists to bring posts a wider audience.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-19 20:02:24 +01:00
Nicolas Sebrecht
72285c92f5 README: fix the incorrect "reporting bugs" section
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 21:17:21 +01:00
Nicolas Sebrecht
5459063306 README: fix inconsistency in the level hierarchy
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 21:12:58 +01:00
Nicolas Sebrecht
6eb56364e7 doc: migrate from SGML to restructuredtext
This is a great move to help contributors in maintaining documentation.

While doing huge changes in this area, do a bit more than simply SGML to rst:

 * move README from markdown to rst
 * make a "true" man page with no more information
 * refactor content and sections

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00