Skip to content

Conversation

@dixonjoel
Copy link
Collaborator

@dixonjoel dixonjoel commented Aug 21, 2025

What does this Pull Request accomplish?

AB#3233030

Updating the conf.py and index.rst etc to make the sphinx doc build generate API content correctly.

Why should this Pull Request be merged?

Correct docs to go on readthedocs.org.

What testing has been done?

Building the docs and inspecting locally.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 21, 2025

Test Results

   66 files  ±0     66 suites  ±0   1m 45s ⏱️ -1s
  180 tests ±0    180 ✅ ±0   0 💤 ±0  0 ❌ ±0 
1 784 runs  ±0  1 774 ✅ ±0  10 💤 ±0  0 ❌ ±0 

Results for commit ef318f3. ± Comparison against base commit 9900c15.

♻️ This comment has been updated with latest results.

@dixonjoel dixonjoel marked this pull request as draft August 21, 2025 15:48
@dixonjoel dixonjoel changed the title [DRAFT - Do Not Review] Fix docs for ni.grpcdevice.v1.proto package [DRAFT] Fix docs for ni.grpcdevice.v1.proto package Aug 21, 2025
@dixonjoel dixonjoel changed the title [DRAFT] Fix docs for ni.grpcdevice.v1.proto package [DRAFT] Fix docs for multiple packages Aug 21, 2025
@dixonjoel dixonjoel changed the title [DRAFT] Fix docs for multiple packages Fix docs for multiple packages Aug 23, 2025
@dixonjoel dixonjoel marked this pull request as ready for review August 23, 2025 21:56
Copy link
Collaborator

@bkeryan bkeryan left a comment

Choose a reason for hiding this comment

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

I didn't get a chance to look at all of the generated docs yet.

@dixonjoel dixonjoel requested a review from bkeryan August 27, 2025 20:19
@dixonjoel dixonjoel requested a review from bkeryan August 27, 2025 21:33
Copy link
Collaborator

@bkeryan bkeryan left a comment

Choose a reason for hiding this comment

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

Almost done

@dixonjoel dixonjoel requested a review from bkeryan August 28, 2025 16:56
@dixonjoel dixonjoel merged commit 98114ee into main Aug 28, 2025
63 checks passed
@dixonjoel dixonjoel deleted the users/jdixon/fix-package-docs branch August 28, 2025 17:26
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.

4 participants