Questions tagged «autodoc»

我正在尝试使用Sphinx在Python中记录5,000多个项目。它有大约7个基本模块。据我所知，为了使用自动文档，我需要为项目中的每个文件编写如下代码： .. automodule:: mods.set.tests :members: :show-inheritance: 这太繁琐了，因为我有很多文件。如果我只想指定要记录的“ mods”包，那会容易得多。然后，Sphinx可以递归地浏览包并为每个子模块创建一个页面。 有这样的功能吗？如果没有，我可以编写一个脚本来制作所有.rst文件，但这将花费很多时间。

149 python  python-sphinx  autodoc 

Sphinx默认情况下不会为__init __（self）生成文档。我尝试了以下方法： .. automodule:: mymodule :members: 和 ..autoclass:: MyClass :members: 在conf.py中，设置以下内容只会将__init __（self）文档字符串附加到类文档字符串（Sphinx autodoc文档似乎同意这是预期的行为，但未提及我要解决的问题）： autoclass_content = 'both'

107 python  python-sphinx  autodoc 

我正在尝试开始使用Sphinx，似乎遇到了很多问题。 命令： docs/sphinx-quickstart 我回答所有问题，一切正常。 命令： docs/ls 一切看起来都很正常。结果：build Makefile source 命令： sphinx-build -d build/doctrees source build/html 似乎有效。我能够打开index.html文件，并看到我想要的“外壳”。 当我尝试将实际的源代码作为source文件夹时，我遇到了问题。 命令： sphinx-build -d build/doctrees ../ys_utils build/html 结果： Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created No builder selected, using default: html loading intersphinx inventory from http://docs.python.org/objects.inv... building [html]: targets …

104 python  python-sphinx  autodoc 

我正在使用sphinx和autodoc插件为我的Python模块生成API文档。虽然可以看到如何很好地记录特定参数，但是找不到如何记录**kwargs参数的示例。 有没有人有一个很好的例子来记录这些问题？

99 python  python-sphinx  autodoc 

我已经花了相当长的时间在互联网上寻找可使用jsdoc正确记录回调的最佳方法，但是不幸的是，我还没有找到一个好的方法。 这是我的问题： 我正在为开发人员编写Node.js库。该库提供了开发人员将要使用的多个类，函数和方法。 为了使我的代码清晰易懂，并在将来（希望）自动生成一些API文档，我开始在代码中使用jsdoc自行记录正在发生的事情。 假设我定义了如下函数： function addStuff(x, y, callback) { callback(x+y); }); 目前，使用jsdoc，我正在将此功能记录如下： /** * Add two numbers together, then pass the results to a callback function. * * @function addStuff * @param {int} x - An integer. * @param {int} y - An integer. * @param {function} callback - …

76 javascript  node.js  jsdoc  autodoc  jsdoc3 

我需要使用Sphinx记录我的Python项目。但是我不能用autodoc。 当我配置我的项目时，我选择选项“ extension autodoc”，但是现在如果我使用 .. autoclass:: Class 我收到一个错误： ERROR: Unknown directive type "autoclass" 我配置了PYTHONPATH，现在很好。但是我已经有这个问题了。 我的索引文件是： .. ATOM documentation master file, created by sphinx-quickstart on Thu Nov 22 15:24:42 2012. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to …

76 python-sphinx  autodoc