sphinxの便利なリンク機能

通常、HTMLだとそのリンクのパスを指定してあげないといけないが、
sphinxだとリンク先にタグを仕込んでおくと、勝手にリンクしてくれる。
これはめちゃくちゃ便利である。

どこにファイルをおこうと、タグを仕込んでおこうだけで勝手にリンクしてくれる。

例えば、リンク元で
- :ref:`miniconda`
と入力する。

リンク元

- :ref:`miniconda`

   - :ref:`miniconda-install`

   - :ref:`miniconda-setting`

   

リンク先

.. _miniconda:

##############
ブーリアン機能
##############

.. _miniconda-install:

****
概要
****

Miniconda のインストール手順を説明します。

.. _miniconda-setting:

****
設定
****

Miniconda の設定手順を説明します。

_miniconda　や

_miniconda-setting　が
リンク先のいわゆるタグである。

リンクタイトルテキストは引用元からとってくれるので、非常に便利。

ただ、sphinxはタイトルなどの表示が変わってる。

sphinxの面倒くさいのがタイトルなどを使う場合はかならず文字数通りの##############や****で囲わないと表示されないので、
注意すること。日本語の場合は２バイトなので二倍の#などでマークする必要がある。

たとえば
ブーリアン機能
は７文字なので
１４文字の＃でマークしないといけない。

VSCODEだと右下にStatusで文字数が表示されるので、参考にしたほうが良い思う。

はっきりいって面倒くさい。

というか、単なる文字数以上で区切れば良いだけでした。
１４文字以上の#で区切ればいいだけです。

参考

https://zenn.dev/y_mrok/books/sphinx-no-tsukaikata/viewer/chapter16