sphinx-togglebutton/docs/conf.py at 22bb3aab4135e7159ebcd46740d1ad29a5350f5f · executablebooks/sphinx-togglebutton · 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
# -- Project information -----------------------------------------------------

project = "Sphinx Toggle Button"
copyright = "2022, Executable Books Community"
author = "Chris Holdgraf"

# The short X.Y version
version = ""
# The full version, including alpha/beta/rc tags
release = ""


# -- General configuration ---------------------------------------------------
extensions = ["myst_nb", "sphinx_examples", "sphinx_design", "sphinx_togglebutton"]
templates_path = ["_templates"]
source_suffix = ".rst"
main_doc = "index"
language = None
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# -- Options for HTML output -------------------------------------------------
html_theme = "sphinx_book_theme"
# html_theme = "sphinx_rtd_theme"  # These are just for testing
# html_theme = "pydata_sphinx_theme"
# html_theme = "alabaster"
# html_theme = "furo"

html_theme_options = {
    "repository_url": "https://github.com/executablebooks/sphinx-togglebutton",
    "path_to_docs": "docs",
    "repository_branch": "master",
    "use_repository_button": True,
    "use_issues_button": True,
    "use_edit_page_button": True,
    "home_page_in_toc": True,
}

myst_enable_extensions = ["colon_fence"]

# To test behavior in JS
# togglebutton_hint = "test show"
# togglebutton_hint_hide = "test hide"
# togglebutton_open_on_print = False