1shot-documentation/source/conf.py at main · 1Shot-API/1shot-documentation · 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
# 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 = '1Shot API'
copyright = '2026, 1Shot API, Inc.'
author = '1Shot API, Inc.'
release = '1.0.0'

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

extensions = [
    'sphinx.ext.githubpages',
    'sphinx_design',
    'sphinx_copybutton',
    'sphinxcontrib.youtube',
    'sphinxcontrib.googleanalytics'
]

templates_path = ['_templates']
exclude_patterns = []

# -- Sphinx Google Analytics options --------------------------------------
googleanalytics_id = "G-MCWRCDN77E"

# -- Sphinx-copybutton options ---------------------------------------------
# Exclude copy button from appearing over notebook cell numbers by using :not()
# The default copybutton selector is `div.highlight pre`
# https://github.com/executablebooks/sphinx-copybutton/blob/master/sphinx_copybutton/__init__.py#L82
copybutton_exclude = ".linenos, .gp"
copybutton_selector = ":not(.prompt) > div.highlight pre"

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

#html_theme = 'alabaster'
html_title = '1Shot Docs'
html_logo = '_static/1shot-logo.svg' # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_logo
html_favicon = '_static/favicon.ico' # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon
html_show_sphinx = False
html_theme = 'pydata_sphinx_theme'
html_static_path = ['_static']
html_css_files = ['cursor-mcp-button.css']
html_baseurl = 'https://docs.1shotapi.com'
html_theme_options = {
    "icon_links": [
        {
            # Label for this link
            "name": "X",
            # URL where the link will redirect
            "url": "https://x.com/1shotapi",  # required
            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
            "icon": "fa-brands fa-x-twitter",
            # The type of image to be used (see below for details)
            "type": "fontawesome",
        },
        {
            # Label for this link
            "name": "Telegram",
            # URL where the link will redirect
            "url": "https://t.me/oneshotapi",  # required
            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
            "icon": "fa-brands fa-telegram",
            # The type of image to be used (see below for details)
            "type": "fontawesome",
        },
        {
            # Label for this link
            "name": "YouTube",
            # URL where the link will redirect
            "url": "https://www.youtube.com/@1ShotAPI",  # required
            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
            "icon": "fa-brands fa-youtube",
            # The type of image to be used (see below for details)
            "type": "fontawesome",
        }
   ],
   "secondary_sidebar_items": ["page-toc"],
}