1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
Commit Graph

51 Commits

Author SHA1 Message Date
Kalle Olavi Niemitalo
573036a403 Generate DocBook and XHTML with help2xml.
The older help2doc script is no longer used for anything.

To make future cherry-picking easier, this commit does not include the
resulting changes in generated files.
2008-05-03 20:28:45 +03:00
Jonas Fonseca
34a18bd597 Add description and version info to manpages
This adopts customized docbook manpage header from git's
Documentation/asciidoc.conf and does away with a couple of
ugly hacks.

(cherry picked from commit 0ecc8b9d60,
 omitting generated files)
2008-03-06 10:28:09 +02:00
Kalle Olavi Niemitalo
cca6ab7034 Enable asciidoc7compatible mode.
AsciiDoc 8 has changed the syntax again and generates e.g. subscripts
where we don't want them.  Instead of updating the documents, I'll
just enable a compatibility mode so that ELinks doesn't require
AsciiDoc 8 yet.
2007-11-25 09:09:58 +02:00
Jonas Fonseca
1079c95b9d Integrate Doxygen better in the build system
This change:

 - Adds a check for the doxygen program to configure.
 - Moves the Doxyfile from src/Doxyfile to doc/Doxyfile.in.
 - Generates a doc/Doxyfile from doc/Doxyfile.in inserting
   an absolute path to the source directory, so that it
   also works when builddir != srcdir.
 - Adds `make api` rule for running doxygen; it depends on
   api/doxygen file which is never created to force the rule
   to always run.
2007-08-08 14:23:21 +02:00
Kalle Olavi Niemitalo
df0f64f9e7 doc: Don't generate HTML for po/perl/ 2007-07-18 15:41:16 +03:00
Kalle Olavi Niemitalo
e6a2430fb7 Rename accelerator checking scripts. 2007-07-17 14:32:07 +03:00
Kalle Olavi Niemitalo
1f68e44a42 elinkskeys.5: Revert 8f030fcb63, which ESR did not review.
Revert 8f030fcb63, "Hack elinkskeys.5
with sed some more, to please ESR."  I asked ESR on 2007-01-06 and
2007-06-09 whether the changes were OK, but he never answered.  So I'm
reverting the changes until someone with troff knowledge reviews them.
2007-06-21 22:49:44 +03:00
Kalle Olavi Niemitalo
9cae6a4fa4 update-man: Install manpages to srcdir, not builddir.
elinks.1.in, elinkskeys.5, and elinks.conf.5 are included in the Git tree,
so they are initially in the srcdir, and that's were the new versions must go.
2007-01-06 22:17:54 +02:00
Kalle Olavi Niemitalo
8f030fcb63 Hack elinkskeys.5 with sed some more, to please ESR.
http://catb.org/~esr/doclifter/problems.html
2007-01-06 21:05:52 +02:00
Kalle Olavi Niemitalo
5331789603 Remove cmd_installsrcdata.
cmd_installdata with $(srcdir) now does the same thing.
2006-12-17 16:25:12 +02:00
Jonas Fonseca
5edec55a86 Remove all traces of the horrid "API Doc" code documentation tool 2006-12-10 01:23:40 +01:00
Kalle Olavi Niemitalo
f52d23c224 make install-doc installs doc/python.txt too. 2006-12-01 22:31:16 +02:00
Kalle Olavi Niemitalo
b3cbb0a915 Rename TXT_DOCS to TXT_DOCS_NOINSTALL.
By analogy with HTML_DOCS_NOINSTALL.
2006-12-01 21:38:06 +02:00
Kalle Olavi Niemitalo
b7a58b74f9 doc/Makefile: Don't install po/perl/ documentation. 2006-11-26 13:42:29 +02:00
Kalle Olavi Niemitalo
6299fb44e1 doc/Makefile: Move a semicolon outside ncmd invocation.
This apparently didn't cause any real problems, but the output of Make
looked suspicious.
2006-11-26 11:55:47 +02:00
Jonas Fonseca
b772b12847 Build HTML versions of scripts in po/perl 2006-02-19 01:27:31 +01:00
Jonas Fonseca
20baf3b207 Newer versions of AsciiDoc (7.0.5 atleast) needs to be passed --unsafe
Detect this in configure and set ASCIIDOC_FLAGS accordingly.
2006-01-27 02:32:06 +01:00
Jonas Fonseca
ed73a5c9b3 Make code2doc use the buildsystem echoing 2006-01-17 16:50:15 +01:00
Jonas Fonseca
a892c84601 Make it possible to build all-docs when $(builddir) != $(srcdir) 2006-01-16 00:21:05 +01:00
Jonas Fonseca
c992a0860c Sound of silence 2006-01-14 19:40:29 +01:00
Jonas Fonseca
01b9ba0983 Fix keymap-%.txt building; move FIXME about prefixes to elinkskeys.5.txt 2006-01-14 19:24:46 +01:00
Jonas Fonseca
97fe1db841 Minor Makefile fixes 2006-01-14 10:59:58 +01:00
Jonas Fonseca
fabd3df984 mv import-features.conf conf2doc; mv make-elinkskeys-manpage keys2doc 2006-01-13 12:58:47 +01:00
Jonas Fonseca
54e980abe4 Make install-doc depend on update-man to get the newest 2006-01-13 12:48:37 +01:00
Jonas Fonseca
b8301917ec Add install-doc rule 2006-01-13 12:42:14 +01:00
Jonas Fonseca
75bf42bfe0 Simplify further; only list generated files; move things around; comment 2006-01-13 12:17:03 +01:00
Jonas Fonseca
686166d5e6 Various api doc related fixes and cleanups 2006-01-13 08:09:06 +01:00
Jonas Fonseca
fd1c3510f5 Improve rebuilding using asciidoc by using files in .deps/ 2006-01-12 11:59:11 +01:00
Jonas Fonseca
aef863da96 Various minor improvements 2006-01-12 10:29:05 +01:00
Jonas Fonseca
aa7d65fb79 Make elinks.conf(5) also be build from .txt files
This simplifies help2doc since it now just have to do one single thing with
output of either --config-help or --long-help. The new manpage is not as
fancy wrt. indentation and sub titles but it is more uniform and we get a
HTML version.

