ユーザーガイドを追加

wabimochi · Dec 30, 2023 · 1a478b9 · 1a478b9
1 parent 9d1b9c1
commit 1a478b9
Show file tree

Hide file tree

Showing 39 changed files with 752 additions and 0 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -0,0 +1,36 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["docs"]
+    paths:
+      - docs/**
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3
+      with: 
+        documentation_path: ./docs/source
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx-rtd-theme <= 2.0.0
+myst_parser
diff --git a/docs/source/_static/css/2dactortools.css b/docs/source/_static/css/2dactortools.css
@@ -0,0 +1,58 @@
+@import url("theme.css");
+
+.wy-nav-content {
+    max-width: 2000px;
+}
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: normal;
+}
+
+.half-width {
+    width:50%;
+    min-width: 400px;
+}
+.restrict-height {
+    max-height: 400px;
+}
+.icon-img {
+    max-height: 60px;
+}
+h2 {
+    margin-right: 1em;
+    border-bottom: 2px solid #7CCEF4;
+}
+h3 {
+    padding-left: 0.5em;
+    border-left: 0.5em solid #7ccef4;
+}
+h3:has(.troubleshooting-issues) {
+    font-size: 1.1em;
+    margin-bottom: 4px;
+}
+
+.mac-deco{ display: none; }
+.mac .win-deco { display: none; }
+.iphone .win-deco { display: none; }
+.ipad .win-deco{ display: none; }
+.mac .mac-deco { display: inline; }
+.iphone .mac-deco { display: inline; }
+.ipad .mac-deco{ display: inline; }
+
+.copy-code-button {
+    display: block;
+    margin:0 0 0 auto;
+    width: 83px;
+    color: #222;
+    background-color: #7CCEF4;
+    border: 0;
+    border-radius: 5px 5px 0 0;
+    white-space: nowrap;
+    padding: 4px;
+    margin-bottom: -1px;
+    cursor: pointer;
+}
+
+.copy-code-button:hover {
+    background-color: #a0d9f4;
+}
+
diff --git a/docs/source/_static/js/attribution.js b/docs/source/_static/js/attribution.js
@@ -0,0 +1,6 @@
+function AddsNewtabAttribute(a) {
+    a.setAttribute("target", "_blank");
+    a.setAttribute("rel", "noopener noreferrer");
+}
+
+document.querySelectorAll(".new_tab").forEach((a) => AddsNewtabAttribute(a));
diff --git a/docs/source/_static/js/copy-code-button.js b/docs/source/_static/js/copy-code-button.js
@@ -0,0 +1,45 @@
+function createCopyButton(highlightDiv) {
+    const button = document.createElement("button");
+    button.className = "copy-code-button";
+    button.type = "button";
+    button.innerText = "Copy";
+    button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv));
+    highlightDiv.parentNode.before(button);
+}
+
+async function copyCodeToClipboard(button, highlightDiv) {
+    let lastIndex = highlightDiv.innerText.length;
+    if(highlightDiv.innerText[lastIndex - 1] === "\n") {
+      lastIndex = highlightDiv.innerText.length - 1;
+    }
+    const codeToCopy = highlightDiv.innerText.slice(0, lastIndex);
+    try {
+        result = await navigator.permissions.query({ name: "clipboard-write" });
+        if (result.state == "granted" || result.state == "prompt") {
+            await navigator.clipboard.writeText(codeToCopy);
+            codeWasCopied(button);
+        } else {
+            copyFail(button);
+        }
+    } catch (_) {
+        copyFail(button);
+    }
+}
+
+function codeWasCopied(button) {
+    button.blur();
+    button.innerText = "Copied!";
+    setTimeout(function () {
+        button.innerText = "Copy";
+    }, 2000);
+}
+
+function copyFail(button) {
+    button.blur();
+    button.innerText = "Failed...";
+    setTimeout(function () {
+        button.innerText = "Copy";
+    }, 5000);
+}
+
+document.querySelectorAll(".highlight-shell > .highlight").forEach((highlightDiv) => createCopyButton(highlightDiv));
diff --git a/docs/source/_static/js/css_browser_selector.js b/docs/source/_static/js/css_browser_selector.js
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,52 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = '2dActorTools'
+copyright = '2023, wabimochi'
+author = 'wabimochi'
+release = '1.3.8'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'myst_parser',
+    'sphinx_rtd_theme'
+]
+myst_enable_extensions = [
+    'attrs_inline'
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+language = 'ja'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_style = [
+    'css/2dactortools.css'
+]
+html_js_files = [
+    'js/css_browser_selector.js',
+    ('js/copy-code-button.js', {'defer':''}),
+    ('js/attribution.js', {'defer':''})
+]
+
+
+html_sidebars = {
+    '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
+}
+html_theme_options = {
+    'navigation_depth': 3,
+}
+
+source_suffix = ['.rst', '.md']
diff --git a/docs/source/images/fig-actor-1.png b/docs/source/images/fig-actor-1.png
diff --git a/docs/source/images/fig-actor-2.png b/docs/source/images/fig-actor-2.png
diff --git a/docs/source/images/fig-actor-3.png b/docs/source/images/fig-actor-3.png
diff --git a/docs/source/images/fig-actor-4.png b/docs/source/images/fig-actor-4.png
diff --git a/docs/source/images/fig-actor-5.png b/docs/source/images/fig-actor-5.png
diff --git a/docs/source/images/fig-actor-6.png b/docs/source/images/fig-actor-6.png
diff --git a/docs/source/images/fig-actor-7-end.png b/docs/source/images/fig-actor-7-end.png
diff --git a/docs/source/images/fig-actor-7-hide.png b/docs/source/images/fig-actor-7-hide.png
diff --git a/docs/source/images/fig-actor-7-lock.png b/docs/source/images/fig-actor-7-lock.png
diff --git a/docs/source/images/fig-actor-7-marker.png b/docs/source/images/fig-actor-7-marker.png
diff --git a/docs/source/images/fig-actor-7-show.png b/docs/source/images/fig-actor-7-show.png
diff --git a/docs/source/images/fig-actor-7-start.png b/docs/source/images/fig-actor-7-start.png
diff --git a/docs/source/images/fig-actor-7.png b/docs/source/images/fig-actor-7.png
diff --git a/docs/source/images/fig-actor-8.png b/docs/source/images/fig-actor-8.png
diff --git a/docs/source/images/fig-autoimport-1.png b/docs/source/images/fig-autoimport-1.png
diff --git a/docs/source/images/fig-autoimport-2.png b/docs/source/images/fig-autoimport-2.png
diff --git a/docs/source/images/fig-subtitle-1.png b/docs/source/images/fig-subtitle-1.png
diff --git a/docs/source/images/fig-subtitle-mogrt-1.png b/docs/source/images/fig-subtitle-mogrt-1.png
diff --git a/docs/source/images/fig-subtitle-mogrt-2.png b/docs/source/images/fig-subtitle-mogrt-2.png
diff --git a/docs/source/images/fig-subtitle-mogrt-3.png b/docs/source/images/fig-subtitle-mogrt-3.png
diff --git a/docs/source/images/fig-subtitle-mogrt-4.png b/docs/source/images/fig-subtitle-mogrt-4.png
diff --git a/docs/source/images/fig-subtitle-srt-1.png b/docs/source/images/fig-subtitle-srt-1.png
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,39 @@
+```{toctree}
+:hidden:
+:maxdepth: 2
+エクステンションのインストール <src/installation.md>
+```
+```{toctree}
+:hidden:
+:caption: 機能の説明・設定
+:maxdepth: 2
+字幕 <src/function-subtitles.md>
+リファインツール <src/function-refine-tools.md>
+立ち絵 <src/function-actor-edit.md>
+自動インポート <src/function-auto-import.md>
+設定 <src/settings.md>
+```
+```{toctree}
+:hidden:
+:caption: その他
+:maxdepth: 2
+トラブルシューティング <src/troubleshooting.md>
+ライセンス <src/license.md>
+各種リンク <src/link.md>
+```
+
+# 2dActorToolsユーザーガイド
+## 2dActorTools
+合成音声ソフトの作成支援を行うPremiere Proのエクステンションです。  
+[https://github.com/wabimochi/2dActorTools](https://github.com/wabimochi/2dActorTools){.new_tab}
+
+## 主な機能
+- 立ち絵の差分変更
+- 音声データの自動インポート
+- 字幕の配置
+- 自動改行
+
+## 動作環境
+- WindowsとMacOSで使用できます。
+- 基本的に最新のPremiere Proで使用することを想定しています。
+- 現在は日本語環境のみ対応しています。