docs: document CMake variables using Sphinx styles

[njzjz]

Summary by CodeRabbit

• New Features

  • Added support for modern CMake projects in documentation through the sphinxcontrib.moderncmakedomain extension.
  • Enhanced installation documentation for DeePMD-kit's C++ interface and source builds, improving clarity and usability.

• Documentation

  • Improved formatting and structure of CMake configuration options for better readability and understanding.
  • Standardized documentation for DEEPMD_C_ROOT variable and other CMake options, including links to relevant documentation.

[coderabbitai]

Walkthrough

Walkthrough

The changes primarily involve enhancements to the documentation of the DeePMD-kit project. Key updates include the addition of the sphinxcontrib.moderncmakedomain extension to support modern CMake projects, restructuring the installation documentation for clarity, and incorporating detailed CMake variable annotations. These adjustments improve the usability and accessibility of the documentation for users configuring the build process.

Changes

Files	Change Summary
doc/conf.py, pyproject.toml	Added "sphinxcontrib.moderncmakedomain" to enhance documentation for CMake projects.
doc/install/install-from-c-library.md, doc/install/install-from-source.md	Restructured installation documentation to use CMake variable annotations, improving clarity and consistency.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.02%. Comparing base (bf4f203) to head (cc72622).
Report is 196 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4079      +/-   ##
==========================================
- Coverage   83.02%   83.02%   -0.01%     
==========================================
  Files         524      524              
  Lines       51638    51638              
  Branches     3030     3031       +1     
==========================================
- Hits        42871    42870       -1     
  Misses       7822     7822              
- Partials      945      946       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles