path: root/docs/conf.py

import sys
import pathlib

sys.path.append(str(pathlib.PurePath(__file__).parent.parent.joinpath('src')))


# 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 = 'bbss.py'
copyright = '2023, Aleteoryx'
author = 'Aleteoryx'
release = '0.1.0'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['sphinx.ext.doctest', 'sphinx.ext.intersphinx']

templates_path = ['_templates']
exclude_patterns = ['*~']

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'sphinxdoc'
html_theme_options = {
  'sidebarwidth': 300
}

html_static_path = ['_static']

python_display_short_literal_types = True

intersphinx_mapping = {
  'python': ('https://docs.python.org/3', None),
  'requests': ('https://requests.readthedocs.io/en/latest/', None)
}

doctest_global_setup = """
import bbss
import bbss.lists
import bbss.buttons
import bbss.friends
import bbss.site
import bbss.sizes
"""