Merge branch 'feature/sphinx' into develop

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api-reference/devices/ds18x20.rst

@@ -0,0 +1,6 @@
+.. _api_device_ds18x20:
+
+DS18x20 temperature sensor
+==========================
+
+.. doxygengroup:: OW_DEVICE_DS18x20

docs/api-reference/devices/index.rst

@@ -0,0 +1,12 @@
+.. _api_device_drivers:
+
+Device drivers
+==============
+
+List of all supported device drivers
+
+.. toctree::
+	:maxdepth: 2
+	:glob:
+
+	*

docs/api-reference/index.rst

@@ -0,0 +1,14 @@
+.. _api_reference:
+
+API reference
+=============
+
+List of all the modules:
+
+.. toctree::
+	:maxdepth: 2
+	:glob:
+
+	*
+	*/index
+

docs/api-reference/ow.rst

@@ -0,0 +1,6 @@
+.. _api_ow:
+
+OneWire-UART
+============
+
+.. doxygengroup:: OW

docs/api-reference/ow_config.rst

@@ -0,0 +1,6 @@
+.. _api_ow_config:
+
+Configuration
+=============
+
+.. doxygengroup:: OW_CONFIG

docs/api-reference/ow_ll.rst

@@ -0,0 +1,6 @@
+.. _api_ow_ll:
+
+Low-level functions
+===================
+
+.. doxygengroup:: OW_LL

docs/api-reference/ow_sys.rst

@@ -0,0 +1,9 @@
+.. _api_ow_sys:
+
+System functions
+================
+
+System function are used in conjunction with thread safety.
+Please check :ref:`thread_safety` section for more information
+
+.. doxygengroup:: OW_SYS

docs/conf.py

@@ -0,0 +1,105 @@
+# 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('.'))
+from sphinx.builders.html import StandaloneHTMLBuilder
+import subprocess, os
+
+# Run doxygen first
+# read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+# if read_the_docs_build:
+subprocess.call('doxygen doxy_ow.doxy', shell=True)
+# -- Project information -----------------------------------------------------
+
+project = 'OneWire UART'
+copyright = '2019, Tilen Majerle'
+author = 'Tilen MAJERLE'
+
+# The full version, including alpha/beta/rc tags
+release = '1.2.0'
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+
+	'breathe',
+]
+
+# 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']
+
+highlight_language = 'c'
+
+# -- 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'
+html_theme_options = {
+    'canonical_url': '',
+    'analytics_id': '',  #  Provided by Google in your dashboard
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': False,
+
+    'logo_only': False,
+
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False
+}
+html_logo = 'static/images/logo_tm.png'
+github_url = 'https://github.com/MaJerle/onewire-uart'
+
+# 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']
+html_css_files = [
+    'css/common.css',
+    'css/custom.css',
+]
+
+master_doc = 'index'
+
+#
+# Breathe configuration
+#
+#
+#
+breathe_projects = {
+	"onewire_uart": "_build/xml/"
+}
+breathe_default_project = "onewire_uart"
+breathe_default_members = ('members', 'undoc-members')