Skip to content

Commit 469d63d

Browse files
committed
update dependencies and clean conf.py
1 parent 17f941f commit 469d63d

File tree

4 files changed

+20
-13
lines changed

4 files changed

+20
-13
lines changed
File renamed without changes.

docs/conf.py

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,8 @@
1818
import re
1919

2020

21-
extensions = [
22-
"sphinx.ext.autodoc",
23-
"sphinx.ext.napoleon",
24-
"sphinx.ext.intersphinx",
25-
"sphinx.ext.todo",
26-
"sphinx.ext.viewcode",
27-
"autoapi.extension"
28-
]
21+
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.intersphinx", "sphinx.ext.todo",
22+
"sphinx.ext.viewcode", "autoapi.extension"]
2923

3024
templates_path = ["_templates"]
3125

@@ -35,7 +29,6 @@
3529
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3630

3731
html_theme = 'furo'
38-
html_static_path = ['_static']
3932

4033
autoapi_type = "python"
4134
autoapi_dirs = [
@@ -51,11 +44,25 @@
5144
]
5245
autoapi_generate_api_docs = True
5346

47+
autoapi_keep_files = True
48+
49+
def contains(seq, item):
50+
return item in seq
51+
52+
53+
def prepare_jinja_env(jinja_env) -> None:
54+
jinja_env.tests["contains"] = contains
55+
56+
57+
autoapi_prepare_jinja_env = prepare_jinja_env
58+
59+
5460
def skip_submodules(app, what, name, obj, skip, options):
5561
if re.search("marshal*", name) or re.search("unmarshal*", name) or re.search("test*", name) or re.search("utils", name):
5662
skip = True
5763
return skip
5864

59-
6065
def setup(sphinx):
61-
sphinx.connect("autoapi-skip-member", skip_submodules)
66+
sphinx.connect("autoapi-skip-member", skip_submodules)
67+
68+

docs/poetry.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ furo = "^2024.8.6"
1212
scaleway-core = { path = "../scaleway-core", develop = true }
1313
scaleway = { path = "../scaleway", develop = true }
1414
scaleway-async = { path = "../scaleway-async", develop = true }
15-
sphinx-autoapi = "^3.4.0"
15+
sphinx-autoapi = "^3.1.0"
1616
sphinx-copybutton = "^0.5.2"
1717

1818

0 commit comments

Comments
 (0)