From f033569283a623adb538fde9afcdb421832abb12 Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Wed, 17 Nov 2021 08:29:16 +0900 Subject: [PATCH 1/9] use sphinxcontrib.kana_text --- Makefile | 5 +++ source/_theme/sphinxjp/genindex.html | 67 ++++++++++++++++++++++++++++ source/conf.py | 8 ++++ word_list.txt | 14 ++++++ 4 files changed, 94 insertions(+) create mode 100644 source/_theme/sphinxjp/genindex.html create mode 100644 word_list.txt diff --git a/Makefile b/Makefile index cc0c6ee5..9e3e5e2a 100644 --- a/Makefile +++ b/Makefile @@ -35,6 +35,11 @@ html: @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." +kana: + $(SPHINXBUILD) -b kana $(ALLSPHINXOPTS) $(BUILDDIR)/kana + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/kana." + dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo diff --git a/source/_theme/sphinxjp/genindex.html b/source/_theme/sphinxjp/genindex.html new file mode 100644 index 00000000..f0bf2583 --- /dev/null +++ b/source/_theme/sphinxjp/genindex.html @@ -0,0 +1,67 @@ +{%- extends "layout.html" %} +{% set title = _('Index') %} + +{% macro indexentries(firstname, links) %} + {%- if links -%} + + {%- if links[0][0] %}{% endif -%} + {{ firstname }} + {%- if links[0][0] %}{% endif -%} + + + {%- for ismain, link in links[1:] -%} + , {% if ismain %}{% endif -%} + [{{ loop.index }}] + {%- if ismain %}{% endif -%} + + {%- endfor %} + {%- else %} + {{ firstname }} + {%- endif %} +{% endmacro %} + +{% block body %} + +

{{ _('Index') }}

+ +
+ {% for key, dummy in genindexentries -%} + {{ key }} + {% if not loop.last %}| {% endif %} + {%- endfor %} +
+ +{%- for key, entries in genindexentries %} +

{{ key }}

+ + {%- for column in entries|slice_index(2) if column %} + + {%- endfor %} +
    + {%- for entryname, (links, subitems, _) in column %} +
  • {{ indexentries(entryname, links) }} + {%- if subitems %} +
      + {%- for subentryname, subentrylinks in subitems %} +
    • {{ indexentries(subentryname, subentrylinks) }}
      • + {%- endfor %} +
    + {%- endif -%}
    • + {%- endfor %} +
+{% endfor %} + +{% endblock %} + +{% block sidebarrel %} +{% if split_index %} +

{{ _('Index') }}

+

{% for key, dummy in genindexentries -%} + {{ key }} + {% if not loop.last %}| {% endif %} + {%- endfor %}

+ +

{{ _('Full index on one page') }}

