mirror of https://github.com/saimn/sigal.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
3.7 KiB
100 lines
3.7 KiB
import os |
|
|
|
from sigal import __version__ |
|
|
|
# -- 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.autodoc", "sphinx.ext.extlinks"] |
|
|
|
extlinks = {"issue": ("https://github.com/saimn/sigal/issues/%s", "#%s")} |
|
|
|
# Add any paths that contain templates here, relative to this directory. |
|
templates_path = ["_templates"] |
|
|
|
# The suffix of source filenames. |
|
source_suffix = ".rst" |
|
|
|
# The encoding of source files. |
|
# source_encoding = 'utf-8-sig' |
|
|
|
# The master toctree document. |
|
master_doc = "index" |
|
|
|
# General information about the project. |
|
project = "Sigal" |
|
copyright = "2012-2023, Simon Conseil" |
|
|
|
# The version info for the project you're documenting, acts as replacement for |
|
# |version| and |release|, also used in various other places throughout the |
|
# built documents. |
|
release = __version__ |
|
version = __version__ |
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation |
|
# for a list of supported languages. |
|
# language = None |
|
|
|
# There are two options for replacing |today|: either, you set today to some |
|
# non-false value, then it is used: |
|
# today = '' |
|
# Else, today_fmt is used as the format for a strftime call. |
|
# today_fmt = '%B %d, %Y' |
|
|
|
# List of patterns, relative to source directory, that match files and |
|
# directories to ignore when looking for source files. |
|
exclude_patterns = ["_build"] |
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text. |
|
# add_function_parentheses = True |
|
|
|
# If true, the current module name will be prepended to all description |
|
# unit titles (such as .. function::). |
|
# add_module_names = True |
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the |
|
# output. They are ignored by default. |
|
# show_authors = False |
|
|
|
# The name of the Pygments (syntax highlighting) style to use. |
|
pygments_style = "sphinx" |
|
pygments_dark_style = "monokai" |
|
|
|
# A list of ignored prefixes for module index sorting. |
|
# modindex_common_prefix = [] |
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------- |
|
|
|
# Define the canonical URL if you are using a custom domain on Read the Docs |
|
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") |
|
|
|
# Tell Jinja2 templates the build is running on Read the Docs |
|
html_context = {"READTHEDOCS": os.environ.get("READTHEDOCS", "") == "True"} |
|
|
|
html_theme = "furo" |
|
|
|
html_theme_options = { |
|
"source_repository": "https://github.com/saimn/sigal/", |
|
"source_branch": "main", |
|
"source_directory": "docs/", |
|
"footer_icons": [ |
|
{ |
|
"name": "GitHub", |
|
"url": "https://github.com/saimn/sigal", |
|
"html": """ |
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16"> |
|
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path> |
|
</svg> |
|
""", # noqa: E501 |
|
"class": "", |
|
}, |
|
], |
|
} |
|
|
|
# Output file base name for HTML help builder. |
|
htmlhelp_basename = "Sigaldoc"
|
|
|