Basic template for documentation

This commit is contained in:
2020-08-02 22:14:49 +02:00
parent 6cde956c31
commit 75d4af84c4
10 changed files with 2635 additions and 15 deletions

8
doc/source/api/dmas.rst Normal file
View File

@@ -0,0 +1,8 @@
.. _api_dmas:
Peripheral DMA Library Code
====================================
.. doxygengroup:: dma-ring-buffer
:project: Reflow Controller Firmware

11
doc/source/api/index.rst Normal file
View File

@@ -0,0 +1,11 @@
.. _api:
Firmware Code Documentation
===========================
.. toctree::
:maxdepth: 2
:glob:
*
safety/safety-controller

8
doc/source/api/main.rst Normal file
View File

@@ -0,0 +1,8 @@
.. _api_main:
Reflow Controller Firmware Main File
====================================
.. doxygenfile:: main.c
:project: Reflow Controller Firmware

View File

@@ -0,0 +1,8 @@
.. _dox_safety_adc:
Safety ADC
====================================
.. doxygengroup:: safety-adc
:project: Reflow Controller Firmware

View File

@@ -0,0 +1,14 @@
.. _dox_safety_controller:
Safery Controller
====================================
.. toctree::
:maxdepth: 1
safety-adc
.. doxygengroup:: safety-controller
:project: Reflow Controller Firmware