# 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 # -- Path setup -------------------------------------------------------------- import os import sys sphinx_settings = eval(os.getenv('SPHINX_SETTINGS')) # set in tools/batools/docs.py ballistica_root = os.getenv('BALLISTICA_ROOT') + '/' assets_dirs: dict = { 'ba_data': 'src/assets/ba_data/python/', 'dummy_modules': 'build/dummymodules/', 'efro_tools': 'tools/', # for efro and bacommon package } sys.path.append(os.path.abspath(ballistica_root + assets_dirs['ba_data'])) sys.path.append(os.path.abspath(ballistica_root + assets_dirs['dummy_modules'])) sys.path.append(os.path.abspath(ballistica_root + assets_dirs['efro_tools'])) # -- Options for HTML output ------------------------------------------------- # for more themes visit https://sphinx-themes.org/ html_theme = 'furo' # python_docs_theme, groundwork, furo, sphinx_rtd_theme html_title = sphinx_settings['project_name'] + ' ' + str(sphinx_settings['version']) + ' documentation' # do not remove, sets the logo on side panel html_logo = sphinx_settings['ballistica_logo'] if html_theme == 'furo': html_theme_options = { 'announcement': 'This is a placeholder announcement', 'light_css_variables': { 'color-brand-primary': '#3cda0b', 'color-brand-content': '#7C4DFF', }, 'dark_css_variables': { 'color-brand-primary': '#3cda0b', 'color-brand-content': '#7C4DFF', }, 'footer_icons': [{ 'name': 'GitHub', 'url': 'https://github.com/efroemling/ballistica/', 'html': """ """, 'class': '', }, ], 'top_of_page_button': 'edit', 'navigation_with_keys': True, } # -- Project information ----------------------------------------------------- project = sphinx_settings['project_name'] copyright = sphinx_settings['copyright'] author = sphinx_settings['project_author'] # The full version, including alpha/beta/rc tags version = str(sphinx_settings['version']) release = str(sphinx_settings['buildnum']) # -- 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. autosummary_generate = True extensions = [ 'sphinx.ext.napoleon', # https://stackoverflow.com/questions/45880348/how-to-remove-the-cause-of-an-unexpected-indentation-warning-when-generating-cod 'sphinx.ext.autodoc', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # 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'] # 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']