/
conf.py
194 lines (161 loc) · 6.19 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config
# -- Project information -----------------------------------------------------
import sys
import os
import types
import ray
# stub ray.remote to be a no-op so it doesn't shadow docstrings
def noop_decorator(*args, **kwargs):
if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
# This is the case where the decorator is just @ray.remote without parameters.
return args[0]
return lambda cls_or_func: cls_or_func
ray.remote = noop_decorator
# fake modules if they're missing
for mod_name in ("cudf", "cupy", "pyarrow.gandiva", "pyhdk", "pyhdk.hdk", "xgboost"):
try:
__import__(mod_name)
except ImportError:
sys.modules[mod_name] = types.ModuleType(
mod_name, f"fake {mod_name} for building docs"
)
if not hasattr(sys.modules["cudf"], "DataFrame"):
sys.modules["cudf"].DataFrame = type("DataFrame", (object,), {})
if not hasattr(sys.modules["cupy"], "ndarray"):
sys.modules["cupy"].ndarray = type("ndarray", (object,), {})
if not hasattr(sys.modules["pyhdk"], "PyDbEngine"):
sys.modules["pyhdk"].PyDbEngine = type("PyDbEngine", (object,), {})
if not hasattr(sys.modules["pyhdk.hdk"], "HDK"):
sys.modules["pyhdk.hdk"].HDK = type("HDK", (object,), {})
if not hasattr(sys.modules["pyhdk.hdk"], "ExecutionResult"):
sys.modules["pyhdk.hdk"].ExecutionResult = type("ExecutionResult", (object,), {})
if not hasattr(sys.modules["pyhdk.hdk"], "RelAlgExecutor"):
sys.modules["pyhdk.hdk"].RelAlgExecutor = type("RelAlgExecutor", (object,), {})
if not hasattr(sys.modules["pyhdk"], "__version__"):
# Show all known pyhdk config options in documentation
sys.modules["pyhdk"].__version__ = "999"
if not hasattr(sys.modules["xgboost"], "Booster"):
sys.modules["xgboost"].Booster = type("Booster", (object,), {})
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
import modin
from modin.config.__main__ import export_config_help
configs_file_path = os.path.abspath(
os.path.join(os.path.dirname(__file__), "flow/modin/configs_help.csv")
)
# Export configs help to create configs table in the docs/flow/modin/config.rst
export_config_help(configs_file_path)
project = "Modin"
copyright = "2018-2022, Modin Developers."
author = "Modin contributors"
# The short X.Y version
version = "{}".format(modin.__version__)
# The full version, including alpha/beta/rc tags
release = version
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.mathjax",
"sphinx.ext.githubpages",
"sphinx.ext.graphviz",
"sphinxcontrib.plantuml",
"sphinx_issues",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# -- Options for HTML output -------------------------------------------------
# Maps git branches to Sphinx themes
default_html_theme = "pydata_sphinx_theme"
current_branch = "nature"
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "pydata_sphinx_theme"
html_favicon = "img/MODIN_ver2.ico"
html_logo = "img/MODIN_ver2.png"
html_context = {"default_mode": "light"}
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
"navbar_end": ["navbar-icon-links"],
"sidebarwidth": 270,
"collapse_navigation": False,
"navigation_depth": 4,
"show_toc_level": 2,
"github_url": "https://github.com/modin-project/modin",
"icon_links": [
{
"name": "PyPI",
"url": "https://pypi.org/project/modin",
"icon": "fab fa-python",
},
{
"name": "conda-forge",
"url": "https://anaconda.org/conda-forge/modin",
"icon": "fas fa-circle-notch",
},
{
"name": "Join the Slack",
"url": "https://modin.org/slack.html",
"icon": "fab fa-slack",
},
{
"name": "Discourse",
"url": "https://discuss.modin.org/",
"icon": "fab fa-discourse",
},
{
"name": "Mailing List",
"url": "https://groups.google.com/forum/#!forum/modin-dev",
"icon": "fas fa-envelope-square",
},
],
"navigation_with_keys": True,
}
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# The default pydata_sphinx_theme sidebar templates are
# sidebar-nav-bs.html and search-field.html.
html_sidebars = {}
issues_github_path = "modin-project/modin"