Improve build process and github workflows. Verify the docs links. #90
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chaitu236
reviewed
Sep 9, 2025
Collaborator
chaitu236
left a comment
chaitu236
left a comment
There was a problem hiding this comment.
Can you rebase your commits and drop the merge commit
amstewart
force-pushed
the
dev/build-process
branch
from
3acdc8b to
a1390d1
Compare
Collaborator
Author
Patch V2
|
Collaborator
Author
|
PR check failure on patch v2 is due to the ni.com/docs site being down for maintenance and so failing Will rerun tomorrow. Or otherwise we could pull this PR as-is, since the remainder of the pipeline seems to work. |
chaitu236
approved these changes
Sep 11, 2025
added 6 commits
December 2, 2025 11:35
We do not support building the sources on Windows, so remove the unneeded batch file. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Sphinx documentation output can vary substantially between sphinx build environments, if there is no way to coordinate python module versions between build systems. Use a requirements.txt file to do that coordination. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Add a top-level Makefile for convenience. Update the README with new build instructions. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Add a Makefile target to run the Sphinx linkcheck 'builder', which actually checks the validity of the external links in the documentation. Fixup a couple broken links found in the documentation. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
The PR check should try to build the project and lint it. If either fails, the PR shouldn't be accepted. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Use peaceiris' gh-pages action to create and publish the gh-pages, because it can do so in an automated fashion (does not require final approval from an admin.) When using this action, it automatically adds a .nojekyll file, so remove the unneeded source file. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
amstewart
force-pushed
the
dev/build-process
branch
from
a1390d1 to
2ebbb37
Compare
added 3 commits
December 2, 2025 11:38
Resolves docutils compile warning. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Previous table file path pointed at an obsolete file. Corrected to new file path. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Makefilewith basic targets like: all, clean, and lint.linttarget will runsphinx linkcheckon the docs sources.main, the docs will be built and automatically pushed to thegh-pagesref.requirements.txtfile to coordinate python dependencies between build environments.make.batfile.Testing
Process
This patchset is based on #87.