|
a |
|
b/doc/source/conf.py |
|
|
1 |
""" |
|
|
2 |
Sphinx configuration. |
|
|
3 |
|
|
|
4 |
********************* |
|
|
5 |
""" |
|
|
6 |
|
|
|
7 |
# Configuration file for the Sphinx documentation builder. |
|
|
8 |
# |
|
|
9 |
# This file only contains a selection of the most common options. For a full |
|
|
10 |
# list see the documentation: |
|
|
11 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html |
|
|
12 |
|
|
|
13 |
# -- Path setup -------------------------------------------------------------- |
|
|
14 |
|
|
|
15 |
# If extensions (or modules to document with autodoc) are in another directory, |
|
|
16 |
# add these directories to sys.path here. If the directory is relative to the |
|
|
17 |
# documentation root, use os.path.abspath to make it absolute, like shown here. |
|
|
18 |
# |
|
|
19 |
import sphinx_rtd_theme |
|
|
20 |
import os |
|
|
21 |
import sys |
|
|
22 |
sys.path.insert(0, os.path.abspath('../..')) |
|
|
23 |
|
|
|
24 |
|
|
|
25 |
# -- Project information ----------------------------------------------------- |
|
|
26 |
|
|
|
27 |
project = 'pathaia' |
|
|
28 |
copyright = '2020, arnaud abreu' |
|
|
29 |
author = 'arnaud abreu' |
|
|
30 |
|
|
|
31 |
# The full version, including alpha/beta/rc tags |
|
|
32 |
release = '0.1' |
|
|
33 |
|
|
|
34 |
|
|
|
35 |
# -- General configuration --------------------------------------------------- |
|
|
36 |
|
|
|
37 |
# Add any Sphinx extension module names here, as strings. They can be |
|
|
38 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
|
39 |
# ones. |
|
|
40 |
extensions = [] |
|
|
41 |
extensions.append("sphinx.ext.autodoc") |
|
|
42 |
extensions.append("sphinx.ext.napoleon") |
|
|
43 |
extensions.append("sphinx_autodoc_typehints") |
|
|
44 |
|
|
|
45 |
add_module_names = False |
|
|
46 |
|
|
|
47 |
# Add any paths that contain templates here, relative to this directory. |
|
|
48 |
templates_path = ['_templates'] |
|
|
49 |
|
|
|
50 |
# List of patterns, relative to source directory, that match files and |
|
|
51 |
# directories to ignore when looking for source files. |
|
|
52 |
# This pattern also affects html_static_path and html_extra_path. |
|
|
53 |
exclude_patterns = [] |
|
|
54 |
autodoc_member_order = 'bysource' |
|
|
55 |
autodoc_mock_imports = ["fastcore", |
|
|
56 |
"numpy", |
|
|
57 |
"tqdm", |
|
|
58 |
"openslide", |
|
|
59 |
"cv2", |
|
|
60 |
"skimage", |
|
|
61 |
"matplotlib", |
|
|
62 |
"nptyping", |
|
|
63 |
"pandas", |
|
|
64 |
"sklearn", |
|
|
65 |
"tensorflow" |
|
|
66 |
] |
|
|
67 |
|
|
|
68 |
|
|
|
69 |
# -- Options for HTML output ------------------------------------------------- |
|
|
70 |
|
|
|
71 |
# The theme to use for HTML and HTML Help pages. See the documentation for |
|
|
72 |
# a list of builtin themes. |
|
|
73 |
# |
|
|
74 |
# html_theme = 'alabaster' |
|
|
75 |
|
|
|
76 |
html_theme = 'sphinx_rtd_theme' |
|
|
77 |
|
|
|
78 |
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
|
|
79 |
|
|
|
80 |
# Add any paths that contain custom static files (such as style sheets) here, |
|
|
81 |
# relative to this directory. They are copied after the builtin static files, |
|
|
82 |
# so a file named "default.css" will overwrite the builtin "default.css". |
|
|
83 |
html_static_path = ['_static'] |