a b/docs/source/conf.py
1
# Configuration file for the Sphinx documentation builder.
2
#
3
# For the full list of built-in configuration values, see the documentation:
4
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5
6
# -- Project information -----------------------------------------------------
7
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8
9
10
import sys, os
11
12
sys.path.insert(0, os.path.abspath('../../'))
13
14
15
# -- General configuration ------------------------------------------------
16
17
# If your documentation needs a minimal Sphinx version, state it here.
18
#
19
# needs_sphinx = '1.0'
20
21
master_doc = "index"
22
source_suffix = ['.rst', '.md']
23
24
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".ipynb_checkpoints"]
25
26
27
28
# Add any Sphinx extension module names here, as strings. They can be
29
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30
# ones.
31
32
project = 'aggmap'
33
copyright = '2022, Shen Wan Xiang'
34
author = 'Shen Wan Xiang'
35
release = '1.1.8'
36
37
# -- General configuration ---------------------------------------------------
38
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
39
40
41
extensions = [
42
    "sphinx.ext.autodoc",
43
    "sphinx.ext.intersphinx",
44
    "sphinx.ext.mathjax",
45
    "sphinx.ext.viewcode",
46
    'sphinx.ext.napoleon',
47
    'nbsphinx',
48
    #"sphinx_gallery.gen_gallery",
49
    #    'bokeh.sphinxext.bokeh_plot',
50
]
51
52
53
#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
54
55
56
57
# Example configuration for intersphinx: refer to the Python standard library.
58
intersphinx_mapping = {
59
    "python": ("https://docs.python.org/{.major}".format(sys.version_info), None),
60
    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
61
    "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
62
    "matplotlib": ("https://matplotlib.org/", None),
63
    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
64
    "sklearn": ("http://scikit-learn.org/stable/", None),
65
    "bokeh": ("http://bokeh.pydata.org/en/latest/", None),
66
}
67
68
69
70
sphinx_gallery_conf = {
71
    # path to your examples scripts
72
    "examples_dirs": "../examples",
73
    "ignore_pattern": r"(.*torus.*|inverse_transform.*)\.py",
74
    # path where to save gallery generated examples
75
    "gallery_dirs": "auto_examples",
76
    "plot_gallery": False,  # Turn off running the examples for now
77
    "reference_url": {
78
        "python": "https://docs.python.org/{.major}".format(sys.version_info),
79
        "numpy": "https://docs.scipy.org/doc/numpy/",
80
        "scipy": "https://docs.scipy.org/doc/scipy/reference",
81
        "matplotlib": "https://matplotlib.org/",
82
        "pandas": "https://pandas.pydata.org/pandas-docs/stable/",
83
        "sklearn": "http://scikit-learn.org/stable/",
84
        "bokeh": "http://bokeh.pydata.org/en/latest/",
85
    },
86
}
87
88
89
templates_path = ['_templates']
90
exclude_patterns = []
91
92
93
94
# -- Options for HTML output -------------------------------------------------
95
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
96
97
98
html_theme = "sphinx_rtd_theme"
99
#html_theme = 'alabaster'
100
html_theme_options = {"navigation_depth": -1, 
101
                      "collapse_navigation": False, 
102
                      'globaltoc_collapse': False,
103
                      'globaltoc_maxdepth': -1,
104
                      "logo_only": True,}
105
106
107
html_logo = "../images/logo.png"
108
109
# Add any paths that contain custom static files (such as style sheets) here,
110
# relative to this directory. They are copied after the builtin static files,
111
# so a file named "default.css" will overwrite the builtin "default.css".
112
html_static_path = ['_static']
113