chore: sphinx-autoapiをv3.1.0に上げる (#808)

* chore: sphinx-autoapiをv3.1.0に上げる * poetry.lockを修正 * poetry.lockをGHAの`ubuntu-22.04`が吐くやつに合わせる * `exclude_patterns`にコメント
VOICEVOX · Jul 22, 2024 · e22ec47 · e22ec47
1 parent d66a8b0
commit e22ec47
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 22 deletions.
diff --git 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
diff --git 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
@@ -32,7 +32,7 @@
 ]
 
 # templates_path = ['_templates']
-exclude_patterns = []
+exclude_patterns = ["autoapi/*/_rust/*"] # パブリックAPIを意図した部分ではなく、またorphan扱いとなって警告が出るため
 
 
 # -- Options for HTML output -------------------------------------------------