About this documentation

The nRF Connect SDK documentation is written using the reStructuredText markup language (.rst file extension) with Sphinx extensions and processed using Sphinx. It contains all information that is specific to the nRF Connect SDK and describes our libraries, samples, and applications. API documentation is generated from Doxygen comments and included with the library documentation.

The documentation follows specific conventions and templates proper to the nRF Connect SDK, which might differ from Zephyr’s conventions and templates.

Subpages:

• Documentation structure
  • Documentation search
  • Different set versions
• Building the nRF Connect SDK documentation
  • Before you start
  • Building documentation output
  • Caching and cleaning
  • Testing different versions locally
  • Dealing with warnings
• Documentation guidelines
  • RST guidelines
  • Doxygen guidelines
• Documentation templates
  • Template: Ecosystem integration
  • Custom service template
  • Template: Library
  • Mesh model template
  • Template: Sample
• Documentation build process
  • Building with Sphinx
  • Building and publishing the documentation