zephyr/boards/xtensa
David B. Kinder 6000a6205a doc: prepare for improving doc API linking
Linking to API material requires knowing the pecularities of how
doxygen, sphinx, and breathe work. In an attempt to hide some of this
we're preparing the current docs to allow use of configuration defaults
that will let us more simply use a default role that will hunt for a
reference target in the various domains that are available by using a
default "role" of "all".  This will let us use the simple notation
`functionname` or `typename` without fully specifying the reference as
:c:func:`functionname`.

This patch cleans up exising docs that were (incorrectly) using single
backtics where double backtics should have been used, and also found
some typos (such as a space between the role name and the reference,
such as :file: `filename`, and a missing colon such as
c:func:`functionname`)

This is a start to address issue #14313

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-15 05:47:19 +01:00
..
esp32 doc: prepare for improving doc API linking 2019-03-15 05:47:19 +01:00
intel_s1000_crb doc: update xcc installation instructions 2019-02-26 02:58:07 +01:00
qemu_xtensa kconfig: Remove blank lines at the beginning/end of files 2019-03-13 07:29:42 -05:00
xt-sim doc: use :zephyr_file: where appropriate 2019-03-09 09:50:27 -05:00
index.rst doc: fix sidebar nav issues with board docs 2017-06-27 19:21:29 -04:00