conf.py 2.33 KB
Newer Older
1
2
3
4
# -*- coding: utf-8 -*-
import os
import sys

5
# import tlcpack_sphinx_addon
6
7
8
9
10
11
12
13

# -- General configuration ------------------------------------------------

sys.path.insert(0, os.path.abspath("../tilelang"))
sys.path.insert(0, os.path.abspath("../"))
autodoc_mock_imports = ["torch"]

# General information about the project.
14
project = "Tile Language <br>"
15
16
17
18
19
author = "Tile Lang Contributors"
copyright = "2025-2025, %s" % author

# Version information.

20
# TODO: use the version from project metadata
21
22
23
24
25
26
27
28
29
version = "0.1.0"
release = "0.1.0"

extensions = [
    "sphinx_tabs.tabs",
    "sphinx_toolbox.collapse",
    "sphinxcontrib.httpdomain",
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
30
    "sphinx.ext.intersphinx",
31
    "sphinx_reredirects",
32
33
    "sphinx.ext.mathjax",
    "sphinx.ext.autosummary",
34
35
36
37
38
39
40
41
42
43
44
    "myst_parser",
]

source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

myst_enable_extensions = [
    "colon_fence",
    "deflist",
45
46
47
48
]

redirects = {"get_started/try_out": "../index.html#getting-started"}

49
source_suffix = [".md"]
50
51
52

language = "en"

53
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.md"]
54
55
56
57
58
59
60
61
62
63

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

# -- Options for HTML output ----------------------------------------------

64
html_theme = "furo"
65
66
67

templates_path = []

68
html_static_path = ["_static"]
69
70
71
72
73

footer_copyright = "© 2025-2025 Tile Language"
footer_note = " "

html_theme_options = {
74
75
    "light_logo": "img/logo-row.svg",
    "dark_logo": "img/logo-row.svg",
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
}

header_links = [
    ("Home", "https://github.com/tile-ai/tilelang"),
    ("Github", "https://github.com/tile-ai/tilelang"),
]

html_context = {
    "footer_copyright": footer_copyright,
    "footer_note": footer_note,
    "header_links": header_links,
    "display_github": True,
    "github_user": "tile-ai",
    "github_repo": "tilelang",
    "github_version": "main/docs/",
    "theme_vcs_pageview_mode": "edit",
    # "header_logo": "/path/to/logo",
    # "header_logo_link": "",
    # "version_selecter": "",
}

97
98
99
# # add additional overrides
# templates_path += [tlcpack_sphinx_addon.get_templates_path()]
# html_static_path += [tlcpack_sphinx_addon.get_static_path()]