rubydoc.info
YARD
rubydoc.info | YARD | |
---|---|---|
6 | 18 | |
132 | 1,907 | |
0.0% | - | |
5.3 | 6.5 | |
9 months ago | 9 days ago | |
Ruby | Ruby | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
rubydoc.info
-
What's the Difference Between `ruby-doc.org` and `docs.ruby-lang.org`?
Yes, I use rubydoc.info to refer to the docs for gems, didn't realize until now that it also includes documentation for Ruby itself. Thanks!
-
Xeme: I'd value your opinion on my new Ruby gem
GitHub will render markdown (and other formats), but I don't believe it supports parsing and rendering YARD or RDoc. Both tools ship with tools that generate documentation websites that you can use for your project. YARD also has https://rubydoc.info
-
Is anybody aware that rubydoc.info is down?
Right now, gemdocs.org is very similar to rubydoc.info as it both uses YARD, with rubydoc.info supporting custom YARD plugins for gems (which might make some gem output look better if they specify said plugins). I have some ideas for improving Ruby documentation in general, so I've been trying to not add too much functionality to YARD as I might be trying to pivot back to RDoc.
-
What's the skinny re: rubydoc.info?
The experiment is: can I pre-generate and store the docs forever? Everyone is probably going to say sure, stick them on S3 and forget about it. But how does that get funded? Who is going to pay for that? rubydoc.info is hosted via sponsorship.
-
What's up with rubydoc.info?
rubydoc.info is supported by one person and is open-source. Care to report the problems here: https://github.com/docmeta/rubydoc.info ?
YARD
-
What is JSDoc and why you may not need typescript for your next project?
JSDOC is a predefined method of documenting code for javascript ecosystem created in 1999 that works similar to libraries for other languages such as: Javadoc for java, YARD for ruby, etc..
-
Xeme: I'd value your opinion on my new Ruby gem
In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.
-
Programming types and mindsets
I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.
-
kwargs and YARD: @param or @option?
I had a dig into the file history, and it looks like we have to go back to 0.7 to find the old tag list. Here we find the info we need to understand the intent of the @option tag:
-
Comparing RDoc, YARD, and SDoc: Choosing the Right Documentation Generator for Your Ruby on Rails 5 Project
YARD: http://yardoc.org/
-
How do you document your code?
I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
-
The right is on the left
That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
-
#buildinpublic, issue 1: building API documentation browser for command line
My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.
-
The Why and How of Yardoc
I’ve long used the YARD format and chose to use that as my documentation syntax. I suppose I didn’t check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.
-
Graphic representation of class / module inheritance in Rails?
That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).
What are some alternatives?
chunky_png - Read/write access to PNG images in pure Ruby.
RDoc - RDoc produces HTML and online documentation for Ruby projects.
sord - Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files
Apipie - Ruby on Rails API documentation tool
rdoc-markdown - RDoc to Markdown generator
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Asciidoctor - :gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
rubocop - A Ruby static code analyzer and formatter, based on the community Ruby style guide.
Annotate - Annotate Rails classes with schema and routes info
zeal - Offline documentation browser inspired by Dash
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.