tools/make_docs.py

import json
from pathlib import Path

from voicevox_engine.aivm_manager import AivmManager
from voicevox_engine.app.application import generate_app
from voicevox_engine.core.core_adapter import CoreAdapter
from voicevox_engine.core.core_initializer import CoreManager
from voicevox_engine.dev.core.mock import MockCoreWrapper
from voicevox_engine.dev.tts_engine.mock import MockTTSEngine
from voicevox_engine.engine_manifest import load_manifest
from voicevox_engine.library.library_manager import LibraryManager
from voicevox_engine.preset.preset_manager import PresetManager
from voicevox_engine.setting.setting_manager import USER_SETTING_PATH, SettingHandler
from voicevox_engine.tts_pipeline.tts_engine import TTSEngineManager
from voicevox_engine.user_dict.user_dict_manager import UserDictionary
from voicevox_engine.utility.path_utility import engine_manifest_path, get_save_dir


def generate_api_docs_html(schema: str) -> str:
    """OpenAPI schema から API ドキュメント HTML を生成する"""

    return (
        """<!DOCTYPE html>
<html lang="ja">
<head>
    <title>AivisSpeech Engine API Document</title>
    <meta charset="utf-8">
</head>
<body>
    <div id="redoc-container"></div>
    <script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"></script>
    <script>
        Redoc.init(%s, {"hideHostname": true}, document.getElementById("redoc-container"));
    </script>
</body>
</html>"""
        % schema
    )


if __name__ == "__main__":
    core_manager = CoreManager()
    core_manager.register_core(CoreAdapter(MockCoreWrapper()), "mock")
    tts_engines = TTSEngineManager()
    tts_engines.register_engine(MockTTSEngine(), "mock")
    preset_path = get_save_dir() / "presets.yaml"
    engine_manifest = load_manifest(engine_manifest_path())
    library_manager = LibraryManager(
        # get_save_dir() / "installed_libraries",
        # AivisSpeech では利用しない LibraryManager によるディレクトリ作成を防ぐため、get_save_dir() 直下を指定
        get_save_dir(),
        engine_manifest.supported_vvlib_manifest_version,
        engine_manifest.brand_name,
        engine_manifest.name,
        engine_manifest.uuid,
    )

    # FastAPI の機能を用いて OpenAPI schema を生成する
    app = generate_app(
        tts_engines=tts_engines,
        aivm_manager=AivmManager(get_save_dir() / "Models"),
        core_manager=core_manager,
        setting_loader=SettingHandler(USER_SETTING_PATH),
        preset_manager=PresetManager(preset_path),
        user_dict=UserDictionary(),
        engine_manifest=engine_manifest,
        library_manager=library_manager,
    )
    api_schema = json.dumps(app.openapi())

    # API ドキュメント HTML を生成する
    api_docs_html = generate_api_docs_html(api_schema)

    # HTML ファイルとして保存する
    api_docs_root = Path("docs/api")  # 'upload-docs' workflow の対象
    output_path = api_docs_root / "index.html"
    output_path.parent.mkdir(parents=True, exist_ok=True)
    output_path.write_text(api_docs_html)