Skip to content

ci: Add ReadtheDocs configuration file - #72

Open
junliang-tan wants to merge 1 commit into
mainfrom
users/jltan/readthedocs
Open

ci: Add ReadtheDocs configuration file#72
junliang-tan wants to merge 1 commit into
mainfrom
users/jltan/readthedocs

Conversation

@junliang-tan

@junliang-tan junliang-tan commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

What does this Pull Request accomplish?

Adds a Read the Docs configuration that:

  • Builds the Sphinx documentation on Ubuntu 24.04 with Python 3.11.
  • Installs the project’s main and documentation dependency groups in the Read the Docs virtual environment.
  • Uses docs/conf.py as the Sphinx configuration file.

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.

Signed-off-by: Jun Liang Tan <junliang.tan@emerson.com>
@ni-github-admins

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

Test Results

   14 files  ±0     14 suites  ±0   14m 23s ⏱️ +46s
  224 tests ±0    224 ✅ ±0  0 💤 ±0  0 ❌ ±0 
3 136 runs  ±0  3 136 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 9f3bbeb. ± Comparison against base commit 9e2f01a.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.yml targeting Ubuntu 24.04 with Python 3.11.
  • Installs Poetry and installs the main + docs dependency 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.

Comment thread .readthedocs.yml
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.

3 participants