Skip to content

samples: misc fixes to docs #44775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 12, 2022
Merged

samples: misc fixes to docs #44775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion samples/modules/tflite-micro/hello_world/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ It is recommended that you copy and modify one of the two TensorFlow
samples when creating your own TensorFlow project. To build with
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`:

.. code-block:: console
.. code-block:: kconfig

CONFIG_CPLUSPLUS=y
CONFIG_NEWLIB_LIBC=y
Expand Down
8 changes: 3 additions & 5 deletions samples/modules/tflite-micro/magic_wand/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ start the emulator:

.. code-block:: console

renode -e "set zephyr_elf @./build/zephyr/zephyr.elf; s @./renode/litex-vexriscv-tflite.resc"
renode -e "set zephyr_elf @./build/zephyr/zephyr.elf; s @./samples/modules/tflite-micro/magic_wand/renode/litex-vexriscv-tflite.resc"

.. _download and install Renode 1.12 or higher as a package:
https://github.com/renode/renode/releases/
Expand Down Expand Up @@ -102,11 +102,9 @@ Modifying Sample for Your Own Project

It is recommended that you copy and modify one of the two TensorFlow
samples when creating your own TensorFlow project. To build with
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`.
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`:

:file:`prj.conf`:

.. code-block:: console
.. code-block:: kconfig

CONFIG_CPLUSPLUS=y
CONFIG_NEWLIB_LIBC=y
Expand Down
2 changes: 1 addition & 1 deletion samples/net/cloud/google_iot_mqtt/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ from the Google Cloud Platform itself:
From these values, the config values can be set using the following
template:

.. code-block: kconfig
.. code-block:: kconfig

CLOUD_CLIENT_ID="projects/PROJECT_ID/locations/REGION/registries/REGISTRY_ID/devices/DEVICE_ID"
CLOUD_AUDIENCE="PROJECT_ID"
Expand Down
2 changes: 1 addition & 1 deletion samples/net/mqtt_publisher/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ same host as the MQTT broker.
To start a proxy server, ``ssh`` can be used.
Use the following command to run it on your host with the default port:

.. code-block: console
.. code-block:: console

$ ssh -N -D 0.0.0.0:1080 localhost

Expand Down
4 changes: 2 additions & 2 deletions samples/net/sockets/echo_client/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,13 @@ with the default port:

For IPv4 proxy server:

.. code-block: console
.. code-block:: console

$ ssh -N -D 0.0.0.0:1080 localhost

For IPv6 proxy server:

.. code-block: console
.. code-block:: console

$ ssh -N -D [::]:1080 localhost

Expand Down