标签: pydoc

我正在尝试从我的模块中创建一个文档.我pydoc在Windows 7中使用Python 3.2.3从命令行使用:

python "<path_to_pydoc_>\pydoc.py" -w myModule

这导致我的shell充满了文本,我的模块中的每个文件都有一行,说:

no Python documentation found for '<file_name>'

这就像Pydoc试图获取我的文件的文档,但我想自动创建它.我找不到使用谷歌的好教程.有没有人有关于如何使用Pydoc的任何提示？

如果我尝试使用一个文件创建文档

python ... -w myModule\myFile.py

此外,它在我的计算机上有一个指向文件本身的链接,我可以单击它,它会在我的网络浏览器上显示文件内部的内容.

我在我的脚本中使用argparse.ArgumentParser(),我想显示我的脚本的pydoc描述作为argparse的' - help'选项的一部分.

一种可能的解决方案是使用ArgumentParser 的formatter_class或description属性来配置帮助的显示.但在这种情况下,我们需要在内部使用'pydoc'命令来获取描述.

我们还有其他方法(可能是优雅的)吗？

pydoc在Windows中不起作用.在这篇文章Pydoc无法正常工作(Windows XP) dave webb的最后一个答案是创建一个包含此代码的pydoc.bat文件:

@python c:\Python27\Lib\pydoc.py %*

我创建了pydoc.bat应该放在哪里,以便pydoc命令在命令提示符下工作？

PS添加C:\python27\Lib\pydoc.py到系统环境变量中的Windows路径不起作用.即使在退出并重新登录后也无效.

我有一个python包,输出相当多的帮助文本: help(package)

我想将此帮助文本以其显示的格式导出到文件中 help(package)

我怎么能这样做？

我想使用Sphinx,因此它可以为我的python代码自动生成一个pydoc,但是我收到了一个错误.我做错了什么？

conf.py sphinx配置文件

import sys
import os
from django.conf import settings
os.environ['DJANGO_SETTINGS_MODULE'] = '../cloud_server.settings'

sys.path.insert(0, os.path.abspath('../cloud_server/cloud_api'))

views.py django文件

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from cloud_api.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

我正在尝试制作html文件时抛出Typeerror错误.

    C:\Users\ogward\STUDPROJ\docs\code.rst:3: WARNING: autodoc: failed to …

有没有办法评论函数的参数,使它们被pydoc库识别？

即pydoc的文档字符串是什么？

我是python开发的新手,使用Eclipse/Pydev.有没有一种很好的方法可以将用于生成文档的工具(例如Sphinx,pydoc)集成到IDE中,以获得良好的工作流程,或者在单独的选项卡中显示文档？

完全是编程和python的新手.在我正在学习的书中,作者建议我找出Pydoc的目的.

我对它进行了谷歌搜索,并找到了一个匹配(来自Gnome Terminal),但对我来说没有多大意义.有人介意简化一下吗？谢谢.

我决定是否使用Sphinx或Pydoc来记录大型现有项目.我应该选择哪一个？哪一个在特定条件下表现更好？哪一个配置项目运行速度更快？

在Pycharm中,我希望有一个记录的函数,它返回一个元组,以便我可以在其上获得代码.评论的风格是谷歌风格.

这工作正常:

def func():
    """

    Returns:
        str: something

    """
    pass

func().正确键入显示方法str.

然而,键入此不工作了:

def func():
    """

    Returns:
        (int, str): something

    """
    pass

a, b = func()

打字b.不提供任何东西.

我知道PyCharm能够解析元组,因为这段代码有效:

def func():
    """

    :rtype: (int, str)
    """
    pass

a, b = func()

但是,这不符合谷歌的风格.

如何根据标准记录函数,以便Pycharm接收返回类型？