3

私はSphinxドキュメントを生成しており、理想的にはdocstringをコードでできるだけ読みやすくしたいので、reStructuredTextを最小限に抑えながら、Docstringから直接Sphinxドキュメントをできるだけ多く生成したいと思います。

特に、可能な限りURLをドキュメント文字列から除外し、邪魔にならない場所にURLを配置し、必要に応じてリンクテキストをコードとしてフォーマットできるようにしたいと考えています。しかし、これらすべてのことをどのように行うかは明確ではありません。例えば、

Sadly, `git`_, though it works as a link, does not format `git` as code, 
while ``git``_ generates an error; and `git <http://git-scm.com>`_ 
again does not format `git` while ``git` <http://git-scm.com>`_ is 
again an error.
.. _`git`:  http://git-scm.com

拡張機能、設定、またはその他のマークアップを使用して、次のようなコンパクトなものを使用できますか?

`git`_

またはのような置換

:git:

コード形式のリンクを生成しますか?

4

0 に答える 0