Generate options-{config,command}.txt with help2doc. Only conditionally
check for API header files, to speed up execusion.
2006-01-12 08:33:50 +01:00
Jonas Fonseca
247b3c4623 Don't masq calls 2006-01-11 11:12:03 +01:00
Jonas Fonseca
ba6221c6f6 Redo the whole doc/ build thing
You can now use: make {all-docs,pdf,html,man,api,update-man}
     instead of: make {all-docs,pdf-docs,html-docs,man-docs}

Away is building into separate dirs. This makes make able to actually get
dependencies right, since there are now a collection of 'common' build
rules, some of which have even been moved to use the cmd infrastructure.

To update the man pages there is a new update-man rule. It builds the
manual pages and copies them to their proper place under man/ while doing
the final preformatting.

As good thing is that the (two) man pages are moved to .txt files and
include the generated content.

The API building thing is also refined. It builds into api/ and builds it's
list of files dynamically by searching throught the .h files in the src/
directory. Documented header files must contain a comment like this:

	/* API Doc :: <api-name> */

where <api-name> is the name used for the file under api/, for example
dom-scanner.
2006-01-11 11:02:43 +01:00
Laurent MONIN
7af11c507f More dependencies. 2006-01-10 22:18:03 +01:00
Laurent MONIN
1ac97927b5 Make $(MAN_DIR)/man5/elinkskeys.5 target depends on $(HELP2DOC) and
Makefile.
2006-01-10 22:11:14 +01:00
Jonas Fonseca
6bd67a6f09 Preprocess elinks.1.in and elinkskeys.5 to add title and date fields
Regenerate all man pages.
2006-01-10 17:09:02 +01:00
Laurent MONIN
6b19a4fe1f Enforce locales env vars to be sure elinks generate english texts,
even on systems using non-english locales.
2006-01-09 23:51:29 +01:00
Jonas Fonseca
d657060b74 Build html/api/dom.html 2006-01-09 22:48:09 +01:00
Jonas Fonseca
0e5853cae7 More perl snacks; added macro:[] for #define'd values; api dom/scanner.h 2006-01-09 14:06:47 +01:00
Jonas Fonseca
2206f560c6 Build a DOM api from the two doctised header files 2006-01-09 12:45:50 +01:00
Jonas Fonseca
61efbc4c9a First attempt to build html/api docs
It only does src/dom/sgml/parser.h for now.
2006-01-08 23:44:59 +01:00
Jonas Fonseca
b70133760f Make *-docs depend on doc-dirs; beware if you build individual files 2006-01-08 23:15:47 +01:00
Jonas Fonseca
15cd8c8d2c Simplify dependency on doc-dirs by making MAKECMDGOALS depend on it 2006-01-08 22:33:26 +01:00
Jonas Fonseca
905aa95a6e Simplify some more 2006-01-08 21:57:55 +01:00
Jonas Fonseca
877ed348be Simplify the doc Makefile tremendously 2006-01-08 21:46:21 +01:00
Russ Rowan
42f715f90f Clean up 'make clean'. 2005-12-15 04:04:26 -05:00
Jonas Fonseca
c88afeb1c2 path_to_top -> top_builddir 2005-10-20 04:00:35 +02:00
Jonas Fonseca
e39a4342d6 Include $(top_srcdir)/Makefile.lib instead of $(path_to_top)/Makefile.lib
A step towards out of tree builds ...
2005-10-20 01:11:47 +02:00
Jonas Fonseca
b30064c0d0 Rename targets: *-l -> *-local 2005-09-27 21:11:28 +02:00
Jonas Fonseca
249fac4345 Tune the clean-l usage
- Fix the doc/ clean target which was called clean-local
 - Consistently use $(RM)
 - Introduce CLEAN variable to make it simpler to costumize local cleaning
2005-09-27 18:27:17 +02:00
Jonas Fonseca
7446adecd5 Remove *.tmp files created by pod2html 2005-09-23 15:07:40 +02:00