Posted at

SphinxでMarkdownを使うときに注意すること

More than 3 years have passed since last update.

SphinxでMarkdownを使うときにつまずいた。


参考にしたページ


  1. http://blog.readthedocs.com/adding-markdown-support/

  2. https://github.com/rtfd/recommonmark/issues/24


問題

私の場合、下記のような状況でした。2.を読んでみるとversionがあっていなかったので、versionを合わしてあげたら実行できるようになりました。


from recommonmark.parser import CommonMarkParser
....
ImportError: cannot import name DocParser


やった事

$ pip install recommonmark==0.4.0

Sphinxプロジェクトのconf.pyの中を編集

from recommonmark.parser import CommonMarkParser

source_parsers = {'.md': CommonMarkParser}

source_suffix = ['.rst', '.md']