Skip to content

docs: style cpp-rs api reference#386

Merged
wprzytula merged 5 commits intoscylladb:masterfrom
dgarcia360:docs-style-api-ref
Nov 25, 2025
Merged

docs: style cpp-rs api reference#386
wprzytula merged 5 commits intoscylladb:masterfrom
dgarcia360:docs-style-api-ref

Conversation

@dgarcia360
Copy link
Copy Markdown
Contributor

@dgarcia360 dgarcia360 commented Nov 17, 2025

Related scylladb/sphinx-scylladb-theme#1516

Updates API reference look and feel:

image

How to test

  1. Build the docs.
  2. Open the API reference.
  3. Review the new UI at http://127.0.0.1:5500/api/

@dgarcia360 dgarcia360 changed the title docs: style api reference docs: style cpp-rs api reference Nov 17, 2025
@dgarcia360 dgarcia360 marked this pull request as draft November 17, 2025 09:13
@dgarcia360 dgarcia360 marked this pull request as ready for review November 21, 2025 17:34
@dgarcia360
Copy link
Copy Markdown
Contributor Author

cc/ @annastuchlik

Copy link
Copy Markdown

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 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.

@Lorak-mmk
Copy link
Copy Markdown
Contributor

In the sidebar, each method name is prefixed with the ClassName::. This isn't really necessary - the methods are already in the section about the class, as indicated by the indentation level:
image

This causes more line wrapping than would be otherwise necessary, maybe it would be more readable to drop the prefix?

@wprzytula wprzytula added the documentation Improvements or additions to documentation label Nov 24, 2025
@dgarcia360
Copy link
Copy Markdown
Contributor Author

@Lorak-mmk removed the prefix in 3ded240

image

@wprzytula wprzytula merged commit d652dac into scylladb:master Nov 25, 2025
10 checks passed
@wprzytula wprzytula added this to the 0.6.0 milestone Dec 16, 2025
@wprzytula wprzytula mentioned this pull request Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants