Skip to content

fix: missing whitespace in api docs#433

Merged
wprzytula merged 1 commit intoscylladb:masterfrom
dgarcia360:docs-fix-spacing
Mar 12, 2026
Merged

fix: missing whitespace in api docs#433
wprzytula merged 1 commit intoscylladb:masterfrom
dgarcia360:docs-fix-spacing

Conversation

@dgarcia360
Copy link
Copy Markdown
Contributor

Closes #430

@wprzytula wprzytula added the documentation Improvements or additions to documentation label Mar 12, 2026
Copy link
Copy Markdown
Contributor

@wprzytula wprzytula left a comment

Choose a reason for hiding this comment

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

Now looks good!

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

Adds a Sphinx custom stylesheet to restore whitespace rendering in generated C/C++ API signatures (Breathe/Doxygen output), addressing issue #430.

Changes:

  • Configure Sphinx to include _static assets and load a custom CSS file.
  • Add custom.css that forces signature whitespace spans (.w) to display inline for C/C++ domains.

Reviewed changes

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

File Description
docs/source/conf.py Enables static asset serving and registers custom.css with Sphinx.
docs/source/_static/custom.css Restores visible whitespace in C/C++ API signatures by overriding theme styles for .w spans.

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

You can also share your feedback on Copilot code review. Take the survey.

@wprzytula wprzytula merged commit d6d7fa0 into scylladb:master Mar 12, 2026
12 of 13 checks passed
@wprzytula wprzytula removed the request for review from Lorak-mmk March 12, 2026 19:44
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.

API docs: No space between argument type and name, and return type / name of function

3 participants