Сфинкс и Markdown .md ссылки - PullRequest
Новая
       4

Сфинкс и Markdown .md ссылки

0 голосов
/ 25 сентября 2018

Я пытаюсь преобразовать файлы Markdown в html, используя Sphinx, но у меня возникают проблемы с переводом [links](another.md) в <a href="another.html">links</a>, скорее расширение цели остается исходным .md и выглядит как <a href="another.md">links</a>.

Я создал простой пример ...

test.md 

[Test link](https://www.stackoverflow.com)

[Another Markdown doc](another.md)

another.md 

# Another test markdown

Оба файла находятся в каталоге верхнего уровня, и я запускаю sphinx-quickstart, чтобы создать conf.py, принимая значения по умолчанию.Затем я изменяю conf.py, чтобы иметь ... 

from recommonmark.parser import CommonMarkParser
extensions = [
    'sphinx.ext.autodoc',
]
source_suffix = ['.rst', '.md']
source_parsers = {
    '.md': CommonMarkParser,
}

Полученные html-файлы создаются, но ссылка с test.html на another.html неверна и выглядит как ...

test.html 

...
<p><a class="reference external" href="https://thefloow.com">Test link</a></p>
<p><a class="reference external" href="another.md">A real test</a></p>
...

... и указывает на another.md вместо another.html.Я спросил несколько дней назад, и мне было предложено использовать AutoStructify Recommonmark (см. Нить здесь ), но это не сработало, и при дальнейшем копании / чтении выясняется, что enable_auto_doc_ref сейчасустаревшие и .md ссылки добавляются как :any: и должны обрабатываться Sphinx .

Но я не понимаю, почему это не работает или что мне следуетсделать, чтобы решить это.Любые предложения будут очень признательны.

РЕДАКТИРОВАТЬ

Версии следующие

  • Сфинкс 1.8.0
  • Recommonmark 0.4.0

1 Ответ

0 голосов
/ 02 января 2019

recommonmark==0.5.0.dev0 решает эту проблему.

conf.py конфигурация 

extensions = [
    # other
    'recommonmark',
]

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

pip конфигурация (requirements.txt) 

sphinx==1.8.2
# recommonmark==0.5.0.dev0
git+https://github.com/rtfd/recommonmark

Пожалуйста, обратитесь кhttps://www.sphinx -doc.org / ru / master / использовании / markdown.html , если вам нужна дополнительная информация.

...