Markdown Sphinx Recommonmark CommonMarkParser未检测到URL链接
我正在使用Sphinx从降价文件中构建文档。 文档非常清楚,myst解析器应该以典型的Markdown Sphinx Recommonmark CommonMarkParser未检测到URL链接,markdown,python-sphinx,myst,Markdown,Python Sphinx,Myst,我正在使用Sphinx从降价文件中构建文档。 文档非常清楚,myst解析器应该以典型的[some text](www.example.com)方式处理标记链接 随后,我安装了myst解析器,设置扩展名extensions=['myst\u parser'],并指定了源后缀: source\u后缀={ “.rst”:“restructuredtext”, “.txt”:“降价”, “.md”:“降价”, } 遗憾的是,链接没有正确转换,只是显示为以下HTML格式: [一些文本]() 然后在浏览
[some text](www.example.com)
方式处理标记链接
随后,我安装了myst解析器,设置扩展名extensions=['myst\u parser']
,并指定了源后缀:
source\u后缀={
“.rst”:“restructuredtext”,
“.txt”:“降价”,
“.md”:“降价”,
}
遗憾的是,链接没有正确转换,只是显示为以下HTML格式:
[一些文本]()
然后在浏览器中以以下方式显示[某些文本](www.example.com)
,这显然不是预期的链接
我还尝试以以下方式使用RecomonMark:
从recomonmark.parser导入CommonMarkParser
源解析程序={
“.md”:CommonMarkParser,
}
source_后缀=['.rst','.md']
如前所述和,但最终的输出相同。
如何解决这个相当简单的问题
正在使用的版本:
建议0.7.1
myst解析器0.13.6
斯芬克斯3.5.4
python 3.9.2
编辑
在这里找到更新的conf.py文件
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
import sphinx_rtd_theme
import sys
import os
print("CURRENT WORKING DIRECTORY")
print(os.getcwd())
print('adding path')
sys.path.insert(0, r'path_to_repo')
print(sys.path)
# At top on conf.py (with other import statements)
import recommonmark
from recommonmark.transform import AutoStructify
from recommonmark.parser import CommonMarkParser
# -- Project information -----------------------------------------------------
project = 'py_neuromodulation'
copyright = '2021, John Doe'
author = 'John Doe'
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'numpydoc',
'sphinx_rtd_theme',
'sphinx.ext.napoleon',
'recommonmark'
]
autosummary_generate = True
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
# At the bottom of conf.py
def setup(app):
app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
}, True)
app.add_transform(AutoStructify)
默认情况下,必须包含用于外部链接的协议 但是,如果要在不使用协议的情况下使用裸链接,请使用: 将“
linkify
”添加到myst\u enable\u extensions
(在sphinxconf.py
中)将自动识别“裸”web URL并添加超链接:
www.example.com
->
此扩展需要已安装的。要么直接pip安装linkify it py
或通过pip安装myst解析器[linkify]
如果答案解决了您的问题,请不要忘记在答案的左侧向上投票。不幸的是,它没有解决问题,我添加了conf.py以获取更多详细信息提示RecomonMark不赞成使用myst解析器。不幸的是,这没有解决[text]中不支持标记链接的问题(链接)方式。我试图在上面概述recommonmark理论上应该解决这个问题,但是自动构造也会导致相同的结果您的
conf.py
没有显示您添加了linkify
。你试过了吗,如MyST的文档所述?