草庐IT

Sphinx-apidoc

全部标签

python - 如何使用 Sphinx 标记引用记录在案的 Python 函数参数?

我想在Python文档字符串的其他地方引用以前记录的函数参数。考虑以下(诚然完全人为的)示例:deffoo(bar):"""Performfooaction:parambar:Thebarparameter"""defnested():"""Somenestedfunctionthatdependsonenclosingscope'sbarparameter.I'dliketoreferencefunctionfoo'sbarparameterherewithalink,isthatpossible?"""returnbar*bar#...returnnested()有没有一种使用Sp

python - 如何使用 Sphinx 标记引用记录在案的 Python 函数参数?

我想在Python文档字符串的其他地方引用以前记录的函数参数。考虑以下(诚然完全人为的)示例:deffoo(bar):"""Performfooaction:parambar:Thebarparameter"""defnested():"""Somenestedfunctionthatdependsonenclosingscope'sbarparameter.I'dliketoreferencefunctionfoo'sbarparameterherewithalink,isthatpossible?"""returnbar*bar#...returnnested()有没有一种使用Sp

python - 使用 sphinx 生成 python 文档时如何保留换行符

我正在使用Sphinx为python项目生成文档。输出html不保留文档字符串中存在的换行符。示例:代码deftestMethod(arg1,arg2):"""ThisisatestmethodArguments:arg1:arg1descriptionarg2:arg2descriptionReturns:None"""print"Iamatestmethod"狮身人面像O/P:TestModule.testMethod(arg1,arg2)ThisisatestmethodArguments:arg1:arg1descriptionarg2:arg2descriptionRetur

python - 使用 sphinx 生成 python 文档时如何保留换行符

我正在使用Sphinx为python项目生成文档。输出html不保留文档字符串中存在的换行符。示例:代码deftestMethod(arg1,arg2):"""ThisisatestmethodArguments:arg1:arg1descriptionarg2:arg2descriptionReturns:None"""print"Iamatestmethod"狮身人面像O/P:TestModule.testMethod(arg1,arg2)ThisisatestmethodArguments:arg1:arg1descriptionarg2:arg2descriptionRetur

python - sphinx-build 失败 - autodoc 无法导入/查找模块

我正在尝试开始使用Sphinx,但似乎遇到了很多问题。命令:docs/sphinx-quickstart我回答了所有问题,一切正常。命令:docs/ls一切看起来都很正常。结果:构建Makefile源代码命令:sphinx-build-dbuild/doctreessourcebuild/html它似乎工作。我能够打开index.html文件并看到我想要的“外壳”。当我尝试将我的实际源代码作为source文件夹时,我遇到了问题。命令:sphinx-build-dbuild/doctrees../ys_utilsbuild/html结果:Makingoutputdirectory...R

python - sphinx-build 失败 - autodoc 无法导入/查找模块

我正在尝试开始使用Sphinx,但似乎遇到了很多问题。命令:docs/sphinx-quickstart我回答了所有问题,一切正常。命令:docs/ls一切看起来都很正常。结果:构建Makefile源代码命令:sphinx-build-dbuild/doctreessourcebuild/html它似乎工作。我能够打开index.html文件并看到我想要的“外壳”。当我尝试将我的实际源代码作为source文件夹时,我遇到了问题。命令:sphinx-build-dbuild/doctrees../ys_utilsbuild/html结果:Makingoutputdirectory...R

Doxygen + Sphinx 文档构建笔记(非流程教程,支持 C++ 和 Python代码文档生成)

主题:如何将Doxygen的文档注入到Sphinx中、环境:Windows+CMake+Doxygen+Sphinx+Breathe老样子,先把参考内容附上:    主要参考的文章,如何使用Sphinx+Breathe+Doxygen+CMake来生成C++文档    Doxygen官方文档,富含详细的Doxygen的各种注释写法        Shpinx官方文档,如果需要通过Sphinx的语法向文档中注入更多内容,需要参考官网的语法  ​​​​​​​​​​     Breathe官方文档,Breathe是将Doxygen文档注入sphinx的插件,是sphinx工具的插件相关代码已经上传到

php - 与 Cake php 一起实现 Sphinx API 的问题

我正在做一个项目,我需要用Cakephp实现SphinxSearch。所以我只是想在其中使用一个组件和行为。它的链接是:-http://bakery.cakephp.org/articles/eugenioclrc/2010/07/10/sphinx-component-and-behavior我正在请求如下所示的SphinxAPI:$sphinx=array('matchMode'=>SPH_MATCH_ALL,'sortMode'=>array(SPH_SORT_EXTENDED=>'@relevanceDESC'));$results=$this->ModelName->find

ruby-on-rails - 如何根据 sphinx 中的多个因素获得搜索排名?

大家好stackoverflow,我们有一个不断发展壮大的Rails项目,现在我们在搜索中遇到了第一个性能问题,因为我们不知道如何正确地利用sphinx来满足我们的需求。我们有类似“JavaPHPSoftwaredeveloper”的搜索查询。我们现在的问题是排名应该适用于多种情况。作为搜索字段,我们有标签列表、描述和标题。如果其中一个术语在其中一个字段内,它应该得到例如2分。如果它在多个字段中,则更多点,但如果它在同一字段中不止一次,则不是多个点。下一个问题是我有一个大文件,其中的同义词也应该被检查。它看起来像这样:Java>JavaJava-EE>Java...因此,如果发现Jav

php - 将 Sphinx 搜索与 ORM 结合使用

我正在考虑在我们的网站中实现Sphinx搜索。与其不得不通过包含新库等做一些奇怪的事情,对我来说使用SphinxQL集成它更有意义,因为这非常接近原生SQL.但是,我担心我们最终可能不得不重新发明轮子,以便我们可以在我们的系统中使用Sphinx。为了避免这种情况,我想将Sphinx拖到我们的ORM系统中。有没有人以前尝试过这个,或者任何人都可以解决我们可能遇到的问题吗?我们目前混合使用ZendFramework和Propel 最佳答案 最近使用ZendFramework将Sphinx添加到我们的应用程序的长期Propel用户。关于P