`
sinkzephyr
  • 浏览: 89650 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

rdoc生成gem的api文档

    博客分类：
  • Ruby
F# 
阅读更多
用rdoc --help查看帮助.

在gems所在的目录，运行： 
rdoc -f chm -o chm_folder gems_folder_name


-f 是生成的文档格式,支持chm.
chm_folder是生成目的目录
gems_folder_name是目标gems所在的目录


例子 
rdoc -f chm -n hpricot -o hpricot-chm hpricot-0.6.161
分享到：
| autotest, 让你的rspec测试自动化(三)--L ...
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Ruby-RDoc用于为Ruby项目生成HTML和命令行文档

    使用RDoc生成HTML文档的步骤通常是这样的： 1. 首先，在你的Ruby源代码中添加RDoc注释。这些注释应该描述类、模块、方法的用途、参数、返回值等。例如： ```ruby class MyClass # 这是一个描述方法的方法 # @...

    生成Ruby的离线文档

    3. **运行文档生成命令**：在源码目录下，可以使用RDoc或YARD的命令行工具来生成文档。例如，使用RDoc可能会运行`rdoc --all --fmt html`，这将生成所有源码的HTML文档。 4. **组织和浏览离线文档**：生成的HTML...

    rdoc：RDoc为Ruby项目生成HTML和在线文档

    它的主要目标是帮助开发者创建结构清晰、内容丰富的API文档，这些文档可以方便地在线查看或下载为本地HTML文件。RDoc不仅支持Ruby源代码的注释，还支持Markdown语法，使得文档内容更加丰富多彩。 ### 主要功能 1. ...

    rain:受 rdoc 和 yard 启发的 ruby​​ 和 markdown 内联代码 API 文档工具，具有易于修改的 HTML 模板和样式

    Rain 是一个可生成美观且可定制的 API 文档的宝石，其灵感来自 yard 和 rdoc。 rain 的目标是从混合了 Markdown 的 ruby​​ 注释语法生成漂亮的 API 文档。 该文档可以内嵌在 .rb 文件中，或者单独的 .md 或 ....

    ruby 最新 安装文件 与 API

    RDoc是Ruby的官方文档生成工具，它能够从源代码注释中提取信息，生成HTML或其他格式的API文档，帮助开发者理解和使用Ruby代码。安装RDoc后，开发者可以通过`rdoc`命令来生成项目的文档，这对于开源项目和团队协作...

    Ruby-DocumentationRails引擎提供文档添加到Rails应用程序的功能

    例如，你可以使用RDoc、Yard或者Sdoc，这些工具可以解析Ruby源代码并生成易于阅读的HTML文档。 3. **配置文档生成**：在引擎的配置文件中，设定文档生成的参数，如输出格式、目录位置等。 4. **创建任务**：使用...

    支持搜索功能界面美化版rails API

    在Rails项目中，rdoc文件通常包含了项目的API文档，有助于开发者理解和使用代码。 6. **版本控制**: 虽然描述中没有提及，但Rails项目通常会使用Git进行版本控制，这在协作开发和代码管理中至关重要。 7. **测试**...

    watir-bonus-1.5.2

    1. **rdoc** - 这通常是Ruby文档生成器RDoc生成的API文档，用于详细介绍Watir-Bonus库的各种类、方法及其用法。通过阅读这些文档，开发者可以了解如何利用Watir-Bonus进行测试脚本的编写，找到具体的方法来执行各种...

    Rails API

    这个API文档是用rdoc工具从Rails的源代码生成的，旨在帮助开发者理解和利用Rails的强大功能。CHM（Compiled HTML Help）格式使得文档能够以离线方式查看，并且支持全文搜索，使得在开发过程中快速查找和定位关键信息...

    rubygems-3.2.27.tgz

    7. **文档生成**：RubyGems可以自动生成gem的文档，如RDoc或Yard，使开发者更容易理解和使用gem。 在“rubygems-3.2.27”这个版本中，我们可以期待以下可能的变化： - **性能优化**：新版本可能会针对gem的安装和...

    Ruby-Blanket一个超级简单的API包装器

    8. **文档生成**：通过集成其他工具，如Rdoc或Yard，Blanket可以生成关于如何使用包装器的文档，方便团队协作和维护。 使用Blanket，开发者可以专注于业务逻辑，而无需关心底层的HTTP请求细节。这使得开发过程更加...

    Ruby-Manpages为rubygems添加手册页支持

    1. **创建文档**：为各个 gem 自动生成手册页，通常基于源代码的注释，如 Yardoc 或 RDoc。 2. **集成**：将生成的手册页集成到 RubyGems 的安装过程中，使得当 gem 安装完成后，其手册页也一并可用。 3. **访问**：...

    motion-support:RubyMotion标准库的常用扩展

    API文档 。 部分加载 也可以只使用该库的一部分。 为此，请更改您的Gemfile ，使其显示为： gem 'motion-support' , :require => false 然后将如下所示的require语句添加到您的Rakefile 。 全部 require 'motion-...

    绿化ruby193

    它包含了各种内置模块和类，如`Array`、`String`、`Hash`等，以及一些实用工具，如`irb`(交互式Ruby shell)和`rdoc`(用于生成API文档的工具)。 绿化Ruby193的过程通常涉及以下步骤： 1. 下载Ruby193的完整源码或预...

    structured-finance-application

    10. **文档**：项目可能会有 README 文件提供快速入门指南，Gemspec 文件描述 gem 的元数据，YARD 或 RDoc 生成的 API 文档帮助理解项目结构和功能。 通过深入研究这个项目，你可以了解如何使用 Ruby 来解决结构化...

    building_a_rails_api

    可以使用像Swagger或RDoc这样的工具自动生成文档。 13. **部署** 最后，将应用部署到服务器，如Heroku或AWS，确保所有依赖项已正确配置。 通过以上步骤，你将拥有一个基本的Ruby on Rails API。随着需求的增长，...

    Ruby：我学习Ruby存储库的时间

    Ruby项目通常使用Yard或RDoc这样的工具生成API文档，通过README文件介绍项目用途和安装步骤，以及使用Rake任务自动化文档生成和测试过程。 在学习Ruby存储库时，掌握这些基础知识和工具是至关重要的。它们将帮助你...

    docible

    在Ruby世界里，创建和管理文档通常涉及使用像RDoc或YARD这样的文档生成工具。这些工具能够从源代码中的特殊注释中提取信息，生成易于阅读的HTML或其他格式的文档。如果“docible”是一个文档工具，它可能提供了不同...

    powerbi-integration

    Ruby社区有许多优秀的文档生成工具，如Yard或RDoc，可以帮助生成清晰的API文档。 以上是关于“powerbi-integration”的一些关键知识点，涵盖了使用Ruby与Power BI集成的主要方面。实际项目可能涉及到更多细节，如...

    on_fork:当 Ruby 进程分叉时运行的代码管理器

    此任务将安装任何缺少的依赖项，运行测试/规范，并生成 RDoc。 执照： （麻省理工学院许可证） 版权所有 (c) 2015 埃文·菲尼克斯 特此授予任何人免费获得本软件和相关文档文件（“软件”）副本的许可，不受限制...

Magicbox
Global site tag (gtag.js) - Google Analytics