<commit_before>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`_

.. contents::

Writing Documentation
=======================

`Sphinx`_ use reStructuredText. http://www.sphinx-doc.org/en/1.5.1/rest.html.

Embedding `Doxygen`_ generated source documentation is through the `Breathe`_
bridge. http://breathe.readthedocs.io/en/latest/.

Linking to source uses `Sphinx`_'s C++ domain. http://www.sphinx-doc.org/en/1.5.1/domains.html#id2

Previewing Changes
==========================

In order to preview any changes you make you must first install a Sphinx/Breathe/Doxygen toolchain as
described at `mynewt documentation`_. Then:

.. code-block:: bash

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



.. _Apache Mynewt: https://mynewt.apache.org/
.. _mynewt documentation: https://github.com/apache/mynewt-documentation
.. _Sphinx: http://www.sphinx-doc.org/
.. _Doxygen: http://www.doxygen.org/
.. _Breathe: http://breathe.readthedocs.io/en/latest/<commit_msg>docs: update doc for docs<commit_after>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`_

.. contents::

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:

.. code-block:: bash

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



.. _Apache Mynewt: https://mynewt.apache.org/
.. _mynewt documentation: https://github.com/apache/mynewt-documentation
.. _Sphinx: http://www.sphinx-doc.org/
.. _Doxygen: http://www.doxygen.org/
.. _Breathe: http://breathe.readthedocs.io/en/latest/
{'fraction_non_alphanumeric': 0.1614802354920101, 'fraction_numerical': 0.00672834314550042, 'mean_word_length': 4.431506849315069, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1149007', 'n_tokens_mistral': 781, 'n_tokens_neox': 732, 'n_words': 221}