+{% endif %} + {{ super() }} +{% endblock %} diff --git a/source/conf.py b/source/conf.py index 1cda252f..d0f57889 100644 --- a/source/conf.py +++ b/source/conf.py @@ -27,6 +27,7 @@ 'sphinxcontrib.trimblank', 'ogtag', 'sphinxcontrib.gist', + 'sphinxcontrib.kana_text', ] # Add any paths that contain templates here, relative to this directory. @@ -214,3 +215,10 @@ numfig = True trimblank_keep_alnum_blank = ['html', 'singlehtml'] + +#kana_text_separator = r'\|' +#kana_text_option_marker = r'\^' +kana_text_indexer_mode = 'small' +kana_text_word_file = './word_list.txt' +kana_text_on_genindex = True +#kana_text_change_triple = True diff --git a/word_list.txt b/word_list.txt new file mode 100644 index 00000000..6d0c50dc --- /dev/null +++ b/word_list.txt @@ -0,0 +1,14 @@ +ぎゃくびき|逆引き +さんこう|参考文献 +さんしょう|参照 +しゅってん|出典元 +しょう|章 +せつ|節 +ようご|用語 +ようごめい|用語名 +しょう|章や節に番号を振る +ようご|用語を定義する +さんこう|参考文献を書く +しゅってん|出典元を書く +さんしょう|参照する +ほかの|他のファイルを読み込む From 2a33b3f624a4a1f084b134ee527b7283703f3415 Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Wed, 17 Nov 2021 10:33:13 +0900 Subject: [PATCH 2/9] add index directives. --- source/gettingstarted/directives.rst | 2 + source/gettingstarted/index.rst | 8 +++ source/gettingstarted/install_unix.rst | 2 + source/gettingstarted/install_windows.rst | 2 + source/gettingstarted/use_markup.rst | 15 +++++ source/reverse-dict/epub/cover.rst | 2 +- source/reverse-dict/html/japanese.rst | 2 +- source/reverse-dict/html/meta.rst | 2 +- source/reverse-dict/html/title.rst | 2 +- source/reverse-dict/images/caption.rst | 2 +- source/reverse-dict/images/inline.rst | 4 ++ source/reverse-dict/images/numbering.rst | 4 ++ source/reverse-dict/images/scale.rst | 2 + source/reverse-dict/images/target.rst | 4 ++ source/reverse-dict/index.rst | 2 + source/reverse-dict/pdf/font.rst | 2 +- .../reverse-dict/system/excludepatterns.rst | 2 +- source/reverse-dict/system/lang.rst | 2 +- source/reverse-dict/system/smartpants.rst | 2 +- source/reverse-dict/writing/citation.rst | 5 +- source/reverse-dict/writing/comment.rst | 3 + source/reverse-dict/writing/contents.rst | 7 ++- .../reverse-dict/writing/emphasizelines.rst | 3 + source/reverse-dict/writing/emptylines.rst | 3 + source/reverse-dict/writing/hlist.rst | 5 +- .../reverse-dict/writing/horizontal_line.rst | 3 + source/reverse-dict/writing/ifconfig.rst | 6 +- source/reverse-dict/writing/include.rst | 5 +- source/reverse-dict/writing/indexing.rst | 5 +- source/reverse-dict/writing/link.rst | 16 +++-- source/reverse-dict/writing/note.rst | 6 +- source/reverse-dict/writing/numbering.rst | 6 +- source/reverse-dict/writing/only.rst | 5 +- source/reverse-dict/writing/refer.rst | 5 +- source/reverse-dict/writing/replace.rst | 5 +- source/reverse-dict/writing/space.rst | 5 ++ source/reverse-dict/writing/strike.rst | 3 + source/reverse-dict/writing/today.rst | 6 +- source/reverse-dict/writing/todo.rst | 5 +- source/reverse-dict/writing/vocabulary.rst | 3 + word_list.txt | 59 +++++++++++++++---- 41 files changed, 192 insertions(+), 40 deletions(-) diff --git a/source/gettingstarted/directives.rst b/source/gettingstarted/directives.rst index f773e5dd..ccee93f1 100644 --- a/source/gettingstarted/directives.rst +++ b/source/gettingstarted/directives.rst @@ -1,3 +1,5 @@ +.. index:: ディレクティブ + .. _directives: ==================== diff --git a/source/gettingstarted/index.rst b/source/gettingstarted/index.rst index ecb35ec2..11713633 100644 --- a/source/gettingstarted/index.rst +++ b/source/gettingstarted/index.rst @@ -6,6 +6,8 @@ Sphinxをはじめよう Sphinxを使って、かんたんな書籍紹介のドキュメントを作っていきます。 +.. index:: インストール; Sphinxをインストールする + Sphinxのインストール ==================== @@ -17,6 +19,8 @@ SphinxはPythonで書かれているため、Sphinxのインストールにあ install_windows install_unix +.. index:: プロジェクト; プロジェクトを作成する + プロジェクトの作成 ================== @@ -29,6 +33,10 @@ Sphinxでドキュメントを作るには、まずはドキュメントのプ make_project +.. index:: + single: 表; 表、リストなどを追加する + single: リスト; 表、リストなどを追加する + 表、リストなどを追加して完成させる ================================== diff --git a/source/gettingstarted/install_unix.rst b/source/gettingstarted/install_unix.rst index 05fc1c78..6c298fc0 100644 --- a/source/gettingstarted/install_unix.rst +++ b/source/gettingstarted/install_unix.rst @@ -1,3 +1,5 @@ +.. index:: インストール; macOS と Linux(Ubuntu)へのインストール + ====================================== macOS と Linux(Ubuntu)へのインストール ====================================== diff --git a/source/gettingstarted/install_windows.rst b/source/gettingstarted/install_windows.rst index 0340d912..c3523f4a 100644 --- a/source/gettingstarted/install_windows.rst +++ b/source/gettingstarted/install_windows.rst @@ -1,3 +1,5 @@ +.. index:: インストール; Windowsへのインストール + ======================= Windowsへのインストール ======================= diff --git a/source/gettingstarted/use_markup.rst b/source/gettingstarted/use_markup.rst index 24696e09..792f60ba 100644 --- a/source/gettingstarted/use_markup.rst +++ b/source/gettingstarted/use_markup.rst @@ -7,6 +7,8 @@ Sphinxには様々なマークアップがあります。これを利用する .. contents:: ここで紹介するマークアップ一覧 :local: +.. index:: インラインマークアップ + インラインマークアップ ====================== @@ -22,6 +24,8 @@ Sphinxには様々なマークアップがあります。これを利用する `リンク付きテキスト `_ +.. index:: コードブロック + コードブロック ============== @@ -42,6 +46,8 @@ Sphinxには様々なマークアップがあります。これを利用する import this +.. index:: リスト + リスト ====== @@ -65,6 +71,7 @@ Sphinxには様々なマークアップがあります。これを利用する 焼きそば 知る人ぞ知る宇都宮の名物。専門店多数。なぜかビニール袋で持ち帰る。 +.. index:: テーブル テーブル ======== @@ -106,6 +113,8 @@ Sphinxには様々なマークアップがあります。これを利用する これ以外にもディレクティブを使った方法がいくつかあります。詳細は :ref:`directives` を参照してください。 +.. index:: ディレクティブ + ディレクティブ ============== @@ -125,6 +134,8 @@ Sphinxが利用しているreStructuredTextのもっとも特徴的な機能が ディレクティブの種類によって、オプションや引数、コンテンツが指定できるかが異なります。 +.. index:: 画像 + 画像 ---- @@ -139,6 +150,8 @@ Sphinxが利用しているreStructuredTextのもっとも特徴的な機能が 一行あけてここに書いたものがキャプションになります +.. index:: 索引 + 索引 ---- @@ -164,6 +177,8 @@ Sphinxが利用しているreStructuredTextのもっとも特徴的な機能が 3つめのディレクティブは、「うさぎや→チャット,お菓子」「チャット→うさぎや,お菓子」「お菓子→チャット,お菓子」という3組のエントリーが作られます。 +.. index:: 注釈 + 注釈 ---- diff --git a/source/reverse-dict/epub/cover.rst b/source/reverse-dict/epub/cover.rst index e6d9eb53..310a349f 100644 --- a/source/reverse-dict/epub/cover.rst +++ b/source/reverse-dict/epub/cover.rst @@ -1,4 +1,4 @@ -.. index:: conf.py;epub_cover +.. index:: 設定（conf.py）; epub_cover カバー画像を設定したい ---------------------------- diff --git a/source/reverse-dict/html/japanese.rst b/source/reverse-dict/html/japanese.rst index 9f8d340b..1510b3d8 100644 --- a/source/reverse-dict/html/japanese.rst +++ b/source/reverse-dict/html/japanese.rst @@ -1,4 +1,4 @@ -.. index:: japanesesupport, conf.py;japanesesupport, extensions;japanesesupport +.. index:: japanesesupport, 設定（conf.py）; japanesesupport, 拡張機能; japanesesupport .. _japanesesupport: diff --git a/source/reverse-dict/html/meta.rst b/source/reverse-dict/html/meta.rst index d9c8aa50..a4dd9feb 100644 --- a/source/reverse-dict/html/meta.rst +++ b/source/reverse-dict/html/meta.rst @@ -1,4 +1,4 @@ -.. index:: meta, directive;meta +.. index:: meta, ディレクティブ; meta metaタグを指定したい ----------------------- diff --git a/source/reverse-dict/html/title.rst b/source/reverse-dict/html/title.rst index 5e76eb62..a058ae86 100644 --- a/source/reverse-dict/html/title.rst +++ b/source/reverse-dict/html/title.rst @@ -1,4 +1,4 @@ -.. index:: title, directive;title +.. index:: title, ディレクティブ; title titleを指定したい diff --git a/source/reverse-dict/images/caption.rst b/source/reverse-dict/images/caption.rst index a9ced7cf..44605c7e 100644 --- a/source/reverse-dict/images/caption.rst +++ b/source/reverse-dict/images/caption.rst @@ -1,4 +1,4 @@ -.. index:: figure, directive;figure +.. index:: figure, ディレクティブ;figure 図にキャプションをつけたい -------------------------- diff --git a/source/reverse-dict/images/inline.rst b/source/reverse-dict/images/inline.rst index 6a84b1a0..e1596eba 100644 --- a/source/reverse-dict/images/inline.rst +++ b/source/reverse-dict/images/inline.rst @@ -1,3 +1,7 @@ +.. index:: + single: 画像; 文章の途中に画像を埋め込む + single: 埋め込み; 文章の途中に画像を埋め込む + 文章の途中に画像を埋め込みたい ---------------------------------------------------- diff --git a/source/reverse-dict/images/numbering.rst b/source/reverse-dict/images/numbering.rst index 0851b295..f9b3cb0f 100644 --- a/source/reverse-dict/images/numbering.rst +++ b/source/reverse-dict/images/numbering.rst @@ -1,3 +1,7 @@ +.. index:: + single: 図表; 図に番号を自動で振り、参照する + single: 参照; 図に番号を自動で振り、参照する + .. _images-numbering: 図に番号を自動で振り、参照したい diff --git a/source/reverse-dict/images/scale.rst b/source/reverse-dict/images/scale.rst index 35e21820..675de309 100644 --- a/source/reverse-dict/images/scale.rst +++ b/source/reverse-dict/images/scale.rst @@ -1,3 +1,5 @@ +.. index:: 画像; 画像の大きさを変える + 画像の大きさを変えたい ---------------------------------------------------- diff --git a/source/reverse-dict/images/target.rst b/source/reverse-dict/images/target.rst index 7fdf64a1..5d9c2f7a 100644 --- a/source/reverse-dict/images/target.rst +++ b/source/reverse-dict/images/target.rst @@ -1,3 +1,7 @@ +.. index:: + single: 画像; 画像からリンクを貼る + single: リンク; 画像からリンクを貼る + 画像からリンクを貼りたい ---------------------------------------------------- diff --git a/source/reverse-dict/index.rst b/source/reverse-dict/index.rst index 275408ff..47e3630b 100644 --- a/source/reverse-dict/index.rst +++ b/source/reverse-dict/index.rst @@ -1,3 +1,5 @@ +.. index:: 逆引き + 逆引き辞典 ==================================================== diff --git a/source/reverse-dict/pdf/font.rst b/source/reverse-dict/pdf/font.rst index 4c4f496e..434c3ae6 100644 --- a/source/reverse-dict/pdf/font.rst +++ b/source/reverse-dict/pdf/font.rst @@ -1,4 +1,4 @@ -.. index:: conf.py;font_path +.. index:: 設定（conf.py）;font_path 文字化けする ---------------------------- diff --git a/source/reverse-dict/system/excludepatterns.rst b/source/reverse-dict/system/excludepatterns.rst index 8a8ee872..fa7b648a 100644 --- a/source/reverse-dict/system/excludepatterns.rst +++ b/source/reverse-dict/system/excludepatterns.rst @@ -1,4 +1,4 @@ -.. index:: exclude_patterns, conf.py; exclude_patterns +.. index:: exclude_patterns, 設定（conf.py）; exclude_patterns あるディレクトリやファイルを読み込まないようにしたい --------------------------------------------------------------------------- diff --git a/source/reverse-dict/system/lang.rst b/source/reverse-dict/system/lang.rst index ec942924..506d4dd2 100644 --- a/source/reverse-dict/system/lang.rst +++ b/source/reverse-dict/system/lang.rst @@ -1,4 +1,4 @@ -.. index:: lang, conf.py; lang, +.. index:: lang, 設定（conf.py）; lang, 言語を変えたい ------------------------ diff --git a/source/reverse-dict/system/smartpants.rst b/source/reverse-dict/system/smartpants.rst index 58ec79fb..864c5d69 100644 --- a/source/reverse-dict/system/smartpants.rst +++ b/source/reverse-dict/system/smartpants.rst @@ -1,4 +1,4 @@ -.. index:: conf.py;smaprtypants +.. index:: 設定（conf.py）;smaprtypants クォートが開きと閉じで異なる文字になる -------------------------------------------------------------------- diff --git a/source/reverse-dict/writing/citation.rst b/source/reverse-dict/writing/citation.rst index a001093c..6e3e24e6 100644 --- a/source/reverse-dict/writing/citation.rst +++ b/source/reverse-dict/writing/citation.rst @@ -1,4 +1,7 @@ -.. index:: citation, role; citation +.. index:: + single: citation + single: ロール（role）; citation + single: 参考文献; 参考文献を書く .. _writing-citation: diff --git a/source/reverse-dict/writing/comment.rst b/source/reverse-dict/writing/comment.rst index dd8f0873..040bc2e7 100644 --- a/source/reverse-dict/writing/comment.rst +++ b/source/reverse-dict/writing/comment.rst @@ -1,3 +1,6 @@ +.. index:: + single: コメント; コメントアウトする + コメントアウトする --------------------- diff --git a/source/reverse-dict/writing/contents.rst b/source/reverse-dict/writing/contents.rst index f37c501c..e43d7037 100644 --- a/source/reverse-dict/writing/contents.rst +++ b/source/reverse-dict/writing/contents.rst @@ -1,6 +1,9 @@ -.. index:: contents, directive; contents +.. index:: + single: contents + single: ディレクティブ; contents + single: 目次; ページ内に目次を作る -ページ内の目次を作りたい +ページ内に目次を作りたい ------------------------ ``contents`` を使います。 diff --git a/source/reverse-dict/writing/emphasizelines.rst b/source/reverse-dict/writing/emphasizelines.rst index 49d87816..aec7874a 100644 --- a/source/reverse-dict/writing/emphasizelines.rst +++ b/source/reverse-dict/writing/emphasizelines.rst @@ -1,3 +1,6 @@ +.. index:: + single: 強調表示; コードブロック内で特性の行だけ強調表示する + コードブロック内で特定の行だけ強調表示したい ---------------------------------------------- diff --git a/source/reverse-dict/writing/emptylines.rst b/source/reverse-dict/writing/emptylines.rst index 6731e1fa..d5d68cfb 100644 --- a/source/reverse-dict/writing/emptylines.rst +++ b/source/reverse-dict/writing/emptylines.rst @@ -1,3 +1,6 @@ +.. index:: + single: 空行; 空行を追加する + 空行を追加したい --------------------- diff --git a/source/reverse-dict/writing/hlist.rst b/source/reverse-dict/writing/hlist.rst index 4be54c1b..53407700 100644 --- a/source/reverse-dict/writing/hlist.rst +++ b/source/reverse-dict/writing/hlist.rst @@ -1,4 +1,7 @@ -.. index:: hlist, directive; hlist +.. index:: hlist, ディレクティブ; hlist + +.. index:: + single: リスト; リストを横に並べる リストを横に並べたい --------------------------- diff --git a/source/reverse-dict/writing/horizontal_line.rst b/source/reverse-dict/writing/horizontal_line.rst index ccdb6245..637bd2fc 100644 --- a/source/reverse-dict/writing/horizontal_line.rst +++ b/source/reverse-dict/writing/horizontal_line.rst @@ -1,3 +1,6 @@ +.. index:: + single: 水平線; 水平線を引く + 水平線を引きたい ---------------------------- diff --git a/source/reverse-dict/writing/ifconfig.rst b/source/reverse-dict/writing/ifconfig.rst index 278dab9e..2595761a 100644 --- a/source/reverse-dict/writing/ifconfig.rst +++ b/source/reverse-dict/writing/ifconfig.rst @@ -1,4 +1,8 @@ -.. index:: ifconfig, extensions;ifconfig, conf.py;ifconfig +.. index:: ifconfig, 拡張機能; ifconfig, 設定（conf.py）; ifconfig + +.. index:: + single: 設定（conf.py）; 設定に従ってコンテンツを表示する + single: 表示; 設定に従ってコンテンツを表示する .. _writing-ifconfig: diff --git a/source/reverse-dict/writing/include.rst b/source/reverse-dict/writing/include.rst index 036e9c6b..31209866 100644 --- a/source/reverse-dict/writing/include.rst +++ b/source/reverse-dict/writing/include.rst @@ -1,4 +1,7 @@ -.. index:: literalinclude, include, directive;include +.. index:: literalinclude, include, ディレクティブ; include + +.. index:: + single: 他のファイル; 他のファイルを読み込む 他のファイルを読み込みたい -------------------------------------- diff --git a/source/reverse-dict/writing/indexing.rst b/source/reverse-dict/writing/indexing.rst index e3cd3c7c..5346f148 100644 --- a/source/reverse-dict/writing/indexing.rst +++ b/source/reverse-dict/writing/indexing.rst @@ -1,4 +1,7 @@ -.. index:: index +.. index:: + single: index + single: 索引; 索引に載せる + 索引に載せたい -------------------------- diff --git a/source/reverse-dict/writing/link.rst b/source/reverse-dict/writing/link.rst index 984428f8..ba38518e 100644 --- a/source/reverse-dict/writing/link.rst +++ b/source/reverse-dict/writing/link.rst @@ -1,14 +1,10 @@ -.. index:: - single: link - pair: link;inline - pair: link;image - - リンクを貼りたい ================ Sphinxでリンクを貼る方法はいくつかあります。 +.. index:: リンク; リンクを貼る（外部リンク） + URL直書き --------- @@ -18,6 +14,8 @@ URL直書き 詳しくは、 http://sphinx-users.jp を参照してください。 +.. index:: リンク; リンクを貼る（外部リンク） + reSTのインライン構文 -------------------- @@ -27,6 +25,8 @@ reSTのインライン構文 `Sphinxを知りたい方はこちらをクリック `_ +.. index:: リンク; リンクを貼る（内部リンク） + 論文の参考文献のような記述法 ---------------------------- @@ -38,6 +38,8 @@ reSTのインライン構文 .. _SphinxJP: http://sphinx-users.jp +.. index:: リンク; 画像 + 画像をクリックした時のリンク ---------------------------- @@ -49,6 +51,8 @@ reSTのインライン構文 :alt: Sphinx-Users.jpのロゴ :target: http://sphinx-users.jp +.. index:: リンク; リンクを貼る（内部リンク） + Sphinxのドキュメント内の他のページへのリンク -------------------------------------------- diff --git a/source/reverse-dict/writing/note.rst b/source/reverse-dict/writing/note.rst index d0957b7e..1c82e1c4 100644 --- a/source/reverse-dict/writing/note.rst +++ b/source/reverse-dict/writing/note.rst @@ -1,4 +1,8 @@ -.. index:: note, warning, directive; note, directive; warning +.. index:: note, warning, ディレクティブ; note, ディレクティブ; warning + +.. index:: + single: 注意; 注意や警告を書く + single: 警告; 注意や警告を書く 注意や警告を書きたい ---------------------------- diff --git a/source/reverse-dict/writing/numbering.rst b/source/reverse-dict/writing/numbering.rst index d9e1aa0a..7e06b8b5 100644 --- a/source/reverse-dict/writing/numbering.rst +++ b/source/reverse-dict/writing/numbering.rst @@ -1,4 +1,8 @@ -.. index:: numberd, toctree; numberd +.. index:: + single: numberd + single: toctree; numberd + single: 章; 章や節に番号を振る + single: 節; 章や節に番号を振る .. _writing-numbering: diff --git a/source/reverse-dict/writing/only.rst b/source/reverse-dict/writing/only.rst index 3ceacdf0..3ba2d404 100644 --- a/source/reverse-dict/writing/only.rst +++ b/source/reverse-dict/writing/only.rst @@ -1,4 +1,7 @@ -.. index:: only, directive;only +.. index:: only, ディレクティブ; only + +.. index:: + single: 表示; 特定の時だけコンテンツを表示する .. _writing-only: diff --git a/source/reverse-dict/writing/refer.rst b/source/reverse-dict/writing/refer.rst index 059f25ff..a1b324ed 100644 --- a/source/reverse-dict/writing/refer.rst +++ b/source/reverse-dict/writing/refer.rst @@ -1,4 +1,7 @@ -.. index:: refer +.. index:: + single: refer + single: 参照; 参照する + single: リンク; リンクを貼る（内部リンク） .. _writing-refer: diff --git a/source/reverse-dict/writing/replace.rst b/source/reverse-dict/writing/replace.rst index 28a2bbed..8c603f9e 100644 --- a/source/reverse-dict/writing/replace.rst +++ b/source/reverse-dict/writing/replace.rst @@ -1,4 +1,7 @@ -.. index:: replace, role;replace +.. index:: + single: replace + single: ロール（role）; replace + single: 用語; 用語を定義する 用語を定義したい --------------------------- diff --git a/source/reverse-dict/writing/space.rst b/source/reverse-dict/writing/space.rst index 05760401..d7bb5075 100644 --- a/source/reverse-dict/writing/space.rst +++ b/source/reverse-dict/writing/space.rst @@ -1,3 +1,8 @@ +.. index:: + single: スペース; インラインマークアップにスペースを入れない + single: 空白; インラインマークアップにスペースを入れない + + インラインマークアップ前後にスペースを入れたくない ==================================================== diff --git a/source/reverse-dict/writing/strike.rst b/source/reverse-dict/writing/strike.rst index 190a08ea..9b116835 100644 --- a/source/reverse-dict/writing/strike.rst +++ b/source/reverse-dict/writing/strike.rst @@ -1,5 +1,8 @@ .. index:: strike +.. index:: + single: 取り消し線; 取り消し線を引く + 取り消し線を引きたい ------------------------ diff --git a/source/reverse-dict/writing/today.rst b/source/reverse-dict/writing/today.rst index fdc8aa49..6449b8e3 100644 --- a/source/reverse-dict/writing/today.rst +++ b/source/reverse-dict/writing/today.rst @@ -1,4 +1,8 @@ -.. index:: today, conf.py;today_fmt +.. index:: today, 設定（conf.py）;today_fmt + +.. index:: + single: 日付; 今日の日付を埋め込む + single: 埋め込み; 今日の日付を埋め込む 今日の日付を埋め込みたい ---------------------------------------- diff --git a/source/reverse-dict/writing/todo.rst b/source/reverse-dict/writing/todo.rst index dd91967b..4faa76e4 100644 --- a/source/reverse-dict/writing/todo.rst +++ b/source/reverse-dict/writing/todo.rst @@ -1,4 +1,7 @@ -.. index:: todo, extensions; todo, conf.py; todo +.. index:: todo, 拡張機能; todo, 設定（conf.py）; todo + +.. index:: + single: TODO; TODOを記録する TODOを記録しておきたい ---------------------- diff --git a/source/reverse-dict/writing/vocabulary.rst b/source/reverse-dict/writing/vocabulary.rst index fecbc525..11e3e327 100644 --- a/source/reverse-dict/writing/vocabulary.rst +++ b/source/reverse-dict/writing/vocabulary.rst @@ -1,3 +1,6 @@ +.. index:: + single: 独自ディレクティブ; 定義を書くために独自ディレクティブを追加する + 定義を書くために独自ディレクティブを追加したい ============================================== diff --git a/word_list.txt b/word_list.txt index 6d0c50dc..a783fcea 100644 --- a/word_list.txt +++ b/word_list.txt @@ -1,14 +1,51 @@ -ぎゃくびき|逆引き +いんよう|引用 +うめこみ|埋め込み +かくちょ|拡張機能 +がぞう|画像 +ぎゃくび|逆引き +きょうち|強調表示 +くうぎょ|空行 +くうはく|空白 +けいこく|警告 +さくいん|索引 さんこう|参考文献 -さんしょう|参照 -しゅってん|出典元 -しょう|章 -せつ|節 +さんしょ|参照 +しゅって|出典元 +しょう|章^ +すいへい|水平線 +せつ|節^ +せってい|設定 +せってい|設定（conf.py） +ちゅうい|注意 +ちゅしゃ|注釈 +どくじで|独自ディレクティブ +とりけし|取り消し線 +ひづけ|日付 +ひょうじ|表示 +ひょう|表 +ほかのふ|他のファイル +もくじ|目次 ようご|用語 -ようごめい|用語名 -しょう|章や節に番号を振る -ようご|用語を定義する +ようごめ|用語名 +しょうや|章や節に番号を振る +ようごを|用語を定義する さんこう|参考文献を書く -しゅってん|出典元を書く -さんしょう|参照する -ほかの|他のファイルを読み込む +しゅって|出典元を書く +いんよう|引用元を書く +さんしょ|参照する +ほかのふ|他のファイルを読み込む +ちゅうい|注意や警告を書く +とくてい|特定の時だけコンテンツを表示する +せってい|設定に従ってコンテンツを表示する +さくいん|索引に載せる +きょうの|今日の日付を埋め込む +ていぎを|定義を書くために独自ディレクティブを追加する +くうぎょ|空行を追加する +すいへい|水平線を引く +ずひょう|図表 +とりけし|取り消し線を引く +ひょう、|表、リストなどを追加する +ぶんしょ|文章の途中に画像を埋め込む +ずにばん|図に番号を自動で振り、参照する +がぞうの|画像の大きさを変える +がぞうか|画像からリンクを貼る From e30b04cc2c94b89877bb81276f7e359aa842b3f4 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Wed, 17 Nov 2021 11:10:11 +0900 Subject: [PATCH 3/9] Add sphinxcontrib.kana-text --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 5dfcf359..b3dbf71b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,7 @@ Sphinx setuptools sphinxcontrib.gist sphinxcontrib-trimblank +sphinxcontrib.kana-text pillow>=8.1.0 # not directly required, pinned by Snyk to avoid a vulnerability pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability sphinx>=3.0.4 # not directly required, pinned by Snyk to avoid a vulnerability From e3b4a9cdb962db126774e499b0edc7cb833cf40d Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Wed, 17 Nov 2021 13:05:29 +0900 Subject: [PATCH 4/9] add two packages. --- requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements.txt b/requirements.txt index 5dfcf359..2b87a6b6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,3 +6,5 @@ sphinxcontrib-trimblank pillow>=8.1.0 # not directly required, pinned by Snyk to avoid a vulnerability pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability sphinx>=3.0.4 # not directly required, pinned by Snyk to avoid a vulnerability +sphindexer +sphinxcontrib.kana_text From 3211e17fda775ea7f1814c856a16efa8cb15ea01 Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Wed, 17 Nov 2021 13:11:03 +0900 Subject: [PATCH 5/9] update about sphindexer and the other. --- requirements.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 986489d4..bb2ce754 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,8 +4,7 @@ setuptools sphinxcontrib.gist sphinxcontrib-trimblank sphinxcontrib.kana-text +sphindexer pillow>=8.1.0 # not directly required, pinned by Snyk to avoid a vulnerability pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability sphinx>=3.0.4 # not directly required, pinned by Snyk to avoid a vulnerability -sphindexer -sphinxcontrib.kana_text From 64209734d23bfce8680054197be795b9b859b0dc Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Wed, 17 Nov 2021 18:08:52 +0900 Subject: [PATCH 6/9] kana_text depends on sphindexer. --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index bb2ce754..8d65f2d4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,10 @@ Pillow Sphinx setuptools +sphindexer sphinxcontrib.gist sphinxcontrib-trimblank sphinxcontrib.kana-text -sphindexer pillow>=8.1.0 # not directly required, pinned by Snyk to avoid a vulnerability pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability sphinx>=3.0.4 # not directly required, pinned by Snyk to avoid a vulnerability From 8aa4f647facfe2cc55a608debfe148bf57be838b Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Wed, 17 Nov 2021 18:57:11 +0900 Subject: [PATCH 7/9] updates about index directive. --- source/reverse-dict/system/doctree.rst | 2 +- source/reverse-dict/system/load-config-from-ini.rst | 2 +- source/reverse-dict/system/orphan.rst | 4 +++- source/reverse-dict/table/include.rst | 2 +- source/reverse-dict/table/tab.rst | 2 +- word_list.txt | 2 ++ 6 files changed, 9 insertions(+), 5 deletions(-) diff --git a/source/reverse-dict/system/doctree.rst b/source/reverse-dict/system/doctree.rst index cbeaa710..97a2359b 100644 --- a/source/reverse-dict/system/doctree.rst +++ b/source/reverse-dict/system/doctree.rst @@ -1,4 +1,4 @@ -.. index:: orphan, setting; orphan +.. index:: doctree, 中間ファイル;中間ファイルの内容を見る 中間ファイル `*.doctree` の内容をみてSphinxがどのようにreSTをparseしているか知りたい -------------------------------------------------------------------------------------- diff --git a/source/reverse-dict/system/load-config-from-ini.rst b/source/reverse-dict/system/load-config-from-ini.rst index e81e2b88..7b89040a 100644 --- a/source/reverse-dict/system/load-config-from-ini.rst +++ b/source/reverse-dict/system/load-config-from-ini.rst @@ -1,4 +1,4 @@ -.. index:: conf.py, setting; conf.py +.. index:: conf.py, 設定（conf.py） conf.pyにiniファイルから設定を読み込む ------------------------------------------- diff --git a/source/reverse-dict/system/orphan.rst b/source/reverse-dict/system/orphan.rst index cbf65291..74e2a19a 100644 --- a/source/reverse-dict/system/orphan.rst +++ b/source/reverse-dict/system/orphan.rst @@ -1,4 +1,6 @@ -.. index:: orphan, setting; orphan +.. index:: + single: orphan + single: 参照; どこからも参照されていないファイル document isn't included in any toctreeという警告が出る -------------------------------------------------------------------- diff --git a/source/reverse-dict/table/include.rst b/source/reverse-dict/table/include.rst index 301adc0e..9f856666 100644 --- a/source/reverse-dict/table/include.rst +++ b/source/reverse-dict/table/include.rst @@ -1,4 +1,4 @@ -.. index:: csv-table; file, csv-table; url +.. index:: csv-table, file; csv-table, url; csv-table 外部にあるcsvファイルからデータを読み込む ----------------------------------------------------------------- diff --git a/source/reverse-dict/table/tab.rst b/source/reverse-dict/table/tab.rst index c815c078..2c2acda3 100644 --- a/source/reverse-dict/table/tab.rst +++ b/source/reverse-dict/table/tab.rst @@ -1,4 +1,4 @@ -.. index:: csv-table; encoding, csv-table; delim +.. index:: csv-table, encoding; csv-table, delim; csv-table csv-tableでタブや空白を区切り文字に使いたい ------------------------------------------------------------------------ diff --git a/word_list.txt b/word_list.txt index a783fcea..9c76cb57 100644 --- a/word_list.txt +++ b/word_list.txt @@ -17,6 +17,7 @@ せってい|設定 せってい|設定（conf.py） ちゅうい|注意 +ちゅうか|中間ファイル ちゅしゃ|注釈 どくじで|独自ディレクティブ とりけし|取り消し線 @@ -49,3 +50,4 @@ ずにばん|図に番号を自動で振り、参照する がぞうの|画像の大きさを変える がぞうか|画像からリンクを貼る +ちゅうか|中間ファイルの内容を見る From 6d72a8d185bbe251f742626df875d3676471c54f Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Sun, 28 Nov 2021 15:52:08 +0900 Subject: [PATCH 8/9] set the version information. --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 8d65f2d4..b75477b6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,10 @@ Pillow Sphinx setuptools -sphindexer sphinxcontrib.gist sphinxcontrib-trimblank -sphinxcontrib.kana-text pillow>=8.1.0 # not directly required, pinned by Snyk to avoid a vulnerability pygments>=2.7.4 # not directly required, pinned by Snyk to avoid a vulnerability sphinx>=3.0.4 # not directly required, pinned by Snyk to avoid a vulnerability +sphindexer>=0.10.2 +sphinxcontrib.kana-text From 3aef3183c8625c9496562ef98dab6539218b2e76 Mon Sep 17 00:00:00 2001 From: koKekkoh Date: Sun, 28 Nov 2021 23:49:06 +0900 Subject: [PATCH 9/9] add a reading data. --- word_list.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/word_list.txt b/word_list.txt index 9c76cb57..9abb380f 100644 --- a/word_list.txt +++ b/word_list.txt @@ -21,6 +21,7 @@ ちゅしゃ|注釈 どくじで|独自ディレクティブ とりけし|取り消し線 +はっぴょ|発表資料 ひづけ|日付 ひょうじ|表示 ひょう|表