flatdoc 0.1.0

安装

您可以使用pip：

pip install flatdoc

编写文档

您可以在任何 你喜欢的格式markdown和structuredtext都是 使用，因为它们易于键入，所以可读性很强，并且具有工具 生成HTML、PDF、Postscript等所必需的

从所有这些docstring构建平面文档的关键是 它们带有!INCLUDE指令作为一个例子，请考虑以下内容 模块foo.py，带标记文档字符串：

"""# Foo

This module does foo.

!INCLUDE Bar, func
"""
class Bar:
    """## Bar

    This class does bar.

    !INCLUDE baz
    """
    def baz(self):
        """### baz()

        This method does baz.
        """
        pass

def func():
    """## func()

    This function does func.
    """
    pass
"""

为上述模块生成的文档将是一个合并的 标记文件：

# Foo

This module does foo.

## Bar

This class does bar.

### baz()

This method does baz.

## func()

This function does func.

那个！包含指令

正如您在上一节的示例中看到的，文档行 以^{tt2}开头的$被视为对其他docstring的引用。与 此机制可以将多个docstring合并为一个输出 文件

给!INCLUDE的参数是对 其他文档字符串。这些引用总是相对于当前 docstring，例如，在模块docstring中，任何顶级函数或 类可以由其名称引用，在类中，其所有方法都可以 也可以直接引用他们的名字

当需要引用不是直接下属的docstring时， 可以使用标准点符号。使用上一节的例子， 考虑以下情况：

• 包含来自模块foo的类Bar的方法baz：

  !INCLUDE Bar.baz
  

• 包含函数func中的类Bar：

  !INCLUDE .Bar
  

包含包含与方法相同的一个模块，该级别与方法相同。 baz：

!INCLUDE ...mod

命令行用法

flatdoc实用程序可用于从 命令行。此命令采用的唯一参数是 要为其生成文档的顶级对象

您正在阅读的文档是由以下内容生成的 命令：

flatdoc flatdoc > README.rst

API参考

平面文档（名称）

从docstring生成文档。

from flatdoc import flatdoc
print(flatdoc('my_pkg'))