mirror of https://github.com/Jittor/Jittor
102 lines
3.2 KiB
Python
102 lines
3.2 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
|
|
jittor_path = os.path.abspath('../../python')
|
|
print(f"[jittor_path] {jittor_path}")
|
|
sys.path.insert(0, jittor_path)
|
|
|
|
import jittor
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'Jittor'
|
|
copyright = '2020, Jittor'
|
|
author = 'Jittor'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = jittor.__version__
|
|
# fix AttributeError for "typing.get_type_hints(jt.Var)"
|
|
jittor.Var.__module__ = "jittor_core"
|
|
|
|
# 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 = 'zh_CN'
|
|
|
|
|
|
|
|
# -- 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 = [
|
|
# 'recommonmark',
|
|
'myst_parser',
|
|
'sphinx.ext.autodoc',
|
|
# Auto-generate section labels.
|
|
'sphinx.ext.autosectionlabel',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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 = []
|
|
|
|
|
|
# -- 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 = 'alabaster'
|
|
|
|
# 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']
|
|
|
|
import sphinx_rtd_theme
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
source_suffix = {
|
|
'.rst': 'restructuredtext',
|
|
'.txt': 'markdown',
|
|
'.md': 'markdown',
|
|
}
|
|
|
|
import recommonmark
|
|
from recommonmark.transform import AutoStructify
|
|
|
|
# At the bottom of conf.py
|
|
def setup(app):
|
|
app.add_config_value('recommonmark_config', {
|
|
# 'url_resolver': lambda url: github_doc_root + url,
|
|
'auto_toc_tree_section': 'Contents',
|
|
}, True)
|
|
app.add_transform(AutoStructify)
|
|
|
|
|
|
# Prefix document path to section labels, otherwise autogenerated labels would look like 'heading'
|
|
# rather than 'path/to/file:heading'
|
|
autosectionlabel_prefix_document = True
|