mirror of
https://github.com/kennethreitz/replit-py.git
synced 2026-06-05 15:00:20 +00:00
78 lines
2.4 KiB
Python
78 lines
2.4 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 directoricdes 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("../src"))
|
|
sys.path.append(os.path.abspath("../src"))
|
|
|
|
import replit
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "replit-py"
|
|
copyright = "2021"
|
|
author = "<a href='https://repl.it/'>Replit</a>"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = "3.0.0"
|
|
|
|
|
|
# -- 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.napoleon",
|
|
"sphinx_autodoc_typehints",
|
|
|
|
|
|
]
|
|
|
|
# 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 = ["_build", "Thumbs.db", ".DS_Store", "conf.py"]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
|
|
# 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"]
|
|
|
|
html_theme_options = {
|
|
'show_powered_by': False
|
|
}
|
|
|
|
html_sidebars = {
|
|
'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html',
|
|
'hacks.html'],
|
|
'**': ['sidebarintro.html', 'localtoc.html', 'relations.html',
|
|
'sourcelink.html', 'searchbox.html', 'hacks.html']
|
|
}
|
|
|
|
# Custom css
|
|
# html_css_files = ["css/darktheme.css"]
|