Skip to content

docs: update readthedocs setup#3072

Merged
igaw merged 2 commits intolinux-nvme:masterfrom
igaw:docs
Feb 13, 2026
Merged

docs: update readthedocs setup#3072
igaw merged 2 commits intolinux-nvme:masterfrom
igaw:docs

Conversation

@igaw
Copy link
Collaborator

@igaw igaw commented Jan 22, 2026

Update the configuration so it works for two projects.

TODO:

  • update readthedocs build service: use the correct yaml file.
  • update the *readthedocs.yaml build instruction
  • update github workflow

The coverage and the docs build workflow are duplicates, they are
already build by the coverage.yml and docs.yml workflows.

Signed-off-by: Daniel Wagner <[email protected]>
@igaw igaw force-pushed the docs branch 2 times, most recently from af7a042 to 336f720 Compare February 13, 2026 17:26
@igaw igaw marked this pull request as ready for review February 13, 2026 17:31
@igaw igaw requested a review from Copilot February 13, 2026 17:31
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the ReadTheDocs configuration to support separate documentation builds for two projects within the repository: nvme-cli and libnvme. The changes enable ReadTheDocs to build HTML documentation for nvme-cli (using asciidoc) and Sphinx-based documentation for libnvme (using RST) independently, likely as two separate ReadTheDocs projects.

Changes:

  • Added support for building RST documentation separately via a new rst_docs build option
  • Created separate ReadTheDocs configurations for nvme-cli (root) and libnvme (subdirectory)
  • Removed GitHub Actions workflows for libnvme documentation and coverage, delegating documentation builds to ReadTheDocs

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
scripts/build.sh Added rst_docs build option and config_meson_rst_docs() function for building RST documentation; fixed whitespace formatting in config_meson_libnvme()
.readthedocs.yaml Updated root configuration for nvme-cli documentation with custom build commands and output directory specification
libnvme/.readthedocs.yaml New configuration for libnvme Sphinx documentation with separate RST build process
.github/workflows/libnvme-docs.yaml Removed workflow as documentation builds are now handled by ReadTheDocs
.github/workflows/libnvme-coverage.yml Removed coverage workflow (possibly unintended deletion unrelated to documentation changes)
Comments suppressed due to low confidence (1)

.github/workflows/libnvme-coverage.yml:1

  • The libnvme-coverage.yml workflow file is being deleted. This workflow appears to run code coverage tests and upload results to Codecov, which is unrelated to documentation builds.

If this deletion is intentional as part of a broader cleanup or consolidation of CI workflows, please confirm. Otherwise, this might be an accidental deletion that removes code coverage reporting for the libnvme component.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Update the configuration so it works for two projects.

Signed-off-by: Daniel Wagner <[email protected]>
@igaw igaw merged commit fdf2d82 into linux-nvme:master Feb 13, 2026
18 checks passed
@igaw igaw deleted the docs branch February 13, 2026 17:45
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.

1 participant