51 lines
1.6 KiB
Python
51 lines
1.6 KiB
Python
|
# 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 = 'Renderbug'
|
||
|
|
copyright = '2023, Victoria Fierce'
|
||
|
|
author = 'Victoria Fierce'
|
||
|
|
|
||
|
|
# -- General configuration ---------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
|
|
||
|
|
extensions = ['breathe']
|
||
|
|
|
||
|
|
breathe_projects = {"renderbug": "../xml"}
|
||
|
|
|
||
|
|
breathe_default_project = "renderbug"
|
||
|
|
|
||
|
|
templates_path = ['_templates']
|
||
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# -- Options for HTML output -------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
|
|
||
|
|
html_theme = 'alabaster'
|
||
|
|
html_static_path = ['_static']
|
||
|
|
|
||
|
|
import subprocess, sys, os
|
||
|
|
|
||
|
|
def generate_doxygen_xml(app):
|
||
|
|
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
|
||
|
|
|
||
|
|
if read_the_docs_build:
|
||
|
|
try:
|
||
|
|
retcode = subprocess.call("cd ../; doxygen", shell=True)
|
||
|
|
if retcode < 0:
|
||
|
|
sys.stderr.write("doxygen terminated by signal %s" % (-retcode))
|
||
|
|
except OSError as e:
|
||
|
|
sys.stderr.write("doxygen execution failed: %s" % e)
|
||
|
|
|
||
|
|
|
||
|
|
def setup(app):
|
||
|
|
|
||
|
|
# Add hook for building doxygen xml when needed
|
||
|
|
app.connect("builder-inited", generate_doxygen_xml)
|