我继承了一个相当大的代码库，我想为其创建HTML文档。由于它是用Python编写的，我决定使用Sphinx，因为代码的用户习惯于使用Sphinx创建的Python文档的设计和功能。我使用命令sphinx-apidoc自动创建.rst文件。我将模块路径导入到sys.path中，以便Sphinx可以找到代码。到目前为止一切顺利。但是，当我尝试使用命令makehtml创建HTML时，会弹出许多回溯，代码库中的一些示例似乎已被执行。这可能是什么原因，我该如何防止这种情况发生？ 最佳答案 使用autodoc时,Sphinx导入文档化模块，因此
关闭。这个问题需要更多focused.它目前不接受答案。想改进这个问题吗？更新问题，使其只关注一个问题editingthispost.关闭4年前。Improvethisquestion对于我的JavaScript框架，我想使用Sphinx。由于我是Sphinx世界的新手，我希望你们能帮助我开始使用Sphinx和JavaScript。
我正在尝试使用sphinx来记录多个“级别”的文档，例如:API引用手册教程等这个想法是，目录显示在相对于您所在部分的侧边栏上。因此，当您在主索引上时，它只显示上述部分。当你进入例如。“手动”它显示特定于该部分的不同ToC，以及返回主ToC的方法。我一直在尝试弄清楚如何在不侵入Sphinx的情况下让它在Sphinx中工作，但到目前为止还没有完全找到办法。文件夹结构已经反射(reflect)了不同的部分(即所有“手册”文档都存储在_source/manual下)并且我尝试在每个目录中放置单独的索引文件，但似乎toctree功能只查看主索引文件。我正在使用“readthedocs”主题，我
我有一个flask应用程序，我想使用Sphinx的autoflask指令来记录一个flask-restfulAPI。https://pythonhosted.org/sphinxcontrib-httpdomain/#module-sphinxcontrib.autohttp.flask我已经通过pip安装了模块并运行了sphinx-quickstart，这给了我一个conf.py和index.rst。我已经尝试将扩展名放入conf.py中:extensions=['sphinxcontrib.autohttp.flask']根据文档将指令放入index.rst中:..autoflas
我正在使用用Java编写的库处理几个Jython项目。多亏了autodoc扩展，我想用Sphinx创建一些好的文档。但是，当我尝试创建html时，出现错误，因为autodoc找不到用Java编写的库:sphinx-build-bhtml-d_build/doctrees._build/htmlRunningSphinxv1.0.5loadingpickledenvironment...donebuilding[html]:targetsfor1sourcefilesthatareoutofdateupdatingenvironment:0added,1changed,0removedr
我正在使用sphinx为我的python库编写文档，我还使用intersphinx添加了另一个sphinx文档。它工作得很好，但是我的一些函数的名称与引用文档中的名称相同，这导致隐藏了它们的名称以供:func:...引用。有什么方法可以在其他文档中引用阴影函数do_some()吗？(:func:`do_some`创建到我的函数do_some()的链接) 最佳答案 根据docs您可以将intersphinx_mapping中的标识符用作目标的前缀。示例::ref:`comparisonmanual`我认为这也适用于函数。
我希望能够在Python中解析基于sphinx的rst以便进一步处理和检查。像这样的东西:importsphinxp=sphinx.parse("/path/to/file.rst")do_something_with(p)使用docutils.core.publish_file似乎可以在docutils中实现:publish_file(open("/path/to/file.rst")但这对sphinx特定指令等一无所知...... 最佳答案 您可以使用SphinxExtensions在最终写入之前进行自定义处理。文档中有一个非常
我正在尝试使用Sphinx1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展为我的python类生成文档。我有很多模块，我希望每个模块只显示类名，而不是类中方法的完整列表(我的代码中都有文档字符串)。这是我的conf.py文件的片段:sys.path.insert(0,'/blah/sphinx/src')extensions=['sphinx.ext.autodoc']autodoc_member_order='bysource'autodoc_default_flags=['no-members']这是一个玩具模块(my_module.py)，我用它来了
我目前正在将所有现有(不完整)文档迁移到Sphinx.问题是文档使用了Pythondocstrings(该模块是用C语言编写的，但它可能并不重要)并且必须将类文档转换为可用于Sphinx的形式。有sphinx.ext.autodoc,但它会自动将当前文档字符串放入文档中。我想根据当前的文档字符串在(RST)中生成一个源文件，然后我可以手动编辑和改进它。您如何将文档字符串转换为Sphinx的RST？ 最佳答案 autodoc确实会生成RST，只是没有正式的方法可以从中删除它。最简单的破解方法是更改sphinx.ext.autodo
我使用部分包含Java和Python代码的共享存储库。代码基础以python为主，部分库用java编写。是否有可能解析或预处理Java文档以便使用稍后在Python-Sphinx甚至插件中？ 最佳答案 javasphinx(Github)(Documentation)我花了很长时间才找到所有重要的细节来设置它，所以这里有一个简短的说明来解决我所有的麻烦。安装#Recommendworkinginvirtualenvironmentswithlatestpip:mkdirdocs;cddocspython3-mvenvenvsourc
