zephyr/doc/guides/west
Gerard Marull-Paretas 459c3f918f doc: drop single quote references
Many documents relied on single quotes to create references, e.g.
`my_reference`. This is possible because `default_role = "any"` is
enabled in Sphinx conf.py. However, this method comes with its problems:

- It mixes all domains together, so it's not clear to what are you
  referencing: a document? a Kconfig option? a C function?...
- It creates inconsistencies: in some places explicit roles are used
  (e.g. :ref:`my_page`) while in some others not.
- _Conflictis_ with markdown. Single quotes are used for literals in
  Markdown, so people tend to use the same syntax in Sphinx, even though
  it has a different purpose.

Usages have been found using `git grep ' `[^`]*` ' -- **/*.rst`.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-10 16:43:34 -05:00
..
basics.rst doc: west: clean up example workspace 2021-02-10 08:53:39 -05:00
build-flash-debug.rst doc: west: build-flash-debug: fix cmake arg example 2021-11-22 23:04:30 -05:00
built-in.rst doc: west: add 0.11.0 docs 2021-05-04 15:29:36 -05:00
config.rst doc: west: add 0.11.0 docs 2021-05-04 15:29:36 -05:00
extensions.rst doc: west: 'west installation' is now 'west workspace' 2020-02-25 23:08:02 +02:00
index.rst doc: west 0.12 docs 2021-11-04 19:30:42 -04:00
install.rst doc: west: move advanced content out of 'basics' 2021-02-10 08:53:39 -05:00
manifest.rst doc: west 0.12 docs 2021-11-04 19:30:42 -04:00
moving-to-west.rst doc: west: 'west installation' is now 'west workspace' 2020-02-25 23:08:02 +02:00
release-notes.rst doc: west 0.12 docs 2021-11-04 19:30:42 -04:00
sign.rst doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
troubleshooting.rst doc: west: improve troubleshooting for west update 2021-02-10 08:53:39 -05:00
west-apis.rst doc: drop single quote references 2021-12-10 16:43:34 -05:00
west-mr-model.png
west-not-found.rst global: Remove leading/trailing blank lines in files 2019-12-11 19:17:27 +01:00
why.rst doc: west: move advanced content out of 'basics' 2021-02-10 08:53:39 -05:00
without-west.rst doc: improve docs on building without west 2021-02-10 08:53:39 -05:00
workspaces.rst doc: update west's workspaces.rst for 2.5 2021-02-10 08:53:39 -05:00
zephyr-cmds.rst doc: add docs for west spdx 2021-06-01 07:26:33 -05:00