python-sphinx - 使 :manpage: provide a links to webpages

标签 python-sphinx

我正在 Sphinx 中创建教材,并且经常希望将学生重定向到给定的手册页。 Sphinx对此有一个很好的内部语法,例如:manpage:ls(1)。不幸的是,Sphinx 仅对此应用了一些格式,从而产生纯文本输出。我希望 Sphinx 使用给定的联机帮助页呈现指向某个网页的链接,类似于 :rfc: 标记的做法。

有办法吗?有没有一种方法可以轻松重写 :manpage: 宏,以便我可以实现此目的?

最佳答案

我找不到任何解决方案,因此我编写了一个提供 :linuxman: 角色并创建自定义链接的插件,源代码可在此处找到:https://github.com/tdi/sphinxcontrib-manpage

该插件在 pypi 上可用,您可以通过以下方式安装:pip install sphinxcontrib-manpage

用法与sphinx的:manpage:角色类似,只需编写::linuxman:ls(1)http://linux.die.net/man/1/ls的链接被生成。 url 可以在conf.py 中配置。

关于python-sphinx - 使 :manpage: provide a links to webpages,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/19069402/

相关文章:

python - 让 sphinx 在用装饰器包裹时显示函数参数

numpy - Sphinx Autodoc 和 NumpyDoc

python - Sphinx 自动摘要生成表中的自动换行

python - 错误: command 'gpg' failed with exit status 2 when create a dist of Sphinx python package

python-sphinx - reStructuredText 换行符会破坏代码块

python - 在 Sphinx 中禁用语法突出显示(Alabaster 主题)

Ruby 等同于 Sphinx 文档生成器?

python - 强制解包某些 egg 目录

python-sphinx - 使用 Read The Docs & Sphinx 和 ReadTheDocs 主题时删除在 Github 上的编辑链接

python - 使 View 代码显示模块源