开发者手册
开发者手册除了对开发者有参考帮助,对于使用者没有任何意义,请不要浪费你的宝贵时间,推荐使用者使用cockpit管理和运行podman程序,简直不要太好用。如果你是开发者请慢慢欣赏!有错误的地方请发送邮件给我,感谢你对中文翻译站的支持!!!
关于 Podman 的在线手册页和其他文档可以在 Read The Docs 上找到。手册页可以在该页面的 Commands 链接下找到。
构建文档
目录结构
目录 | |
---|---|
手册页的 Markdown 源文件 | docs/source/markdown/ |
手册页别名作为 .so 文件 | docs/source/markdown/links/ |
输出目标目录 | docs/build |
手册页 | docs/build/man |
远程 Linux 手册页 | docs/build/remote/linux |
远程 Darwin 手册页 | docs/build/remote/darwin |
远程 Windows HTML 页面 | docs/build/remote/windows |
支持文件
docs/remote-docs.sh | 读取 docs/source/markdown 文件并为每个平台格式化 |
docs/links-to-html.lua | pandoc 过滤器,用于 html 文件的别名 |
docs/use-pagetitle.lua | pandoc 过滤器,用于设置 html 文档标题 |
手册页语法
所有手册页的格式语法可以在 这里 找到。
API 参考文档
最新的在线文档是由两个协同工作的自动化系统基于上游提交的代码自动生成的。首先,Cirrus-CI 文档任务会构建 pkg/api/swagger.yaml
并将其上传到公共可用的位置(Google 存储桶——一个用于存储非结构化数据的在线服务)。其次,Read The Docs 响应 github.com 仓库的变更,为 libpod 文档站点 构建内容。这个站点的 API 部分包含一些 JavaScript,这些 JavaScript 直接从 Google 存储桶中消费上传的 swagger.yaml
文件。
由于涉及到多个系统和本地缓存,因此可能会出现文档更新(尤其是 Swagger/API 文档)延迟约 10 分钟的情况。但是,由于客户端(即您的 Web 浏览器)从多个不同域名的位置获取内容,访问 API 部分时可能会显示类似于以下内容的堆栈跟踪:
如果重新加载页面或清除本地缓存无法解决问题,那么这可能是由于保护客户端免受跨站脚本攻击所需的元数据损坏造成的。请 通知维护人员,以便他们可以调查 swagger.yaml
文件的 CORS 元数据为何不正确,或者为何文件因其他原因无法访问。
本地测试
要构建标准的 man 页面,运行 make docs
。结果将在 docs/build/man
中。
要构建 HTML 格式的 man 页面:假设您已经安装了依赖项, 接下来安装(这里以 Fedora 为例):
sudo dnf install python3-sphinx python3-recommonmark
pip install sphinx-markdown-tables myst_parser
(上述依赖项截至 2022 年 9 月 15 日是最新的。如果您遇到问题,请查看此目录下的 requirements.txt, 它几乎肯定会比此 README 更新。)
安装完成后,进入 Podman 沙盒中的 docs
目录,然后执行 make html
。
您可以使用以下命令预览 docs/build/html
中的 HTML 文件:
python -m http.server 8000 --directory build/html
...然后在您的网络浏览器中访问 http://localhost:8000/
。