Documentation guidelines

This documentation is built with Sphinx and all source code is available at the path docs.

To contribute to it, first read Forking and publishing, read the guidelines (both the general and the additional guidelines below) and also Creating new pages.

When you are satisfied with your contribution, open a pull request with the changes to this repository.

Templates

Any page can be used as a template.

In particular, for evaluation board user-guide, use the ADRV9009 & ADRV9008 pages as a template.

For (future) template pages with :orphan: on the first line, remove it. This marker is used to hide the templates from the TOC tree.

Also, instructions using the comment syntax may be present on the page and also need to be removed. Those comments have the format:

..
   I'm a comment