Repository navigation
Add rst docs page, CI job that tests docs build - #55
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The documentation contains a checkout-name-dependent include path and presents an undeclared C/C++ API as supported.
Review effort: Balanced
Findings: 1
Open (2)
What changed in this PR
Adds standalone Sphinx documentation and CI validation for ADXSPD.
Changes:
- Adds comprehensive driver documentation.
- Introduces an isolated Pixi documentation environment.
- Builds documentation in GitHub Actions with warnings treated as errors.
| File | Description |
|---|---|
docs/ADXSPD/ADXSPD.rst |
Documents driver usage, parameters, configuration, and testing. |
scripts/sphinx/conf.py |
Configures standalone Sphinx builds. |
pixi.toml |
Defines documentation dependencies and build task. |
pixi.lock |
Locks the documentation environment. |
.github/workflows/ci.yaml |
Adds documentation build validation. |
.gitignore |
Excludes generated documentation output. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| The following startup script is provided with ADXSPD. | ||
|
|
||
| .. literalinclude:: ../../../ADXSPD/iocs/xspdIOC/iocBoot/iocXSPD/st_base.cmd |
Comment on lines
+457
to
+462
| The ADXSPD driver is created with the ``ADXSPDConfig`` command, either from C/C++ or from | ||
| the EPICS IOC shell. | ||
|
|
||
| :: | ||
|
|
||
| int ADXSPDConfig(const char *portName, const char *ip, int portNum, const char *deviceId) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.