feat(docs): docs/を整理する

.github/workflows/generate_document.yml

@@ -51,22 +51,22 @@ jobs:
           poetry install --with test
       - name: mkdir public
         run: mkdir -p public/apis/c_api
-      - name: cp docs/apis/index.html
-        run: cp docs/apis/index.html public/apis/
+      - name: cp docs/ghpages/apis/index.html
+        run: cp docs/ghpages/apis/index.html public/apis/
       - name: Generate rustdoc
         run: |
           cargo +${{ steps.docsrs-rust-version.outputs.rust-toolchain }} docs-rs -p voicevox_core
           mv target/x86_64-unknown-linux-gnu/doc public/apis/rust_api
       - name: cp crates/voicevox_core_c_api/include/voicevox_core.h
-        run: cp crates/voicevox_core_c_api/include/voicevox_core.h docs/apis/c_api/doxygen/
+        run: cp crates/voicevox_core_c_api/include/voicevox_core.h docs/ghpages/apis/c_api/doxygen/
       - name: Generate doxygen document
         uses: mattnotmitt/[email protected]
         with:
-          working-directory: "docs/apis/c_api/doxygen"
+          working-directory: "docs/ghpages/apis/c_api/doxygen"
       - name: Build voicevox_core_python_api
         run: maturin develop --manifest-path ./crates/voicevox_core_python_api/Cargo.toml --locked
       - name: Generate Sphinx document
-        run: sphinx-build docs/apis/python_api public/apis/python_api
+        run: sphinx-build docs/ghpages/apis/python_api public/apis/python_api
       - name: Generate Javadoc
         run: |
           (cd crates/voicevox_core_java_api && ./gradlew javadoc)

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "docs/apis/c_api/doxygen/doxygen-awesome-css"]
-	path = docs/apis/c_api/doxygen/doxygen-awesome-css
+[submodule "docs/ghpages/apis/c_api/doxygen/doxygen-awesome-css"]
+	path = docs/ghpages/apis/c_api/doxygen/doxygen-awesome-css
 	url = https://github.com/jothepro/doxygen-awesome-css.git

README.md

@@ -20,7 +20,7 @@
 
 ## ユーザーガイド
 
-[VOICEVOX コア ユーザーガイド](./docs/usage.md)をご覧ください。
+[VOICEVOX コア ユーザーガイド](./docs/guide/user/usage.md)をご覧ください。
 
 ## 環境構築
 
@@ -57,7 +57,7 @@ chmod +x download
 ./download
 ```
 
-詳細な Downloader の使い方については [こちら](./docs/downloader.md) を参照してください
+詳細な Downloader の使い方については [こちら](./docs/guide/user/downloader.md) を参照してください
 
 <details>
 <summary> Downloader を使わない場合</summary>
@@ -88,13 +88,13 @@ Raspberry Pi 用の ONNX Runtime は以下からダウンロードできます
 nvidia 製 GPU を搭載した Windows, Linux PC では CUDA を用いた合成が可能です。
 
 CUDA 版を利用するには Downloader の実行が必要です。  
-詳細は [CUDA 版をダウンロードする場合](./docs/downloader.md#cuda) を参照してください
+詳細は [CUDA 版をダウンロードする場合](./docs/guide/user/downloader.md#cuda) を参照してください
 
 ##### DirectML
 
 DirectX12 に対応した GPU を搭載した Windows PC では DirectML を用いた合成が可能です  
 DirectML 版を利用するには Downloader の実行が必要です。  
-詳細は [DirectML 版をダウンロードする場合](./docs/downloads/downloader.md#directml) を参照してください
+詳細は [DirectML 版をダウンロードする場合](./docs/guide/user/downloader.md#directml) を参照してください
 
 macOS の場合、CUDA の macOS サポートは現在終了しているため、VOICEVOX CORE の macOS 向けコアライブラリも CUDA, CUDNN を利用しない CPU 版のみの提供となります。
 
@@ -154,7 +154,7 @@ cargo build --release -p voicevox_core_c_api --features load-onnxruntime
 ```
 
 DLL 用のヘッダファイルの雛形は [crates/voicevox_core_c_api/include/voicevox_core.h](https://github.com/VOICEVOX/voicevox_core/tree/main/crates/voicevox_core_c_api/include/voicevox_core.h) にあります。
-詳しくは[feature-options.md](./docs/feature-options.md)を参照してください。
+詳しくは[feature-options.md](./docs/guide/user/feature-options.md)を参照してください。
 
 ```bash
 # ヘッダファイルを加工し、マクロ`VOICEVOX_LOAD_ONNXRUNTIME`を宣言

crates/voicevox_core/src/voice_model.rs

@@ -1,6 +1,6 @@
 //! 音声モデル（ VVM ファイル）。
 //!
-//! VVM ファイルの定義と形式は[ドキュメント](../../../docs/vvm.md)を参照。
+//! VVM ファイルの定義と形式は[ドキュメント](../../../docs/guide/dev/vvm.md)を参照。
 
 use std::{
     collections::HashMap,

docs/apis/c_api/doxygen/Doxyfile → docs/ghpages/apis/c_api/doxygen/Doxyfile

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ../../../../public/apis/c_api
+OUTPUT_DIRECTORY       = ../../../../../public/apis/c_api
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and

docs/apis/python_api/conf.py → docs/ghpages/apis/python_api/conf.py

@@ -19,7 +19,7 @@
 extensions = ["autoapi.extension", "sphinx.ext.napoleon"]
 
 autoapi_type = "python"
-autoapi_dirs = ["../../../crates/voicevox_core_python_api/python"]
+autoapi_dirs = ["../../../../crates/voicevox_core_python_api/python"]
 autoapi_file_patterns = ["*.pyi", "*.py"]
 autoapi_ignore = ["*test*"]
 autoapi_options = [

example/cpp/unix/README.md

@@ -4,7 +4,7 @@ voicevox_core ライブラリを C++ から使用するサンプルコード (`s
 
 ## 必要なファイルの準備
 
-まず、この README があるディレクトリで、[Downloader を使用して voicevox_core をダウンロードします](../../../docs/downloader.md#default)。
+まず、この README があるディレクトリで、[Downloader を使用して voicevox_core をダウンロードします](../../../docs/guide/user/downloader.md#default)。
 
 ## ビルド
 

example/cpp/windows/README.md

@@ -14,7 +14,7 @@ Visual Studio Installerを使用しインストールしてください。
 
 出力フォルダを作成するために、一度ビルドします。「windows_example.sln」をVisual Studioで開き、メニューの「ビルド」→「ソリューションのビルド」を押します。
 この段階では、ビルドは失敗します。「bin」フォルダと「lib」フォルダが生成されていればOKです。  
-[Releases](https://github.com/VOICEVOX/voicevox_core/releases/latest)から「voicevox_core-windows-x64-{バージョン名}.zip」をダウンロードし、展開します。[ダウンローダー](https://github.com/VOICEVOX/voicevox_core/blob/main/docs/downloader.md)を使うと便利です。  
+[Releases](https://github.com/VOICEVOX/voicevox_core/releases/latest)から「voicevox_core-windows-x64-{バージョン名}.zip」をダウンロードし、展開します。[ダウンローダー](https://github.com/VOICEVOX/voicevox_core/blob/main/docs/guide/user/downloader.md)を使うと便利です。  
 展開してできたファイル・フォルダをそれぞれ下記のフォルダへ配置します。
 
 - simple_tts に配置

model/README.md

@@ -1,6 +1,6 @@
 # サンプル VVM ファイル
 
-ここには、自分で一からビルドしたコアライブラリでのみ使用できるサンプルの [VVM ファイル](../docs/vvm.md) が含まれています。
+ここには、自分で一からビルドしたコアライブラリでのみ使用できるサンプルの [VVM ファイル](../docs/guide/dev/vvm.md) が含まれています。
 
 ## 注意