Make the 'docs' target be a PHONY one so that its recipe gets executed
even though there is a directory named 'docs' too.
Signed-off-by: Dodji Seketeli <dodji@seketeli.org>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
`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>
Avoid static version number in the Makefile. It's a possible source of errors,
especially for me.
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
On Thu, Feb 17, 2011 at 12:09:16PM +0100, Sebastian Spaeth wrote:
> still a bug in make docs that I only discovered today.
>
> our Makefile contains
>
> type rst2html 2>/dev/null && echo rst2html || echo rst2html.py
>
> which outputs on my box:
>
> rst2html is /usr/bin/rst2html
> rst2html
>
> which will break things. So either we need to suppres STDOUT too:
>
> type rst2html >/dev/null 2>&1 && echo rst2html || echo rst2html.py
>
> (which works), or we could use `which rst2html` (which returns 0 if the
> command exists) and outputs the proper path.
Reported-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
Looks like some distribution strip the extensions of the python commands and
some don't. Try to find the correct commands by ourself.
Reported-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Reviewed-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
In software engineering the releasing process is an important step. Since most
contributors are comfortable enough with the submitting patches process, it is
good time to involve everybody to the releasing one.
Introduce the Changelog file to rely on it. It is the good place to put topics
not already released.
This way, releases benefit from the review of others in the same way we do for
patches.
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
Contributers don't expect to have their working files deleted on 'make clean'.
This process should only remove files created by the build mechanisms included in
the repository.
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
It's a bit surprising to start the clean process when typing "make".
Create a build process and make it the default.
This will also help not deleting something VERY important.
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
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>
Nicolas Sebrecht
Dodji Seketeli
Sebastian Spaeth
John Goerzen
Adam Spiers