jjzjj

reStructuredText

全部标签

python - 如何在 Sphinx 中创建自定义指令

我目前正在记录用Python编写的restAPI。该项目的所有文档都是使用Sphinx创建的,对于RESTAPI,我想创建一些特殊指令。例如,假设我定义了这个资源:@resource("/user/",method="GET")defuser_details(email):"""Returnsdetailedinformationaboutauseraccount.:resourceGET:/user/:query_parama_param:Somekindofqueryparam."""#Dostuffandreturnuserdetails这基本上就是文档当前的样子。我希望能够为S

python - 如何在 Sphinx 中创建自定义指令

我目前正在记录用Python编写的restAPI。该项目的所有文档都是使用Sphinx创建的,对于RESTAPI,我想创建一些特殊指令。例如,假设我定义了这个资源:@resource("/user/",method="GET")defuser_details(email):"""Returnsdetailedinformationaboutauseraccount.:resourceGET:/user/:query_parama_param:Somekindofqueryparam."""#Dostuffandreturnuserdetails这基本上就是文档当前的样子。我希望能够为S

python - Sphinx 和 Docstrings 中的 reStructuredText : single vs. 双反引号或反引号差异

从文档来看,双反引号似乎用于文字,而当有代码文本要解释时使用单反引号。这将引导我为下面的方法f()编写文档字符串:classA(B):deff(arg1,arg2):returnB(arg1+arg2+self.index)作为:Takestwoarguments,``arg1`and``arg2``,whichareassumedtobeobjectsoftype(orduck-type)`NiceClass`,andreturnsanewobjectofclass`B`with`B.something`assignedsomehashof``arg1``and``arg2``.这对

python - Sphinx 和 Docstrings 中的 reStructuredText : single vs. 双反引号或反引号差异

从文档来看,双反引号似乎用于文字,而当有代码文本要解释时使用单反引号。这将引导我为下面的方法f()编写文档字符串:classA(B):deff(arg1,arg2):returnB(arg1+arg2+self.index)作为:Takestwoarguments,``arg1`and``arg2``,whichareassumedtobeobjectsoftype(orduck-type)`NiceClass`,andreturnsanewobjectofclass`B`with`B.something`assignedsomehashof``arg1``and``arg2``.这对

python - jinja2 + 重构标记

思路如下。我使用类似于stackoverflow的标签向jinja2发送一些文本。我如何告诉jinja2将它们视为包含文本的标记并在html中生成粗体、斜体等文本?谢谢。 最佳答案 我习惯了django-markdown,所以我认为使用过滤器是实现此目的的好方法:{{article.body|rst}}我不知道jinja2是否存在这样的过滤器,但是itshouldbeveryeasytowrite.我猜这行(未经测试的代码):fromdocutils.coreimportpublish_partsimportjinja2defrst

python - jinja2 + 重构标记

思路如下。我使用类似于stackoverflow的标签向jinja2发送一些文本。我如何告诉jinja2将它们视为包含文本的标记并在html中生成粗体、斜体等文本?谢谢。 最佳答案 我习惯了django-markdown,所以我认为使用过滤器是实现此目的的好方法:{{article.body|rst}}我不知道jinja2是否存在这样的过滤器,但是itshouldbeveryeasytowrite.我猜这行(未经测试的代码):fromdocutils.coreimportpublish_partsimportjinja2defrst

html - 将 CSS 类添加到 RST 中的链接

我的.rst文件中有一个链接,看起来像Clickme!这呈现为Clickme!。但是,我想向它添加一个CSS类,以便它看起来像Clickme!。我将下面这行添加到我的RST文件的顶部:role::example然后我把我的链接改成这样:示例:Clickme!但是,此RST呈现为:example:点我!_反而。:(我认为使用..role::是在RST中向文本添加CSS的最佳方式。我需要为链接做些特别的事情吗? 最佳答案 这也给我带来了一些麻烦。这个解决方案不是很好,但我能够做我需要的,所以希望它能帮助你。它基本上在您的类的链接周围添加

html - 将 CSS 类添加到 RST 中的链接

我的.rst文件中有一个链接,看起来像Clickme!这呈现为Clickme!。但是,我想向它添加一个CSS类,以便它看起来像Clickme!。我将下面这行添加到我的RST文件的顶部:role::example然后我把我的链接改成这样:示例:Clickme!但是,此RST呈现为:example:点我!_反而。:(我认为使用..role::是在RST中向文本添加CSS的最佳方式。我需要为链接做些特别的事情吗? 最佳答案 这也给我带来了一些麻烦。这个解决方案不是很好,但我能够做我需要的,所以希望它能帮助你。它基本上在您的类的链接周围添加

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

如何将颜色用于ReStructuredText?例如,**hello**翻译成hello.我怎样才能让ReStructure(rst2html.py)将something翻译成text?我考虑过..raw::html,但它引入了空行。我想插入没有空行的HTML标记。 最佳答案 我发现这个方法有效首先,你有这个角色。..role::redAnexampleofusing:red:`interpretedtext`翻译成如下。Anexampleofusinginterpretedtext现在,你有了红色类,你可以使用CSS来改变颜色。.

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

如何将颜色用于ReStructuredText?例如,**hello**翻译成hello.我怎样才能让ReStructure(rst2html.py)将something翻译成text?我考虑过..raw::html,但它引入了空行。我想插入没有空行的HTML标记。 最佳答案 我发现这个方法有效首先,你有这个角色。..role::redAnexampleofusing:red:`interpretedtext`翻译成如下。Anexampleofusinginterpretedtext现在,你有了红色类,你可以使用CSS来改变颜色。.