Skip to content

Commit 453c719

Browse files
chore: Enable ruff formatting for docs directory
- Remove 'docs' from ruff exclude list in pyproject.toml - Apply ruff formatting to docs/conf.py 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 88c7eb9 commit 453c719

2 files changed

Lines changed: 12 additions & 9 deletions

File tree

docs/conf.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,10 @@ def get_version():
5656
except Exception:
5757
return "unknown"
5858

59+
5960
# -- Setup function ----------------------------------------------------------
6061

62+
6163
def config_inited(app, config):
6264
"""Handler for config-inited event to set version dynamically."""
6365
smv_current_version = getattr(config, "smv_current_version", None)
@@ -77,10 +79,12 @@ def config_inited(app, config):
7779
config.version = f"v{ver}"
7880
config.release = f"v{ver}"
7981

82+
8083
def setup(app):
8184
"""Sphinx setup hook."""
8285
app.connect("config-inited", config_inited)
8386

87+
8488
# -- Project information -----------------------------------------------------
8589
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8690

@@ -122,11 +126,11 @@ def setup(app):
122126

123127
# Autodoc settings
124128
autodoc_default_options = {
125-
'members': True,
126-
'member-order': 'bysource',
127-
'special-members': '__init__',
128-
'undoc-members': True,
129-
'exclude-members': '__weakref__'
129+
"members": True,
130+
"member-order": "bysource",
131+
"special-members": "__init__",
132+
"undoc-members": True,
133+
"exclude-members": "__weakref__",
130134
}
131135

132136
# Autosummary settings
@@ -135,9 +139,9 @@ def setup(app):
135139

136140
# Intersphinx mapping
137141
intersphinx_mapping = {
138-
'python': ('https://docs.python.org/3', None),
139-
'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
140-
'pyarrow': ('https://arrow.apache.org/docs/', None),
142+
"python": ("https://docs.python.org/3", None),
143+
"pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
144+
"pyarrow": ("https://arrow.apache.org/docs/", None),
141145
}
142146

143147
templates_path = ["_templates"]

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ line-length = 100
106106
exclude = [
107107
".venv",
108108
".tox",
109-
"docs",
110109
]
111110
target-version = "py39"
112111

0 commit comments

Comments
 (0)