1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Commit Graph

18 Commits

Author SHA1 Message Date
Mikolai Gütschow
306b8a872b
doc/doxygen: print link to generated documentation 2024-10-08 11:34:38 +02:00
Marian Buschsieweke
cfee27cfb2
doc: do not rebuild riot.css
- simplify the makefile
    - changing behavior depending on lessc being installed is
      surprising and makes the Makefile less readable
    - failing with `make: lessc: No such file or directory` is helpful,
      but `make: No rule to make target 'src/css/riot.css'` is not
      clearly indicating that `lessc` was not found
- don't rebuild `riot.css` when generating HTML output
    - anyone touching the less file will have to manually call
      `make src/css/riot.css -C doc/doxygen`
    - this happens so rarely that implementing a convenient mechanism
      is not worth the trouble

Fixes https://github.com/RIOT-OS/RIOT/issues/8122
2023-05-24 21:24:08 +02:00
Karl Fessel
3de68c7651 doccheck: check without building 2023-01-31 19:36:23 +01:00
Gaëtan Harter
944d0f31af
doc/doxygen: add package name for lessc
Add package name in ubuntu for lessc.
2019-02-20 11:35:06 +01:00
Gaëtan Harter
37349a0b19
doc/doxygen: remove support for lesscpy
lessc (node-less) and lesscpy do not produce the same output.
There are some minor whitespace +-1 in color values which
are not important but the output file is not stable

However lesscpy removes comments and so the license of the output file
As it produces an invalid file it support is dropped.

https://lesscpy.readthedocs.io/en/latest/#differences-from-less-js
2019-02-20 11:32:10 +01:00
61f1b941ce make: replace curly braces with parenthesis 2018-03-22 20:43:15 +01:00
Joakim Nohlgård
d01d91d3c3 doxygen: Use lesscpy if lessc is not found 2017-09-28 19:27:50 +02:00
Martine Lenders
0469dec71e
doc: add release notes to doxygen documentation
Provides a script to generate a doxygen page from the
`release-notes.txt` and includes it to the doxygen build.
2017-05-12 17:54:48 +02:00
Martine Lenders
1724b97b23 doc: add build capacities for LESS 2017-04-18 13:23:34 +02:00
Joakim Nohlgård
7e8f001d43 doc: Remove doxygen_entrydb_*.tmp when cleaning
Doxygen 1.8.12 leaves these files behind after finishing the build.
2017-01-17 14:54:45 +01:00
Joakim Nohlgård
a3aa865541 doc: Only strip core, drivers, and sys include path prefixes
fixes tons of false warnings on cpu_conf.h headers in cpu

/tmp/RIOT/cpu/atmega1281/include/cpu_conf.h:12: warning: the name `/tmp/RIOT/cpu/atmega1281/include/cpu_conf.h' supplied as the second argument in the \file statement matches the following input files:
   /tmp/RIOT/cpu/atmega1281/include/cpu_conf.h
Please use a more specific name by including a (larger) part of the path!
2017-01-17 14:53:48 +01:00
Andreas Paul Pauli
bce61166ee doc: provide include path list for riot.doxyfile 2016-03-23 23:01:46 +01:00
Oleg Hahm
72bc12e146 doxygen: add make targets to build man and latex
HTML will be build per default.
2015-07-20 19:30:30 +02:00
Joakim Gebart
68ce9397cb doc/doxygen: Clean up Makefile 2015-07-16 15:44:32 +02:00
Joakim Gebart
262ae9b0a8 doxygen: Clean leftover doxygen_objdb_*.tmp files. 2015-05-10 08:57:28 +02:00
Ludwig Ortmann
43b191fa00 make: make doc clean target ignore failures 2014-10-10 15:12:54 +02:00
Oliver Hahm
b6f21700ce * clean up stuff (fix gcc warnings and added clean target for doc) 2013-04-02 02:02:58 +02:00
Oliver Hahm
5ffe5a9c27 * renamed makefiles to Makefile 2013-03-09 23:45:56 +01:00