site/docs/conf.py at main · Automating-GIS-processes/site · GitHub

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
# 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

project = 'AutoGIS'
copyright = '2024, Kamyar Hasanzadeh, Department of Geosciences & Geography, University of Helsinki'
author = 'Kamyar Hasanzadeh'
release = '2024'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['nbsphinx']

#nbsphinx_execute = 'always'
nbsphinx_execute = 'auto'  # Execute by default, but respect notebook metadata

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_last_updated_fmt = "%d %B %Y"
html_logo = "static/logo/AutoGIS.PNG"
html_favicon = 'static/logo/favicon.ico'
html_short_title = "AutoGIS"
html_title = ""

html_theme = "sphinx_book_theme"

html_theme_options = {
    "collapse_navigation": False,
    'search_bar_position': 'none',
    'nosidebar': True,
    "launch_buttons": {
        "binderhub_url": "https://mybinder.org",
        "notebook_interface": "classic"
    },
    "path_to_docs": "docs",
    "repository_branch": "main",
    "repository_url": "https://github.com/Automating-GIS-processes/site",
    "use_edit_page_button": True,
    "use_repository_button": True,
    'logo_only': True,
    'display_version': False,
}

#html_static_path = ['static']

nb_execution_mode = "force"
nb_execution_timeout = 120  # needed, e.g., when matplotlib updates its font cache
nb_execution_show_tb = True  # show errors

# temp for wfs issue
#nbsphinx_allow_errors = True