Merge pull request #3 from Hizuru3/update-docs

Update docs
Hizuru3 · Jan 21, 2024 · 1dfcbe7 · 1dfcbe7
2 parents a7270a2 + 5ad8b28
commit 1dfcbe7
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 75 deletions.
diff --git a/docs/_sources/habachen_module.rst.txt b/docs/_sources/habachen_module.rst.txt
@@ -1,5 +1,5 @@
-:mod:`habachen` --- 高速な全角・半角変換
-============================================
+:mod:`habachen` --- 高速な日本語文字種変換モジュール
+====================================================
 
 .. module:: habachen
 
@@ -115,9 +115,9 @@
               hira_to_kata(text: str, /, ignore: Iterable[str] = '', *, hankaku: bool = False) -> str
 
   文字列を受け取り、それに含まれるひらがなを対応するカタカナ（既定では全角カタカナ）に変換した新しい文字列を返します。\
-  オプション引数 *ignore* に含まれるひらがなは変換されません。\
+  オプション引数 *ignore* に含まれるひらがなは変換されません。
   *ignore* 引数に渡すことができるのは、ひらがな文字列、あるいはひらがな文字列のイテラブルで、\
-  ひらがな文字列はカタカナに変換可能でなくてはなりません。
+  カタカナに変換できない文字を含んでいてはなりません。
   *hankaku* オプションを True に設定すると、ひらがなは全角カタカナではなく半角カタカナに変換されるようになります。
 
   以下が使用例です:
@@ -158,7 +158,7 @@
   文字列を受け取り、それに含まれる全角カタカナを対応するひらがなに変換した新しい文字列を返します。\
   オプション引数 *ignore* に含まれるカタカナは変換されません。
   *ignore* 引数に渡すことができるのは、カタカナ文字列、あるいはカタカナ文字列のイテラブルで、\
-  カタカナ文字列はひらがなに変換可能でなくてはなりません。
+  ひらがなに変換できない文字を含んでいてはなりません。
 
   .. note::
 

