stm32f4-nucleo-test/libopencm3/doc
Arti Zirk 2de3a91b0a git subrepo clone https://github.com/libopencm3/libopencm3.git
subrepo:
  subdir:   "libopencm3"
  merged:   "88e91c9a7cce"
upstream:
  origin:   "https://github.com/libopencm3/libopencm3.git"
  branch:   "master"
  commit:   "88e91c9a7cce"
git-subrepo:
  version:  "0.4.3"
  origin:   "???"
  commit:   "???"
2023-01-21 18:31:08 +02:00
..
efm32ezr32wg git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
efm32g git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
efm32gg git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
efm32hg git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
efm32lg git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
efm32tg git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
efm32wg git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
gd32f1x0 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lm3s git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lm4f git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lpc13xx git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lpc17xx git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lpc43xx git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lpc43xxm0 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
lpc43xxm4 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
msp432e4 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
nrf51 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
nrf52 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
pac55xx git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
sam3a git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
sam3n git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
sam3s git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
sam3u git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
sam3x git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
sam4l git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
samd git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32f0 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32f1 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32f2 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32f3 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32f4 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32f7 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32g0 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32g4 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32h7 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32l0 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32l1 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
stm32l4 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
swm050 git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
templates git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
vf6xx git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
Doxyfile git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
Doxyfile_common git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
HACKING git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
index.html git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
Makefile git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02:00
README git subrepo clone https://github.com/libopencm3/libopencm3.git 2023-01-21 18:31:08 +02: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