Basic template for documentation

doc/.gitignore

@@ -0,0 +1 @@
+build/*

doc/build/.gitignore

@@ -1,2 +0,0 @@
-*
-!.gitignore

doc/source/api/dmas.rst

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

doc/source/api/index.rst

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

doc/source/api/main.rst

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

doc/source/api/safety/safety-adc.rst

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

doc/source/api/safety/safety-controller.rst

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

doc/source/conf.py

@@ -10,17 +10,25 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
+import os, subprocess
+import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
 
+import re
+
 project = 'Shimatta Reflow Controller'
 copyright = '2020, Mario Hüttel'
 author = 'Mario Hüttel'
 
+# The full version, including alpha/beta/rc tags.
+release = re.sub('^v', '', os.popen('git describe --always --tags --dirty').read().strip())
+# The short X.Y version.
+version = release
+
+subprocess.call('doxygen Doxyfile.in', shell=True)
 
 # -- General configuration ---------------------------------------------------
 
@@ -28,7 +36,9 @@ author = 'Mario Hüttel'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-	'sphinx_rtd_theme'
+	'sphinx_rtd_theme',
+	'sphinx.ext.autodoc',
+	'breathe'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -51,3 +61,10 @@ html_theme = 'sphinx_rtd_theme'
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+breathe_projects = {
+	"Reflow Controller Firmware": "../build/_doxygen/xml/"
+}
+breathe_default_project = "Reflow Controller Firmware"
+breathe_default_members = ('members', 'undoc-members')
+

doc/source/index.rst

@@ -6,15 +6,14 @@
 Welcome to Shimatta Reflow Controller's documentation!
 ======================================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
+Quick Links
+===========
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+
+.. toctree::
+	:maxdepth: 2
+	:caption: Contents
+
+	self
+	api/index