文件名称：描绘：您的项目拥有出色的文档
文件大小：5.47MB
文件格式：ZIP
更新时间：2024-02-24 10:49:08
python html static-site-generator http documentation
- 比从未编写过的文档更糟糕的是，编写了文档但从未发现过。 刻画是Python3命令行工具和库，可以帮助你用尽可能少的努力尽可能为您的Python项目大文件的网站。 主要特点： 零配置：使用portray无需进行任何配置。 只需在Python项目的根目录中运行portray ，它就会找到您的文档。 静态生成： portray网站易于作为标准静态HTML网站输出，因此可以轻松托管在GitHub页面和其他类似服务上。 Markdown Aware ： portray将自动包括您的项目.md文件并将其呈现为HTML。 它还将在__doc__字符串中查找并渲染Markdown。 完全可配置：虽然不必配置portray ，但您仍然可以在标准pyproject.toml文件中完全配置它。 易于编程： portray了一个干净简单的 。 可搜索的：开箱即用的portray使您的所有文档，甚至是自动生成的代码引用，都可以*文本搜索。 可主题化： portray与所有现有的兼容。 在， 将提供的文档呈现功能与生成的自动参考文档结合。 快速开始 以下指南应立即帮助您启动并运行文档网站
【文件预览】：
portray-master
----.travis.yml(396B)
----.coveragerc(65B)
----pyproject.toml(1KB)
----docs()
--------quick_start()
--------contributing()
----art()
--------logo.xcf(139KB)
--------repo_url.png(35KB)
--------logo.png(59KB)
--------example.gif(5.3MB)
--------logo_small.png(35KB)
----tests()
--------conftest.py(539B)
--------test_config.py(4KB)
--------test_render.py(226B)
--------__init__.py(0B)
--------test_api.py(6KB)
----LICENSE(1KB)
----TROUBLESHOOTING.md(3KB)
----.gitignore(811B)
----CHANGELOG.md(4KB)
----portray()
--------cli.py(903B)
--------mkdocs_templates()
--------__init__.py(133B)
--------logo.py(665B)
--------config.py(8KB)
--------api.py(7KB)
--------_version.py(22B)
--------exceptions.py(937B)
--------render.py(8KB)
----README.md(4KB)
----scripts()
--------test.sh(131B)
--------lint.sh(400B)
--------clean.sh(189B)