conf.py

# This file is generated from sphinx-notes/cookiecutter.
# You need to consider modifying the TEMPLATE or modifying THIS FILE.

# 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

# -- Project information -----------------------------------------------------

project = 'sphinxnotes-render'
author = 'Shengyu Zhang'
copyright = "2025, " + author

# The full version, including alpha/beta/rc tags
version = release = '1.0a0'

# -- 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 = [
    'sphinx.ext.githubpages',
    'sphinx.ext.doctest',
    'sphinx.ext.viewcode',
    'sphinx_design',
    'sphinx_copybutton',
    'sphinx_last_updated_by_git',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The document name of the “master” document, that is,
# the document that contains the root toctree directive.
# Default is 'index', we set it here for supporting Sphinx<2.0
master_doc = 'index'

# 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']

# A boolean that decides whether codeauthor and sectionauthor directives
# produce any output in the built files.
show_authors = True

# Keep warnings as “system message” paragraphs in the rendered documents.
keep_warnings = True

# -- 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 = 'furo'

html_theme_options = {
    "source_repository": "https://github.com/sphinx-notes/data/",
    "source_branch": "master",
    "source_directory": "docs/",
}

# The URL which points to the root of the HTML documentation.
# It is used to indicate the location of document like canonical_url
html_baseurl = 'https://sphinx.silverrainz.me/render'

html_logo = html_favicon = '_static/sphinx-notes.png'

# 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".
html_static_path = ['_static']

html_css_files = ['custom.css']

# -- Extensions -------------------------------------------------------------

extensions.append('sphinx.ext.extlinks')
extlinks = {
    'issue': ('https://github.com/sphinx-notes/data/issues/%s', '💬%s'),
    'pull': ('https://github.com/sphinx-notes/data/pull/%s', '🚀%s'),
    'tag': ('https://github.com/sphinx-notes/data/releases/tag/%s', '🏷️%s'),
}

extensions.append('sphinxcontrib.gtagjs')
gtagjs_ids = ['G-E4SNX0WZYV']

extensions.append('sphinx.ext.autodoc')
autoclass_content = 'init'
autodoc_typehints = 'description'

extensions.append('sphinx.ext.intersphinx')
intersphinx_mapping = {}

extensions.append('sphinx_sitemap')
sitemap_filename = "sitemap.xml"
sitemap_url_scheme = "{link}"

extensions.append('sphinxext.opengraph')
ogp_site_url = html_baseurl
ogp_site_name = project
ogp_image = html_baseurl + '/' + html_logo

extensions.append('sphinxnotes.comboroles')
comboroles_roles = {
    'parsed_literal': (['literal'], True),
}

extensions.append('sphinxnotes.project')
primary_domain = 'any'

# -- Eat your own dog food --------------------------------------------------

# 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('../src/'))
extensions.append('sphinxnotes.render')

# CUSTOM CONFIGURATION

extensions.append('sphinxnotes.render.ext')

# [example config start]
data_define_directives = {
   'cat': {
       'schema': {
           'name': 'str, required',
           'attrs': {
               'color': 'str',
           },
           'content': 'str, required'
       },
       'template': {
           'text': '\n'.join([
               'Hi human! I am a cat named {{ name }}, I have {{ color }} fur.',
               '',
               '{{ content }}.',
           ]),
       },
   },
}
# [example config end]

autodoc_default_options = {
    'member-order': 'bysource',
}

intersphinx_mapping['python'] = ('https://docs.python.org/3', None)
intersphinx_mapping['sphinx'] = ('https://www.sphinx-doc.org/en/master', None)

test_roots = os.path.abspath('../tests/roots')

def setup(app):
    app.add_object_type('event', 'event') # for intersphinx

    sys.path.insert(0, test_roots)
    __import__('test-extra-context.conf').conf.setup(app)
    __import__('test-base-context-directive-example.conf').conf.setup(app)
    __import__('test-base-data-define-directive-example.conf').conf.setup(app)
    __import__('test-strict-data-define-directive-example.conf').conf.setup(app)
    __import__('test-filter-example.conf').conf.setup(app)