ci: Add ReadtheDocs configuration file - #72
Open
junliang-tan wants to merge 1 commit into
Open
Conversation
Signed-off-by: Jun Liang Tan <junliang.tan@emerson.com>
junliang-tan
requested review from
bkeryan,
kkang-NI and
tjying95
as code owners
September 1, 2026 10:26
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Pull request overview
Adds a Read the Docs configuration so the project’s Sphinx documentation can be built/hosted via RTD using the repository’s Poetry dependency groups.
Changes:
- Introduces
.readthedocs.ymltargeting Ubuntu 24.04 with Python 3.11. - Installs Poetry and installs the
main+docsdependency groups during the RTD build. - Points RTD’s Sphinx build at
docs/conf.py.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
What does this Pull Request accomplish?
Adds a Read the Docs configuration that:
Why should this Pull Request be merged?
This configuration enables the project documentation to be built and hosted by Read the Docs.
What testing has been done?
The configuration will be validated by the Read the Docs build triggered for this pull request.