File: api_documentation.rst

package info (click to toggle)
libserial 1.0.0%2Bgit20250903-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,220 kB
  • sloc: cpp: 6,140; makefile: 278; python: 163; sh: 29
file content (21 lines) | stat: -rw-r--r-- 606 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
API Documentation
=================

The API documentation generated by doxygen is available `here
<http://libserial.sourceforge.net/doxygen>`_.

To generate a new set of docs using Sphinx, simply run:

.. code-block:: bash

   sphinx-build -b html docs/user_manual/ docs/html/

The Sphinx output will be located in the */libserial/docs/html/* directory.

To generate a new set of doxygen documentation, you can run the compile.sh script or simply invoke doxygen directly:

.. code-block:: bash

   doxygen doxygen.conf.in

The doxygen output will be located in the */libserial/build/docs/html/* directory.