conf.py#
Файл conf.py является главным файлом конфигурации для проекта документации Sphinx. В этом файле вы можете настроить различные параметры и настройки, влияющие на генерацию и отображение вашей документации.
Проект и базовая информация#
project = 'Название вашего проекта'
author = 'Ваше имя или организация'
copyright = 'Защита авторских прав'
Пути и директории#
source_suffix = '.rst'
master_doc = 'index'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Оформление и темы#
html_theme = 'default'
html_theme_options = {}
Содержание, оглавление и перекрестные ссылки#
autodoc_default_options = {
'members': True,
'undoc-members': True,
}
autodoc_mock_imports = ['numpy']
Язык и локализация#
language = 'ru'
locale_dirs = ['locale/']
Ссылки и расширения#
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
]
Ссылки и внешние ресурсы#
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
Исходники и структура#
source_encoding = 'utf-8'
nitpicky = True