Skip to content

Commit 6583f46

Browse files
committed
chore: run precommit (code format)
1 parent 366b071 commit 6583f46

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+253
-210
lines changed

docs/source/conf.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,19 @@
7676
# -- Options for autodoc extension ----------------------------------
7777

7878
# Configure autodoc to show better signatures
79-
autodoc_typehints = 'description'
80-
autodoc_member_order = 'bysource'
79+
autodoc_typehints = "description"
80+
autodoc_member_order = "bysource"
8181
add_module_names = False # Don't prepend module names to class/function names
8282

8383
# -- Options for breathe extension ----------------------------------
8484

8585
breathe_projects = {
86-
"SampleModule": os.path.join(os.path.dirname(__file__), "examples/doxygen_output/xml")
86+
"SampleModule": os.path.join(
87+
os.path.dirname(__file__), "examples/doxygen_output/xml"
88+
)
8789
}
8890
breathe_default_project = "SampleModule"
89-
breathe_default_members = ('members', 'undoc-members')
91+
breathe_default_members = ("members", "undoc-members")
9092

9193
# -- Options for myst parser ----------------------------------------
9294
myst_enable_extensions = ["colon_fence"]

docs/source/configuration/ai-chatbot.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ScyllaDB Docs integrates with `Biel.ai <https://biel.ai/>`_ to offer a conversat
77
The chatbot can answer documentation-related questions and provide relevant links to help users find the information they need quickly.
88

99
.. note::
10-
This feature is in beta and disabled by default. It will be gradually enabled for all documentation sites in a future release.
10+
This feature is in beta and disabled by default. It will be gradually enabled for all documentation sites in a future release.
1111
If you want to enable it now, please contact us in Slack (``#scylla-docs`` channel).
1212

1313
Installation
@@ -24,7 +24,7 @@ To enable the AI chatbot, update your ``conf.py`` file by setting ``hide_ai_chat
2424
Usage
2525
-----
2626

27-
Once enabled, the Ask AI button will appear in the documentation interface.
27+
Once enabled, the Ask AI button will appear in the documentation interface.
2828
Users can click the button to start a conversation, ask questions, and receive responses with relevant documentation links.
2929

3030
.. figure:: images/ai-chatbot.png
@@ -61,4 +61,3 @@ If the chatbot does not appear:
6161
* Check for errors in the browser console that may indicate issues with the integration.
6262

6363
For more details, refer to the `Biel.ai documentation <https://docs.biel.ai/>`_.
64-

docs/source/configuration/template.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ Configuration options for enabling zendesk.
311311
- Description
312312
* - ``zendesk_tag``
313313
- string
314-
-
314+
-
315315
- Zendesk verification tag. Example: ``gq6ltsh3nfex3cnwfy4aj9``.
316316

317317
.. code:: python
@@ -334,6 +334,5 @@ Multiversion options
334334
- Description
335335
* - ``redirect``
336336
- string
337-
-
337+
-
338338
- Overrides the default redirection of the main domain when using multiversion. By default, it redirects to ``<DOMAIN>/stable/``. Overriding setting this can be useful if the main domain page publishes multiple documentation sets. Example: ``/manual/stable/``.
339-

docs/source/deployment/centralized-publication.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
Centralized publication
33
=======================
44

5-
Certain core ScyllaDB projects are configured or published from the repository `scylladb/scylladb-docs-homepage <https://github.com/scylladb/scylladb-docs-homepage>`_
6-
instead of the project repository itself.
5+
Certain core ScyllaDB projects are configured or published from the repository `scylladb/scylladb-docs-homepage <https://github.com/scylladb/scylladb-docs-homepage>`_
6+
instead of the project repository itself.
77

88
This allows us to:
99

@@ -44,8 +44,8 @@ To add a new release to the centralized publication, submit a pull request to th
4444
{
4545
"tags": [],
4646
"branches": [
47-
"master",
48-
"branch-2025.1",
47+
"master",
48+
"branch-2025.1",
4949
"branch-2025.2"
5050
],
5151
"latest": "branch-2025.1",
@@ -63,8 +63,8 @@ To add a new release to the centralized publication, submit a pull request to th
6363
{
6464
"tags": [],
6565
"branches": [
66-
"master",
67-
"branch-2025.1",
66+
"master",
67+
"branch-2025.1",
6868
"branch-2025.2"
6969
],
7070
"latest": "branch-2025.2",
@@ -98,4 +98,3 @@ You can trigger a manual publication by following these steps:
9898
6. Click the green **Run workflow** button.
9999

100100
For more details, see `Manually running a workflow <https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow>`_.
101-

docs/source/examples/Doxyfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,3 @@ EXTRACT_STATIC = YES
2525
# Other settings
2626
QUIET = YES
2727
WARNINGS = NO
28-

docs/source/examples/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
"""Examples package for ScyllaDB Sphinx Theme documentation."""
2-

docs/source/examples/_sample_module.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class DatabaseConnection {
2626
* @param port The database port number (default: 9042)
2727
* @param username Optional username for authentication
2828
*/
29-
DatabaseConnection(const std::string& host, int port = 9042,
29+
DatabaseConnection(const std::string& host, int port = 9042,
3030
const std::string& username = "");
3131

3232
/**
@@ -79,4 +79,3 @@ std::string format_query(const std::string& query, int indent = 4);
7979
bool validate_connection_params(const std::string& host, int port);
8080

8181
#endif // SAMPLE_MODULE_H
82-

docs/source/examples/_sample_module.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,3 @@ def validate_connection_params(host, port):
105105

106106
MAX_RETRIES = 3
107107
"""Maximum number of connection retry attempts"""
108-

docs/source/examples/api-documentation/doxygen.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Configure in ``conf.py``:
152152
.. code-block:: python
153153
154154
extensions = ['breathe', 'exhale']
155-
155+
156156
exhale_args = {
157157
'containmentFolder': './api',
158158
'rootFileName': 'library_root.rst',
@@ -161,4 +161,3 @@ Configure in ``conf.py``:
161161
}
162162
163163
Exhale will automatically create a page for each class, function, and file in your project.
164-

docs/source/examples/api-documentation/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,3 @@ This approach keeps your API reference in sync with your codebase.
2020
* :doc:`Python <python>`
2121
* :doc:`Doxygen <doxygen>`
2222
* :doc:`REST API (Redocly) <rest-api>`
23-

0 commit comments

Comments
 (0)