python sphinx 文档

发布于 2024-10-05 08:25:33 字数 1436 浏览 7 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

Smile简单爱 2024-10-12 08:25:33

嗯,你得自己读一些书。但是,作为基本概述:

  • 您通常会在项目的子文件夹中运行 sphinx-quickstart 以获取文档(例如 /usr/my-site/docs)。
  • 您可以使用 reStructuredText (rst) 格式编写 Sphinx 文档。首先编辑index.rst 文件,稍后您可以添加更多文件。
  • 完成后,使用 make html(或 Windows 上的 make.bat html)从 RST 构建 HTML 文件。

Well, you're going to have to do some reading up yourself. However, as a basic overview:

  • You would usually run sphinx-quickstart in a subfolder of your project for documentation (e.g. /usr/my-site/docs).
  • You write Sphinx documentation in reStructuredText (rst) format. Start by editing the index.rst file, and you can add more files later.
  • When you're done, use make html (or make.bat html on Windows) to build the HTML files from your RST.
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文