Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
os
.gitignore
Makefile
README.rst
conf.py
doxygen.xml
index.rst

README.rst

Mynewt Documentation

This folder holds the documentation for the core OS of the Apache Mynewt project. It is built using Sphinx. The source code also contains inline comments in Doxygen format to document the APIs.

The complete project documentation can be found at mynewt documentation

Writing Documentation

See: https://github.com/apache/mynewt-documentation#writing-documentation

Previewing Changes

In order to preview any changes you make you must first install a Sphinx/Breathe/Doxygen toolchain as described at https://github.com/apache/mynewt-documentation#id3. Then:

$ cd docs
$ make clean && make preview && (cd _build/html && python -m SimpleHTTPServer 8080)