conf.py 1.97 KB
Newer Older
1
# General information about the project.
2
project = "TileLang <br>"
3
author = "Tile Lang Contributors"
4
copyright = f"2025-2025, {author}"
5
6

# Version information.
7
with open("../VERSION") as f:
8
9
    version = f.read().strip()
release = version
10
11
12
13
14
15

extensions = [
    "sphinx_tabs.tabs",
    "sphinx_toolbox.collapse",
    "sphinxcontrib.httpdomain",
    "sphinx.ext.napoleon",
16
    "sphinx.ext.intersphinx",
17
    "sphinx_reredirects",
18
    "sphinx.ext.mathjax",
19
    "myst_parser",
20
    "autoapi.extension",
21
22
]

23
24
autoapi_type = "python"
autoapi_dirs = ["../tilelang"]
25
26

autoapi_options = [
27
28
29
30
31
    "members",
    "undoc-members",
    "show-inheritance",
    "show-module-summary",
    "special-members",
32
33
34
35
36
]
autoapi_keep_files = False  # Useful for debugging the generated rst files

autoapi_generate_api_docs = True

37
autodoc_typehints = "description"
38
39
40

autoapi_ignore = ["*language/ast*", "*version*", "*libinfo*", "*parser*"]

41
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
42

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

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

language = "en"

49
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.md", "**/*libinfo*", "**/*version*"]
50
51
52
53
54
55

pygments_style = "sphinx"
todo_include_todos = False

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

56
html_theme = "furo"
57
templates_path = []
58
html_static_path = ["_static"]
59
60
html_css_files = ["custom.css"]
footer_copyright = "© 2025-2026 TileLang"
61
62
footer_note = " "

63
html_theme_options = {"light_logo": "img/logo-v2.png", "dark_logo": "img/logo-v2.png"}
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

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",
}