autodoc

    1热度

    1回答

    我正在使用Sphinx autodoc扩展来记录我的Python项目。我在我的文档下面的一类: .. automodule:: ClassName :members: :undoc-members: :show-inheritance: 我记录类有,我不想在文档中包含静态成员。有没有办法做到这一点?

    2热度

    1回答

    我有this python package,我想用Sphinx自动生成文档。我已经在每个函数和类中插入了文档字符串。 我在ReadTheDocs上创建了一个帐户,并做了相应的设置(即docs/ dir和conf.py文件)。然后,基本上,我已经尝试了几乎所有的东西:autodoc::,autofunction::,autoclass::;我尝试使用相同的conf.py文件作为记录API的其他软件包

    0热度

    1回答

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

    0热度

    1回答

    我想通过狮身人面像生成我的项目的autodocumentation。但是,我将在一个没有导入所有模块的环境中运行autodocs。因此,我想嘲笑进口报表。 在http://read-the-docs.readthedocs.io/en/latest/faq.html我发现这招对C模块: import sys from unittest.mock import MagicMock class

    4热度

    1回答

    class Parameters(dict): """ Some doc here """ pass class System(object): Parameter = Parameters """ The default parameters attribute builder """ def __init__(self): s

    1热度

    1回答

    在斯芬克斯可能包括的函数或方法手动使用py:function(或py:method)指令的签名: .. py:function:: my_func(data, named=None, *args, *kwargs) 另外,也可以使用autodoc指令包含和格式化的整个文档字符串一个函数或方法: .. automethod:: my_func 我想知道是否有配置autodoc包括和格式只有签

    4热度

    1回答

    我有一个使用Read-The-Docs主题的编程生成的sphinx-doc源文件。源代码树的样子: source ├── conf.py ├── index.rst ├── models │   ├── 1lin │   │   ├── 1lin_Amplero.rst │   │   ├── 1lin_Blodgett.rst │   │   ├── 1lin_Bugac.rst

    0热度

    1回答

    我尝试使用autodoc制作html时出现错误。 这里是我的项目结构: projet --- app1 ------ models.py ------ views.py --- app2 --- app3 docs --- modules ------ models.rst --- conf.py --- index.rst __init__.py manage.py

    2热度

    2回答

    我生成的文件与狮身人面像的项目,结构是这样的: + project | +- docs | +- tests | +- workflow -+- definitions -+- <some folders> | +- <rest of the project> 我要排除的测试,并从文档制作流程/定义。 我试图排除文档模式/ conf.py exclude

    0热度

    1回答

    当使用Sphinx和autodoc来记录一个Python项目时,可以使用:Example:在你的模块/类/函数docstring中包含一个代码示例,Sphinx会为你高亮显示语法。像这样的东西。 >>> rng = Range(0, 1000) >>> rng [0, 1000) >>> len(rng) 1000 >>> rng.start = 500 >>> rng.start