Commit graph

13 commits

Author SHA1 Message Date
Peter Hutterer
94628309f9 doc: add a placeholder man page
We don't provide man pages (the ones created by doxygen are pretty
terrible) so provide a placeholder page to provide the minimum info and point
people in the right direction.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-09 08:46:24 +10:00
Gaetan Nadon
d15856c77a doxygen: specifying builddir is not required
For the scenarios the module supports it is not required to
be specified.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-26 09:43:35 +10:00
Gaetan Nadon
c495cb42c0 doxygen: fix 'dist' when the html docs have not yet been built
The reason why this did not work is that we do not have a fixed list
of html doc files and it would be  pain to maintain.

The 'find' hack gets a list of html files but only when the package
has already been built. Let's complement this hack with the
html/index.html file which act as a build trigger as it is the target name.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:40:05 +10:00
Gaetan Nadon
dd016ebc3f doxygen: fix rebuild when not necessary
Everytime make is invoked, doxygen is invoked to generate the html doc.

Dependencies are added so it does rebuild when necessary.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:25:32 +10:00
Gaetan Nadon
ebb70f42dc doxygen: fix error msg: 'find: `html': No such file or directory'
Every time a make target is run in the doc directory when the html dir
is absent, you get this error. Even with 'make clean'.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:24:45 +10:00
Gaetan Nadon
83d679f1a1 doxygen: remove redundant "dist_noinst_DATA = libevdev.doxygen.in" statement
All .in files in AC_CONFIG_FILES are distributed.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:24:30 +10:00
Gaetan Nadon
17eb113524 doxygen: implement silent rules in the makefile
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:24:00 +10:00
Gaetan Nadon
40dde58556 doxygen: invocation of doxygen fails due to hard coded path
The makefile does not use $(DOXYGEN) variable.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:23:52 +10:00
Gaetan Nadon
a0fc429f06 doxygen: libevdev.doxygen must not be distributed
It reflects the values on the build machine.
Same pattern as libevdev.pc vs libevdev.pc.in.

For example, in libevdev.doxygen:
HTML_EXTRA_STYLESHEET  = ./libevdev.css

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:23:45 +10:00
Stephen Kitt
92b03c9da1 Avoid shipping generated documentation twice
Only add files to EXTRA_DIST, to avoid having a full copy of doc/html as
doc/html/html in the distributed tarball.

Signed-off-by: Stephen Kitt <skitt@debian.org>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-09-24 04:21:17 +10:00
Peter Hutterer
144b731202 doc: actually package generated documentation
Previous find command wouldn't actually list the generated documentation
files, so they'd be missing in the tarball.

...and add a dist-hook to make sure this won't happen during release.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
2013-08-29 11:13:49 +10:00
Peter Hutterer
c45d402979 Add libevdev.css to EXTRA_DIST
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-22 10:50:20 +10:00
Peter Hutterer
479e16725d Use doxygen instead of man pages
Doxygen is bad for man pages, but having an online API documentation
is better and easier to maintain.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-06-27 10:41:54 +10:00