Commit Graph

27 Commits

Author SHA1 Message Date
Martin Geisler
92882a99d0 doc: use reStructuredText for man and HTML pages
The Makefile now requires the rst2html and rst2man programs. Both can
be found in Debian testing or downloaded from the Docutils homepage:

  http://docutils.sf.net/
  http://docutils.sf.net/sandbox/manpage-writer/

The new HTML and man pages no longer contain huge amounts of
un-wrapping literal blocks, thanks to how snippets of reStructuredText
can easily be included inside other reStructuredText documents.

The HTML pages now have anchors for all sections, including the help
topics in hgrc.1 which were missing from the old HTML pages.
2009-07-16 23:25:26 +02:00
Martin Geisler
784725778f doc/Makefile: let hg1.gendoc.txt depend on gendoc.py 2009-07-10 01:23:07 +02:00
Cédric Duval
32cb7a3823 doc: fix regexp for determining the man page section
Preceding a .* pattern with an other dot serves little purpose,
better anchor the regexp to the start of the file name.
2009-06-10 19:59:44 +02:00
Giorgos Keramidas
afd8c70fd6 manpage build: fail early when xmlto is not available
When we try to build manpages with xmlto and sed, but xmlto is
missing fail at the xmlto stage.  Otherwise, one may run `cd doc;
make' and miss the warnings like:

  xmlto: not found
  sed: hg.1: No such file or directory

and end up with empty files installed as manpages.
2009-05-07 15:08:25 +03:00
Christian Ebert
d3b93918d5 Do not install executable man pages
Default mode of install might be 755, therefore specify 644.
2009-01-25 12:21:57 +01:00
Patrick Mezard
2771395c7d Document how HTML documentation is built under Windows 2009-01-17 15:15:26 +01:00
Christian Ebert
c486b58886 doc/Makefile: rephrase comment (typo) 2008-08-28 13:06:24 +02:00
Dirkjan Ochtman
331f22c437 use ${PYTHON} var in doc/Makefile as well 2008-06-24 09:33:13 +02:00
Christian Ebert
d68174388b doc: escape .hg at bol in manpages with make (issue1072)
This works around a bug in old docbook stylesheets.
Remove .*.swp example from hgignore.5.txt.

Diagnosis and workaround thanks to Alexis S. L. Carvalho.
2008-04-07 09:02:04 +02:00
Thomas Arendsen Hein
28e90ca5c4 Fixed double slash for doc install path introduced by using $DESTDIR (issue620)
$MANDIR already is an absolute path so the extra / isn't needed.
2007-07-08 12:58:19 +02:00
Jonathan Smith
873ddc131c use DESTDIR both places its needed 2007-01-15 15:49:06 -05:00
Jonathan Smith
5282371a7c honor DESTDIR env variable for docs' make install 2007-01-15 15:31:38 -05:00
Jonathan Smith
2389afe820 install man pages by default into $(PREFIX)/share/man not $(PREFIX)/man since the FHS puts them there 2007-01-15 15:30:50 -05:00
Thomas Arendsen Hein
ef969c8db0 Include hg.1.gendoc.txt in doc/MANIFEST to prevent unnecessary rebuild. 2006-12-16 13:57:37 +01:00
Thomas Arendsen Hein
9a5ca784b6 Regenerate hg.1 manpage if help text in help.py changes. 2006-12-16 13:54:23 +01:00
Benoit Boissinot
253a9af902 fix MANIFEST generation 2006-12-12 11:39:05 +01:00
Thomas Arendsen Hein
84a05c493c Some versions of sed don't support .\+, so use ..* instead.
Reported by Christian Ebert for MacOS X.
2006-10-05 20:03:38 +02:00
Thomas Arendsen Hein
42c4074e72 Corrected install location of manpages.
(man/manSECTION/ instead of man/man.SECTION/)
2006-10-04 18:43:40 +02:00
wilde@trapperkeeper.sha-bang.de
5d9b2c557e Added install target. 2006-05-09 17:05:49 +02:00
Thomas Arendsen Hein
d465810792 make clean now removes generated documentation. 2006-03-10 20:06:41 +01:00
Thomas Arendsen Hein
14700b71df Regenerate hg.1.gendoc.txt if commands.py changed. 2006-03-01 09:19:27 +01:00
Benoit Boissinot
f1aae6bd52 generate hg manpage from commands.py docstring
gendoc.py is a script generating a part of the manpage (the commands
help and options) from the docstring in commands.py.
It avoids duplicating the doc between the doc/ directory and the docstrings.
To generate the manpage, 'make doc' will create all the necessary intermediate
files.
2006-02-28 00:48:49 +01:00
Thomas Arendsen Hein
5ac036946f Fall back to asciidoc6 html backend if html4 doesn't work.
This reenables building documentation on Debian sarge,
which broke after 95bbf2b4e4f9.
2006-02-03 10:54:58 +01:00
Eric Bloodworth
7242221f63 Change asciidoc backend to more recent name.
The latest asciidoc doesn't have an 'html' backend. 'html' was last valid
with version 6 ( 2005-1-28).  Current options are  xhtml11, or
html4, with xhtml11 by default.
2005-10-24 14:54:34 -07:00
Thomas Arendsen Hein
98af7adde9 Generate html documentation by default, too. 2005-08-22 08:33:02 +02:00
Bryan O'Sullivan
a2873f02e1 Move hgrc documentation out to its own man page, hgrc(5).
# HG changeset patch
# User Bryan O'Sullivan <bos@serpentine.com>
# Node ID 5076cf1fd6a1b8eb410e5e03cb004ca6a52a30f9
# Parent  d5198e5dd8087ca487031662f0908a6296512e5d
Move hgrc documentation out to its own man page, hgrc(5).
The new man page expands on the existing documentation by describing
the file format and the purpose of each section and field.
2005-07-10 16:14:06 -08:00
mpm@selenic.com
1fd4329dca Add a doc makefile
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Add a doc makefile

- From Vincent Danjean

manifest hash: ef14a37f8bdee641148e705ba13ce386cf29316a
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.0 (GNU/Linux)

iD8DBQFCvQSmywK+sNU5EO8RAh/QAJoCDQVUKS8uYO5kcIqJBsrKYtj+FACgmSvI
FnYSmWjUX5kLbDHdQqM6jls=
=fPAM
-----END PGP SIGNATURE-----
2005-06-24 23:15:50 -08:00