conf.py 1.94 KB
Newer Older
Robert T. McGibbon's avatar
Robert T. McGibbon committed
1
import os
2
import sys
Robert T. McGibbon's avatar
Robert T. McGibbon committed
3

4
extensions = ["sphinx.ext.mathjax", "breathe"]
Robert T. McGibbon's avatar
Robert T. McGibbon committed
5

6
autosummary_generate = False
7
autodoc_member_order = "bysource"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
8

9
10
11
12
13
14
15
16
17
18
19
breathe_projects = {
    "api-c++": "doxygen/xml",
}
breathe_default_project = "api-c++"

# Tell sphinx what the primary language being documented is.
primary_domain = "cpp"

# Tell sphinx what the pygments highlight language should be.
highlight_language = "cpp"

20
21
source_suffix = ".rst"
master_doc = "index"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
22

23
project = u"OpenMM C++ API"
24
copyright = u"2015-2025, Stanford University and the Authors"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
25

26
27
version = "@OPENMM_MAJOR_VERSION@.@OPENMM_MINOR_VERSION@"
release = "@OPENMM_MAJOR_VERSION@.@OPENMM_MINOR_VERSION@"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
28

29
30
31
exclude_patterns = ["_build", "_templates"]
html_static_path = ["_static"]
templates_path = ["_templates"]
Robert T. McGibbon's avatar
Robert T. McGibbon committed
32

33
pygments_style = "sphinx"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
34
35
36

html_theme = "alabaster"
html_theme_options = {
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
    "github_button": False,
    "github_user": "openmm",
    "github_repo": "openmm",
    "logo_name": True,
    "logo": "logo.png",
    "extra_nav_links": [
        {
            "title": "OpenMM.org",
            "uri": "https://openmm.org",
            "relative": False,
        },
        {
            "title": "User's Manual",
            "uri": "../userguide/",
            "relative": True,
        },
        {
            "title": "Developer Guide",
            "uri": "../developerguide/",
            "relative": True,
        },
        {
            "title": "Python API reference",
            "uri": "../api-python/",
            "relative": True,
        },
63
64
65
66
67
        {
            "title": "Cookbook & Tutorials",
            "uri": "https://openmm.github.io/openmm-cookbook/",
            "relative": False,
        },
68
69
70
71
72
73
74
        {
            "title": "GitHub",
            "uri": "https://github.com/openmm",
            "relative": False,
        },
    ],
    "show_relbar_bottom": True,
Robert T. McGibbon's avatar
Robert T. McGibbon committed
75
76
}
html_sidebars = {
77
78
    "**": [
        "about.html",
79
        "searchbox.html",
80
        "navigation.html",
Robert T. McGibbon's avatar
Robert T. McGibbon committed
81
82
83
    ]
}

Robert T. McGibbon's avatar
Robert T. McGibbon committed
84
doxygen_xml = "doxygen/xml"