具有出色文档的项目
项目描述
最糟糕的事情莫过于没有编写的文档，其次是编写的文档却从未被发现。
描绘是一个Python3命令行工具和库，它可以帮助您以尽可能少的努力为您的Python项目创建出色的文档网站。
主要功能
- 零配置：使用
描绘不需要配置。只需在您的Python项目根目录中运行描绘，它就会找到您的文档。 - 静态生成：
描绘网站以标准的静态HTML网站输出，因此很容易托管在GitHub页面和其他类似服务上。 - Markdown感知：
描绘将自动包含您的项目中的.md文件并将它们渲染成HTML。它还会找到并渲染__doc__字符串中的Markdown。 - 完全可配置：虽然
描绘不需要配置，但您仍然可以在标准的pyproject.toml文件中完全配置它。 - 易于编程：
描绘提供了一个干净且简单的Python API。 - 可搜索：默认情况下，
描绘使所有文档可搜索，包括自动生成的代码引用。 - 可主题化：
描绘与所有现有的MkDocs主题兼容。
在底层，描绘结合了Markdown文档渲染能力，由MkDocs提供，以及由pdocs自动生成的参考文档。
快速开始
以下指南应能帮助您快速启动文档网站。
- 安装 - 简要说明：在项目的虚拟环境中运行
pip3 install portray。 - 命令行使用 - 简要说明：运行
portray in_browser进行测试，运行portray on_github_pages进行部署。 - API 使用 - 简要说明：通过 CLI 可用的所有内容，也都可以通过 Python 程序轻松访问。
- 配置 - 简要说明：将所有配置放在
pyproject.toml文件的[tool.portray]部分中。
为什么创建 Portray？
我创建了大量的 Python 项目，并一直希望有一种快速的方法来为它们构建包含手动编写的指南和自动生成的参考文档的文档网站。工具在过去几年中有所改进，但仍然没有任何工具能给我带来开箱即用的这种体验。Portray 不是与 2 个较新的 Python 文档项目（pdocs 和 MkDocs）竞争，而是将它们融合在一起，为我提供我一直想要的快速创建和内容全面的文档网站生成器。
感谢您的使用，希望您也能发现 portray 有用！
~Timothy Crosley
下载文件
下载适合您平台文件的文件。如果您不确定该选择哪个，请了解有关 安装包 的更多信息。
源分布
portray-1.8.0.tar.gz (13.6 kB 查看散列)
构建分布
portray-1.8.0-py3-none-any.whl (14.2 kB 查看散列)
关闭
portray-1.8.0.tar.gz 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | a9dd2973a0235051c5b68a29390c3eeee192dc248cc2d944452ee9c02423b47d |
|
| MD5 | 3ecd7a4aefb28c3d4a9f7c10796ffc1a |
|
| BLAKE2b-256 | 31c5647feff9c1a65c403594e51e8ebc9eb93b71e77808c159cf688970585715 |
关闭
portray-1.8.0-py3-none-any.whl 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | c7ee981b51f9b41b60b04c1351e1b61edd291049d10c45f7c8f05897caa6a931 |
|
| MD5 | 11512d49d135c114555fdc1f7d750f13 |
|
| BLAKE2b-256 | 319973ee12584f7186b99ce07f130a1f8b727e72008f4f767552c227ff1a5fb7 |
