Add documentation

Add the starting point for new and improved documentation.

Signed-off-by: Håvard Vermeer <[email protected]>

doc/API_documentation.rst

@@ -0,0 +1,27 @@
+.. _liblwm2m_api:
+
+API documentation
+#################
+
+.. contents::
+   :local:
+   :depth: 2
+
+Following are the API elements used by the Softbank FOTA library:
+
+| Header files: :file:`lib/bin/sb_fota/include`
+| Source files: :file:`lib/bin/sb_fota`
+
+Softbank FOTA library API
+=========================
+
+.. doxygengroup:: sb_fota
+   :members:
+
+.. _sb_fota_os:
+
+Softbank FOTA OS layer
+======================
+
+.. doxygengroup:: sb_fota_os
+   :members:

doc/Doxyfile

@@ -918,8 +918,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = _doxygen/main.md \
-                         _doxygen/groups.dox \
-                         ../include
+                         ../lib/bin/sb_fota/include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doc/conf.py

@@ -3,6 +3,9 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+from pathlib import Path
+import sys
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
@@ -11,15 +14,43 @@
 author = 'Nordic Semiconductor'
 release = '0.0.1'
 
+# Paths
+
+DOC_BASE = Path(__file__).absolute()
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+sys.path.insert(0, str("_extensions"))
+
+extensions = [
+    'breathe',
+    'sphinxcontrib.mscgen',
+    'sphinx_tabs.tabs',
+    'sphinx_togglebutton',
+]
+
 
 templates_path = ['_templates']
 exclude_patterns = ['_build_sphinx', 'Thumbs.db', '.DS_Store']
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'sphinx_ncs_theme'
+
+## -- Options for Breathe ----------------------------------------------------
+# https://breathe.readthedocs.io/en/latest/index.html
+#
+# WARNING: please, check breathe maintainership status before using this
+# extension in production!
+
+breathe_projects = {'ncs-softbank': '_build_doxygen/xml'}
+breathe_default_project = 'ncs-softbank'
+breathe_default_members = ('members', )
+
+# Include following files at the end of each .rst file.
+rst_epilog = """
+.. include:: /links.txt
+.. include:: /shortcuts.txt
+"""