zephyr/doc/guides
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
..
bluetooth doc: Bluetooth: Add initial documentation for the GATT layer 2019-03-13 10:40:05 +01:00
device_mgmt
documentation
dts doc: prepare for improving doc API linking 2019-03-15 05:47:19 +01:00
kconfig doc: kconfig: Encourage using menuconfig as a sanity check 2019-03-11 16:36:20 -07:00
networking
porting doc: prepare for improving doc API linking 2019-03-15 05:47:19 +01:00
test doc: prepare for improving doc API linking 2019-03-15 05:47:19 +01:00
tools
tracing
west doc: Fix typo and markup elements 2019-03-14 19:14:36 -05:00
c_library.rst
coccinelle.rst
code-relocation.rst
coverage.rst
index.rst