Search Results for "document"

With the new dynamic documentation server in YARD 0.6, you can now see exactly what YARD sees as you document your code. Simply type yard server, reload to have your project watch for changes in your codebase everytime you refresh the page. With this functionality, you almost have no excuse not to write documentation! You can write all kinds of extensions in YARD, including ones that can understand all of the dynamic magic your framework does in its own little Domain Specific Languages (DSLs). ...

Mongoid is the officially supported ODM (Object-Document-Mapper) framework for MongoDB in Ruby. This Mongoid community organization is a group of open-source contributors around the Mongoid ODM not affiliated with the company, MongoDB. Mongoid is customarily configured through a mongoid.yml file that specifies options and clients. The simplest configuration is as follows, which configures Mongoid to talk to a MongoDB server at “localhost:27017” and use the database named “mongoid”. ...

HexaPDF is a pure Ruby library with an accompanying application for working with PDF files. It was designed with ease of use and performance in mind. It uses lazy loading and lazy computing when possible and tries to produce small PDF files by default.

...Jazzy can also generate documentation from compiled Swift modules using their symbol graph instead of source code. You need development tools to build the project you wish to document. Jazzy supports both Xcode and Swift Package Manager projects. Jazzy expects to be running on macOS. Run jazzy from your command line. Run jazzy -h for a list of additional options. Swift documentation is written in markdown and supports a number of special keywords. You can set options for your project’s documentation in a configuration file, .jazzy.yaml by default.

A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more. Asciidoctor is a fast, open source, Ruby-based text processor for parsing AsciiDoc® into a document model and converting it to output formats such as HTML 5, DocBook 5, manual pages, PDF, EPUB 3, and other formats. Asciidoctor also has an ecosystem of extensions, converters, build plugins, and tools to help you author and publish content written in AsciiDoc.

Grape is a Ruby framework for building REST-like APIs with a focus on simplicity and convention. It provides a DSL for declaring endpoints, parameters, formats, and validation rules, making it easy to build consistent and documented APIs. Grape supports multiple content types (JSON, XML, etc.), versioning, error handling, and authentication hooks, which are crucial for maintaining long-lived APIs. It integrates well with frameworks like Rails or Sinatra but can also be used standalone for...

...Comprehensive internationalization features, including full support for UTF-8 based fonts, right-to-left text rendering, fallback font support, and extension points for customizable text wrapping. Support for PDF outlines for document navigation. Low level PDF features, allowing users to create custom extensions by dropping down all the way to the PDF object tree layer. (Mostly useful to those with knowledge of the PDF specification). If you are looking for a highly flexible PDF document generation system, Prawn might be the tool for you. It is not a reporting tool or a publishing toolchain, though it could be fairly easily used to build those things.

API documentation generator for Sencha JavaScript frameworks. JSDuck aims to be a better documentation generator for Ext JS than the old ext-doc was. It is used by Sencha to document Ext JS 4, Sencha Touch and several other products. NB! Windows binaries are now hosted in Github: https://github.com/senchalabs/jsduck/releases

The XML Code Template Engine produces class code skeletons that can include equality and logging methods in C++ or Java(so far) from an XML document outlining. It also creates Doxygen compatible comments and a has very simple plugin system.

Document based acceptance tester. Similar to FIT in goal. Manages requirements documents in Word or RTF format that are created jointly by customer and developer. Requirements are parsed to extract a glossary and test suite.

This project will produce one or more tutorial documents covering object-oriented concepts for people who want to learn the Ruby programming language. The initial rubyboot document is based on the perlboot man page, from the standard Perl distribution.