1NimBLE Bluetooth Stack Documentation 2################################# 3 4This folder holds the documentation for the NimBLE Bluetooth stack from the 5`Apache Mynewt`_ project. It is built using `Sphinx`_. 6The source code also contains inline comments in `Doxygen`_ 7format to document the APIs. 8 9The complete project documentation can be found at `mynewt documentation`_ 10 11.. contents:: 12 13Writing Documentation 14======================= 15 16See: https://github.com/apache/mynewt-documentation#writing-documentation 17 18Previewing Changes 19========================== 20 21In order to preview any changes you make you must first install a Sphinx 22toolchain as described at https://github.com/apache/mynewt-documentation#id3. 23 Then: 24 25.. code-block:: bash 26 27 $ cd docs 28 $ make clean && make preview && (cd _build/html && python -m SimpleHTTPServer 8080) 29 30.. _Apache Mynewt: https://mynewt.apache.org/ 31.. _mynewt documentation: https://github.com/apache/mynewt-documentation 32.. _Sphinx: http://www.sphinx-doc.org/ 33.. _Doxygen: http://www.doxygen.org/ 34