-
0 votesanswersviews
sphinx，kivy和autodoc：警告和创建文档的问题
我想在Sphinx中创建我的代码文档 . 我安装了一切并做了一些简单的试用，运行正常 . （我运行sphinx-quickstart，编辑conf.py以包含模块的路径，使用教程来了解sphinx如何工作等等） 然而，我的代码导入了许多kivy库 . 当我想在导入kivy的模块上创建文档时，它会失败 . 例如，如果我有这样的main.py： #!/usr/bin/python # -*- cod... -
1 votesanswersviews
如何使用Sphinx doctest测试非ASCII字符的输出？
我不知道如何使用Sphinx doctest测试包含非ASCII字符的打印输出 . 当我测试包含生成非ASCII字符的代码，或者包含包含非ASCII字符的预期结果时，我会遇到编码错误 . 例如，如果我有： def foo(): return 'γ' 然后是doctest包括 >>> print(foo()) 会产生表格的错误 编码错误：'ascii'编解码器无法编码... -
135 votesanswersviews
Sphinx autodoc不够自动化
我正在尝试使用Sphinx来记录Python中的5000行项目 . 它有大约7个基本模块 . 据我所知，为了使用autodoc我需要为我的项目中的每个文件编写这样的代码： .. automodule:: mods.set.tests :members: :show-inheritance: 这太繁琐了，因为我有很多文件 . 如果我能指定我想要记录'mods'包，那将会容易得多 .... -
1 votesanswersviews
Sphinx autodoc在第三方软件包的ImportError上死亡
有没有办法排除模块的导入部分，然后用sphinx-python记录它？我有一个模块导入另一个包（其他不同的项目），然后sphinx给出了这个错误： “”“”文件“/usr/local/lib/python2.7/dist-packages/Sphinx-1.1.3-py2.7.egg/sphinx/ext/autodoc.py”，第321行，在import_object导入中（self .mod... -
3 votesanswersviews
python-sphinx记录没有py扩展名的脚本
道歉 - 这是一个完整的n00b问题： 我有几个没有.py扩展名的python脚本 . 我如何说服Sphinx它应该记录该脚本？示例错误： /home/XXX/YYYYY/development/dst/build/index.rst:25:(警告/ 2）autodoc无法导入/查找模块'site_scons.random'，它报告错误：“没有模块名为随机”，请检查你的拼写和sys.path -
3 votesanswersviews
通过autodoc为C Python模块提供Sphinx文档
我试图记录pycurl，它主要是一个C扩展模块 . 在这个扩展模块中有一些用C语言编写的类 . 它们有方法 . 这些方法在其上定义了docstrings： >>> help(pycurl.Curl().close) Help on built-in function close: close(...) close() -> None. Close handle ... -
0 votesanswersviews
Sphinx autodoc无法导入/查找模块
我是狮身人面像的新手 . 我从一开始就得到了一些东西 . 我的文件结构非常简单： conf.py index.rst p1.rst P1（资料） m1.py（p1中的文件） m2.py（p1中的文件）...... 在p1.rst写道： .. automodule:: p1.m1 :members: 我在conf.py中添加了抽象路径 sys.path.append(os.path.abs... -
0 votesanswersviews
为什么sphinx conf.py在尝试导入sys时出错
我正在尝试使用sphinx和autodoc创建一个简单的文档，但autodoc无法影响我的模块 . 图是因为我没有在conf.py中将模块的路径添加到sys路径中 所以我在conf.py的开头添加了这个： import sys import os sys.path.insert(0, os.path.abspath('.')) 现在我在导入sys的行上得到以下错误，我不知道为什么，因为我有与... -
3 votesanswersviews
在我的Django项目中无法使用Sphinx生成autodoc
我使用sphinx将addind文档添加到我的Django项目（github link，该项目是开源的），但是我包括带有文档字符串的models.py文件但是，当运行时 make html 我不确定我是在修复它们还是只生成一个新的bug . 如果删除了models.py文件的包含，则完全运行 . 换句话说，只有当我在.rst文件中包含以下行时才会生成错误： .. automodule:: acco... -
2 votesanswersviews
Sphinx-如何在多个文件夹中的autodoc .py文件？
我是Python和Sphinx的新手，我正在尝试autodoc位于类似于以下结构的目录中的python文件： Project ├── Sphinx | ├── index.rst | ├── autodoc.rst | └── conf.py ├── Scripts | ├── file1.py | └── file2.py | ├── folder | | └... -
0 votesanswersviews
如何在sphinx中包含模块
我一直在寻找这个问题的答案一个星期 . 希望你能帮我： 我正在使用Sphinx进行记录，这是我项目的结构： -folder __init__ -main_tool_folder __init__ main.py -docs_folder -modulefolder __init__ fileIw... -
2 votesanswersviews
Python Sphinx记录包的公共接口
我有一个包含子模块的Python包 . 目前，我的目的是允许使用包出口的功能，例如： package_X +-- __init__.py +-- submodule_A.py +-- submodule_B.py 子模块是实现细节 . 包的用户需要知道的所有内容都将导出到 __init__.py 文件中 . 现在，在使用Sphinx构建文档时，我获得了TOC和文档，如下所示： package_X... -
8 votesanswersviews
在Sphinx文档中保留包装/修饰Python函数的默认参数
如何将 *args 和 **kwargs 替换为装饰函数文档中的真实签名？ 假设我有以下装饰器和装饰功能： import functools def mywrapper(func): @functools.wraps(func) def new_func(*args, **kwargs): print('Wrapping Ho!') return ... -
2 votesanswersviews
Django REST Swagger可用于生成静态HTML文档吗？ [关闭]
我正在开发一个新的Django REST Framework项目，我正在使用Django REST Swagger提供开箱即用的漂亮文档 . 但是，我想分享这个文档而无需启动升级机或类似的东西 . 我只想生成类似静态sphinx的文档，而不需要花哨的客户端功能 . 我不需要能够实际访问API endpoints . 我只想要一个用户友好的描述存在什么 endpoints ，他们接受/返回什么等 ...