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>
This commit is contained in:
Nicolas Sebrecht
2011-01-15 16:48:30 +01:00
parent ff3eb17b0f
commit 6eb56364e7
13 changed files with 1103 additions and 1701 deletions

View File

@ -31,20 +31,15 @@ clean:
-rm -f `find . -name ".cache*"`
-rm -f manpage.links manpage.refs
-find . -name auth -exec rm -vf {}/password {}/username \;
-rm -f manual.html manual.pdf manual.txt manual.ps offlineimap.1
-rm -f readme.html
@$(MAKE) -C docs clean
man:
@$(MAKE) -C docs man
doc:
docbook2man offlineimap.sgml
docbook2man offlineimap.sgml
docbook2html -u offlineimap.sgml
mv offlineimap.html manual.html
man -t -l offlineimap.1 > manual.ps
ps2pdf manual.ps
groff -Tascii -man offlineimap.1 | sed $$'s/.\b//g' > manual.txt
-rm manpage.links manpage.refs manual.ps
faq:
curl -o FAQ.html http://software.complete.org/offlineimap/wiki/FrequentlyAskedQuestions
@$(MAKE) -C docs
rst2html.py README.rst readme.html
targz: ../$(TARGZ)
../$(TARGZ):