跳转到主要内容

未知

项目描述

[![构建状态](https://travis-ci.org/enthought/refactordoc.svg?branch=master)](https://travis-ci.org/enthought/refactordoc) [![覆盖率状态](https://img.shields.io/coveralls/enthought/refactordoc.svg)](https://coveralls.io/r/enthought/refactordoc?branch=master)

RefactorDoc扩展会解析autodoc扩展检索到的函数和类文档字符串,并将其重构为sphinx友好的rst格式。该扩展与替代方案(如numpydoc)具有相似之处,但旨在反映文档字符串的原始形式。

RefactorDoc的主要目标

  • 不要更改节顺序。

  • 允许在节块之间(以及内部)使用sphinx指令。

  • 更容易调试(原生支持调试)和扩展(未来版本)。

仓库

RefactorDoc扩展位于GitHub。您可以使用以下命令克隆仓库

$ git clone https://github.com/enthought/refactordoc.git

安装

  1. 使用pip从PyPI安装refactordoc

    $ pip install reafactordoc
  2. 将refactor-doc添加到您的sphinx conf.py扩展变量中

    extensions = [
        ...,
        'refactordoc',
        ...,
    ]

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。

源分布

refactordoc-0.3.1.tar.gz (11.3 kB 查看哈希值)

上传时间:

由以下提供支持