diff --git a/.github/workflows/generate_document.yml b/.github/workflows/generate_document.yml index c4af6b80b..d63a2f819 100644 --- a/.github/workflows/generate_document.yml +++ b/.github/workflows/generate_document.yml @@ -65,9 +65,6 @@ jobs: working-directory: "docs/apis/c_api/doxygen" - name: Build voicevox_core_python_api run: maturin develop --manifest-path ./crates/voicevox_core_python_api/Cargo.toml --locked - # https://github.com/readthedocs/sphinx-autoapi/issues/405 - - name: Workaround to make Sphinx recognize `_rust` as a module - run: touch ./crates/voicevox_core_python_api/python/voicevox_core/_rust/__init__.py - name: Generate Sphinx document run: sphinx-build docs/apis/python_api public/apis/python_api - name: Generate Javadoc diff --git a/crates/voicevox_core_python_api/poetry.lock b/crates/voicevox_core_python_api/poetry.lock index 0decb2a6a..911dfafc2 100644 --- a/crates/voicevox_core_python_api/poetry.lock +++ b/crates/voicevox_core_python_api/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. [[package]] name = "accessible-pygments" @@ -39,17 +39,6 @@ files = [ [package.dependencies] typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.9\""} -[[package]] -name = "anyascii" -version = "0.3.2" -description = "Unicode to ASCII transliteration" -optional = false -python-versions = ">=3.3" -files = [ - {file = "anyascii-0.3.2-py3-none-any.whl", hash = "sha256:3b3beef6fc43d9036d3b0529050b0c48bfad8bc960e9e562d7223cfb94fe45d4"}, - {file = "anyascii-0.3.2.tar.gz", hash = "sha256:9d5d32ef844fe225b8bc7cba7f950534fae4da27a9bf3a6bea2cb0ea46ce4730"}, -] - [[package]] name = "astroid" version = "3.0.1" @@ -923,17 +912,16 @@ test = ["cython", "filelock", "html5lib", "pytest (>=4.6)"] [[package]] name = "sphinx-autoapi" -version = "3.0.0" +version = "3.1.0" description = "Sphinx API documentation generator" optional = false python-versions = ">=3.8" files = [ - {file = "sphinx-autoapi-3.0.0.tar.gz", hash = "sha256:09ebd674a32b44467222b0fb8a917b97c89523f20dbf05b52cb8a3f0e15714de"}, - {file = "sphinx_autoapi-3.0.0-py2.py3-none-any.whl", hash = "sha256:ea207793cba1feff7b2ded0e29364f2995a4d157303a98603cee0ce94cea2688"}, + {file = "sphinx_autoapi-3.1.0-py2.py3-none-any.whl", hash = "sha256:b102ded12ff5397ff6f9536065644c0a01a203b1d53dac07419c267fd771367f"}, + {file = "sphinx_autoapi-3.1.0.tar.gz", hash = "sha256:c5455191c36af19e0de73dd52e15feb04a37ca4439fa5e8d77f1941768c15d32"}, ] [package.dependencies] -anyascii = "*" astroid = [ {version = ">=2.7", markers = "python_version < \"3.12\""}, {version = ">=3.0.0a1", markers = "python_version >= \"3.12\""}, @@ -1091,4 +1079,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = ">=3.8,<3.13" -content-hash = "42faee9d02ea5ad43eaef485f2127f0ffd77a5f8951ef71529eb1e85249e9c04" +content-hash = "68fffc23b63507c95b965429a6a54f161f8c6a94fe98b6dcad001475f690b6a3" diff --git a/crates/voicevox_core_python_api/pyproject.toml b/crates/voicevox_core_python_api/pyproject.toml index 4ae2da74a..ac9dba7b3 100644 --- a/crates/voicevox_core_python_api/pyproject.toml +++ b/crates/voicevox_core_python_api/pyproject.toml @@ -44,7 +44,7 @@ pydantic = ">=2.5.2,<3" [tool.poetry.group.docs.dependencies] sphinx = "6.2.1" pydata-sphinx-theme = "0.14.1" -sphinx-autoapi = "3.0.0" +sphinx-autoapi = "3.1.0" [tool.poetry.group.dev.dependencies] maturin = "1.3.1" diff --git a/docs/apis/python_api/conf.py b/docs/apis/python_api/conf.py index b1695b750..60f9df90e 100644 --- a/docs/apis/python_api/conf.py +++ b/docs/apis/python_api/conf.py @@ -32,7 +32,7 @@ ] # templates_path = ['_templates'] -exclude_patterns = [] +exclude_patterns = ["autoapi/*/_rust/*"] # パブリックAPIを意図した部分ではなく、またorphan扱いとなって警告が出るため # -- Options for HTML output -------------------------------------------------