vgmstream/doc/conf.py
Kevin López Brante 8735d1f14d Documentation and website revamped
Now using Sphinx to build the website, whose contents are
based on the documentation
2022-08-30 18:36:09 -04:00

43 lines
1.3 KiB
Python

import sphinx_rtd_theme
# 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
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'vgmstream'
copyright = '2022, the vgmstream authors'
author = 'the vgmstream authors'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ['myst_parser', 'sphinx_rtd_theme']
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
root_doc = 'index'
myst_enable_extensions = ['smartquotes', 'linkify']
myst_heading_anchors = 5
myst_linkify_fuzzy_links = False
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_options = {
'collapse_navigation': False,
'prev_next_buttons_location': 'both',
'style_external_links': True,
'style_nav_header_background': '#449607'
}