conf.py 1.64 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
5
6
7
8
9
10
extensions = [
    "sphinx.ext.mathjax",
    "sphinx.ext.autosummary",
    "sphinx.ext.autodoc",
    "sphinxcontrib.lunrsearch",
    "sphinxcontrib.autodoc_doxygen",
]
Robert T. McGibbon's avatar
Robert T. McGibbon committed
11
12

autosummary_generate = True
13
autodoc_member_order = "bysource"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
14

15
16
source_suffix = ".rst"
master_doc = "index"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
17

18
19
project = u"OpenMM C++ API"
copyright = u"2015, Stanford University and the Authors"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
20

21
22
version = "@OPENMM_MAJOR_VERSION@.@OPENMM_MINOR_VERSION@"
release = "@OPENMM_MAJOR_VERSION@.@OPENMM_MINOR_VERSION@"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
23

24
25
26
exclude_patterns = ["_build", "_templates"]
html_static_path = ["_static"]
templates_path = ["_templates"]
Robert T. McGibbon's avatar
Robert T. McGibbon committed
27

28
pygments_style = "sphinx"
Robert T. McGibbon's avatar
Robert T. McGibbon committed
29
30
31

html_theme = "alabaster"
html_theme_options = {
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
    "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,
        },
        {
            "title": "GitHub",
            "uri": "https://github.com/openmm",
            "relative": False,
        },
    ],
    "show_relbar_bottom": True,
Robert T. McGibbon's avatar
Robert T. McGibbon committed
65
66
}
html_sidebars = {
67
68
69
70
    "**": [
        "about.html",
        "lunrsearch.html",
        "navigation.html",
Robert T. McGibbon's avatar
Robert T. McGibbon committed
71
72
73
    ]
}

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