docs: style cpp-rs api reference#386
Merged
wprzytula merged 5 commits intoscylladb:masterfrom Nov 25, 2025
Merged
Conversation
Contributor
Author
|
cc/ @annastuchlik |
There was a problem hiding this comment.
Pull request overview
This PR updates the styling and build configuration for the CPP-Rust Driver's API reference documentation. The changes aim to improve the look and feel of the API documentation by adjusting the table of contents depth and optimizing the preview workflow.
Key changes:
- Reduced API documentation table of contents depth from 2 to 1 for a cleaner appearance
- Added ignore pattern for auto-generated API files in the documentation preview command
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/api/index.rst | Reduced maxdepth from 2 to 1 to simplify the API documentation navigation hierarchy |
| docs/Makefile | Added --ignore flag to skip watching auto-generated API files during live preview, improving build performance |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
27 tasks
Contributor
Contributor
Author
|
@Lorak-mmk removed the prefix in 3ded240
|
Lorak-mmk
approved these changes
Nov 25, 2025
wprzytula
approved these changes
Nov 25, 2025
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.


Related scylladb/sphinx-scylladb-theme#1516
Updates API reference look and feel:
How to test