94 lines
2.9 KiB
Python
94 lines
2.9 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
||
#
|
||
# For the full list of built-in configuration values, see the documentation:
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||
|
||
import os
|
||
import sys
|
||
|
||
sys.path.append(os.path.abspath('../..'))
|
||
|
||
# -- Project information -----------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||
|
||
project = 'boxes.py'
|
||
project_copyright = '2023, Florian Festi'
|
||
author = 'Florian Festi'
|
||
|
||
# -- General configuration ---------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
||
extensions = [
|
||
'sphinx.ext.autodoc',
|
||
'sphinx.ext.coverage',
|
||
'sphinx.ext.ifconfig',
|
||
'sphinx.ext.viewcode',
|
||
'sphinx.ext.githubpages',
|
||
]
|
||
|
||
templates_path = ['_templates']
|
||
#exclude_patterns = []
|
||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||
|
||
# The suffix of source filenames.
|
||
source_suffix = '.rst'
|
||
|
||
# The root toctree document.
|
||
root_doc = 'index'
|
||
|
||
# The name of the Pygments (syntax highlighting) style to use.
|
||
pygments_style = 'sphinx'
|
||
|
||
# -- Options for HTML output -------------------------------------------------
|
||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
||
html_theme = 'nature'
|
||
html_static_path = ['_static']
|
||
|
||
# The name of an image file (relative to this directory) to place at the top
|
||
# of the sidebar.
|
||
html_logo = "../../static/boxes-logo.svg"
|
||
|
||
# The name of an image file (within the static path) to use as favicon of the
|
||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||
# pixels large.
|
||
html_favicon = "../../static/favicon.ico"
|
||
|
||
# Output file base name for HTML help builder.
|
||
htmlhelp_basename = 'boxespydoc'
|
||
|
||
# If this is not None, a ‘Last updated on:’ timestamp is inserted at every page bottom.
|
||
html_last_updated_fmt = ''
|
||
|
||
# -- Options for LaTeX output ---------------------------------------------
|
||
|
||
latex_elements = {}
|
||
|
||
# Grouping the document tree into LaTeX files. List of tuples
|
||
# (source start file, target name, title,
|
||
# author, documentclass [howto, manual, or own class]).
|
||
latex_documents = [
|
||
('index', 'boxespy.tex', 'boxes.py Documentation',
|
||
'Florian Festi', 'manual'),
|
||
]
|
||
|
||
# -- Options for manual page output ---------------------------------------
|
||
|
||
# One entry per manual page. List of tuples
|
||
# (source start file, name, description, authors, manual section).
|
||
man_pages = [
|
||
('index', 'boxespy', 'boxes.py Documentation',
|
||
['Florian Festi'], 1)
|
||
]
|
||
|
||
# -- Options for Texinfo output -------------------------------------------
|
||
|
||
# Grouping the document tree into Texinfo files. List of tuples
|
||
# (source start file, target name, title, author,
|
||
# dir menu entry, description, category)
|
||
texinfo_documents = [
|
||
('index', 'boxespy', 'boxes.py Documentation',
|
||
'Florian Festi', 'boxespy', 'One line description of project.',
|
||
'Miscellaneous'),
|
||
]
|