python-sphinx

    2热度

    1回答

    我可以使用recommonmark在Sphinx中呈现我的Readme.md文件。但是,当我尝试在.rst文件中添加多个自述文件时,只能从文档链接访问第一个文件。 Kick! KVM ========= Source Code: https://bitbucket-eng-rtp1.cisco.com/bitbucket/projects/KICK/repos/kickdb/browse/k

    2热度

    2回答

    看起来像sphinx.ext.autodoc已经成为Python文档字符串中类似“JavaDoc”注释的事实标准。 Sphinx用于在docs.python.org生成文档。但它是否从Python源文件.py文件(使用autodoc)读取文档到docs.python.org上? library section of the docs包括逐个方法的摘要,但这些摘要与文本无缝显示。他们是否与源代码中的

    2热度

    1回答

    我使用美妙的狮身人面像工具来创建一些文档,我需要创建一个自定义的HTML div,以便我可以将它与斯芬克斯的其他自动创建的div区分开来。 这是可能的使用container directive做的,但问题是,如果我用一个subsubsection低于这个指令,它会自动嵌套与容器指令创建的专区内的subsubsection,像这样: <div id="automatically-created sp

    0热度

    2回答

    有没有人成功链接到scikit-intersphinx学习。这是一个斯芬克斯项目,它看起来像它的通过GitHub的网页托管 https://github.com/scikit-learn/scikit-learn.github.io 但到目前为止,我还没有能够产生在我的狮身人面像的项目完成链接的土地上scikit学习 当前页面在我interspinx映射使用 'sklearn': ('http:/

    0热度

    2回答

    我花了无数个小时,但仍然卡住了。文件是如此缺乏。使用Django 1.10,尝试创建一直给出各种错误的Sphinx文档。最后我被困在这里。我在我的主应用程序kyc_connect中创建了一个示例模型,如下所示。 Models.py from django.db import models class example(models.Model): filed1 = models.Da

    0热度

    1回答

    所以我正在为我的库编写PHP文档。 我使用“sphinxcontrib.phpdomain”扩展名来支持PHP域。 比方说,我已经定义了下列文件: .. toctree:: :numbered: :maxdepth: 3 :caption: Couch .. php:class:: Couch This is the low-level class t

    0热度

    1回答

    所以这是一个重复发生的问题,我没有资格解决它,但我需要它修复,所以我将不得不学习。请参阅this question以了解过时的/不可行的解决方案,并且for a similar question without answer. 基本问题,我需要为私有python模块提供文档。该项目托管在gitlab上,我使用CI来生成文档。它们对世界而言是可见的,这并不理想。这是一个known issue,git

    0热度

    1回答

    有没有办法在sphinx中的表格中为特定的行着色? 我尝试使用..角色::这是关于一个CSS文件作为讨论在sphinx, restructuredtext: set color for a single word。然而,a:角色:似乎不适用于表格。

    1热度

    1回答

    我曾尝试这样的代码: from docutils.core import publish_string text = publish_string(open(file_path, 'r').read(), writer_name='html') 但它说: <p>Unknown directive type "toctree".</p> 所以不会有一些具体的狮身人面像的

    0热度

    1回答

    我一直在为我的Python文件设置自动文档,这些文件位于目录结构的大型层次结构中。我能够用我的脚本和使用autodoc模块为它们生成rst和html文件。我想知道是否可以在与Python文件相同的目录结构/目录结构中生成rst和html文件。 例如,我的python文件的相对路径是:python/common/element.py; 生成的第一个文件是:python.common.element.