conf.py

# 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
import glob
import os
import sys
from pathlib import Path

project = 'Aprende Python'
description = 'Aprende Python'
copyright = 'Sergio Delgado Quintero'
author = 'Sergio Delgado Quintero'

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

sys.path.append(str(Path(__file__).parent))

extensions = [
    'extra_roles',
    'sphinxext.opengraph',
    'sphinx.ext.autosectionlabel',
    'sphinx_copybutton',
    'sphinxnotes.strike',
]

autosectionlabel_prefix_document = True

templates_path = ['_templates']
exclude_patterns = ['.venv', '_build', 'Thumbs.db', '.DS_Store', 'prolog.rst']

rst_prolog = open('prolog.rst').read()

language = 'es'

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

html_theme = 'furo'
html_static_path = ['_static']
html_show_sourcelink = False
html_css_files = ['css/custom.css']
STATIC_DIR = f'{html_static_path[0]}/'
html_css_files = [
    p.replace(STATIC_DIR, '') for p in glob.glob(os.path.join(STATIC_DIR, 'css/*.css'))
]
html_js_files = [p.replace(STATIC_DIR, '') for p in glob.glob(os.path.join(STATIC_DIR, 'js/*.js'))]
html_logo = '_static/img/aprendepython-logo.svg'
html_theme_options = {
    'sidebar_hide_name': True,
}
html_favicon = 'favicon.png'
html_show_sourcelink = False
html_title = 'Aprende Python'

# -- Options for Open Graph -------------------------------------------------
# https://sphinxext-opengraph.readthedocs.io/en/latest/

ogp_site_url = 'https://aprendepython.es/'
ogp_image = 'https://raw.githubusercontent.com/sdelquin/aprendepython/main/_static/img/aprendepython-logo.png'

# -- Options for Copy button -------------------------------------------------
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html

# copybutton_prompt_text = r'>>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: '
# copybutton_prompt_is_regexp = True