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# If extensions (or modules to document with autodoc) are in another directory, 10# add these directories to sys.path here. If the directory is relative to the 11# documentation root, use os.path.abspath to make it absolute, like shown here. 12# 13# import os 14# import sys 15# sys.path.insert(0, os.path.abspath('.')) 16 17 18# -- Project information ----------------------------------------------------- 19 20project = 'DragonOS' 21copyright = '2022-2023, DragonOS Community' 22author = 'longjin' 23 24# The full version, including alpha/beta/rc tags 25release = 'dev' 26 27 28# -- General configuration --------------------------------------------------- 29 30# Add any Sphinx extension module names here, as strings. They can be 31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32# ones. 33extensions = ['myst_parser'] 34 35# Add any paths that contain templates here, relative to this directory. 36templates_path = ['_templates'] 37 38# The language for content autogenerated by Sphinx. Refer to documentation 39# for a list of supported languages. 40# 41# This is also used if you do content translation via gettext catalogs. 42# Usually you set "language" from the command line for these cases. 43language = 'zh_CN' 44 45# List of patterns, relative to source directory, that match files and 46# directories to ignore when looking for source files. 47# This pattern also affects html_static_path and html_extra_path. 48exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 49source_suffix = ['.rst', '.md'] 50 51# -- Options for HTML output ------------------------------------------------- 52 53# The theme to use for HTML and HTML Help pages. See the documentation for 54# a list of builtin themes. 55# 56html_theme = 'sphinx_rtd_theme' 57 58# Add any paths that contain custom static files (such as style sheets) here, 59# relative to this directory. They are copied after the builtin static files, 60# so a file named "default.css" will overwrite the builtin "default.css". 61html_static_path = ['_static'] 62 63myst_enable_extensions = [ 64 "amsmath", 65 "colon_fence", 66 "deflist", 67 "dollarmath", 68 "fieldlist", 69 "html_admonition", 70 "html_image", 71 "replacements", 72 "smartquotes", 73 "strikethrough", 74 "substitution", 75 "tasklist", 76]