SPHINX - 技术教程文章
python – sphinx的最小域名【代码】
我想将Sphinx用于我自己的项目,为此我想创建一个新的sphinx domain.但是我开始时遇到了严重的麻烦.我的最小sphinx域只允许一条名为’command’的指令：.. xx:command:: Somecommand我找不到任何关于在互联网上编写sphinx域名的介绍,只有一些准备好为ruby,erlang等运行域名.有人可以告诉我如何开始吗？解决方法:在Sphinx源代码中查看reStructuredText domain,它非常简单,应该让您入门.你也可以在sphinx-contrib source找到一些很好的...
php – Sphinx搜索Reindex【代码】
我在XAMPP服务器上设置了Sphinx,现在我不想在Linux服务器上设置它.我怎么能得到这个？另外,如何在给定的时间后自动重新索引？我搜索了一个教程,但我找到的只是解释如何设置第一个索引,没有关于重建索引和设置cronjob或类似的东西.解决方法:您需要将此命令添加到系统中作为调度程序作业：indexer --all --rotate在Linux中,您可以使用cron.在Windows中 – 带有bat文件的标准调度程序,带有此Windows命令模拟.
php – Sphinx_Query失败：没有启用本地索引进行搜索【代码】
嗨我在我的测试服务器中配置了sphinx搜索. 现在我收到这种错误“Sphinx_Query失败：没有启用本地索引搜索”. 我不知道为什么会出现这个错误.任何身体都可以帮助我. 这是我的狮身人面像source objectcollection {type = mysqlsql_host = localhostsql_user = rootsql_pass = rootsql_db = mydatabasesql_port = 3306 sql_query ...
python – 像文档一样解析sphinx【代码】
我有一个sphinx格式的docstring,我想从中提取不同的部分(param,return,type,rtype等)以便进一步处理.我怎样才能做到这一点？解决方法:你可以使用docutils,这是Sphinx的基础.在this other answer中,我使用docutils.core.publish_doctree来获取reStructuredText文档的XML表示(实际上是一串文本),然后使用xml.minidom方法从该XML中提取字段列表.另一种方法是使用xml.etree.ElementTree,这在我看来更容易使用. 然而,首先,每次docutils遇...
python – 在App Engine上安装Sphinx – 可能吗？
关注我的last year’s question文档,我现在想要开始并尝试基于Python的Sphinx,以便汇总我一直在研究的PHP CMS的开发人员文档. 我想在我的工作站上本地设置Python,而不是从一开始就在公共可访问的Web服务器上运行它.我有权访问LAMP堆栈上的所有Web托管包,我不愿意购买基于Python的托管.我对Google App Engine非常感兴趣,他们提供的免费配额将为我做一百次,即使没有,他们的定价看起来也很合理. 现在我对Python一无所知 – 让Sphinx工...
php – sphinx仅重置一个过滤器【代码】
我有狮身人面像的对象.我得到了狮身人面像的所有结果.现在我需要再次运行搜索而不重置整个对象.我只需要重置一个过滤器. 这是我需要重置的过滤器$sphinx-> SetFilter(“cid”,$category_ids); 如何仅重置一个过滤器.我需要从过滤器中完全删除旧值.解决方法:将其添加到您的SphinxClient类<?phpfunction RemoveFilter ( $attribute ){assert ( is_string($attribute) );foreach($this->_filters AS $key => $filter){if($filter['att...
用sphinx和python2.x和python3.x生态系统构建文档的方法有哪些？
我有a project使用单个代码库支持Python 2.7和Python 3.x.在其中,我使用了可选期货： > Twisted(仅限Python 2.x)> concurrent.futures(仅限Python 3.2) 如果应用程序在Python 2.x上运行,则可以使用Twisted. 如果应用程序在Python 3.2上运行,则可以使用concurent.futures. 我想在整个项目中使用Sphinx构建文档,但我如何才能为这两个生态系统做到这一点？解决方法:为了解决这个问题,我发布了mockautodoc sphinx扩展
使用Sphinx的sphinx-apidoc实用程序从python代码自动生成文档
我想知道评论格式是什么,以便使用Sphinx的sphinx-apidoc实用程序获得自我记录代码.我能够让这个实用程序为每个python文件生成一组reStructuredText文件,但是仍然需要填写这些文件.我正在寻找一种方法来获取此实用程序,或者其他一些Sphinx实用程序来生成文档. python代码docstrings.我理解这需要熟悉传统的评论格式,我希望能够指出这个参考资料.谢谢！解决方法:mzjn,感谢您的评论.您的第二个链接提供了有关如何格式化文档字符串的一...
python – Sphinx：页面的本地conf？【代码】
我可以拥有conf变量的页面本地值(通常在conf.py中找到)吗？ 例如,我有hyphenator_language = "en-us"在conf.py.我可以拥有它吗？hyphenator_language = "ru"对于sphinx文档的给定ReST页面？解决方法:据我所知,对于任意配置变量没有通用的方法,但在你的情况下,特别是对于连字符,你有几个选择： >说服Sphinx连字符扩展的作者添加对指令的支持,该指令设置每页的语言.>由于连字符扩展使用了hyphenator.js,这是一个JS库,你可以使用一些原...
php – Lucene / Sphinx / Solr如何工作？
我在Phalcon有一个网站,我正在尝试添加一个搜索引擎.但是,内容不在数据库中,而是位于app / views /中的平面文件中. 我从来没有实现过搜索引擎,但从我收集的内容来看,似乎Lucene或Solr / Sphinx就是我所需要的. 这些工具是否提供了解析我的网站ala HTTrack的选项,从而创建索引和必要的绝对URI超链接？ 如何指定要解析的HTML文件的哪个部分？他们如何与忽略某些领域(例如HTML,JS)进行交互？解决方法:Lucene首先是一个指数.这甚至不是...
python – 使用readthedocs.org使用的静态资源进行本地sphinx构建的简单方法是什么？【代码】
目前,我能找到获取readthedocs.org使用的当前设计资产的唯一方法是安装full theme并构建它,这需要SASS等. 我想获得一组静态文件,让我在本地看到我的构建在readthedocs上的样子.有没有办法在没有从上面的链接建立资产的情况下做到这一点？目标是让新手很容易为文档做出贡献.解决方法:如果您想为其贡献/开发,您只需要构建主题.您可以使用pip install sphinx_rtd_theme安装主题.然后,您可以在Sphinx conf.py中使用该主题.见：http://r...
python – Sphinx：将代码段放在无序列表项的第一行【代码】
我正在使用Sphinx来管理我的项目文档. 我有一个无序列表,我希望每个项目的第一行是一个代码段. (不是内联,一段.) 我怎样才能做到这一点？解决方法:看看我自己的文档,我发现了一个类似的场景,但是我不能保证它可以作为列表中的第一个文本使用文档：#. **Defining the Model Class**All models must inherit from |LrbBaseModel| either directly orindirectly and have the |LrbModelInit| decorator above theirconstructor (a.k....
python – 如何自定义Sphinx的模块名称【代码】
就狮身人面像而言,我是新手.我的项目结构如下： > argparse_actions / > argparse_actions / > __init__.py> folder_actions.py> ip_actions.py > doc / > _build /> index.rst ==>这是起点,主页或根文档.>等等…… __init__.py看起来像这样：from folder_actions import * from ip_actions import *folder_actions.py看起来像这样：''' Folder Actions ==============This module implements some reusable custom actions... aut...
Php与Sphinx的联系遭到拒绝【代码】
我已经在我的服务器上安装了Sphinx,一切似乎都有效,除了当我从网络浏览器运行test.php时,我收到此错误：查询失败：连接到localhost：9312失败(错误号= 111,msg =连接被拒绝). 我在线搜索,包括堆栈溢出,几乎所有的建议都是确保searchd服务正在运行,并且它正在正确的端口上进行监听.我可以对两个问题说“是”,因为如果直接在命令行中运行相同的测试程序,一切正常.我知道托管服务提供商可能没有打开端口,但端口应该正在监听服务器,对吗...
python – 如何使用sphinx生成sitemap.xml文件？【代码】
Here它说：“特殊条目名称self代表包含toctree指令的文档.如果你想从toctree生成一个”站点地图“,这很有用.”而且我一直在看这个thred – Using self to create a sitemap with toctree in sphinx seem broken?.我似乎无法让这个工作. 是否有任何地方有一个详细的例子,我可以看看sphinx生成的站点地图？解决方法:我最终使用自己的主题中的站点地图生成器.https://github.com/guzzle/guzzle_sphinx_theme# Import guzzle theme h...
php – 如何在Sphinx中的一个索引中使用多个源？【代码】
Sphinx配置文件提示它支持一个索引的多个源,我该如何实际指定它？ 这是配置文件中的代码段：# document source(s) to index # multi-value, mandatory # document IDs must be globally unique across all sources source = src1我尝试过以下格式设置它：source = src1, src2 source = [src1, src2]我也尝试过两次使用源变量,例如：source = src1 source = src2我怀疑我只是一个笨蛋,因为我不确定在配置文件中使用...
python – Sphinx – autodata显示str .__ doc__【代码】
我正在尝试使用Sphinx记录我的python代码,但是我发现了一个记录用exec实例化的数据的问题;我有一个表,其中包含我需要实例化的名称和值. 所以在我的代码中我写了类似的东西：my_vars = [{'name': 'var1', 'value': 'first'},{'name': 'var2', 'value': 'second'}]for var in my_vars:exec("{var[name]} = '{var[value]}'".format(var=var))问题在于Sphinx：因为我只想维护我使用自动数据的源代码,我的.rst文件中的相应行是：.. auto...
python – 两个文档之间的Sphinx连接【代码】
我正在为一些python项目编写文档.我在连接两个或多个文档时遇到问题 – 我有三个Sphinx项目(文档),我希望能够在一般文档中添加指向详细文档的链接. 我有这样一个项目结构：project/ | doc/ # this is my general doc | | source/ # sphinx general doc .rst files are here | | build/ | | _static/ | | _templates/ | | CVS/ | | | forms...
Python：我如何在sphinx中定义应该使用哪个.rst文件和目录？【代码】
我如何在sphinx中定义应该使用哪个.rst文件和目录？ 我想在我的测试/构建/文档脚本中包含一个自动文档生成器.sphinx-quickstart在我的工作区中执行并创建了一个index.rst文件.由于sphinx使用重组文本文件作为文档,我在工作区中导航并使用sphinx-autogen手动创建它们.它导致了tasks.rst文件(见下文). 当我使用’make html’时,我会收到几个警告：WARNING: invalid signature for automodule (u’tasks/add_to_config’) WARNING: au...
什么是从Sphinx(PHP)中检索信息的最佳方法？【代码】
我是狮身人面像的新手,我正在一个新的网站上发布它.它工作正常,当我在控制台中搜索搜索时,一切正常. 使用PHP api和搜索,也给我相同的结果.但是它只为我找到的行提供了ID和权重.例如,有没有办法让一些文本字段与’匹配’哈希一起使用？ 如果没有办法做到这一点,是否有人知道如何以sphinx权重排序顺序从数据库(sql)中检索记录(同时搜索所有这些记录)？解决方法:您可以在ORDER BY中使用mysql FIELD()函数调用,以确保所有内容都符合sph...
python – sphinx文档给了我关于toctree refrences的警告【代码】
Contents:.. toctree:::maxdepth: 2foo.rstbar.rstIndices and tables ==================* :ref:`genindex` * :ref:`modindex` * :ref:`search`我正在尝试使用sphinx-build构建它. doc它给了我警告：(WARNING/2) toctree references unknown document u'bar'可能是什么原因？提前致谢.解决方法:Sphinx不需要toctree指令中的.rst扩展名.假设toctree类似于index.rst而bar.rst位于同一目录中,请尝试分别用foo和bar替换toctree指令中的...
python – 如何在Sphinx生成的文档中添加“上一章”和“下一章”链接？【代码】
当我查看文档时,大多数页面底部都有前一章和下一章链接/按钮,例如virtualenv.我无法使用Sphinx文档工具找到如何为我的项目文档完成此操作.有人能告诉我这是如何工作的或指向一个有用的资源(虽然我已经搜索了很多)？解决方法:关于模板的sphinx-doc.org文档提到了next和prev变量：The next document for the navigation. This variable is either false orhas two attributes link and title. The title contains HTML markup. Forex...
python – Sphinx：导入错误而不是文档包.有没有办法“跳过”？【代码】
我正在尝试使用Sphinx开始记录一个小型Python项目. 我创建了一个samplecode.rst,我将尝试组织(并自动生成)我的一个类(MyClass.py)的文档. 这是该samplecode.rst的一部分：MyClass.py ---------------------------------- .. autoclass:: backlib.classes.MyClass:members:但是当我尝试执行make html时,我得到一个导入错误并且没有导入’MyClass(在生成的.html中显示’MyClass’的空条目)：Traceback (most recent call last):de ...
如何以纯数据格式获取Python Sphinx文档？
我正在开发一个非常庞大的代码库,它使用sphinx-apidoc从Python源代码中的docstrings自动生成HTML文档.文档字符串使用以下格式： ：param message：要显示的消息：type message：string：返回：格式化字符串：rtype：string 要求将Sphinx HTML文档替换为以不同方式组织/呈现的内容 – 但我们仍然希望从源文档中自动生成文档字符串.有没有办法用Sphinx以中介(如xml)格式生成文档？我发现没办法做到这一点.谁知道我会做什么？解决方法...
使用sphinx快速为你python注释生成API文档
sphinx简介sphinx是一种基于Python的文档工具，它可以令人轻松的撰写出清晰且优美的文档，由Georg Brandl在BSD许可证下开发。新版的Python3文档就是由sphinx生成的，并且它已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持。更多详细特性请参考spinx官方文档，本篇博客主要介绍如何快速为你的Python注释生成API文档。 环境需要安装python安装sphinxpip install sphinx1实例新建一个项目 目录结构如上图所示，doc目...
php-Sphinx多个动态数据库索引【代码】
在我的情况下,我有一个包含多个数据库的Web应用程序.每个注册客户一个数据库.由于这些数据库是在用户注册时创建的,因此我无法将这些源手动添加为sphinx config.但是,所有数据库的结构都相同,搜索查询也相同.当然只是不同的数据库名称和数据.因此,问题是；可以将狮身人面像配置为从中获取数据库列表INI或其他外部文件,然后为这些数据库建立索引？然后,我可以在查询中传递数据库名称以从指定的数据库索引中获取结果吗？还是有其他工具...
mysql-Sphinx搜索引擎的缩写
我如何索引像“ m.i.a.”这样的缩写？当我搜索“ mia”时,我得到的结果是“ mia”而不是“ m.i.a.”.当我搜索“ m.i.a.”时,我什么也没得到. 编辑： 解决方案大致如下：ignore_chars =-,.解决方法:您可以添加“.”到您忽略的字符列表：http://www.sphinxsearch.com/docs/current.html#conf-ignore-chars 或者您可以添加m.i.a. > mia作为字形：http://www.sphinxsearch.com/docs/current.html#conf-wordforms
通过MySQL协议连接到Sphinx时出错
我正在使用宝石’思考 – 狮身人面像’,’?> 3.1.1’在我的Rails应用程序中.我按照Git hub的所有步骤进行安装思考-sphinx,但是当我搜索记录时它会给我错误Error connecting to Sphinx via the MySQL protocol. Error connecting toSphinx via the MySQL protocol. Can’t connect to MySQL server on‘127.0.0.1’ (111) – SELECT * FROM listing_core, listing_deltaWHERE MATCH(‘product 1‘) AND community_ids = 1 AND sphi...
mysql – Sphinx主/ delta索引,sql_query_killlist【代码】
我目前正在使用Sphinx索引具有2000万条记录的MySQL查询. 我使用delta索引来更新主索引并添加所有新记录. 不幸的是,删除了对表的所有更改. 我知道我可以使用sql_query_killlist来获取需要删除或更新的所有文档ID.不幸的是,我不明白这实际上是如何工作的,而且Sphinx的文档没有一个足够好的例子供我理解. 如果我使用以下示例,我该如何实现killlist？ 在MySQL中CREATE TABLE sph_counter (counter_id INTEGER PRIMARY KEY NOT NULL,max...
mysql – 当您向SQL添加数据时,Sphinx自动更新是否为索引？【代码】
我很好奇Sphinx是否会在您添加新SQL数据时自动更新其索引,或者您是否必须专门告知它重新编制数据库索引. 如果没有,有没有人有一个例子,说明当数据库数据发生变化时如何自动化这个过程？解决方法:如在sphinx documentation part about real-time indexes中找到的Real-time indexes (or RT indexes for brevity) are a new backend that lets you insert, update, or delete documents (rows) on the fly.因此,要动态更新索引,您只需...