python-sphinx - 如果可能,我们如何在 rst 文件的代码部分中放置超链接?

标签 python-sphinx restructuredtext

我在 rst 文件中有以下内容:

.. code-block:: bash

   user@adi:~/workspace$ pytest
   test/test/functional/example/test_api_2.py
   --testbed test/test/topo_confs/pytest_tb.json
   --loglevel DEBUG --html /home/user/test.html --self-contained-html

现在我如何在 上放置超链接pytest_tb.json 那个代码中的词?

最佳答案

.. code-block::仅将语法高亮应用于文字代码,这意味着它不支持通过解释 reStructuredText 标记来支持超链接。

相反,您可以在 Sphinx 主题的 CSS 文件中使用自定义样式,假设名为 my-code-block ,并使用 reST 标记,如下所示。

在您的 CSS 文件中:

p.my-code-block {
    font-family: monospace;
    white-space: pre;
}

在你的rest源文件中:
.. rst-class:: my-code-block

    user@adi:~/workspace$ pytest
    test/test/functional/example/test_api_2.py
    --testbed test/test/topo_confs/`pytest_tb.json <relative/path/to/pytest_tb.json>`_
    --loglevel DEBUG --html /home/user/test.html --self-contained-html

请注意,不会应用 Pygments 中的 bash 语法突出显示。然而,您可能会喜欢并在 HTML 输出上使用 JavaScript 语法高亮显示,但是让 HTML 输出符合 JavaScript 的要求以及更新主题可能具有挑战性,而且比它值得的麻烦更多。

关于python-sphinx - 如果可能,我们如何在 rst 文件的代码部分中放置超链接?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/45499108/

相关文章:

markup - ReStructuredText 编号的标题

python-sphinx - ReStructuredText 中的粗体斜体

python - Sphinx - toctree 和内容之间有什么不同?

jupyter - 使用 ReadTheDocs 托管使用 Jupyter 创建的 Sphinx 文档

python - 'autodoc_default_flags' 在 python Sphinx 配置中如何工作?

python - 扩展第一个容器以输出额外的 div 属性

python - 自动类和实例属性

python - 有没有办法让类使用 sphinx 继承其父类(super class)的文档?

latex - 在 reStructuredText 希腊字母需要 "\\",其他希腊字母只有 "\"当目标是 pdf

python - 如何右对齐 reStructuredText 简单表中的列内容?