docs/source/conf.py - master - SeleznyovDV/test

docs/source/conf.py
79 строк4 KB
Dmitriy Seleznyov
test
10 май 2026, 21:14
10 май 2026, 21:145506330
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
# Project: Metatron
# Author: Dmitriy Seleznyov

import os
import sys

# ---- Пути к исходникам MATLAB --------------------------------------------
# Получаем абсолютный путь к папке, где лежит этот файл (docs/source)
this_dir = os.path.dirname(os.path.abspath(__file__))
# Поднимаемся на два уровня вверх, чтобы попасть в корень проекта (Metatron)
project_root = os.path.abspath(os.path.join(this_dir, '..', '..'))

# Добавляем корень проекта в sys.path для поиска модулей
sys.path.insert(0, project_root)

# ---- Основная информация о проекте ---------------------------------------
project = 'Metatron'
copyright = '2026, Dmitriy Seleznyov'
author = 'Dmitriy Seleznyov'
release = '0.1.0'

# ---- Расширения Sphinx ---------------------------------------------------
extensions = [
    'sphinxcontrib.matlab',      # поддержка MATLAB
    'sphinx.ext.autodoc',        # автодокументация
    'sphinx.ext.napoleon',       # Google-style docstrings
]

# ---- Настройки MATLAB domain --------------------------------------------
primary_domain = 'mat'                      # основной язык — MATLAB
matlab_src_dir = project_root               # корневая папка с .m файлами
matlab_src_encoding = 'utf-8'               # кодировка исходников
matlab_short_links = True                   # короткие имена в ссылках
matlab_auto_link = 'basic'                  # автолинки в "See also"

# Если ваши .m файлы сохранены в windows-1251 (русская Windows по умолчанию),
# закомментируйте строку выше и раскомментируйте следующую:
# matlab_src_encoding = 'cp1251'

# ---- Настройки интернационализации --------------------------------------
language = 'ru'                             # язык интерфейса (русский)

# ---- Настройки HTML -----------------------------------------------------
html_theme = 'shibuya'                       # природная тема
html_static_path = ['_static']
html_title = 'Документация Metatron'

# Дополнительные опции для темы nature (опционально)
html_theme_options = {
    'sidebarwidth': '300px',                # ширина боковой панели
}

# ---- Настройки LaTeX (опционально) --------------------------------------
root_doc = 'index'                          # корневой документ
latex_documents = [
    (root_doc, 'Metatron.tex', 'Metatron Documentation',
     author, 'manual'),
]

# ---- Настройки боковой панели (для темы nature) -------------------------
html_sidebars = {
    '**': [
        'localtoc.html',           # локальное оглавление страницы
        'relations.html',          # ссылки "предыдущая/следующая"
        'searchbox.html',          # поиск
        #'sidebar_links.html',      # пользовательские ссылки (создадим ниже)
    ]
}

# Дополнительные ссылки в боковой панели (пока тоже закомментировать)
# html_context = {
#     'sidebar_links': [
#         ('GitHub', 'https://github.com/DmitriySeleznyov/Metatron', 'github'),
#         ('Сообщить об ошибке', 'https://github.com/DmitriySeleznyov/Metatron/issues', 'bug'),
#     ]
# }