|
7 | 7 | # add these directories to sys.path here. If the directory is relative to the |
8 | 8 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
9 | 9 | # Problems with imports? Could try `export PYTHONPATH=$PYTHONPATH:`pwd`` from root project dir... |
10 | | -import os |
11 | 10 | import sys |
12 | 11 | from pathlib import Path |
| 12 | + |
13 | 13 | src_path = Path("../../src") |
14 | 14 | assert src_path.is_dir() |
15 | | -assert (src_path/"raffalib").is_dir() |
| 15 | +assert (src_path / "raffalib").is_dir() |
16 | 16 | sys.path.insert(0, src_path.resolve()) # Source code dir relative to this file |
17 | 17 |
|
18 | 18 | # -- Project information ----------------------------------------------------- |
19 | 19 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
20 | 20 |
|
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" |
24 | 24 |
|
25 | 25 | # -- General configuration --------------------------------------------------- |
26 | 26 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
27 | 27 |
|
28 | 28 | extensions = [ |
29 | | - 'autoapi.extension', |
30 | | - 'sphinx.ext.doctest', |
| 29 | + "autoapi.extension", |
| 30 | + "sphinx.ext.doctest", |
31 | 31 | ] |
32 | 32 |
|
33 | | -autoapi_dirs = ['../../src'] |
| 33 | +autoapi_dirs = ["../../src"] |
34 | 34 |
|
35 | 35 | # -- doctest configuration --------------------------------------------------- |
36 | 36 | # The examples in the narrative docs are executable doctests, run with |
37 | 37 | # ``sphinx-build -b doctest`` (``make doctest``). ELLIPSIS lets the |
38 | 38 | # non-deterministic ``Took: ...`` timing lines match; NORMALIZE_WHITESPACE makes |
39 | 39 | # the DataFrame/table reprs robust to incidental spacing differences. |
40 | | -import doctest as _doctest |
| 40 | +import doctest as _doctest # noqa: E402 |
41 | 41 |
|
42 | 42 | doctest_default_flags = _doctest.ELLIPSIS | _doctest.NORMALIZE_WHITESPACE |
43 | 43 |
|
@@ -87,9 +87,9 @@ def emit(self, record): |
87 | 87 | "special-members", |
88 | 88 | ] |
89 | 89 |
|
90 | | -exclude_patterns = ['_build', '_templates'] |
| 90 | +exclude_patterns = ["_build", "_templates"] |
91 | 91 |
|
92 | 92 | # Add any paths that contain templates here, relative to this directory. |
93 | | -templates_path = ['_templates'] |
| 93 | +templates_path = ["_templates"] |
94 | 94 |
|
95 | 95 | html_theme = "sphinx_rtd_theme" |
0 commit comments