m4_init/3rd/libopencm3/doc
2023-02-02 16:50:31 +00:00
..
efm32ezr32wg Init 2023-02-02 16:50:31 +00:00
efm32g Init 2023-02-02 16:50:31 +00:00
efm32gg Init 2023-02-02 16:50:31 +00:00
efm32hg Init 2023-02-02 16:50:31 +00:00
efm32lg Init 2023-02-02 16:50:31 +00:00
efm32tg Init 2023-02-02 16:50:31 +00:00
efm32wg Init 2023-02-02 16:50:31 +00:00
gd32f1x0 Init 2023-02-02 16:50:31 +00:00
lm3s Init 2023-02-02 16:50:31 +00:00
lm4f Init 2023-02-02 16:50:31 +00:00
lpc13xx Init 2023-02-02 16:50:31 +00:00
lpc17xx Init 2023-02-02 16:50:31 +00:00
lpc43xx Init 2023-02-02 16:50:31 +00:00
lpc43xxm0 Init 2023-02-02 16:50:31 +00:00
lpc43xxm4 Init 2023-02-02 16:50:31 +00:00
msp432e4 Init 2023-02-02 16:50:31 +00:00
pac55xx Init 2023-02-02 16:50:31 +00:00
sam3a Init 2023-02-02 16:50:31 +00:00
sam3n Init 2023-02-02 16:50:31 +00:00
sam3s Init 2023-02-02 16:50:31 +00:00
sam3u Init 2023-02-02 16:50:31 +00:00
sam3x Init 2023-02-02 16:50:31 +00:00
sam4l Init 2023-02-02 16:50:31 +00:00
samd Init 2023-02-02 16:50:31 +00:00
stm32f0 Init 2023-02-02 16:50:31 +00:00
stm32f1 Init 2023-02-02 16:50:31 +00:00
stm32f2 Init 2023-02-02 16:50:31 +00:00
stm32f3 Init 2023-02-02 16:50:31 +00:00
stm32f4 Init 2023-02-02 16:50:31 +00:00
stm32f7 Init 2023-02-02 16:50:31 +00:00
stm32g0 Init 2023-02-02 16:50:31 +00:00
stm32g4 Init 2023-02-02 16:50:31 +00:00
stm32h7 Init 2023-02-02 16:50:31 +00:00
stm32l0 Init 2023-02-02 16:50:31 +00:00
stm32l1 Init 2023-02-02 16:50:31 +00:00
stm32l4 Init 2023-02-02 16:50:31 +00:00
swm050 Init 2023-02-02 16:50:31 +00:00
templates Init 2023-02-02 16:50:31 +00:00
vf6xx Init 2023-02-02 16:50:31 +00:00
Doxyfile Init 2023-02-02 16:50:31 +00:00
Doxyfile_common Init 2023-02-02 16:50:31 +00:00
HACKING Init 2023-02-02 16:50:31 +00:00
index.html Init 2023-02-02 16:50:31 +00:00
Makefile Init 2023-02-02 16:50:31 +00:00
README Init 2023-02-02 16:50:31 +00:00

libopencm3 Documentation
14 September 2012 (C) K Sarkies
-------------------------------

To generate all documentation run 'make doc' in the doc directory, or
for html documentation only run 'make html' (much faster). This runs doxygen
for each of the processor families then integrates the whole.

Alternatively run 'make doc' in the top directory to make html documentation.
LaTeX and pdf documentation is currently very large in size.

This requires doxygen v 1.8.2 or later.

HTML, LaTeX, and pdf output can be produced.

Generation of HTML
------------------

To view HTML, point a browser to libopencm3/doc/html/index.html.

Generation of PDF
-----------------

The pdf is generated via LaTeX. The pdf files are placed in the
doc directory. Each file contains all documentation for the core and common
features. The resulting files are huge.


Requirements
------------
On Fedora 19, the following packages (at least!) are needed to build the pdf
output

    texlive texlive-sectsty texlive-tocloft texlive-xtab texlive-multirow