conf.py 2.01 KB
Newer Older
1
2
3
# -*- coding: utf-8 -*-

# General information about the project.
4
project = "Tile Language <br>"
5
6
7
8
author = "Tile Lang Contributors"
copyright = "2025-2025, %s" % author

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

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

25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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*"]

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

myst_enable_extensions = [
    "colon_fence",
    "deflist",
51
52
53
54
55
56
]

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

language = "en"

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

pygments_style = "sphinx"
todo_include_todos = False

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

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

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

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