1# Configuration file for the Sphinx documentation builder. 2 3# -- Project information 4project = 'rules_testing' 5copyright = '2023, The Bazel Authors' 6author = 'Bazel' 7 8# Readthedocs fills these in 9release = '0.0.0' 10version = release 11 12# -- General configuration 13 14# Any extensions here not built into Sphinx must also be added to 15# the dependencies of Bazel and Readthedocs. 16# * //docs:requirements.in 17# * Regenerate //docs:requirements.txt (used by readthedocs) 18# * Add the dependencies to //docs:sphinx_build 19extensions = [ 20 'sphinx.ext.duration', 21 'sphinx.ext.doctest', 22 'sphinx.ext.autodoc', 23 'sphinx.ext.autosummary', 24 'sphinx.ext.intersphinx', 25 'sphinx.ext.autosectionlabel', 26 'myst_parser', 27 'sphinx_rtd_theme', # Necessary to get jquery to make flyout work 28] 29 30intersphinx_mapping = { 31} 32 33intersphinx_disabled_domains = ['std'] 34 35# Prevent local refs from inadvertently linking elsewhere, per 36# https://docs.readthedocs.io/en/stable/guides/intersphinx.html#using-intersphinx 37intersphinx_disabled_reftypes = ["*"] 38 39templates_path = ['_templates'] 40 41# -- Options for HTML output 42 43html_theme = 'sphinx_rtd_theme' 44 45# See https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html 46# for options 47html_theme_options = {} 48 49# Keep this in sync with the stardoc templates 50html_permalinks_icon = '¶' 51 52# See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html 53# for additional extensions. 54myst_enable_extensions = [ 55 "fieldlist", 56 "attrs_block", 57 "attrs_inline", 58 "colon_fence", 59 "deflist", 60] 61 62# These folders are copied to the documentation's HTML output 63html_static_path = ['_static'] 64 65# These paths are either relative to html_static_path 66# or fully qualified paths (eg. https://...) 67html_css_files = [ 68 'css/custom.css', 69] 70 71# -- Options for EPUB output 72epub_show_urls = 'footnote' 73 74