Python
Java
PHP
IOS
Android
Nodejs
JavaScript
Html5
Windows
Ubuntu
Linux
嵌套/复合角色:将多个角色应用于重叠文本
In my custom css我有的文件 bold font weight bold red color red 而在我的 rst file role bold role red 但如果我尝试嵌套 复合它们 只有最外面的角色才会生效 例如
pythonsphinx
reStructuredText
RestructedText 文档中的行距不一致
我正在为我公司的文档构建 RST 文件 一件令人恼火的事情是 枚举列表在行距方面似乎没有任何一致性 有没有简单的方法来解决这个问题 Robert 这是一个众所周知的问题docutils Sphinx 构建的库 来自 GitHub 上的 Sp
pythonsphinx
reStructuredText
Python 将 sphinx RST 转换为 HTML
我试过这段代码 from docutils core import publish string text publish string open file path r read writer name html 但它说 p Unknow
pythonsphinx
reStructuredText
docutils
变量替换在 Sphinx 中无法正常工作
我有一个用以下内容制作的文档项目Sphinx http www sphinx doc org en stable 我通过配置键使用全局变量rst epilog My conf py文件包含以下内容 rst epilog MY VERSION
python
versioning
pythonsphinx
substitution
reStructuredText
在 Sphinx 中,有没有办法在声明参数的同时记录参数?
我更喜欢在声明参数的同一行记录每个参数 根据需要 以便应用D R Y http en wikipedia org wiki Don t repeat yourself 如果我有这样的代码 def foo flab nickers a ser
python
reStructuredText
pythonsphinx
用于类工厂/选择器的 python rtype 文档字符串/重构文本
rtype 指定这是返回对象的类型 因此 当我创建对象时obj在下面的代码片段中 我收到来自 IDE 的警告 cls is not callable 因为 IDE 期望cls is object类型的SomeAbstractClass 而且
python
pycharm
reStructuredText
docstring
Sphinx内联代码高亮
我使用 Sphinx 制作一个包含代码示例的网站 我成功地使用了 code block获取语 法高亮的指令 但我无法使用此代码获得内联语法突出显示 role bash code language bash Test inline bash
css
syntaxhighlighting
pythonsphinx
reStructuredText
pygments
如何在代码块中包含内部引用?
在我的 Sphinx rst 文档中 我有一个代码块 其中包含使用 UNIX 的产品结构的树视图tree命令 parent child grandchild 它位于代码块中 以便 Sphinx 保留空格 我希望读者能够单击每个节点来关注内部
pythonsphinx
reStructuredText
reStructuredText 页面中的非 TOC 标题
我正在使用 Sphinx 编写一些文档 有没有一种方法可以格式化页面中不成为目录一部分的标题 理想情况下 有一些反映在格式中的层次结构吗 例如 我想要做 My page TOC heading Subheading not in TOC a
pythonsphinx
reStructuredText
sections
tableofcontents
reStructuredText:README.rst 未在 PyPI 上解析
我有一个托管在 Github 和 PyPI 上的 Python 项目 在 Github 上 https github com sloria TextBlob blob master README rst https github com s
python
reStructuredText
PyPI
用于将一个文档包含到另一个文档中的 sphinx 指令是什么?
在我的文档中我有一个examples我可以说的目录 literalinclude examples 1 basic usage py language python linenos 效果很好 因为它们是代码 并且它们的格式正确为代码 但是
python
pythonsphinx
reStructuredText
如何处理 ReST 中的两个破折号
我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序 我希望能够记录命令行选项 例如 region像这样 region
pythonsphinx
reStructuredText
在 Sphinx 中的引用中保留内联代码
在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som
pythonsphinx
reStructuredText
crossreference
通过 :ref:? 从 ReST 文档中提取文本块
我有一些 reStructuredText 文档 我想在在线帮助中使用其中的片段 似乎一种方法是通过引用 剪掉 标记片段 例如 my boring section Introductory prose blah blah blah my i
python
pythonsphinx
reStructuredText
docutils
如何在节标题和段落之间添加额外的空格
我希望标题和段落之间以及段落之间有更多的空间 我不希望这是一个全局设置 但我想在需要的地方和时间使用它 感谢任何建议 您可以在行首使用竖线在输出中生成空行 像这样 Heading Paragraph with text
python
pythonsphinx
reStructuredText
摆脱 Sphinx 中的“重复标签”警告
在 Sphinx 中 我收到大量警告 例如 PATH FILENAME LINE WARNING duplicate label LABELNAME other instance in PATH FILENAME 似乎将所有节标题视为 标签
markdown
pythonsphinx
reStructuredText
commonmark
如何交叉引用 Sphinx 中 autodoc 生成的函数?
我正在使用Sphinx autodoc根据我的 Python 库的文档字符串生成文档的功能 找到交叉引用的语法here http sphinx doc org markup inline html ref role 该部分之前必须有一个标签
python
Methods
pythonsphinx
reStructuredText
autodoc
Python 文档的 reStructuredText 有真正的替代品吗? [关闭]
Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我很快就要开始一个开源 Python 项目 并且我试图提前决定如何编写我的文档字符串 显而易见的答案是
python
pythonsphinx
reStructuredText
docstring
我可以在 reStructuredText 中使用内联原始 LaTeX
我正在尝试将 LaTeX 变量嵌入到一些 reStructuredText 中 我知道 raw 指令 但我希望将其嵌入到文本段落中 具体来说 我希望从模板考试文档中复制 numquestions 和 numpoints 变量 我尝试过使用
latex
reStructuredText
Sphinx 文档中人类可读的迭代
Sphinx autodoc 扁平化字典 列表和元组 使得长的几乎难以阅读 漂亮的打印格式也并不总是需要的 因为一些嵌套容器最好保持扁平化而不是列化 有没有办法显示可迭代对象as typed在源代码中 直接从源获取它 并添加一个 rst其命
pythonsphinx
reStructuredText
autodoc
1
2
3
4
5
»