Skip to content

Commit 2d0893f

Browse files
Make docs/source/conf.py ruff-clean
Remove the unused os import, mark the deliberate mid-file doctest import with noqa: E402, and apply ruff format so the whole repo passes ruff. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 6a21f3e commit 2d0893f

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/source/conf.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,37 @@
77
# add these directories to sys.path here. If the directory is relative to the
88
# documentation root, use os.path.abspath to make it absolute, like shown here.
99
# Problems with imports? Could try `export PYTHONPATH=$PYTHONPATH:`pwd`` from root project dir...
10-
import os
1110
import sys
1211
from pathlib import Path
12+
1313
src_path = Path("../../src")
1414
assert src_path.is_dir()
15-
assert (src_path/"raffalib").is_dir()
15+
assert (src_path / "raffalib").is_dir()
1616
sys.path.insert(0, src_path.resolve()) # Source code dir relative to this file
1717

1818
# -- Project information -----------------------------------------------------
1919
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2020

21-
project = 'raffalib-python'
22-
copyright = '2026, Raffaele Mancuso'
23-
author = 'Raffaele Mancuso'
21+
project = "raffalib-python"
22+
copyright = "2026, Raffaele Mancuso"
23+
author = "Raffaele Mancuso"
2424

2525
# -- General configuration ---------------------------------------------------
2626
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2727

2828
extensions = [
29-
'autoapi.extension',
30-
'sphinx.ext.doctest',
29+
"autoapi.extension",
30+
"sphinx.ext.doctest",
3131
]
3232

33-
autoapi_dirs = ['../../src']
33+
autoapi_dirs = ["../../src"]
3434

3535
# -- doctest configuration ---------------------------------------------------
3636
# The examples in the narrative docs are executable doctests, run with
3737
# ``sphinx-build -b doctest`` (``make doctest``). ELLIPSIS lets the
3838
# non-deterministic ``Took: ...`` timing lines match; NORMALIZE_WHITESPACE makes
3939
# the DataFrame/table reprs robust to incidental spacing differences.
40-
import doctest as _doctest
40+
import doctest as _doctest # noqa: E402
4141

4242
doctest_default_flags = _doctest.ELLIPSIS | _doctest.NORMALIZE_WHITESPACE
4343

@@ -87,9 +87,9 @@ def emit(self, record):
8787
"special-members",
8888
]
8989

90-
exclude_patterns = ['_build', '_templates']
90+
exclude_patterns = ["_build", "_templates"]
9191

9292
# Add any paths that contain templates here, relative to this directory.
93-
templates_path = ['_templates']
93+
templates_path = ["_templates"]
9494

9595
html_theme = "sphinx_rtd_theme"

0 commit comments

Comments
 (0)