Skip to content

Conversation

mjohanse-emr
Copy link
Collaborator

What does this Pull Request accomplish?

  • Adds the RTD link as documentation in project.urls
  • Updates intersphinx mappings for packages that depend on other packages within ni-apis-python.

Why should this Pull Request be merged?

Fixes #96

What testing has been done?

Docs build during PR checks

Copy link
Contributor

github-actions bot commented Sep 11, 2025

Test Results

   76 files  ±0     76 suites  ±0   1m 58s ⏱️ +3s
  187 tests ±0    185 ✅ ±0   2 💤 ±0  0 ❌ ±0 
1 850 runs  ±0  1 820 ✅ ±0  30 💤 ±0  0 ❌ ±0 

Results for commit c24c3d3. ± Comparison against base commit 139f7f6.

♻️ This comment has been updated with latest results.

Signed-off-by: Michael Johansen <[email protected]>
@mjohanse-emr mjohanse-emr marked this pull request as ready for review September 11, 2025 19:50
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ni.measurementlink.discovery.v1.client/pyproject.toml is missing the doc url

Comment on lines +79 to +84
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"ni.measurementlink.discovery.v1.client": ("https://nimeasurementlinkdiscoveryv1client.readthedocs.io/en/latest/", None),
"ni.measurementlink.measurement.v1.proto": ("https://nimeasurementlinkmeasurementv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.measurement.v2.proto": ("https://nimeasurementlinkmeasurementv2proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.sessionmanagement.client": ("https://nimeasurementlinksessionmanagementclient.readthedocs.io/en/latest/", None),
"ni.measurementlink.pinmap.v1.proto": ("https://nimeasurementlinkpinmapv1proto.readthedocs.io/en/latest/", None),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these are needed. Also, one is missing v1.

Suggested change
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"ni.measurementlink.discovery.v1.client": ("https://nimeasurementlinkdiscoveryv1client.readthedocs.io/en/latest/", None),
"ni.measurementlink.measurement.v1.proto": ("https://nimeasurementlinkmeasurementv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.measurement.v2.proto": ("https://nimeasurementlinkmeasurementv2proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.sessionmanagement.client": ("https://nimeasurementlinksessionmanagementclient.readthedocs.io/en/latest/", None),
"ni.measurementlink.pinmap.v1.proto": ("https://nimeasurementlinkpinmapv1proto.readthedocs.io/en/latest/", None),
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"ni.measurementlink.discovery.v1.client": ("https://nimeasurementlinkdiscoveryv1client.readthedocs.io/en/latest/", None),
("https://nimeasurementlinksessionmanagementclient.readthedocs.io/en/latest/", None),
"ni.measurementlink.pinmap.v1.proto": ("https://nimeasurementlinkpinmapv1proto.readthedocs.io/en/latest/", None),

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ni.measurementlink.sessionmanagement.v1.client/pyproject.toml is missing the doc link

Comment on lines 80 to 87
"grpc": ("https://grpc.github.io/grpc/python/", None),
"ni.measurementlink.sessionmanagement.v1.proto": ("https://nimeasurementlinksessionmanagementv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.pinmap.v1.proto": ("https://nimeasurementlinkpinmapv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.proto": ("https://nimeasurementlinkproto.readthedocs.io/en/latest/", None),
"ni.grpcdevice.v1.proto": ("https://nigrpcdevicev1proto.readthedocs.io/en/latest/", None),
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"ni.measurementlink.discovery.v1.client": ("https://nimeasurementlinkdiscoveryv1client.readthedocs.io/en/latest/", None),
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"grpc": ("https://grpc.github.io/grpc/python/", None),
"ni.measurementlink.sessionmanagement.v1.proto": ("https://nimeasurementlinksessionmanagementv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.pinmap.v1.proto": ("https://nimeasurementlinkpinmapv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.proto": ("https://nimeasurementlinkproto.readthedocs.io/en/latest/", None),
"ni.grpcdevice.v1.proto": ("https://nigrpcdevicev1proto.readthedocs.io/en/latest/", None),
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"ni.measurementlink.discovery.v1.client": ("https://nimeasurementlinkdiscoveryv1client.readthedocs.io/en/latest/", None),
}
"grpc": ("https://grpc.github.io/grpc/python/", None),
"ni.measurementlink.sessionmanagement.v1.proto": ("https://nimeasurementlinksessionmanagementv1proto.readthedocs.io/en/latest/", None),
"ni.measurementlink.proto": ("https://nimeasurementlinkproto.readthedocs.io/en/latest/", None),
"ni.grpcdevice.v1.proto": ("https://nigrpcdevicev1proto.readthedocs.io/en/latest/", None),
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"ni.measurementlink.discovery.v1.client": ("https://nimeasurementlinkdiscoveryv1client.readthedocs.io/en/latest/", None),
}

@@ -31,6 +31,7 @@ requires-python = '>=3.9,<4.0'

[project.urls]
repository = "https://github.com/ni/ni-apis-python"
documentation = "https://nidatamonikersv1proto.readthedocs.io/en/latest/"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's working now. @mjohanse-emr did you change anything?

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.

Update docs conf.py intersphinx mappings once all packages have been published
3 participants