docs:opkg: clean up RST

[amstewart]

Summary

• Fixup minor RST layout issues.
• Use inline literal markup for inline code and applications, rather than bold.
• Refer to IPKs and DEBs, instead of .ipks and .debs in most places.
• Reflow prose to line-break on sentence ends, for easier diffing.
• Minor content changes for clarity.

Testing

• Ran make html locally and manually validated that the opkg tutorials look better and the links work.

[amstewart]

Patch V2

• Address review feedback.

[Copilot]

Pull Request Overview

This PR cleans up and improves the RST documentation for opkg tutorials by addressing minor formatting issues and improving readability. The changes focus on:

• Replacing bold formatting with inline literal markup for code elements and applications
• Changing references from ".ipks" and ".debs" to "IPKs" and "DEBs" for consistency
• Reflowing prose to break on sentence boundaries for better diff readability
• Minor content clarifications and link reference improvements

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File	Description
docs/source/opkg/opkg_intro.rst	Updates formatting, terminology, and prose flow for the basic opkg tutorial
docs/source/opkg/dkms_opkg.rst	Applies similar formatting and terminology improvements to the DKMS-based kernel module tutorial

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[amstewart]

Patch v2

• Addressed copilot feedback.
• Removed tarballs from source control and build them from the Makefile.
• Replace Charlie Johnston's email in the example opkg IPKs with the RTOS team email.

[jpautler]

When I build and preview the HTML content locally, I see a lot of lines wrapping with syllable-boundary hyphenation. Wrapping on word boundaries seems more readable. Was this intentional or just an unintended side effect?

[jpautler]

When I extract the new locally built dkms_opkg.tar.gz archive, I noticed that it lost the containing dkms_opkg directory upon extraction. Instead it extracts the hello and module_src directories directly into the current directory. This is different than opkg_intro.tar.gz and different than the old dkms_opkg.tar.gz. Perhaps unintended?

[amstewart]

When I build and preview the HTML content locally, I see a lot of lines wrapping with syllable-boundary hyphenation. Wrapping on word boundaries seems more readable. Was this intentional or just an unintended side effect?

I didn't do anything to effect the word-braking logic. I see places on the published docs that sphinx breaks the word as well.

https://nilrt-docs.ni.com/opkg-keyrings/opkg-keyrings_index.html#systemlink

Copilot tells me that this behavior is controlled by the browser and your CSS. We could modify our sphinxdocs theme to tell it not to break words. But that isn't a part of this PR's purpose.

[amstewart]

When I extract the new locally built dkms_opkg.tar.gz archive, I noticed that it lost the containing dkms_opkg directory upon extraction. Instead it extracts the hello and module_src directories directly into the current directory. This is different than opkg_intro.tar.gz and different than the old dkms_opkg.tar.gz. Perhaps unintended?

These are the example IPKs I just downloaded from the published site. They seem similar to what we package with this PR. Are you seeing something different?

[0]usr0@rtosams3:Downloads$ tar --list -f ./opkg_intro\(2\).tar.gz 
CONTROL
debian-binary
helloworld.c
[0]usr0@rtosams3:Downloads$ tar --list -f ./dkms_opkg.tar.gz 
hello/
hello/debian-binary
hello/CONTROL/
hello/CONTROL/control
hello/CONTROL/prerm
hello/CONTROL/postinst
hello/usr/
hello/usr/src/
hello/usr/src/hello-0.1/
hello/usr/src/hello-0.1/Makefile
hello/usr/src/hello-0.1/hello.c
hello/usr/src/hello-0.1/dkms.conf
module_src/
module_src/hello-0.1/
module_src/hello-0.1/Makefile
module_src/hello-0.1/hello.c
module_src/hello-0.1/dkms.conf

Though now that I look at them more closely... I'm not sure these are good examples of IPKs. Especially the DKMS one seems malformed.

[amstewart]

I'll take a deeper look at the example IPKs when I have some time.

[amstewart]

Patch v3

• Refactor opkg_intro and dkms_opkg source tarballs to be a little more sane.
• Use literalinclude in dkms_opkg to include source files.
• Enable -W in sphinx compilation so that we will fail on warnings.
• Set word-break to 'manual' in the CSS to reduce the frequency of word breaks.
• Fix some broken image embeds.