インラインマークアップ前後にスペースを入れたくない¶
Sphinxが使っているreSturucturedTextでは、インラインマークアップの前後にスペースが必要でした。スペースなしでは単語の区切りを認識しないため、インラインマークアップが無視されます。
SphinxでHTMLファイルをビルドするときは ``make html`` とタイプします。
SphinxでHTMLファイルをビルドするときは``make html``とタイプします。
このスペースを除外する方法がいくつかあります。
エスケープ + スペース¶
前後のスペースの前にバックスラッシュを置いて、スペースをエスケープします。
SphinxでHTMLファイルをビルドするときは\ ``make html``\ とタイプします。
Docutilsのcharacter-level-inline-markup
オプション¶
Python.jpの世話人をしてくださっている石本さんがパッチを送り、マージしてもらったオプション がDocutilsの0.13に入りました。このオプションを有効化すると、スペースなしでもインラインマークアップが解釈されるようになります。
Sphinxから使うには、 docutils.conf
というファイルを作り、 conf.py
と同じ場所において普段通り実行します。
[restructuredtext parser]
character_level_inline_markup: yes
これで、最初に紹介したNGの例のときに正しく解釈されるようになります。ただし、注意点としては、多くのエディタなどがこの形式をサポートしていない点です。下記のハイライトもそうですが、多くのツールがまだ解釈できないため、ソースのハイライトがおかしくなることがあります。
SphinxでHTMLファイルをビルドするときは``make html``とタイプします。
なお、このオプションはパーサーの動作に影響を与える強い副作用をともないます。インラインマークアップで使用する各文字をエスケープしなければなりません。
|
URLではなく、 |
---|---|
|
|
|
強調テキストの開始として解釈される |
|
置換の参照の開始として解釈される |
参考¶
この項目はreSturucturedTextを書く際の空白を入れたくない場合に関するものです。
不自然な空白が表示されるに書かれているjapanesesupportを使うと、HTML出力時に不自然なスペースを削除できます。