URL
URL を指定
ドキュメント内に URL を記述すると、そのままリンクになります。
Sphinx の日本ユーザー会のサイトは https://sphinx-users.jp/index.html です。
リンクテキスト
リンク先の URL を < と > でくくって、リンクに表示する文字列（リンクテキスト）を設定します。上記のリンク部分（ URL ）をリンクテキストに変更します。
Sphinx の日本ユーザー会のサイトは `ここをクリック <https://sphinx-users.jp/index.html>`_ します。
rst ファイル：doc
この例で使用するファイルの配置です。
PS C:\GitHub\sphinx-test\files> tree /F /A
フォルダー パスの一覧
ボリューム シリアル番号は B6FC-C6AE です
C:.
| conf.py
| index.rst
| make.bat
| Makefile
|
+---github
| github.rst
|
+---miniconda
| miniconda.rst
|
+---sphinx
| sphinx.rst
|
+---vscode
| vscode.rst
|
+---_build
+---_static
\---_templates
PS C:\GitHub\sphinx-test\files>
rst ファイルにリンクを設定
doc ディレクティブを使用し rst ファイルにリンクを設定します。リンク先の rst ファイルの見出しがリンクテキストになります。 rst ファイルのパスは、doc ディレクティブを含む rst ファイルを保存したフォルダーを起点とした相対パスです。 toctree ディレクティブと同様に rst ファイルの拡張子は省略できます。
index.rst
##########
環境の説明
##########
:doc:`./miniconda/miniconda` → :doc:`./sphinx/sphinx` → :doc:`./vscode/vscode` → :doc:`./github/github` の順に環境を構築します。
.. toctree::
:hidden:
./miniconda/miniconda
./sphinx/sphinx
./vscode/vscode
./github/github
minconda/miniconda.rst
#########
Miniconda
#########
************
インストール
************
Miniconda のインストール手順を説明します。
****
設定
****
Miniconda の設定手順を説明します。
sphinx/sphinx.rst
######
Sphinx
######
************
インストール
************
Sphinx のインストール手順を説明します。
****
設定
****
Sphinx の設定手順を説明します。
vscode/vscode.rst
#######
VS Code
#######
************
インストール
************
VS Code のインストール手順を説明します。
**********************
拡張機能をインストール
**********************
VS Code の拡張機能の説明とインストール手順を説明します。
github/github
######
GitHub
######
****************
リポジトリを作成
****************
リポジトリの作成手順を説明します。
**************
VS Code と連携
**************
VS Code との連携手順を説明します。
リンクテキスト
リンク先の rst ファイル名を < と > でくくって、リンクに表示する文字列（リンクテキスト）を設定します。
index.rst
##########
環境の説明
##########
:doc:`Miniconda のインストールと設定 <./miniconda/miniconda>` → :doc:`Sphinx のインストールと設定 <./sphinx/sphinx>` → :doc:`VS Code と拡張機能をインストール <./vscode/vscode>` → :doc:`GitHub でリポジトリの設定と VS Code との連携設定 <./github/github>` の順に環境を構築します。
.. toctree::
:hidden:
./miniconda/miniconda
./sphinx/sphinx
./vscode/vscode
./github/github
ラベル：ref
ドキュメント内にラベルを埋め込み、そのラベルにリンクを設定します。ラベルはドキュメント内でユニークでなければなりません。
※ファイルの配置は上述の「rst ファイル：doc」と同じです。
ラベルへリンクを設定
ラベル
ラベルは必ず見出しと遂に設定します。設定位置は見出しの直前です。
.. _ラベル名:
.. _miniconda: がラベルの定義で、 miniconda がラベル名です。
miniconda/miniconda.rst
.. _miniconda:
#########
Miniconda
#########
.. _miniconda-install:
************
インストール
************
Miniconda のインストール手順を説明します。
.. _miniconda-setting:
****
設定
****
Miniconda の設定手順を説明します。
sphinx/sphinx.rst
.. _sphinx:
######
Sphinx
######
.. _sphinx-install:
************
インストール
************
Sphinx のインストール手順を説明します。
.. _sphinx-setting:
****
設定
****
Sphinx の設定手順を説明します。
vscode/vscode.rst
.. _vscode:
#######
VS Code
#######
.. _vscode-install:
************
インストール
************
VS Code のインストール手順を説明します。
.. _vscode-extra:
**********************
拡張機能をインストール
**********************
VS Code の拡張機能の説明とインストール手順を説明します。
github/github.rst
.. _github:
######
GitHub
######
.. _github-repo:
****************
リポジトリを作成
****************
リポジトリの作成手順を説明します。
.. _github-vscode:
**************
VS Code と連携
**************
VS Code との連携手順を説明します。
リンクを設定
ref ディレクティブを使用し、ラベルにリンクを設定します。ラベルと対になる見出しがリンクテキストになります。ビルド後の表示に、ラベルは表示されません。
index.rst
.. _kankyo-setsumei:
##########
環境の説明
##########
環境構築に必要なソフトウェアです。
- :ref:`miniconda`
- :ref:`miniconda-install`
- :ref:`miniconda-setting`
- :ref:`sphinx`
- :ref:`sphinx-install`
- :ref:`sphinx-setting`
- :ref:`vscode`
- :ref:`vscode-install`
- :ref:`vscode-extra`
- :ref:`github`
- :ref:`github-repo`
- :ref:`github-vscode`
.. toctree::
:hidden:
./miniconda/miniconda
./sphinx/sphinx
./vscode/vscode
./github/github
リンクテキスト
ラベル名を < と > でくくって、リンクに表示する文字列（リンクテキスト）を設定します。
index.rst
.. _kankyo-setsumei:
##########
環境の説明
##########
環境構築に必要なソフトウェアです。
- :ref:`Miniconda の環境構築 <miniconda>`
- :ref:`Miniconda のインストール <miniconda-install>`
- :ref:`Miniconda の設定 <miniconda-setting>`
- :ref:`Sphinx の環境構築 <sphinx>`
- :ref:`Sphinx のインストール <sphinx-install>`
- :ref:`Sphinx の設定 <sphinx-setting>`
- :ref:`Microsoft Visual Studio Code の環境構築 <vscode>`
- :ref:`VS Code のインストール <vscode-install>`
- :ref:`便利な拡張機能 <vscode-extra>`
- :ref:`GitHub の設定 <github>`
- :ref:`ドキュメント用リポジトリを作成 <github-repo>`
- :ref:`VS Code との連携設定 <github-vscode>`
.. toctree::
:hidden:
./miniconda/miniconda
./sphinx/sphinx
./vscode/vscode
./github/github
その他
ここまでの例は toctree ディレクティブに hidden オプションを指定しました。リンクを設定するとき toctree ディレクティブに必ず hidden オプションを指定するのではなく、次のような使い方も可能です。
index.rst
.. _kankyo-setsumei:
##########
環境の説明
##########
.. _kankyo-setsumei-software:
****************************
環境構築に必要なソフトウェア
****************************
- :ref:`Miniconda の環境構築 <miniconda>`
- :ref:`Miniconda のインストール <miniconda-install>`
- :ref:`Miniconda の設定 <miniconda-setting>`
- :ref:`Sphinx の環境構築 <sphinx>`
- :ref:`Sphinx のインストール <sphinx-install>`
- :ref:`Sphinx の設定 <sphinx-setting>`
- :ref:`Microsoft Visual Studio Code の環境構築 <vscode>`
- :ref:`VS Code のインストール <vscode-install>`
- :ref:`便利な拡張機能 <vscode-extra>`
- :ref:`GitHub の設定 <github>`
- :ref:`ドキュメント用リポジトリを作成 <github-repo>`
- :ref:`VS Code との連携設定 <github-vscode>`
.. _kankyo-setsumei-sitemap:
************
サイトマップ
************
.. toctree::
./miniconda/miniconda
./sphinx/sphinx
./vscode/vscode
./github/github
