mirror of
https://github.com/bab2min/Kiwi.git
synced 2026-06-17 01:54:27 +00:00
102 lines
3.3 KiB
Python
102 lines
3.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
from sphinx.builders.html import StandaloneHTMLBuilder
|
|
import subprocess, os
|
|
|
|
# Doxygen
|
|
subprocess.call("doxygen Doxyfile.in", shell=True)
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "Kiwi"
|
|
copyright = "2021, bab2min"
|
|
author = "bab2min"
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.mathjax",
|
|
"sphinx.ext.githubpages",
|
|
"sphinx.ext.ifconfig",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx_sitemap",
|
|
"sphinx.ext.inheritance_diagram",
|
|
"breathe",
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = "en"
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
highlight_language = "c++"
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_options = {
|
|
"analytics_id": "", # Provided by Google in your dashboard
|
|
"display_version": True,
|
|
"prev_next_buttons_location": "bottom",
|
|
"style_external_links": False,
|
|
"logo_only": False,
|
|
# Toc options
|
|
"collapse_navigation": True,
|
|
"sticky_navigation": True,
|
|
"navigation_depth": 4,
|
|
"includehidden": True,
|
|
"titles_only": False,
|
|
}
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ["_static"]
|
|
|
|
# This must be the same as GitHub repo name since the output is hosted at
|
|
# https://bab2min.github.io/Kiwi
|
|
html_baseurl = "/Kiwi"
|
|
|
|
# -- Breathe configuration -------------------------------------------------
|
|
|
|
master_doc = "index"
|
|
|
|
breathe_projects = {"Kiwi": "_build/xml/"}
|
|
breathe_default_project = "Kiwi"
|
|
breathe_default_members = ("members", "undoc-members")
|