import os import sys sys.path.insert(0, os.path.abspath('..')) # 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 = 'PROTAC-Degradation-Predictor' copyright = '2024, Stefano Ribes' author = 'Stefano Ribes' release = 'v1.0.1' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', ] templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The following will place the type hints in the description rather than in the function signature autodoc_typehints = 'description' # Mock pytorch lightning autodoc_mock_imports = [ 'pytorch_lightning', ] autodoc_default_options = { 'members': True, 'undoc-members': True, 'show-inheritance': True, 'inherited-members': True, 'member-order': 'bysource', } # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'sphinx_rtd_theme' # html_theme = 'alabaster' html_static_path = ['_static']