LookingGlass/doc/conf.py

93 lines
2.8 KiB
Python
Raw Normal View History

2021-03-26 22:12:37 +00: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('.'))
# -- Project information -----------------------------------------------------
project = 'Looking Glass'
2021-05-04 10:52:18 +00:00
copyright = '2021, Looking Glass team'
author = 'Geoffrey McRae and the Looking Glass team'
2021-03-26 22:12:37 +00:00
# The full version, including alpha/beta/rc tags
release = 'B4'
rst_prolog = """
.. |license| replace:: GPLv2
"""
2021-03-26 22:12:37 +00: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.
extensions = [
]
try:
from sphinxcontrib import spelling
except ImportError:
pass
else:
del spelling
extensions += ['sphinxcontrib.spelling']
import sys, os
sys.path.append(os.path.dirname(__file__))
spelling_filters = [
'lgspell.OptionFilter', 'lgspell.PackageFilter', 'lgspell.PathFilter',
'lgspell.CryptoAddressFilter'
]
spelling_word_list_filename = [os.path.join(os.path.dirname(__file__), 'words.txt')]
2021-03-26 22:12:37 +00:00
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
2021-03-26 22:12:37 +00:00
# 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']
# Explicitly state master_doc instead of relying on default
master_doc = 'index'
2021-03-26 22:12:37 +00:00
# -- 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'
2021-05-04 10:51:24 +00:00
html_theme_options = {
2021-12-25 19:16:25 +00:00
'logo': 'icon-128x128.png',
'fixed_sidebar': 'true',
2021-05-04 10:51:24 +00:00
}
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html',
'searchbox.html',
]
}
2021-05-04 09:20:24 +00:00
html_favicon = '../resources/icon.ico'
2021-03-26 22:12:37 +00: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".
2021-05-04 10:51:24 +00:00
html_static_path = ['../resources/icon-128x128.png']