Furo

Sphinx 是一个工具，她能够轻易地创建智慧和优雅的文档，她是出自 Georg Brandl 之手，在BSD许可证下授权。

Sphinx简单来说，是一个文档生成工具，用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。 和 DocBook一样，Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧，大家一定都曾有过上学时用Word痛苦地修改论文 的

问题内容： 我正在使用Sphinx记录非Python项目。我想在每个子模块中分发文件夹，其中包含用于记录该模块文件的文件。然后，我想将这些文件吸收到主层次结构中，以创建整个设计的规范。 即： 我试图像这样在主文档toctree中包含文件： 但是，此错误消息导致： 警告：toctree包含对不存在的文档u’modules / module1 / docs / module1’的引用 是否无法以某种方

问题内容： 我正在用Sphinx写一些文档，我只想为HTML文档而不是LaTeX文档打印某些文本块。某事告诉我我应该可以做到这一点，但我不知道如何做到。有谁知道如何做到这一点？ 问题答案： 不需要扩展名。只需使用指令即可。 （旧链接，摘自2010年的原始帖子） https://web.archive.org/web/20100129001557/http://sphinx.pocoo.org/ma

问题内容： 所以这是一个经常发生的问题，我没有资格解决它，但我需要解决它，因此我将必须学习。见这个问题的一个过时的/没有可行的解决方案，并为没有回答过类似的问题。 基本问题，我需要提供私有python模块的文档。该项目托管在gitlab上，我使用CI生成文档。它们对全世界都是可见的，这并不理想。这是一个已知问题，gitlab可能最终会提供解决方案。我等不了那么久。我的计划是使用此项目（crypto

运行api服务后，我的swagger文档位于localhost： port/docs。这将显示我所有的api。无论如何，是否只显示某些api或某些标签下的api？ 也许某个标签下的所有api都有不同的文档url？ 我正在用快递运行它。