About this documentation

The Bridle 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 Bridle and describes our libraries, samples, and applications. API documentation is extracted from the source code and included with the library documentation.

The documentation follows specific conventions and templates proper to the Bridle, which might differ from Zephyr’s conventions and templates. Read the reStructuredText Primer, the Sphinx Documentation and the Li-Pro.Net Sphinx Primer to learn how to write documentation.

• Documentation structure
  • Documentation search
  • Different set versions
• Building Bridle documentation
  • Before you start
  • Building documentation output
  • Serve documentation locally
  • Caching and cleaning
  • Testing different versions locally
  • Dealing with warnings
• Documentation style guide
  • RST style guide
  • Doxygen style guide
• Documentation templates
  • Custom service template
  • Sample template