unstructured

1
# Configuration file for the Sphinx documentation builder.
2
#
3
# This file only contains a selection of the most common options. For a full
4
# list see the documentation:
5
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6

7
# -- Path setup --------------------------------------------------------------
8

9
import os
10
import sys
11

12
sys.path.insert(0, os.path.abspath("../.."))
13

14
# -- Project information -----------------------------------------------------
15

16
from unstructured.__version__ import __version__  # noqa: E402
17

18
project = "Unstructured"
19
copyright = "2022-2023, Unstructured Technologies"
20
author = "Unstructured Technologies"
21

22
# The full version, excluding alpha/beta/rc tags
23
release = __version__.split("-")[0]
24

25
# -- General configuration ---------------------------------------------------
26

27
# Add any Sphinx extension module names here, as strings. They can be
28
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29
# ones.
30
extensions = [
31
    "sphinx_rtd_theme",
32
    "sphinx_tabs.tabs",
33
    "myst_parser",
34
]
35

36
# Add any paths that contain templates here, relative to this directory.
37
templates_path = ["_templates"]
38

39
# List of patterns, relative to source directory, that match files and
40
# directories to ignore when looking for source files.
41
# This pattern also affects html_static_path and html_extra_path.
42
exclude_patterns = []
43

44

45
# -- Options for HTML output -------------------------------------------------
46

47
# The theme to use for HTML and HTML Help pages.  See the documentation for
48
# a list of builtin themes.
49
#
50
html_theme = "furo"
51

52
# Add any paths that contain custom static files (such as style sheets) here,
53
# relative to this directory. They are copied after the builtin static files,
54
# so a file named "default.css" will overwrite the builtin "default.css".
55
html_static_path = ["_static"]
56

57
# Adding a custom css file in order to add custom css file and can change the necessary elements.
58
# custom css and js for kapa.ai integration
59
html_favicon = "_static/images/unstructured_small.png"
60
html_js_files = ["js/githubStargazers.js", "js/sidebarScrollPosition.js", "custom.js"]
61
html_css_files = ["unstructured.css", "custom.css"]
62

63
html_theme_options = {
64
    "sidebar_hide_name": True,
65
    "light_logo": "images/logo-light-mode.svg",
66
    "dark_logo": "images/logo-dark-mode.svg",
67
    "light_css_variables": {
68
        "color-sidebar-background": "#FFFFFF",
69
        "color-sidebar-background-border": "#e9eaed",
70
        "color-sidebar-caption-text": "#484848",
71
        "color-sidebar-link-text": "#484848",
72
        "color-sidebar-link-text--top-level": "#484848",
73
        "color-sidebar-item-background--current": "transparent",
74
        "color-sidebar-item-background--hover": "transparent",
75
        "color-sidebar-item-expander-background": "transparent",
76
        "color-sidebar-item-expander-background--hover": "transparent",
77
        "color-sidebar-search-text": "#484848",
78
        "color-sidebar-search-background": "#FFFFFF",
79
        "color-sidebar-search-background--focus": "#FFFFFF",
80
        "color-sidebar-search-border": "#b9b9b9",
81
        "color-sidebar-search-border-focus": "#484848",
82
        "color-sidebar-current-text": "#ff675f",
83
        "color-content-foreground": "#484848",
84
        "color-toc-title": "#212529",
85
        "color-toc-item-text--hover": "#484848",
86
        "color-toc-item-text--active": "#484848",
87
        "color-table-header": "#FDDACA",
88
        "color-table-bg": "#FFE5D9",
89
        "color-table-row": "#FEEDE6",
90
        "color-link": "#ff675f",
91
        "color-link--hover": "#ff675f",
92
        "content-padding": "5em",
93
        "content-padding--small": "2em",
94
        "color-search-icon": "#484848",
95
        "color-search-placeholder": "#484848",
96
        "color-literal": "#FF675F",
97
        "toc-spacing-vertical": "3em",
98
        "color-page-info": "#646776",
99
        "toc-item-spacing-vertical": "1em",
100
        "color-img-background": "#ffffff",
101
        "sidebar-tree-space-above": "0",
102
        "sidebar-caption-space-above": "0",
103
    },
104
    "dark_css_variables": {
105
        "color-sidebar-background": "#131416",
106
        "color-sidebar-background-border": "#303335",
107
        "color-sidebar-caption-text": "#FFFFFF",
108
        "color-sidebar-link-text": "#FFFFFF",
109
        "color-sidebar-link-text--top-level": "#FFFFFF",
110
        "color-sidebar-item-background--current": "none",
111
        "color-sidebar-item-background--hover": "none",
112
        "color-sidebar-item-expander-background": "transparent",
113
        "color-sidebar-item-expander-background--hover": "transparent",
114
        "color-sidebar-search-text": "#FFFFFF",
115
        "color-sidebar-search-background": "#131416",
116
        "color-sidebar-search-background--focus": "transparent",
117
        "color-sidebar-search-border": "#FFFFFF",
118
        "color-sidebar-search-border-focus": "#FFFFFF",
119
        "color-sidebar-search-foreground": "#FFFFFF",
120
        "color-sidebar-current-text": "#FFC2BF",
121
        "color-content-foreground": "#FFFFFF",
122
        "color-toc-title": "#FFFFFF",
123
        "color-toc-item-text--hover": "#FFFFFF",
124
        "color-toc-item-text--active": "#FFFFFF",
125
        "color-table-header": "#131416",
126
        "color-table-bg": "#232427",
127
        "color-table-row": "#444444",
128
        "color-link": "#FFC2BF",
129
        "color-link--hover": "#FFC2BF",
130
        "color-search-icon": "#FFFFFF",
131
        "color-search-placeholder": "#FFFFFF",
132
        "color-literal": "#F8C0A7",
133
        "color-page-info": "#FFFFFF",
134
        "color-img-background": "#131416",
135
        "sidebar-tree-space-above": "0",
136
        "sidebar-caption-space-above": "0",
137
    },
138
}
139