Basic template for documentation

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

1
doc/.gitignore vendored Normal file
View File

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

View File

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

2556
doc/source/Doxyfile.in Normal file

File diff suppressed because it is too large Load Diff

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

View File

@ -10,17 +10,25 @@
# add these directories to sys.path here. If the directory is relative to the # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
# import os import os, subprocess
# import sys import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
import re
project = 'Shimatta Reflow Controller' project = 'Shimatta Reflow Controller'
copyright = '2020, Mario Hüttel' copyright = '2020, Mario Hüttel'
author = '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 --------------------------------------------------- # -- General configuration ---------------------------------------------------
@ -28,7 +36,9 @@ author = 'Mario Hüttel'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinx_rtd_theme' 'sphinx_rtd_theme',
'sphinx.ext.autodoc',
'breathe'
] ]
# Add any paths that contain templates here, relative to this directory. # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
breathe_projects = {
"Reflow Controller Firmware": "../build/_doxygen/xml/"
}
breathe_default_project = "Reflow Controller Firmware"
breathe_default_members = ('members', 'undoc-members')

View File

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