草庐IT

文档模板

全部标签

ruby - 使用 YARD for Ruby 文档的内部评论?

我正在将我维护的ruby​​gem从RDoc切换到YARD文档。但是,代码中有一些关键注释只需要保留在代码中,不应出现在文档中。例如:###SomeClassdocumentationhere.#--#CRITICALcommentthatshouldbeinthecodebutnotinthedocumentation,#andmustbeatthisparticularspotinthecode.#++#moredocumentationthatfollowsthecriticalcommentblock,butthispart#shouldbeinthegenerateddocu

ruby-on-rails - REST API 文档生成

是否有库提供用于编写​​RESTAPI文档的标记?我见过几家公司使用类似的文档模式,例如:http://api.teamlab.com/2.0/http://www.fullcontact.com/docs/?category=person我想知道他们是否使用相同的库或服务。本质上,该库应该根据标记文本生成用于API导航、搜索和显示的页面(很像用于ruby​​文档的YARD)。这是我目前发现的:rapi_docgem.这是一个article讨论用法。 最佳答案 你绝对应该看看Swagger.它是开源的,被数百个API使用,也被3sc

【Elasticsearch基础】Elasticsearch索引、文档以及映射操作详解

文章目录概念索引相关操作创建索引更新副本查看索引删除索引索引的打开与关闭收缩索引索引别名查询索引别名文档相关操作新建文档查询文档更新文档删除文档映射相关操作查询文档映射创建静态映射创建索引并添加映射概念es中有三个概念要清楚,分别为索引、映射和文档(不用死记硬背,大概有个印象就可以)索引可理解为MySQL数据库;映射可理解为MySQL的表结构;文档可理解为MySQL表中的每行数据静态映射和动态映射上面已经介绍了,映射可理解为MySQL的表结构,在MySQL中,向表中插入数据是需要先创建表结构的;但在es中不必这样,可以直接插入文档,es可以根据插入的文档(数据),动态的创建映射(表结构),这就

安装 ri 文档时 Ruby gem 失败

我正在尝试在我的Debian6.0.4机器上安装GitLabHQ。这是2012年4月13日的全新安装。现在我已经到了需要由Rubygem完成一些安装的地步。特别是:geminstallbundler这揭示了以下错误:Successfullyinstalledbundler-1.1.31geminstalledInstallingridocumentationforbundler-1.1.3...ERROR:Whileexecutinggem...(ArgumentError)undefinedclass/moduleEncoding然后我尝试重建Ruby包gempristine--al

ruby - Chef - 提供者内的模板找不到源

我有一些nginx站点的资源和提供程序,它可以为站点写出配置文件。action:startdotemplate"/etc/nginx/sites-enabled/my_site"dosource"nginx_site.conf.erb"notifies:reload,"service[nginx]"endend当我从另一本Recipe中使用它时,找不到模板nginx_site.conf.erb,因为Chef正在寻找调用此资源的模板。有没有办法告诉Chef在nginx资源和提供者Recipe中寻找模板? 最佳答案 您可以为templa

ruby-on-rails - 如何使用 Rails 或 Ruby 文档?

我来自C#,最近我开始编写一些RubyonRails应用程序。我最大的问题是文档,因为我发现它极难使用。例如,找出如何从我的Controller调用生成器花了我大约2小时,然后15分钟之后我找到了Rails::Generators.invoke方法来找出我应该传递给这个函数的参数.也许我使用文档的方式不对;首先,我大胆猜测并在Netbeans代码完成中搜索,这几乎没有帮助,然后我在Google中搜索,然后使用API。有经验的Rails程序员可以给我一些建议吗? 最佳答案 如果您是Rails的新手,我建议您先阅读一本书,然后再深入研究

ruby-on-rails - Rails 应用程序模板

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭4年前。Improvethisquestion我开始学习RubyonRails。我想创建一个应用程序,但我知道我将不得不重复很多已经完成一百万次的事情(例如用户身份验证等)。我刚刚了解到Rails模板。据我了解,您可以使用其中一个模板来创建新的Rails应用程序并设置很多基础知识。我在哪里可以找到一些最流行的模板,我应该使用其中之一吗?

ruby-on-rails - ActionView::TemplateError(缺少模板)在 ruby​​ on rails 中

我正在运行一个RoR应用程序(rails2.3.8,ruby1.8.7),该应用程序在我的本地机器上运行良好。但在生产中,日志显示以下错误:ActionView::TemplateError(Missingtemplatefolder/_file_name.erbinviewpathapp/views)online#19ofapp/views/layouts/main.rhtml:19:"folder/file_name"-%>文件名为folder/_file_name.html.erb,我试图在生产环境中重现该问题,但没有成功,出于某种原因,rails应用程序要求folder/_fi

ruby-on-rails - Rake 文档 :app fails after upgrading to Ruby 2. 1.1 和 Rails 4.1

我使用命令rakedoc:app为我的Rails应用程序生成一些基本文档。它在过去一直运行良好。昨天我通过应用程序从Ruby1.9.3升级到2.1.1,从Rails3.2升级到4.1。该应用程序一切正常,所以几周后我第一次重新生成文档,但失败了。我运行上面的命令并收到以下错误消息:rakeaborted!Don'tknowhowtobuildtask'README.rdoc'/home/vagrant/.rvm/gems/ruby-2.1.1/bin/ruby_executable_hooks:15:in`eval'/home/vagrant/.rvm/gems/ruby-2.1.1/

ruby - 使用 ruby​​ 解析 PDF 文档

我在一个文件夹中有多个具有特定结构的PDF文档:现在我希望能够解析PDF中的信息。请注意,段落的长度各不相同。显然,我并不是要你为我解决问题,但我确实需要一些关于如何实现这一目标的指导。我以前使用过nokogiri,从技术上讲,我需要类似的东西,但用于PDF。因此我的示例的伪结果如下所示:-ItemA-Title:ItemA-File:123456789.pdf-Image:ImageA.png(theimagewasstoredondisk)-Subtitle1:Contentforsubtitle1-Subtitle2:Contentforsubtitle2-Subtitle3:C