Sphinx

作成日:2022.1.10(月)、変更日:22022.1.10(月)


SphinxはPythonで作られた文書作成ツールで、reStructectedTextで書かれたソースコードをHTMLやPDFなどの形式コンパイル(変換)できる。

Sphinxの使い方を書いていく。

Escapeの書き方

Escapeとは、プログラミング言語の中の特殊文字を通常のテキストとして解釈するようにするための書方。

Escapeしたい特殊文字の前に、Backslash(\)を記入する。[1]

例えば、以下のコードで「%」をescapeしたい場合、

好評率:100%

以下のように「%」の前に「\」を書けば良い。

好評率:100\%

参考資料