Commit Graph

40 Commits

Author SHA1 Message Date
Nicolas Sebrecht
76ca65e0b2 Makefile: fix clean target
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2017-04-21 21:02:54 +02:00
Dodji Seketeli
ccb3bc3819 Really execute the recipe of the 'docs' target in top-most Makefile
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>
2016-03-21 18:41:41 +01:00
Nicolas Sebrecht
456d1724ca make: improve making targz
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-10-13 00:30:03 +02:00
Nicolas Sebrecht
f152509446 Makefile: learn to build websitedoc
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-25 20:10:29 +01:00
Nicolas Sebrecht
5eeea9ed83 improve documentation
- README
- restrict sphinx documentation to the API
- update the Makefiles

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-13 19:10:48 +01:00
Nicolas Sebrecht
5478481617 Makefile: avoid packaging the website and the wiki
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-13 18:42:53 +01:00
Nicolas Sebrecht
c9ce43313f fix the Makefile(s)
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 16:33:30 +01:00
Nicolas Sebrecht
7c7e7f92b1 website: learn to build the sphinx documentation
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 15:52:46 +01:00
Sebastian Spaeth
bfb7a79d6b documentation: Make top-level README a plain text file.
It makes direct reading much simpler.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 14:46:14 +01:00
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
b1a570d393 Merge branch 'ns/fix-documentation-build' into next 2011-03-10 19:24:17 +01:00
Nicolas Sebrecht
b18bde70c9 doc: rst2xxx: fix ignoring output while determining the command name
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-07 22:27:35 +01:00
Nicolas Sebrecht
b768d2d28b Makefile: get version number dynamically
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>
2011-02-21 13:15:04 +01:00
Nicolas Sebrecht
374dea8063 v6.3.2
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-02-21 12:26:48 +01:00
Nicolas Sebrecht
9482a37533 fix documentation build
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>
2011-02-17 18:57:15 +01:00
Nicolas Sebrecht
429cf53166 Merge branch 'ns/makefile-learn-to-remove-html-files' into next
Conflicts:
	Changelog.draft.rst
2011-01-28 19:55:35 +01:00
Nicolas Sebrecht
c79112baa1 Makefile: clean: remove generated html files
Reviewed-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-28 19:54:01 +01:00
Nicolas Sebrecht
c8b8e26735 Makefile: fix docutils commands call if extension is stripped
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>
2011-01-28 19:39:19 +01:00
Nicolas Sebrecht
ab3caedf11 Merge branch 'ns/introduce-changelog' into next 2011-01-18 19:20:12 +01:00
Nicolas Sebrecht
5544c58391 involve the community to the process of releases
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>
2011-01-18 19:19:41 +01:00
Nicolas Sebrecht
2ad2be3077 Merge branch 'ns/makefile-cleaning' into next 2011-01-18 18:49:12 +01:00
Nicolas Sebrecht
921dd0aa52 Merge branch 'ns/makefile-create-build-and-run-as-default' into next 2011-01-18 18:47:57 +01:00
Nicolas Sebrecht
b81c8b58ed Makefile: fix cleaning path having whitespaces
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-16 18:01:45 +01:00
Nicolas Sebrecht
980ebb6f19 Makefile: don't remove unrelated files
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>
2011-01-16 18:01:00 +01:00
Nicolas Sebrecht
48eb48946c convert SubmittingPatches to restructuredtext
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-16 15:16:55 +01:00
Nicolas Sebrecht
aea3e88436 Makefile: learn to build the package and make it the default
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>
2011-01-15 21:04:59 +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
Nicolas Sebrecht
e5deec0960 'make clean' remove manual.ps
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2009-04-17 10:37:37 -05:00
John Goerzen
df4e32f864 Changed Makefile line to igonre .git instead of _darcs 2008-03-03 04:27:42 -06:00
John Goerzen
e16596e110 doc target no longer depends on faq 2007-03-27 08:20:44 +01:00
John Goerzen
05716dc977 No longer include docs in source tarball 2006-12-06 04:24:11 +01:00
John Goerzen
14e13c9719 Now download FAQ from trac 2006-12-02 22:02:56 +01:00
John Goerzen
2d9c1ed9b8 Updating version number to 4.0.16 2006-12-02 21:59:02 +01:00
John Goerzen
f2515a0b02 Updated copyright and version info for 4.0.15 2006-11-30 10:51:14 +01:00
John Goerzen
365aff78d2 No longer generate/distribute PostScript manual 2006-11-30 04:26:14 +01:00
John Goerzen
381f71b180 Tiny bit of make cleaning 2006-10-18 01:18:27 +01:00
John Goerzen
39a18fef60 Update FSF address 2006-08-12 05:15:55 +01:00
Adam Spiers
8642a73caa add .spec file and Makefile rule for building an rpm 2006-05-15 02:59:52 +01:00
John Goerzen
aabe612a96 Removed old subversion commands 2005-06-02 19:58:01 +01:00
John Goerzen
d839be3c61 Step 2 of SVN to arch tree conversion 2005-04-16 20:33:35 +01:00