doc: add missing snapm.manager._mounts to Sphinx docs

[bmr-cymru]

Resolves: #660

Summary by CodeRabbit

Documentation

• Expanded the public API documentation to include a newly documented module offering comprehensive reference materials. This addition provides developers with complete documentation of module members, special-member specifications, detailed inheritance hierarchies, and curated exclusions. Users now have improved access to thorough platform reference information for seamless integration and application development.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

A new automodule documentation entry for snapm.manager._mounts has been added to the Sphinx documentation configuration in doc/snapm.rst. The entry includes standard directives for members, special members, private members, and inheritance information, aligning with existing module documentation patterns.

Changes

Cohort / File(s)	Change Summary
Documentation expansion doc/snapm.rst	Added automodule block for snapm.manager._mounts module with Sphinx directives (:members:, :special-members:, :private-members:, :exclude-members:, :undoc-members:, :show-inheritance:), exposing the module's public surface in generated documentation alongside _boot, _calendar, and _schedule modules.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A module once hidden from sight,
Now documented, shining so bright!
With members and methods laid bare,
The _mounts module gets proper care! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title directly and concisely describes the main change: adding the snapm.manager._mounts module to Sphinx documentation.
Linked Issues check	✅ Passed	The PR successfully implements the requirements from issue #660 by adding the automodule directive for snapm.manager._mounts with all specified options and exclusions.
Out of Scope Changes check	✅ Passed	All changes are directly related to the objective of documenting snapm.manager._mounts; no out-of-scope modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bmr-add-mounts-to-doc

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7439b1f and b5cdf39.

📒 Files selected for processing (1)

• doc/snapm.rst (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: bmr-cymru
Repo: snapshotmanager/snapm PR: 541
File: snapm/manager/_mounts.py:174-197
Timestamp: 2025-10-22T20:06:54.993Z
Learning: For snapshotmanager/snapm follow-up requests from bmr-cymru, create a GitHub issue with label "enhancement", set/ensure a "type: Task" label, and assign it to bmr-cymru. Include backlinks to the PR and the discussion comment in the issue body.

Learnt from: bmr-cymru
Repo: snapshotmanager/snapm PR: 541
File: snapm/manager/_mounts.py:372-377
Timestamp: 2025-10-20T21:12:52.344Z
Learning: In snapm/manager/_mounts.py mount operations: do not create missing mount point directories on snapshot filesystems; instead, check if the directory exists with isdir(), log a warning if missing, and skip that mount to avoid modifying the snapshot filesystem unnecessarily.

📚 Learning: 2025-10-20T21:12:52.344Z

Learnt from: bmr-cymru
Repo: snapshotmanager/snapm PR: 541
File: snapm/manager/_mounts.py:372-377
Timestamp: 2025-10-20T21:12:52.344Z
Learning: In snapm/manager/_mounts.py mount operations: do not create missing mount point directories on snapshot filesystems; instead, check if the directory exists with isdir(), log a warning if missing, and skip that mount to avoid modifying the snapshot filesystem unnecessarily.

Applied to files:

• doc/snapm.rst

📚 Learning: 2025-10-21T14:48:15.958Z

Learnt from: bmr-cymru
Repo: snapshotmanager/snapm PR: 541
File: snapm/manager/_mounts.py:205-236
Timestamp: 2025-10-21T14:48:15.958Z
Learning: In snapm/manager/_mounts.py (and generally for mount operations): since util-linux 2.23 and Linux kernel 2.6.15+, mount propagation flags like --make-rprivate and --make-unbindable can be combined with the initial mount command in a single invocation. The mount utility automatically applies these flags via additional mount(2) system calls after the mount succeeds. It is not necessary to split these into separate remount commands.
<!--

Applied to files:

• doc/snapm.rst

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (45)

• GitHub Check: rpm-build:fedora-41-x86_64
• GitHub Check: rpm-build:fedora-42-x86_64
• GitHub Check: rpm-build:centos-stream-9-x86_64
• GitHub Check: rpm-build:centos-stream-10-x86_64
• GitHub Check: rpm-build:fedora-43-x86_64
• GitHub Check: rpm-build:fedora-rawhide-x86_64
• GitHub Check: rpm-build:epel-9-x86_64
• GitHub Check: rpm-build:fedora-rawhide-x86_64
• GitHub Check: rpm-build:centos-stream-9-x86_64
• GitHub Check: rpm-build:fedora-42-x86_64
• GitHub Check: rpm-build:centos-stream-10-x86_64
• GitHub Check: rpm-build:fedora-43-x86_64
• GitHub Check: rpm-build:epel-9-x86_64
• GitHub Check: rpm-build:fedora-41-x86_64
• GitHub Check: rpm-build:fedora-41-x86_64
• GitHub Check: rpm-build:fedora-43-x86_64
• GitHub Check: rpm-build:epel-9-x86_64
• GitHub Check: rpm-build:fedora-42-x86_64
• GitHub Check: rpm-build:centos-stream-9-x86_64
• GitHub Check: rpm-build:fedora-rawhide-x86_64
• GitHub Check: rpm-build:centos-stream-10-x86_64
• GitHub Check: rpm-build:fedora-rawhide-x86_64
• GitHub Check: rpm-build:fedora-41-x86_64
• GitHub Check: rpm-build:fedora-43-x86_64
• GitHub Check: rpm-build:centos-stream-10-x86_64
• GitHub Check: rpm-build:centos-stream-9-x86_64
• GitHub Check: rpm-build:fedora-42-x86_64
• GitHub Check: rpm-build:epel-9-x86_64
• GitHub Check: virt_tests (uefi, lvm-thin, centos-stream10)
• GitHub Check: virt_tests (uefi, lvm-thin, fedora41)
• GitHub Check: virt_tests (bios, lvm-thin, centos-stream9)
• GitHub Check: virt_tests (bios, lvm, fedora42)
• GitHub Check: virt_tests (uefi, lvm-thin, centos-stream9)
• GitHub Check: virt_tests (uefi, lvm, fedora42)
• GitHub Check: virt_tests (bios, lvm, fedora41)
• GitHub Check: virt_tests (uefi, lvm, centos-stream10)
• GitHub Check: virt_tests (bios, lvm-thin, fedora42)
• GitHub Check: virt_tests (bios, lvm-thin, fedora41)
• GitHub Check: virt_tests (bios, lvm-thin, centos-stream10)
• GitHub Check: virt_tests (bios, lvm, centos-stream10)
• GitHub Check: virt_tests (uefi, lvm-thin, fedora42)
• GitHub Check: virt_tests (uefi, lvm, fedora41)
• GitHub Check: virt_tests (uefi, lvm, centos-stream9)
• GitHub Check: virt_tests (bios, lvm, centos-stream9)
• GitHub Check: python-basic-tests

🔇 Additional comments (1)

doc/snapm.rst (1)

50-59: Documentation addition follows the requirements and existing patterns correctly.

The automodule directive for snapm.manager._mounts matches the requested snippet from issue #660 exactly. The placement is alphabetically correct between the _calendar and _schedule modules, and the directive configuration (members, special members, private members, exclusions, undoc members, and inheritance) is consistent with all other manager submodules. The formatting and structure align seamlessly with the existing documentation.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[packit-as-a-service]

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

• sudo dnf install -y 'dnf*-command(copr)'
• dnf copr enable packit/snapshotmanager-snapm-661
• And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.