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

Add sample docs #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

krish2718
Copy link
Contributor

@krish2718 krish2718 commented Jan 9, 2025

Add sample documentation to main docs.

@krish2718 krish2718 force-pushed the add_sample_docs branch 2 times, most recently from 673c213 to 9675203 Compare January 9, 2025 18:49
This was missed initially, but quite handy.

Signed-off-by: Chaitanya Tata <[email protected]>
@krish2718
Copy link
Contributor Author

krish2718 commented Jan 9, 2025

@sachinthegreen this works, but the RST files are copied from NCS and rely on NCS custom sphinx extensions, we have below choices:

  1. Fork from NCS and remove NCS custom extensions reliance and instead replace those texts manually. This approach has Duplicate maintenance effort.
  2. Clone sdk-nrf (it was removed recently from the manifest) and get those extensions work, which needs significant effort as it needs combining two sphinx projects.
  3. Remove all RST files from samples and instead point to NCS docs (URLs).

WDYT?

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.

1 participant