150 lines
4.3 KiB
Python
150 lines
4.3 KiB
Python
|
# Configuration file for the Sphinx documentation builder.
|
|||
|
|
#
|
|||
|
|
# This file does only contain a selection of the most common options. For a
|
|||
|
|
# full list see the documentation:
|
|||
|
|
# http://www.sphinx-doc.org/en/master/config
|
|||
|
|
|
|||
|
|
# -- 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('.'))
|
|||
|
|
|
|||
|
|
|
|||
|
|
# -- Project information -----------------------------------------------------
|
|||
|
|
|
|||
|
|
project = 'Rougail'
|
|||
|
|
copyright = '2019-2023, Silique'
|
|||
|
|
author = 'gwen'
|
|||
|
|
|
|||
|
|
# The short X.Y version
|
|||
|
|
version = ''
|
|||
|
|
# The full version, including alpha/beta/rc tags
|
|||
|
|
release = '1.0'
|
|||
|
|
|
|||
|
|
|
|||
|
|
# -- General configuration ---------------------------------------------------
|
|||
|
|
|
|||
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|||
|
|
#
|
|||
|
|
# needs_sphinx = '1.0'
|
|||
|
|
|
|||
|
|
# 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.extlinks', 'sphinx_lesson',
|
|||
|
|
#'myst_parser', 'sphinx.ext.extlinks'
|
|||
|
|
]
|
|||
|
|
#
|
|||
|
|
#myst_enable_extensions = [
|
|||
|
|
# "amsmath",
|
|||
|
|
# "attrs_inline",
|
|||
|
|
# "colon_fence",
|
|||
|
|
# "deflist",
|
|||
|
|
# "dollarmath",
|
|||
|
|
# "fieldlist",
|
|||
|
|
# "html_admonition",
|
|||
|
|
# "html_image",
|
|||
|
|
## "linkify",
|
|||
|
|
# "replacements",
|
|||
|
|
# "smartquotes",
|
|||
|
|
# "strikethrough",
|
|||
|
|
# "substitution",
|
|||
|
|
# "tasklist",
|
|||
|
|
#]
|
|||
|
|
|
|||
|
|
|
|||
|
|
# **extlinks** 'sphinx.ext.extlinks',
|
|||
|
|
# enables syntax like :proxy:`my source <hello>` in the src files
|
|||
|
|
extlinks = {'proxy': ('/proxy/%s.html',
|
|||
|
|
'external link: ')}
|
|||
|
|
|
|||
|
|
default_role = "code"
|
|||
|
|
|
|||
|
|
html_theme = "sphinx_rtd_theme"
|
|||
|
|
|
|||
|
|
pygments_style = 'sphinx'
|
|||
|
|
|
|||
|
|
html_short_title = "Rougail"
|
|||
|
|
html_title = "Rougail documenation"
|
|||
|
|
|
|||
|
|
# If true, links to the reST sources are added to the pages.
|
|||
|
|
html_show_sourcelink = False
|
|||
|
|
|
|||
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|||
|
|
html_show_sphinx = False
|
|||
|
|
|
|||
|
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|||
|
|
html_show_copyright = True
|
|||
|
|
|
|||
|
|
# Add any paths that contain templates here, relative to this directory.
|
|||
|
|
templates_path = ['_templates']
|
|||
|
|
|
|||
|
|
# The suffix(es) of source filenames.
|
|||
|
|
# You can specify multiple suffix as a list of string:
|
|||
|
|
#
|
|||
|
|
#source_suffix = ['.rst', '.md']
|
|||
|
|
source_suffix = '.rst'
|
|||
|
|
#source_suffix = {
|
|||
|
|
# '.rst': 'restructuredtext',
|
|||
|
|
# '.txt': 'restructuredtext',
|
|||
|
|
# '.md': 'markdown',
|
|||
|
|
#}
|
|||
|
|
# The master toctree document.
|
|||
|
|
master_doc = 'index'
|
|||
|
|
|
|||
|
|
# 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']
|
|||
|
|
|
|||
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|||
|
|
pygments_style = None
|
|||
|
|
|
|||
|
|
|
|||
|
|
# -- 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'
|
|||
|
|
# **themes**
|
|||
|
|
#html_theme = 'bizstyle'
|
|||
|
|
|
|||
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|||
|
|
# further. For a list of options available for each theme, see the
|
|||
|
|
# documentation.
|
|||
|
|
#
|
|||
|
|
# html_theme_options = {}
|
|||
|
|
|
|||
|
|
# 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']
|
|||
|
|
|
|||
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|||
|
|
# to template names.
|
|||
|
|
#
|
|||
|
|
# The default sidebars (for documents that don't match any pattern) are
|
|||
|
|
# defined by theme itself. Builtin themes are using these templates by
|
|||
|
|
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
|||
|
|
# 'searchbox.html']``.
|
|||
|
|
#
|
|||
|
|
# html_sidebars = {}
|
|||
|
|
|
|||
|
|
def setup(app):
|
|||
|
|
app.add_css_file('css/custom.css')
|