alchemiscale/docs/conf.py at 843918eec7e8df14f44d7d3a70bf12dbd8a8d91d · OpenFreeEnergy/alchemiscale · 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
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
# 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 = "alchemiscale"
copyright = '2022, "OpenFE and OpenFF developers"'
author = '"OpenFE and OpenFF developers"'

import sys
import os

sys.path.insert(0, os.path.abspath("."))


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

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.githubpages",
    "sphinx.ext.intersphinx",
    "myst_nb",
]

numfig = True

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

autodoc_mock_imports = [
    "async_lru",
    "bcrypt",
    "boto3",
    "click",
    "diskcache",
    "fastapi",
    "httpx",
    "jose",
    "neo4j",
    "pydantic",
    "pydantic_settings",
    "starlette",
    "yaml",
]

intersphinx_mapping = {
    "gufe": ("https://gufe.openfree.energy/en/stable/", None),
    "openfe": ("https://docs.openfree.energy/en/stable/", None),
    "python": ("https://docs.python.org/3", None),
}

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

html_theme = "furo"
html_logo = "assets/logo/logo_full_horizontal_inverted.png"
html_theme_options = {
    "sidebar_hide_name": True,
    "navigation_with_keys": True,
}

# -- Options for MystNB ------------------------------------------------------

myst_url_schemes = [
    "http",
    "https",
]

myst_enable_extensions = [
    "amsmath",
    "colon_fence",
    "deflist",
    "dollarmath",
    "html_image",
    "smartquotes",
    "replacements",
]

myst_heading_anchors = 2

# Never execute notebooks
# Output is stored in the notebook itself
# Remember `Widgets -> Save Notebook Widget State` in the notebook.
# See: https://myst-nb.readthedocs.io/en/latest/computation/execute.html
nb_execution_mode = "off"