Skip to content
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.

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

samples: hello_world: use zephyr:code-sample directive #78304

Merged

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented Sep 11, 2024

Adds missing code-sample directive to the Hello World sample in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata.

This obviously touches many files but the only actual change is the addition of the directive to the hello world sample:

.. zephyr:code-sample:: hello_world
   :name: Hello World

   Print "Hello World" to the console.

First commit is some trivial Sphinx lint fixes.

rerickson1
rerickson1 previously approved these changes Sep 12, 2024
@kartben kartben requested review from gmarull and removed request for marwaiehm-st September 12, 2024 13:09
erwango
erwango previously approved these changes Sep 12, 2024
@kartben kartben force-pushed the hello_world_code_sample_directive branch from 078e7d0 to f86ed69 Compare September 13, 2024 17:04
@kartben kartben dismissed stale reviews from erwango and rerickson1 via f6c9be9 September 13, 2024 17:07
@kartben kartben force-pushed the hello_world_code_sample_directive branch from f86ed69 to f6c9be9 Compare September 13, 2024 17:07
@kartben
Copy link
Collaborator Author

kartben commented Sep 13, 2024

rebased on main to address recent boards' READMEs referencing hello world the "old" way

https://github.com/zephyrproject-rtos/zephyr/compare/f86ed69b5910ef5f6b8356b9fb60123f3a0b090e..f6c9be99189b600e018eb216da9cabe0261867d0

@kartben
Copy link
Collaborator Author

kartben commented Sep 13, 2024

Oops, will rebase once more when Hotfix for docs currently broken on main will get merged

@kartben kartben force-pushed the hello_world_code_sample_directive branch from f6c9be9 to b23f3ce Compare September 14, 2024 06:11
fixed some ReST/Sphinx lint issues missed in earlier cleanups
prior to introducing Sphinx-linter in compliance check

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Adds missing code-sample directive to the Hello World sample in
preparation for upcoming changes to the Zephyr documentation that will
be leveraging the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
@kartben kartben force-pushed the hello_world_code_sample_directive branch from b23f3ce to 117a483 Compare September 14, 2024 07:31
@kartben kartben assigned kartben and unassigned rerickson1 Sep 14, 2024
@kartben
Copy link
Collaborator Author

kartben commented Sep 14, 2024

Re-assigned to myself as this is 100% docs/samples stuff

@aescolar aescolar merged commit 9a16b93 into zephyrproject-rtos:main Sep 16, 2024
21 checks passed
@kartben kartben deleted the hello_world_code_sample_directive branch September 16, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants