68 lines
2.0 KiB
Python
68 lines
2.0 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 os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'e-nms-qa-automation'
|
|
copyright = '2025, NPO KIS'
|
|
author = 'NPO KIS'
|
|
release = '0.1.0'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx_rtd_theme',
|
|
]
|
|
|
|
# Настройки для автоматического документирования
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'member-order': 'bysource',
|
|
'special-members': '__init__',
|
|
'undoc-members': True,
|
|
'exclude-members': '__weakref__'
|
|
}
|
|
|
|
autodoc_typehints = 'description'
|
|
|
|
# Для Google-style docstrings
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = False
|
|
napoleon_include_init_with_doc = True
|
|
napoleon_include_private_with_doc = True
|
|
napoleon_include_special_with_doc = True
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = []
|
|
|
|
language = 'ru'
|
|
|
|
# -- 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 = {
|
|
'navigation_depth': 4,
|
|
'collapse_navigation': False,
|
|
'titles_only': False
|
|
}
|
|
|
|
# Настройки для исходного кода
|
|
add_module_names = False
|
|
python_use_unqualified_type_names = True
|