Inkycal/docsource/conf.py

62 lines
2.1 KiB
Python
Raw Permalink Normal View History

2020-05-07 20:17:32 +02:00
# 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('..'))
2020-05-07 20:17:32 +02:00
2020-11-10 23:39:54 +01:00
master_doc = 'index'
2020-05-07 20:17:32 +02:00
# -- Project information -----------------------------------------------------
project = 'inkycal'
2023-06-03 15:44:07 +02:00
copyright = '2018-2023, aceinnolab'
author = 'aceinnolab'
2020-05-07 20:17:32 +02:00
# The full version, including alpha/beta/rc tags
2024-06-26 01:47:58 +02:00
release = '2.0.4'
2020-05-07 20:17:32 +02:00
# -- 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.
2020-11-23 14:36:46 +01:00
extensions = ['sphinx.ext.autodoc', 'sphinxemoji.sphinxemoji',
2020-11-24 00:35:12 +01:00
'sphinx_rtd_theme', 'recommonmark']
2020-05-07 20:17:32 +02:00
# 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']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2020-11-24 00:35:12 +01:00
html_theme = "sphinx_rtd_theme" # html_theme = 'classic'
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}
2020-05-07 20:17:32 +02:00
# 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".
2020-11-24 00:35:12 +01:00
# html_static_path = ['_static']