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

Doc changes cherrypick #2286

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

sean-madigan
Copy link
Contributor

Brings in doc changes from upstream

…le directive

Adopt zephyr:code-sample directive to describe the Dining
Philosophers sample and update reference accordingly.

Signed-off-by: Benjamin Cabé <[email protected]>
(cherry picked from commit a5b7349)

Signed-off-by: Sean Madigan <[email protected]>
…ated package

move domain.py to domain/ to make it easier to keep things organized
and e.g. add dedicated css/js resources, etc.

Signed-off-by: Benjamin Cabé <[email protected]>
(cherry picked from commit 3d7bb30)

Signed-off-by: Sean Madigan <[email protected]>
…ries

This commit adds support for categorizing code samples in the
documentation.

It introduces two new directives:

- `zephyr:code-sample-category::` to create a category and associated
  brief description, that implicitly acts as a toctree too.

- `zephyr:code-sample-listing::` to allow dumping a list of samples
  corresponding to a category anywhere in the documentation.

Fixes #62453.

Signed-off-by: Benjamin Cabé <[email protected]>
(cherry picked from commit 793c70d)

Signed-off-by: Sean Madigan <[email protected]>
This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <[email protected]>
(cherry picked from commit 1db9b00)

Signed-off-by: Sean Madigan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants