diff --git a/.github/workflows/generate_document.yml b/.github/workflows/generate_document.yml index d63a2f819..67561b392 100644 --- a/.github/workflows/generate_document.yml +++ b/.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/doxygen-action@v1.9.8 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) diff --git a/.gitmodules b/.gitmodules index 2f82562fc..ac7c00cfd 100644 --- a/.gitmodules +++ b/.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 diff --git a/README.md b/README.md index 129854da8..8f4f2749d 100644 --- a/README.md +++ b/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) を参照してください
Downloader を使わない場合 @@ -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`を宣言 diff --git a/crates/voicevox_core/src/voice_model.rs b/crates/voicevox_core/src/voice_model.rs index 96ff1045d..f31b8ecb1 100644 --- a/crates/voicevox_core/src/voice_model.rs +++ b/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, diff --git a/docs/ghpages/apis/README.md b/docs/ghpages/apis/README.md new file mode 100644 index 000000000..dbeb17a68 --- /dev/null +++ b/docs/ghpages/apis/README.md @@ -0,0 +1,3 @@ +# voicevox.github.io/voicevox_core/apis + +用の雛形と設定をここにまとめています。 diff --git a/docs/apis/c_api/doxygen/.gitignore b/docs/ghpages/apis/c_api/doxygen/.gitignore similarity index 100% rename from docs/apis/c_api/doxygen/.gitignore rename to docs/ghpages/apis/c_api/doxygen/.gitignore diff --git a/docs/apis/c_api/doxygen/Doxyfile b/docs/ghpages/apis/c_api/doxygen/Doxyfile similarity index 99% rename from docs/apis/c_api/doxygen/Doxyfile rename to docs/ghpages/apis/c_api/doxygen/Doxyfile index c845adbd4..39f9c302b 100644 --- a/docs/apis/c_api/doxygen/Doxyfile +++ b/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 diff --git a/docs/apis/c_api/doxygen/doxygen-awesome-css b/docs/ghpages/apis/c_api/doxygen/doxygen-awesome-css similarity index 100% rename from docs/apis/c_api/doxygen/doxygen-awesome-css rename to docs/ghpages/apis/c_api/doxygen/doxygen-awesome-css diff --git a/docs/apis/index.html b/docs/ghpages/apis/index.html similarity index 100% rename from docs/apis/index.html rename to docs/ghpages/apis/index.html diff --git a/docs/apis/python_api/conf.py b/docs/ghpages/apis/python_api/conf.py similarity index 95% rename from docs/apis/python_api/conf.py rename to docs/ghpages/apis/python_api/conf.py index 60f9df90e..404162870 100644 --- a/docs/apis/python_api/conf.py +++ b/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 = [ diff --git a/docs/apis/python_api/index.rst b/docs/ghpages/apis/python_api/index.rst similarity index 100% rename from docs/apis/python_api/index.rst rename to docs/ghpages/apis/python_api/index.rst diff --git a/docs/vvm.md b/docs/guide/dev/vvm.md similarity index 100% rename from docs/vvm.md rename to docs/guide/dev/vvm.md diff --git a/docs/downloader.md b/docs/guide/user/downloader.md similarity index 100% rename from docs/downloader.md rename to docs/guide/user/downloader.md diff --git a/docs/feature-options.md b/docs/guide/user/feature-options.md similarity index 100% rename from docs/feature-options.md rename to docs/guide/user/feature-options.md diff --git a/docs/usage.md b/docs/guide/user/usage.md similarity index 100% rename from docs/usage.md rename to docs/guide/user/usage.md diff --git a/example/cpp/unix/README.md b/example/cpp/unix/README.md index 8b73da96c..5e59c3ba7 100644 --- a/example/cpp/unix/README.md +++ b/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)。 ## ビルド diff --git a/example/cpp/windows/README.md b/example/cpp/windows/README.md index 4012acdf9..947dea9b1 100644 --- a/example/cpp/windows/README.md +++ b/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 に配置 diff --git a/model/README.md b/model/README.md index 5f6af6a2f..3e5c472c7 100644 --- a/model/README.md +++ b/model/README.md @@ -1,6 +1,6 @@ # サンプル VVM ファイル -ここには、自分で一からビルドしたコアライブラリでのみ使用できるサンプルの [VVM ファイル](../docs/vvm.md) が含まれています。 +ここには、自分で一からビルドしたコアライブラリでのみ使用できるサンプルの [VVM ファイル](../docs/guide/dev/vvm.md) が含まれています。 ## 注意