1回答
项目的所有文档都是使用Sphinx创建的，对于REST，我想创建一些特殊的指令。:一样格式化一个或多个:param:的指令。，，我该怎么做？
浏览 3提问于2012-09-21得票数 16
这是"ReST删除线“的后续，但在Sphinx而不是ReST上下文中。我的问题是，在sphinx中是否有一个中心位置来放置“角色”指令，或者这个指令是否真的必须在sphinx文档中的每个rst文件中重复。更详细地说：.. role:: custom
This is an :cust
浏览 1提问于2012-03-14得票数 25
回答已采纳
我在Sphinx中创建了一个自定义指令'limitation‘，它提到了某个产品的“限制”。我希望将限制写在一个类似于'note‘或'warning’指令的彩色框中，并将' limitation‘写为标题，而不是'note’或'warning‘。我想让我的自定义指令“limitation”本身来处理这个问题。 有没有办法做到这一点？
浏览 9提问于2019-02-13得票数 2
我正在尝试使用Sphinx为我的每个方法创建一些HTML div。我认为这样做需要创建一个自定义指令，并告诉Sphinx如何解析它。
我该怎么做呢？
浏览 0提问于2011-08-29得票数 0
回答已采纳
我会在reStructuredText中自动编号代码块，如果自动编号是不可能的，然后手动命名/编号。我们不需要在文档本身中引用它们。
有没有可能呢？是开箱即用还是通过扩展Sphinx？
浏览 0提问于2014-09-23得票数 1
我继承了使用reStructuredText和Sphinx构建的用户指南，我们希望(也可以)从指南中生成一个使用rst2pdf与狮身人面像集成的PDF。我们想做的一件事是将自定义的页眉和页脚应用到文档的每一页(a‘’la“草稿-不是用于发布”或"Version x.y.z")，但是没有一种明显的方法(对我来说)。配置指令中似乎没有类似的选项可以在狮身人面像中指定。尽管RST确实支持头指令和脚指令，但Sphinx文档明确警告不要使用它
浏览 13提问于2022-08-02得票数 0
回答已采纳
5回答
Sphinx是一个Python库，用于从一组ReST格式的文本文件生成漂亮的文档。不是用于全文搜索的工具
我也完全了解doxygen / phpdoc工具。我想知道有没有办法使用Sphinx来记录PHP项目？或者其他任何非Python语言？
浏览 0提问于2009-11-18得票数 27
在中，我定义了自定义rst指令test_action和自定义狮身人面像构建器xmlexport，这样当我使用默认的sphinx构建器(通过make html)构建sphinx项目时，test_action指令被转换成单个html表，而对于xmlexport构建器，这些指令只是包装在div html标记中，而不需要进行任何额外的处理。为此，test_action指令生成自定义文档树节点，这些节点在使用
浏览 0提问于2018-03-18得票数 1
回答已采纳
1回答
}\n".format(what, name))
app.connect('autodoc-process-docstring', warn_undocumented_members) 有没有可能在Sphinx中冒泡警告？我发现的唯一一件事是在if子句中引发一个SphinxError，但这会停止构建，而不是收集所有警告。这也不尊重sphinx-build的-W标志(我总是有一个硬错误)。
浏览 31提问于2021-10-18得票数 1
回答已采纳
1回答
继Sphinx TODO directive教程之后，我做了一个Sphinx自定义指令(让我们称之为A)，它将文件路径作为输入，从该文件中提取信息，并相应地生成节点。我想要创建一个新的自定义指令(让我们称之为B)，它以目录作为输入，对目录中的所有文件调用指令A(对文件的搜索实际上比这稍微复杂一些，但它与我的问题无关)，并追加生成的节点。
我找不到该怎么做。我已经开始为这个指令B编写Python文件，但我不知道如何获得
浏览 6提问于2022-08-05得票数 2
ourserver\projects\project1-A\\ourserver\projects\project1-C
我希望能够在其中一个文件夹中创建一个从文档到
浏览 0提问于2014-03-14得票数 8
我试图使用Sphinx1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展为我的python类生成文档。我有很多模块，我希望每个模块只显示类名，而不是类中的完整方法列表(所有这些方法都在我的代码中有文档字符串)。documentation for getName print "hello"我只显示这个类的代码，以防我需要在文档字符串中</em
浏览 7提问于2016-04-02得票数 8
回答已采纳
我正在用Sphinx记录一个项目，我想创建一个专门版本的autoclass::指令，它允许我修改某些类的文档字符串。下面是我尝试过的一件事:搜索sphinx源代码，我发现autoclass指令是通过创建的。MyClassDocumenter)
问题是，当我运行它时，我得到一个错误：ERROR: Unknown directive type "py:myclass".似乎注册一个文档管理器不足以注册相关的指令，但是我在sphinx源代
浏览 3提问于2016-09-19得票数 1
我想要从一个模板创建几个文件，这个模板仅通过变量名来区别。例如：..在标题中，用"1“替换”声变量“很好，但在图像文件名中不起作用，在编译时我得到：
WARNING: image file not readable: .
浏览 4提问于2013-12-11得票数 17
回答已采纳
1回答
我已经编写了自定义的Ansible模块，并使用标准的Ansible约定对其进行了记录，即在模块文件中编写DOCUMENTATION和EXAMPLES全局字符串。我已经有了一些使用Sphinx 1.8.3生成并在本地托管的文档。我希望将Ansible文档包含在Sphinx生成的页面中。我的目录结构相当简单：├── __init__.py现在，我可以将文档编写为函数文档字符串，然后使用Sphinx</e
浏览 2提问于2018-12-31得票数 0
回答已采纳
如何在android studio中裁剪mapbox中的语音指令？我正在创建一个类似waze的应用程序，但它会警告用户即将出现的事故多发区域。我很难添加自定义的语音说明。请帮帮忙。
浏览 28提问于2020-04-18得票数 0
1回答
我感兴趣的是创建一个可以在Sphinx环境中使用的自定义语法高亮工具。这个是可能的吗？如果是这样的话，我该怎么做呢？
浏览 0提问于2013-05-10得票数 12
回答已采纳
1回答
在有关sphinx扩展的文档中，有一些“配置值”。例如在中。
但我不知道如何设置这些价值观。它是我必须设置的shell上的参数吗？
浏览 6提问于2022-03-03得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
云直播
对象存储
腾讯会议活动推荐
腾讯云开发者
