Used breathe to go from Doxy to Sphinx

Author: laurentva

.gitignore

@@ -1,5 +1,6 @@
-Doxyfile
-xml/
-html/
+# Doxyfile
+docs/doxygen_output/*
 *.gch
 docs/_build
+
+!docs/doxygen_output/xml

Doxyfile

@@ -1,4 +1,4 @@
-/**
+/*
   Pozyx_definitions.h - Library for Arduino Pozyx shield.
   Copyright (c) Pozyx Laboratories.  All right reserved.
 
@@ -28,7 +28,7 @@
 #define _POZYX_FORMAT_FOOT
 #define _POZYX_FORMAT_INCH
 
-// maximum number of anchors to be stored in the interal anchor list on the pozyx device
+/* Maximum number of anchors to be stored in the interal anchor list on the pozyx device */
 #define MAX_ANCHORS_IN_LIST          20
 
 #define POZYX_I2C_ADDRESS        0x4B

Pozyx_definitions.h

@@ -24,7 +24,7 @@
 author = 'Samuel Van de Velde, Vadim Vermeiren, Laurent Van Acker'
 
 # The short X.Y version
-version = ''
+version = '1.2'
 # The full version, including alpha/beta/rc tags
 release = '1.2.2'
 
@@ -39,8 +39,14 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'breathe',
 ]
 
+
+breathe_projects = { "ardupozyx": '/'.join(__file__.split('/')[:-1]) + "/doxygen_output/xml"}
+
+breathe_default_project = "ardupozyx"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/conf.py

@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
+  <compounddef id="_r_e_a_d_m_e_8md" kind="file" language="Markdown">
+    <compoundname>README.md</compoundname>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <programlisting>
+<codeline><highlight class="normal">#<sp/>Pozyx-Arduino-library</highlight></codeline>
+<codeline><highlight class="normal">The<sp/>Arduino<sp/>library<sp/>for<sp/>use<sp/>with<sp/>the<sp/>pozyx<sp/>shield.</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">Please<sp/>download<sp/>a<sp/>release<sp/>version<sp/>for<sp/>a<sp/>safely<sp/>stable<sp/>experience!</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">The<sp/>library<sp/>requires<sp/>**firmware<sp/>version<sp/>1.1**<sp/>installed<sp/>on<sp/>the<sp/>Pozyx<sp/>devices.</highlight></codeline>
+<codeline><highlight class="normal">If<sp/>you&apos;re<sp/>on<sp/>an<sp/>older<sp/>version<sp/>of<sp/>the<sp/>firmware<sp/>and<sp/>do<sp/>not<sp/>want<sp/>to<sp/>upgrade<sp/>for<sp/>some<sp/>reason,<sp/>please<sp/>download<sp/>an<sp/>older<sp/>release<sp/>of<sp/>the<sp/>library<sp/>according<sp/>to<sp/>their<sp/>respective<sp/>release<sp/>description.</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">Documentation<sp/>for<sp/>the<sp/>library<sp/>can<sp/>be<sp/>found<sp/>here:</highlight></codeline>
+<codeline><highlight class="normal">https://www.pozyx.io/Documentation/Datasheet/arduino</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">If<sp/>you<sp/>encounter<sp/>any<sp/>issues,<sp/>please<sp/>send<sp/>a<sp/>mail<sp/>to<sp/>support@pozyx.io<sp/>instead<sp/>of<sp/>creating<sp/>an<sp/>issue<sp/>here.</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">The<sp/>following<sp/>folders<sp/>can<sp/>be<sp/>found<sp/>together<sp/>with<sp/>this<sp/>library:</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">1.<sp/><sp/>**examples**.<sp/>These<sp/>example<sp/>scripts<sp/>showcase<sp/>some<sp/>basic<sp/>functionality<sp/>of<sp/>the<sp/>Pozyx<sp/>device,<sp/>each<sp/>example<sp/>comes<sp/>with<sp/>a<sp/>tutorial<sp/>that<sp/>can<sp/>be<sp/>found<sp/>on<sp/>the<sp/>pozyx<sp/>website<sp/>https://www.pozyx.io/Documentation</highlight></codeline>
+<codeline><highlight class="normal">2.<sp/><sp/>**unit_test**.<sp/>This<sp/>folder<sp/>contains<sp/>a<sp/>collection<sp/>of<sp/>Arduino<sp/>scripts<sp/>that<sp/>can<sp/>be<sp/>run<sp/>to<sp/>test<sp/>certain<sp/>functionalities<sp/>of<sp/>the<sp/>Pozyx<sp/>device.<sp/>They<sp/>also<sp/>serve<sp/>as<sp/>some<sp/>good<sp/>examples<sp/>for<sp/>some<sp/>Arduino<sp/>library<sp/>functions.</highlight></codeline>
+<codeline><highlight class="normal">3.<sp/><sp/>**useful**.<sp/>This<sp/>folder<sp/>contains<sp/>a<sp/>number<sp/>of<sp/>useful<sp/>Arduino<sp/>sketches<sp/>that<sp/>provide<sp/>basic<sp/>functionality<sp/>such<sp/>as<sp/>discovering<sp/>all<sp/>pozyx<sp/>devices<sp/>or<sp/>configuring<sp/>them.</highlight></codeline>
+    </programlisting>
+    <location file="README.md"/>
+  </compounddef>
+</doxygen>

docs/doxygen_output/xml/_pozyx_8h.xml

@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
+  <compounddef id="changelog_8md" kind="file" language="Markdown">
+    <compoundname>changelog.md</compoundname>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <programlisting>
+<codeline><highlight class="normal">#<sp/>Arduino<sp/>Pozyx<sp/>library<sp/>change<sp/>log</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">##<sp/>Version<sp/>1.0.1</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>function<sp/>documentation<sp/>for<sp/>doxygen</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>defines<sp/>for<sp/>parameter<sp/>descriptions</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>assertions<sp/>to<sp/>all<sp/>functions<sp/>for<sp/>checking<sp/>API<sp/>function<sp/>parameters</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>function<sp/>getErrorCode</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>function<sp/>setTxPower,<sp/>getTxPower</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>function<sp/>setUWBChannel,<sp/>getUWBChannel</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Added<sp/>unit<sp/>tests<sp/>for<sp/>platform<sp/>specific<sp/>functions</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>The<sp/>sensor<sp/>functions<sp/>now<sp/>return<sp/>the<sp/>sensor<sp/>values<sp/>in<sp/>metric<sp/>numbers<sp/>instead<sp/>of<sp/>raw<sp/>numbers</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Removed<sp/>spurious<sp/>Serial.print<sp/>lines<sp/></highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getAcceleration<sp/>to<sp/>getAcceleration_mg</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getGyro<sp/>to<sp/>getAngularVelocity_dps</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getEulerAngles<sp/>to<sp/>getEulerAngles_deg</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getGravity<sp/>to<sp/>getGravityVector_mg</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getLinearAcceleration<sp/>to<sp/>getLinearAcceleration_mg</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getSensorData<sp/>to<sp/>getAllSensorData</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getPressure<sp/>to<sp/>getPressure_Pa</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getMagnetic<sp/>to<sp/>getMagnetic_uT</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>Rename<sp/>function<sp/>getTemperature<sp/>to<sp/>getTemperature_c</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">##<sp/>Version<sp/>1.0.0</highlight></codeline>
+<codeline><highlight class="normal">-<sp/>initial<sp/>release</highlight></codeline>
+    </programlisting>
+    <location file="changelog.md"/>
+  </compounddef>
+</doxygen>