Prepare Repo for Publishing autoapi Documentation via readthedocs

[alexdubois-ni]

What does this Pull Request accomplish?

Prepare Repo for Publishing autoapi Documentation via readthedocs

Why should this Pull Request be merged?

As-of-today, we only have documentation via our README and inline code. This does not follow the standard in nimi-python and daqmx-python as-of-today which use readthedocs and sphynx to publish documentation and even embed direct references.

When I am adding documentation to nimi-python and daqmx-python, this will make documentation more streamlined and consistent (no linking to direct github README pages or anything, etc).

This was recommended from folks like Jay and Brad.

While I AM at it, I am also re-evaluating our public API surface. The autoapi flagged a LOT of our API and made it VERY public facing. But, in my opinion only a very small portion of this should really be public. Furthermore, I fixed a lot of documentation to be more properly representative. Also, I renamed everything from NI-TLS to NI TLS to match what we have on gRPC device's documentation and what I am adding to nimi-python as well.

What testing has been done?

Checked the generated docs and they look reasonable now.

[ni-github-admins]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[Copilot]

🟢 Approval recommended

The documentation publishing setup and intentional API-surface changes are consistent and covered by updated tests.

Pull request overview

Prepares the project for Read the Docs publishing while refining its documented public API.

Changes:

• Adds Read the Docs configuration and README-based documentation landing page.
• Marks internal CLI, audit, and service helpers as private.
• Improves NI TLS terminology and sensitive-data guidance.

File summaries

File	Description
.readthedocs.yml	Configures Poetry and Sphinx builds.
docs/index.rst	Includes the README and API reference.
pyproject.toml	Adds the documentation URL and updates metadata.
README.md	Clarifies installation, TLS defaults, and examples.
src/nitlsconfig/__init__.py	Updates package documentation.
src/nitlsconfig/_service.py	Updates service terminology.
src/nitlsconfig/audit.py	Makes transport-audit internals private.
src/nitlsconfig/channel_tag.py	Clarifies channel-tag documentation.
src/nitlsconfig/cli.py	Narrows the public API and improves key warnings.
src/nitlsconfig/errors.py	Updates NI TLS terminology.
src/nitlsconfig/grpc_channel.py	Uses private internals and refines documentation.
tests/unit/test_audit.py	Updates tests for private audit symbols.
tests/unit/test_nitlsconfig.py	Updates fixtures for private CLI helpers.

Review details

• Files reviewed: 13/13 changed files
• Comments generated: 0
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.