Commit c6a7a99f authored by Niels Post's avatar Niels Post
Browse files

- Added documentation generation through doxygen-breathe-sphinx

parent 145546a2
......@@ -2,4 +2,5 @@
CMakeListsPrivate.txt
cmake-build-*/
CMakeLists.txt
docs/*/
\ No newline at end of file
This diff is collapsed.
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# 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
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'PMSV Warehouse Robot'
copyright = '2020, Niels Post'
author = 'Niels Post'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"breathe"
]
breathe_default_project = "PMSVRobot"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,
# 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']
\ No newline at end of file
doxygen Doxyfile
sphinx-build -b html -Dbreathe_projects.PMSVRobot=./xml "." "_build"
.. PMSV Warehouse Robot documentation master file, created by
sphinx-quickstart on Tue Oct 27 13:49:22 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PMSV Warehouse Robot's documentation!
================================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Communication
==================
.. doxygenclass:: CommunicationController
:members:
:protected-members:
Commands
-------------------
.. doxygenstruct:: Command
:members:
.. doxygenstruct:: ReturnCommand
:members:
Handlers
-------------------
.. doxygenclass:: CommandHandler
:members:
.. doxygenclass:: GeneralCommandHandler
:members:
.. doxygenclass:: ActionCommandHandler
:members:
.. doxygenclass:: MeasurementCommandHandler
:members:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment