-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
12b7bcb
commit 0983d15
Showing
1 changed file
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
# Configuration file for the Sphinx documentation builder. | ||
# | ||
# For the full list of built-in configuration values, see the documentation: | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
||
import infini | ||
import os, sys | ||
|
||
if sys.version_info >= (3, 11): | ||
import tomllib | ||
else: | ||
import tomli as tomllib | ||
|
||
DATA = None | ||
PYPROJECT = os.path.join("..", "..", "pyproject.toml") | ||
with open(PYPROJECT, "r", encoding="utf8") as f: | ||
pyproject = f.read() | ||
DATA = tomllib.loads(pyproject) | ||
PROJECT_VERSION = DATA["project"]["version"] | ||
PROJECT_NAME = DATA["project"]["name"] | ||
AUTHOR_TABLE = DATA["project"]["authors"] | ||
AUTHORS = ",".join([f"{aut['name']}" for aut in AUTHOR_TABLE]) | ||
|
||
# -- Project information ----------------------------------------------------- | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
||
project = PROJECT_NAME | ||
release = PROJECT_VERSION | ||
copyright = ( | ||
"2023-PRESENT, HydroRoll-Team." | ||
) | ||
author = AUTHORS | ||
|
||
html_title = "FAQ" | ||
|
||
# -- General configuration --------------------------------------------------- | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||
|
||
extensions = [ | ||
"sphinx.ext.autodoc", | ||
"sphinx.ext.viewcode", | ||
"sphinx.ext.todo", | ||
"sphinx.ext.napoleon", | ||
"sphinx.ext.autosummary", | ||
"sphinx.ext.extlinks", | ||
"myst_parser", | ||
] | ||
|
||
templates_path = ["_templates"] | ||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] | ||
extlinks = { | ||
"issue": ("https://github.com/HydroRoll-Team/infini/%s", "issue %s"), | ||
"doc": ("https://infini.hydroroll.team/zh-cn/latest/%s", "pages/%s"), | ||
} | ||
source_suffix = { | ||
".rst": "restructuredtext", | ||
".txt": "markdown", | ||
".md": "markdown", | ||
} | ||
|
||
locale_dirs = ["../locales/"] # path is example but recommended. | ||
gettext_compact = False # optional. | ||
gettext_uuid = True # optional. | ||
|
||
# -- Options for HTML output ------------------------------------------------- | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
|
||
html_theme = "furo" | ||
html_static_path = ["../_static"] | ||
# _html_logo = ( | ||
# "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png" | ||
# ) | ||
# html_favicon = _html_logo | ||
|
||
html_css_files = [ | ||
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css", | ||
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css", | ||
] | ||
|
||
html_theme_options = { | ||
"source_repository": "https://github.com/HydroRoll-Team/faq/", | ||
"source_branch": "master", | ||
"source_directory": "docs/source/", | ||
"footer_icons": [ | ||
{ | ||
"name": "GitHub", | ||
"url": "https://github.com/HydroRoll-Team/faq/", | ||
"html": "", | ||
"class": "fa-brands fa-github", | ||
}, | ||
], | ||
} |