|
6 | 6 | # -- Project information ----------------------------------------------------- |
7 | 7 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
8 | 8 |
|
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' |
16 | 13 |
|
17 | 14 | # -- General configuration --------------------------------------------------- |
18 | 15 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
19 | 16 |
|
| 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 | + |
20 | 24 | extensions = [ |
21 | 25 | "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", |
24 | 30 | ] |
25 | | -autosummary_generate = True |
26 | 31 |
|
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*'] |
29 | 43 |
|
| 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" |
30 | 53 |
|
31 | 54 | # -- Options for HTML output ------------------------------------------------- |
32 | 55 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
33 | 56 |
|
34 | | -html_theme = "sphinx_rtd_theme" |
35 | | -html_static_path = ["_static"] |
| 57 | +html_theme = 'furo' |
| 58 | +html_static_path = ['_static'] |
| 59 | + |
36 | 60 |
|
37 | | -sys.path.insert(0, os.path.abspath("..")) |
|
0 commit comments