sphinx Autodoc 帮助

发布于 2024-10-20 19:00:42 字数 97 浏览 7 评论 0原文

尝试使用 sphinx 的 autdoc 扩展,但它不起作用。我将“docs”文件夹保留在 djano 项目文件夹中。它没有为我的模块生成文档。我也不确定自动待办事项是如何工作的。

Trying to use autdoc extension of sphinx but its not working. i kept "docs" folder in djano project folder. its not generating docs for my module. Also i am not sure how does auto-todo works.

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

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

发布评论

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

评论(1

神仙妹妹 2024-10-27 19:00:42

如果没有看到您的 index.rst 文件,我们只能猜测,而且我的猜测会丢失这样的内容:

.. automodule:: myproject.myapp
    :members:

您当然可以在哪里替换 myprojectmyapp 使用您的应用程序。

您还可以尝试使用这个非常新的项目 http://pypi.python.org/ pypi/django-sphinx-autodoc/0.0 这是非常新的版本 0.0!

以下是一些讨论如何使用 autodoc 的博客文章:

http://yml-blog.blogspot.com/2009/06/sphinx-autodoc-and-django-app.html

http://www.toast38coza.com/incomplete-thoughts/setting-up-sphinx-documenter- with-a-django-project-a-quickstart-tutorial

Without seeing your index.rst file we can only guess, and my guess would be missing something like this:

.. automodule:: myproject.myapp
    :members:

Where of course you replace myproject and myapp with your apps.

You can also try using this very new project http://pypi.python.org/pypi/django-sphinx-autodoc/0.0 which is so new it's at version 0.0!

Here are some blog posts discussing how to use autodoc:

http://yml-blog.blogspot.com/2009/06/sphinx-autodoc-and-django-app.html

http://www.toast38coza.com/incomplete-thoughts/setting-up-sphinx-documenter-with-a-django-project-a-quickstart-tutorial

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文