标签: restructuredtext

在ReStructuredText中加粗斜体

我正在使用ReStructuredText(ReST)格式编写一些文档,以便稍后使用Sphinx生成Web页面,我找不到编写一些"粗体斜体"文本的方法.

所谓的"强调"(斜体)和"强调"(粗体)文本都有标记.他们*italic text*和**bold text**分别.我还阅读了一些关于这种格式的文档,这些格式标记不能简单地"嵌套".即***text***(或** *text* **)不产生粗体斜体文本.

仍然可能有某种方式来生成一个用粗体和斜体标记强调的文本,因为通过这种方式标记文本片段是一种普遍的做法.

documentation restructuredtext python-sphinx

40
推荐指数
3
解决办法
9741
查看次数

如何在重组文本中注释字符串?

HTML的评论是<!-- .. -->,如何使用重组文本制作此注释块?换句话说,如何在重组文本中注释掉一些行?

html restructuredtext

36
推荐指数
4
解决办法
1万
查看次数

在reStructuredText中的新窗口中打开一个链接

我想使用reStucturedText在新窗口中打开一个链接.这可能吗?

这将在同一窗口中打开链接:

You can `check your location here. <http://geoiptool.com>`_
Run Code Online (Sandbox Code Playgroud)

restructuredtext

36
推荐指数
3
解决办法
8488
查看次数

在Sphinx中保留引用中的内联代码

在Sphinx中,如果我有以下标题声明:

.. _somestuff:

``this is code``, this is not!
==============================
Run Code Online (Sandbox Code Playgroud)

它渲染,像这样:

    this is code, 这不是!

哪个好,但是,如果我使用参考,例如:

Have a look at :ref:`somestuff`
Run Code Online (Sandbox Code Playgroud)

它丢失了代码格式并呈现如下:

    看看这是代码,这不是!

代替:

    看看this is code,这不是!


是否可以在引用中保留代码格式?我该怎么办呢?

documentation restructuredtext documentation-generation python-sphinx

35
推荐指数
1
解决办法
1123
查看次数

如何链接/引用文档中的其他reST文件?

我根本不知道如何链接到reST文件中的另一个文档.

我想install.rst在段落中链接一个名为我的快速入门指南的文件.我不知道如何实现这一目标.

请你也可以参考一个很好的资源,从那里我可以查找语法休息.默认的快速入门有点无聊,并没有涉及使用sphinx休息的深入讨论.

有问题的文件是:http://todx.rtfd.io

restructuredtext python-sphinx read-the-docs

34
推荐指数
4
解决办法
2万
查看次数

您如何获得Texinfo Info格式的Python文档?

从Python 2.6开始,文档似乎采用了新的reStructuredText格式,并且现在开始构建Texinfo Info文件似乎并不容易.

我是Emacs上瘾者,更喜欢我在Info中安装的文档.

有没有人用Texinfo格式的Python 2.6或更高版本的文档?你是怎么转换它们的?或者,那里有某个维护的构建吗?

我知道我可以使用w3m或haddoc来查看html文档 - 我真的希望它们在Info中.

我和Pandoc一起玩过,但是经过一些小小的实验后,它似乎并不能很好地处理文档之间的链接,我的大型实验 - 在所有文档中运行它以便看到会发生什么 - 仍然在两天内徘徊自从我开始吧!

两个好的答案

突出显示以下两个答案,因为SO不允许我接受这两个答案:

  • @ wilfred-hughes:从MELPA安装是将预构建信息导入Emacs的最快方法
  • @alioth:自己构建它看起来比我在2009年提出这个问题时容易得多

python emacs restructuredtext texinfo

31
推荐指数
3
解决办法
4711
查看次数

如何使用sphinx首先链接到文件?

我正在撰写文档,我想包含pdf文件或zip档案的链接.如何使用第一语言和狮身人面像实现这一目标?

如果我这样做

here is a pdf file : `pdf <doc/mypdf.pdf>`_
Run Code Online (Sandbox Code Playgroud)

它不起作用,因为在编译期间sphinx不复制doc目录的包含(我使用sphinx-quickstart生成的makefile).

相反,使用image指令:

.. image:: img/plop.png
Run Code Online (Sandbox Code Playgroud)

sphinx会在构建目录中复制plop.png图像.如何获得pdf或zip存档的相同行为?

restructuredtext python-sphinx

31
推荐指数
1
解决办法
2万
查看次数

在Sphinx和reStructuredText中使用数字引用数字

在编写将使用Sphinx处理的RST时,我无法在引用数字时使用Sphinx LaTeX输出来使用图号.例如,这段代码:

The lemmings are attacking, as can be seen in :ref:`figlem`.

.. _figlem:

.. figure:: _static/lemming_invasion.* 

   They're coming!
Run Code Online (Sandbox Code Playgroud)

将转换成这个:

旅行者正在攻击,正如他们即将到来的那样!

/ image到这里/

图1.1:他们来了!

但我想要的是"标准"LaTeX引用数字的方式,如下所示:

旅鼠正在攻击,如图1.1所示

我该如何实现这一目标?我目前使用的代码是Sphinx手册推荐的代码,但它不会产生我想要的输出.

restructuredtext python-sphinx

30
推荐指数
3
解决办法
1万
查看次数

Sphinx代码块中的替换

在这个reST示例意味着由Sphinx呈现,| yaco_url | 不会被替换,因为它在代码块中:

.. |yaco_url| replace:: http://yaco.es/

You can use wget to download it:

.. code-block:: console

    $ wget |yaco_url|package.tar.gz
Run Code Online (Sandbox Code Playgroud)

我想知道是否有某种方法可以强制更换| yaco_url | 在渲染代码块之前.

python restructuredtext python-sphinx

30
推荐指数
2
解决办法
3732
查看次数

如何使用ReStructured Text(rst2html.py)在文本中使用颜色或如何插入没有空行的HTML标签?

如何在ReStructured Text中使用颜色?例如,**hello**翻译成<strong>hello</strong>.我怎样才能使重组(rst2html.py)翻译的东西 成<font color="####">text</font>?

我想过..raw :: html,但它引入了空白行.我想插入没有空行的HTML标签.

html restructuredtext rst2html.py

28
推荐指数
3
解决办法
2万
查看次数