-
Notifications
You must be signed in to change notification settings - Fork 2
/
conf.py
89 lines (74 loc) · 2.71 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os
import sys
from plotly.io._sg_scraper import plotly_sg_scraper
sys.path.insert(0, os.path.abspath('..'))
project = 'mloptimizer'
copyright = '2024, Antonio Caparrini, Javier Arroyo'
author = 'Antonio Caparrini, Javier Arroyo'
release = '0.8.1'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx.ext.autosummary',
'sphinx_gallery.gen_gallery',
'sphinx_mdinclude',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.graphviz',
'sphinx.ext.intersphinx',
'autoapi.extension',
'sphinx_favicon',
'sphinxcontrib.mermaid'
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
autoapi_dirs = ['../mloptimizer']
autoapi_type = "python"
autoapi_options = [
"members",
"undoc-members",
"show-inheritance",
"show-module-summary",
"imported-members",
]
autodoc_typehints = "signature"
autoapi_ignore = ['*test*']
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_book_theme'
# html_static_path = ['_static']
image_scrapers = ('matplotlib', plotly_sg_scraper,)
autodoc_default_flags = ['members']
autosummary_generate = True
autoclass_content = 'both'
html_show_sourcelink = False
autodoc_inherit_docstrings = True
set_type_checking_flag = True
sphinx_gallery_conf = {
'examples_dirs': '../examples',
'gallery_dirs': 'auto_examples',
'reference_url': {
# The module you locally document uses None
'mloptimizer': None,
},
'image_scrapers': image_scrapers,
}
html_theme_options = {
"repository_url": "https://github.com/Caparrini/mloptimizer",
"use_repository_button": True,
}
html_logo = 'http://raw.githubusercontent.com/Caparrini/mloptimizer-static/main/logos/mloptimizer_banner_readme.png'
favicons = [
"https://raw.githubusercontent.com/Caparrini/mloptimizer-static/main/logos/favicon-16x16.png",
"https://raw.githubusercontent.com/Caparrini/mloptimizer-static/main/logos/favicon-32x32.png",
"https://raw.githubusercontent.com/Caparrini/mloptimizer-static/main/logos/favicon.ico",
]