You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Karl Palsson f14c678ccb stm32l4: add gpio support 9 years ago
..
cm3 stm32l4: Add to documentation build 9 years ago
efm32g stm32l4: Add to documentation build 9 years ago
efm32gg stm32l4: Add to documentation build 9 years ago
efm32lg stm32l4: Add to documentation build 9 years ago
efm32tg stm32l4: Add to documentation build 9 years ago
lm3s stm32l4: Add to documentation build 9 years ago
lm4f stm32l4: Add to documentation build 9 years ago
lpc13xx stm32l4: Add to documentation build 9 years ago
lpc17xx stm32l4: Add to documentation build 9 years ago
lpc43xx stm32l4: Add to documentation build 9 years ago
sam3a stm32l4: Add to documentation build 9 years ago
sam3n stm32l4: Add to documentation build 9 years ago
sam3s stm32l4: Add to documentation build 9 years ago
sam3u stm32l4: Add to documentation build 9 years ago
sam3x stm32l4: Add to documentation build 9 years ago
stm32f0 stm32l4: Add to documentation build 9 years ago
stm32f1 stm32l4: Add to documentation build 9 years ago
stm32f2 stm32l4: Add to documentation build 9 years ago
stm32f3 stm32l4: Add to documentation build 9 years ago
stm32f4 stm32l4: Add to documentation build 9 years ago
stm32f7 stm32l4: Add to documentation build 9 years ago
stm32l0 stm32l4: Add to documentation build 9 years ago
stm32l1 stm32l4: Add to documentation build 9 years ago
stm32l4 stm32l4: add gpio support 9 years ago
usb stm32l4: Add to documentation build 9 years ago
vf6xx [stm32f7] Add initial support of the family, GPIO support. 9 years ago
Doxyfile Fix a number of top level doxygen issues. 11 years ago
Doxyfile_common Strip the BEGIN_DECLS definition from the first function in a module documentation. 12 years ago
DoxygenLayout.xml stm32l4: Add to documentation build 9 years ago
HACKING Fix a number of top level doxygen issues. 11 years ago
Makefile stm32l4: Add to documentation build 9 years ago
README docs: note dependencies for PDF generation 11 years ago
index.html [DOXYGEN] Add links to the HTML pages for easy debugging of pages 11 years ago

README

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