conf.py 1.98 KB
Newer Older
1
# General information about the project.
2
project = "Tile Language <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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
autoapi_type = 'python'
autoapi_dirs = ['../tilelang']

autoapi_options = [
    'members',
    'undoc-members',
    'show-inheritance',
    'show-module-summary',
    'special-members',
]
autoapi_keep_files = False  # Useful for debugging the generated rst files

autoapi_generate_api_docs = True

autodoc_typehints = 'description'

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

41
42
43
44
45
46
47
48
source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

myst_enable_extensions = [
    "colon_fence",
    "deflist",
49
50
51
52
53
54
]

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

language = "en"

55
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.md", "**/*libinfo*", "**/*version*"]
56
57
58
59
60
61

pygments_style = "sphinx"
todo_include_todos = False

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

62
html_theme = "furo"
63
templates_path = []
64
html_static_path = ["_static"]
65
66
67
68
footer_copyright = "© 2025-2025 Tile Language"
footer_note = " "

html_theme_options = {
69
70
    "light_logo": "img/logo-row.svg",
    "dark_logo": "img/logo-row.svg",
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
}

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