SphinxQL-Query-Builder/docs/conf.py at a5da4c3307f31a89ff85b5fcb7f8ce3965bde893 · FoolCode/SphinxQL-Query-Builder · 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
from datetime import date

project = "SphinxQL Query Builder"
author = "FoolCode"
copyright = f"2012-{date.today().year}, {author}"

# We track release notes in CHANGELOG.md and do not hardcode package versions here.
version = "current"
release = version

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.viewcode",
    "sphinx.ext.githubpages",
    "sphinx_copybutton",
]

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

source_suffix = {".rst": "restructuredtext"}
root_doc = "index"
language = "en"

pygments_style = "sphinx"
pygments_dark_style = "monokai"

html_theme = "furo"
html_title = "SphinxQL Query Builder Documentation"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_theme_options = {
    "source_repository": "https://github.com/FoolCode/SphinxQL-Query-Builder/",
    "source_branch": "master",
    "source_directory": "docs/",
    "navigation_with_keys": True,
}

copybutton_prompt_text = r">>> |\.\.\. |\$ "
copybutton_prompt_is_regexp = True