diff --git a/docs/_static/basic.css b/docs/_static/basic.css
@@ -670,6 +670,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +748,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/docs/_static/translations.js b/docs/_static/translations.js
@@ -2,8 +2,7 @@ Documentation.addTranslations({
     "locale": "ja",
     "messages": {
         "%(filename)s &#8212; %(docstitle)s": "%(filename)s &#8212; %(docstitle)s",
-        "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s.": "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s.",
-        "&#169; Copyright %(copyright)s.": "&#169; Copyright %(copyright)s.",
+        "&#169; %(copyright_prefix)s %(copyright)s.": "",
         ", in ": ", in ",
         "About these documents": "\u3053\u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u306b\u3064\u3044\u3066",
         "Automatically generated list of changes in version %(version)s": "\u30d0\u30fc\u30b8\u30e7\u30f3 %(version)s \u306e\u5909\u66f4\u70b9\uff08\u3053\u306e\u30ea\u30b9\u30c8\u306f\u81ea\u52d5\u751f\u6210\u3055\u308c\u3066\u3044\u307e\u3059\uff09",

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -7,13 +7,13 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>索引 &#8212; Habachen  ドキュメント</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b849a4e9" />
+    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=c92c1228" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
-    <script src="_static/translations.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2aa0fae8"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="_static/translations.js?v=4dbe4bdc"></script>
     <script src="_static/bizstyle.js"></script>
     <link rel="index" title="索引" href="#" />
     <link rel="search" title="検索" href="search.html" />
@@ -47,9 +47,9 @@ <h1 id="index">索引</h1>
 <div class="genindex-jumpbox">
  <a href="#H"><strong>H</strong></a>
  | <a href="#K"><strong>K</strong></a>
+ | <a href="#M"><strong>M</strong></a>
  | <a href="#T"><strong>T</strong></a>
  | <a href="#Z"><strong>Z</strong></a>
- | <a href="#モ"><strong>モ</strong></a>
 
 </div>
 <h2 id="H">H</h2>
@@ -59,7 +59,7 @@ <h2 id="H">H</h2>
     habachen
 
       <ul>
-        <li><a href="habachen_module.html#module-habachen">モジュール</a>
+        <li><a href="habachen_module.html#module-habachen">module</a>
 </li>
       </ul></li>
       <li><a href="habachen_module.html#habachen.han_to_zen">han_to_zen() (habachen モジュール)</a>
@@ -87,6 +87,19 @@ <h2 id="K">K</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li>
+    module
+
+      <ul>
+        <li><a href="habachen_module.html#module-habachen">habachen</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -115,19 +128,6 @@ <h2 id="Z">Z</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="モ">モ</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    モジュール
-
-      <ul>
-        <li><a href="habachen_module.html#module-habachen">habachen</a>
-</li>
-      </ul></li>
-  </ul></td>
-</tr></table>
-
 
 
             <div class="clearer"></div>
@@ -164,8 +164,8 @@ <h3>ナビゲーション</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2023, Hizuru.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.1.3.
+    &#169; 著作権 2023-2024, Hizuru.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
     </div>
   </body>
 </html>
diff --git a/docs/habachen_module.html b/docs/habachen_module.html
@@ -7,14 +7,14 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>habachen --- 高速な全角・半角変換 &#8212; Habachen  ドキュメント</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
+    <title>habachen --- 高速な日本語文字種変換モジュール &#8212; Habachen  ドキュメント</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b849a4e9" />
+    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=c92c1228" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
-    <script src="_static/translations.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2aa0fae8"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="_static/translations.js?v=4dbe4bdc"></script>
     <script src="_static/bizstyle.js"></script>
     <link rel="index" title="索引" href="genindex.html" />
     <link rel="search" title="検索" href="search.html" />
@@ -37,7 +37,7 @@ <h3>ナビゲーション</h3>
           <a href="index.html" title="Welcome to Habachen&#39;s documentation!"
              accesskey="P">前へ</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Habachen  ドキュメント</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code> --- 高速な全角・半角変換</a></li> 
+        <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code> --- 高速な日本語文字種変換モジュール</a></li> 
       </ul>
     </div>  
 
@@ -47,7 +47,7 @@ <h3>ナビゲーション</h3>
           <div class="body" role="main">
 
   <section id="module-habachen">
-<span id="habachen"></span><h1><a class="reference internal" href="#module-habachen" title="habachen"><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code></a> --- 高速な全角・半角変換<a class="headerlink" href="#module-habachen" title="この見出しへのパーマリンク">¶</a></h1>
+<span id="habachen"></span><h1><a class="reference internal" href="#module-habachen" title="habachen"><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code></a> --- 高速な日本語文字種変換モジュール<a class="headerlink" href="#module-habachen" title="この見出しへのパーマリンク">¶</a></h1>
 <hr class="docutils" />
 <p>このモジュールは、日本語の全角／半角と、ひらがな／カタカナを相互変換する関数を提供します。</p>
 <p>利用可能な関数は以下の通りです：</p>
@@ -148,7 +148,8 @@ <h3>ナビゲーション</h3>
 <span class="sig-prename descclassname"><span class="pre">habachen.</span></span><span class="sig-name descname"><span class="pre">to_katakana</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hankaku</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#habachen.to_katakana" title="この定義へのパーマリンク">¶</a></dt>
 <dt class="sig sig-object py" id="habachen.hira_to_kata">
 <span class="sig-prename descclassname"><span class="pre">habachen.</span></span><span class="sig-name descname"><span class="pre">hira_to_kata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hankaku</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#habachen.hira_to_kata" title="この定義へのパーマリンク">¶</a></dt>
-<dd><p>文字列を受け取り、それに含まれるひらがなを対応するカタカナ（既定では全角カタカナ）に変換した新しい文字列を返します。オプション引数 <em>ignore</em> に含まれるひらがなは変換されません。<em>ignore</em> 引数に渡すことができるのは、ひらがな文字列、あるいはひらがな文字列のイテラブルで、ひらがな文字列はカタカナに変換可能でなくてはなりません。
+<dd><p>文字列を受け取り、それに含まれるひらがなを対応するカタカナ（既定では全角カタカナ）に変換した新しい文字列を返します。オプション引数 <em>ignore</em> に含まれるひらがなは変換されません。
+<em>ignore</em> 引数に渡すことができるのは、ひらがな文字列、あるいはひらがな文字列のイテラブルで、カタカナに変換できない文字を含んでいてはなりません。
 <em>hankaku</em> オプションを True に設定すると、ひらがなは全角カタカナではなく半角カタカナに変換されるようになります。</p>
 <p>以下が使用例です:</p>
 <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="go"># ひらがなをカタカナに変換する。ひらがな以外は変換されない</span>
@@ -189,7 +190,7 @@ <h3>ナビゲーション</h3>
 <dt class="sig sig-object py" id="habachen.kata_to_hira">
 <span class="sig-prename descclassname"><span class="pre">habachen.</span></span><span class="sig-name descname"><span class="pre">kata_to_hira</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#habachen.kata_to_hira" title="この定義へのパーマリンク">¶</a></dt>
 <dd><p>文字列を受け取り、それに含まれる全角カタカナを対応するひらがなに変換した新しい文字列を返します。オプション引数 <em>ignore</em> に含まれるカタカナは変換されません。
-<em>ignore</em> 引数に渡すことができるのは、カタカナ文字列、あるいはカタカナ文字列のイテラブルで、カタカナ文字列はひらがなに変換可能でなくてはなりません。</p>
+<em>ignore</em> 引数に渡すことができるのは、カタカナ文字列、あるいはカタカナ文字列のイテラブルで、ひらがなに変換できない文字を含んでいてはなりません。</p>
 <div class="admonition note">
 <p class="admonition-title">注釈</p>
 <p>半角カタカナからひらがなへの変換はサポートしていません。</p>
@@ -1368,7 +1369,7 @@ <h2>APPENDIX: 変換テーブル<a class="headerlink" href="#appendix" title="
   <div>
     <h3><a href="index.html">目次</a></h3>
     <ul>
-<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code> --- 高速な全角・半角変換</a><ul>
+<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code> --- 高速な日本語文字種変換モジュール</a><ul>
 <li><a class="reference internal" href="#habachen.hankaku_to_zenkaku"><code class="docutils literal notranslate"><span class="pre">hankaku_to_zenkaku()</span></code></a></li>
 <li><a class="reference internal" href="#habachen.to_zenkaku"><code class="docutils literal notranslate"><span class="pre">to_zenkaku()</span></code></a></li>
 <li><a class="reference internal" href="#habachen.han_to_zen"><code class="docutils literal notranslate"><span class="pre">han_to_zen()</span></code></a></li>
@@ -1426,12 +1427,12 @@ <h3>ナビゲーション</h3>
           <a href="index.html" title="Welcome to Habachen&#39;s documentation!"
              >前へ</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Habachen  ドキュメント</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code> --- 高速な全角・半角変換</a></li> 
+        <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">habachen</span></code> --- 高速な日本語文字種変換モジュール</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2023, Hizuru.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.1.3.
+    &#169; 著作権 2023-2024, Hizuru.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
     </div>
   </body>
 </html>