diff options
| author | Wyatt Hepler <hepler@google.com> | 2020-09-30 18:59:33 -0700 |
|---|---|---|
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2020-10-01 21:47:35 +0000 |
| commit | f9fb90f2993a0c450869e71ac015c3b8b1e152b5 (patch) | |
| tree | d365b92ab6d997116cebbcdde2099e0759cc8cad /pw_arduino_build | |
| parent | 455b4923ba20a18d65a813dc8fba8fc852799bfe (diff) | |
| download | pigweed-f9fb90f2993a0c450869e71ac015c3b8b1e152b5.tar.gz | |
docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
copy-and-pasted `chapter` prefix, name labels with a prefix consistent
with what they point to:
- "module-" for module
- "target-" for targets
- "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
Neither is necessary since the Pigweed docs always specify the
language in code snippets and other directives.
Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Diffstat (limited to 'pw_arduino_build')
| -rw-r--r-- | pw_arduino_build/docs.rst | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/pw_arduino_build/docs.rst b/pw_arduino_build/docs.rst index 638fd9402..6db47e32e 100644 --- a/pw_arduino_build/docs.rst +++ b/pw_arduino_build/docs.rst @@ -1,8 +1,4 @@ -.. default-domain:: cpp - -.. highlight:: sh - -.. _chapter-pw-arduino-build: +.. _module-pw_arduino_build: ----------------- pw_arduino_build @@ -12,7 +8,7 @@ The ``pw_arduino_build`` module contains both the `arduino_builder`_ command line utility and an `Arduino Main Wrapper`_. .. seealso:: - See the :ref:`chapter-arduino` target documentation for a list of supported + See the :ref:`target-arduino` target documentation for a list of supported hardware. Arduino Main Wrapper @@ -43,7 +39,7 @@ after that early init we run it within ``setup()``: void loop() {} .. note:: - ``pw_arduino_Init()`` initializes the :ref:`chapter-pw-sys-io-arduino` + ``pw_arduino_Init()`` initializes the :ref:`module-pw_sys_io_arduino` module. .. warning:: |