Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Still using rdoc for doc generation? #85

Closed
utkarsh2102 opened this issue May 21, 2020 · 1 comment
Closed

Still using rdoc for doc generation? #85

utkarsh2102 opened this issue May 21, 2020 · 1 comment

Comments

@utkarsh2102
Copy link

Hi @mvidner,

Thanks for your work on ruby-dbus so far.
However, whilst maintaining this in Debian, I stumbled upon this:
rdoc --all --line-numbers -o doc/rdoc lib --> which means that we're relying on rdoc for docs generation. The previous maintainer of the Debian package left the following comment:

Title: Documentation of the Ruby bindings for D-Bus
Author: Chris Lalancette et al.
Abstract: This API documentation is generated with RDoc from the source of
 Ruby/Dbus, providing Ruby bindings for D-Bus.

However, whilst working on the Reproducible Build front, I noticed that the generation of docs using rdoc makes this gem build un-reproducibly. So I am inclined to remove the rdoc generation part altogether.

Before I do, I wanted to know where that is the correct thing to do? Or are you really using RDoc for some part of documentation generation?

@mvidner
Copy link
Owner

mvidner commented Feb 10, 2022

Hi @utkarsh2102,

sorry for the delay.

I have switched from RDoc to YARD in 22bf8f0 (2012 already, released in v0.9.1).

@mvidner mvidner closed this as completed Feb 10, 2022
mvidner added a commit that referenced this issue Feb 10, 2022
found while looking for RDoc traces for #85.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants