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