Skip to content

Commit 32e6510

Browse files
committed
feat(doc): generate documentations
1 parent 3ebc665 commit 32e6510

File tree

2 files changed

+44
-15
lines changed

2 files changed

+44
-15
lines changed

docs/conf.py

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,55 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
import os
10-
import sys
11-
12-
13-
project = "Scaleway Python SDK"
14-
copyright = "2022, Scaleway"
15-
author = "Scaleway"
9+
project = 'Scaleway SDK Python'
10+
copyright = '2025, Scaleway'
11+
author = 'Scaleway'
12+
release = '2.7.0'
1613

1714
# -- General configuration ---------------------------------------------------
1815
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1916

17+
import os
18+
import sys
19+
20+
sys.path.insert(0, os.path.abspath('../scaleway'))
21+
sys.path.insert(0, os.path.abspath('../scaleway-async'))
22+
sys.path.insert(0, os.path.abspath('../scaleway-core'))
23+
2024
extensions = [
2125
"sphinx.ext.autodoc",
22-
"sphinx.ext.autosummary",
23-
"sphinx_rtd_theme",
26+
"sphinx.ext.napoleon",
27+
"sphinx.ext.intersphinx",
28+
"sphinx.ext.todo",
29+
"sphinx.ext.viewcode",
2430
]
25-
autosummary_generate = True
2631

27-
templates_path = ["_templates"]
28-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
32+
autoapi_dirs = [
33+
os.path.abspath('../scaleway'),
34+
# os.path.abspath('../scaleway-async'),
35+
# os.path.abspath('../scaleway-core'),
36+
]
37+
38+
autoapi_generate_api_docs = True
39+
40+
41+
templates_path = ['_templates']
42+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**/marshalling*']
2943

44+
autodoc_default_options = {
45+
"show-inheritance": True,
46+
"members": True,
47+
"undoc-members": False,
48+
}
49+
50+
source_suffix = ".rst"
51+
52+
master_doc = "index"
3053

3154
# -- Options for HTML output -------------------------------------------------
3255
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3356

34-
html_theme = "sphinx_rtd_theme"
35-
html_static_path = ["_static"]
57+
html_theme = 'furo'
58+
html_static_path = ['_static']
59+
3660

37-
sys.path.insert(0, os.path.abspath(".."))

docs/modules.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
guide
2+
=====
3+
4+
.. toctree::
5+
:maxdepth: 4
6+

0 commit comments

Comments
 (0)