我正在用Sphinx写一些文档,我只想为HTML文档而不是LaTeX文档打印某些文本块。某事告诉我我应该可以做到这一点,sphinx.ext.ifconfig
但我不知道如何做到。有谁知道如何做到这一点?
不需要扩展名。只需使用only
指令即可。
(旧链接,摘自2010年的原始帖子)
https://web.archive.org/web/20100129001557/http://sphinx.pocoo.org/markup/misc.html#include-
content-based-on-
tags
(最新链接)
https://www.sphinx-
doc.org/zh/master/usage/restructuredtext/directives.html#include-content-
based-on-tags
它是这样的:
..仅::乳胶
此处的内容仅出现在乳胶输出中。
..仅:: html
此块中的内容仅出现在HTML输出中。它的
与该指令一起使用通常很有用:
.. raw :: html
这对于嵌入视频之类的东西很有用。
Sphinx 是一个工具,她能够轻易地创建智慧和优雅的文档,她是出自 Georg Brandl 之手,在BSD许可证下授权。
Sphinx简单来说,是一个文档生成工具,用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。 和 DocBook一样,Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧,大家一定都曾有过上学时用Word痛苦地修改论文 的
问题内容: 我有以下内容: 如何将其放入我的.rst文件?我这样写: 但是它仅打印而不是实际的URL。 如何获取要发出的实际配置值? 问题答案: 对于链接的替换, extlinks 很好,因为可以按照问题中的要求包含任意配置值,所以可以使用rst_epilog进行替换(或使用rst_prolog进行文本替换,应将其添加到.rst文件的顶部): 在您的conf.py中: 在您的.rst来源中: 我的
问题内容: 所以这是一个经常发生的问题,我没有资格解决它,但我需要解决它,因此我将必须学习。见这个问题的一个过时的/没有可行的解决方案,并为没有回答过类似的问题。 基本问题,我需要提供私有python模块的文档。该项目托管在gitlab上,我使用CI生成文档。它们对全世界都是可见的,这并不理想。这是一个已知问题,gitlab可能最终会提供解决方案。我等不了那么久。我的计划是使用此项目(crypto
问题内容: 我在Python项目源代码中有一个字典,描述了默认配置值。字典很长。我想在Sphinx文档中以除“查看源代码”之外的其他格式查看字典,以便人们可以快速检查默认值。 当与Sphinx autodoc一起使用时,Sphinx是否提供选项来格式化类似于字典的变量以实现人类可读的格式?我目前正在使用转储整个模块,并将字典作为文档中的一个长字符串转储(没有换行符,漂亮的打印内容,任何东西)来获取
问题内容: 我正在使用Sphinx记录非Python项目。我想在每个子模块中分发文件夹,其中包含用于记录该模块文件的文件。然后,我想将这些文件吸收到主层次结构中,以创建整个设计的规范。 即: 我试图像这样在主文档toctree中包含文件: 但是,此错误消息导致: 警告:toctree包含对不存在的文档u’modules / module1 / docs / module1’的引用 是否无法以某种方