81 lines
2.5 KiB
Python
81 lines
2.5 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
|
|
|
|
import sys
|
|
import os
|
|
|
|
# Add the project root to the path
|
|
sys.path.insert(0, os.path.abspath('../../..'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'Crypto Trader'
|
|
copyright = '2025, kfox'
|
|
author = 'kfox'
|
|
release = '0.1.0'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.napoleon', # For Google-style docstrings
|
|
'sphinx_autodoc_typehints', # Type hints in docs
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = []
|
|
|
|
# Napoleon settings for Google-style docstrings
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = False
|
|
napoleon_include_init_with_doc = False
|
|
napoleon_include_private_with_doc = False
|
|
napoleon_include_special_with_doc = True
|
|
napoleon_use_admonition_for_examples = False
|
|
napoleon_use_admonition_for_notes = False
|
|
napoleon_use_admonition_for_references = False
|
|
napoleon_use_ivar = False
|
|
napoleon_use_param = True
|
|
napoleon_use_rtype = True
|
|
|
|
# Autodoc settings
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'undoc-members': True,
|
|
'show-inheritance': True,
|
|
'special-members': '__init__',
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_static_path = ['_static']
|
|
html_theme_options = {
|
|
'collapse_navigation': False,
|
|
'display_version': True,
|
|
'logo_only': False,
|
|
}
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
|
|
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3', None),
|
|
'pandas': ('https://pandas.pydata.org/docs/', None),
|
|
'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),
|
|
'ccxt': ('https://docs.ccxt.com/en/latest/', None),
|
|
}
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
|
|
|
|
todo_include_todos = True
|