Dne 01. 11. 22 v 5:51 Benson Muite napsal(a):
On 10/26/22 18:32, Vít Ondruch wrote:
>
> Dne 26. 10. 22 v 16:50 Vít Ondruch napsal(a):
>>
>> Dne 26. 10. 22 v 11:59 Jarek Prokop napsal(a):
>>
>>> I am afraid we won't dodge monkey patching here due to the lack of
>>> parametrization of the documentation generator options.
>>
>>
>> I will need to experiment with this idea a bit.
>>
>>
>
> One option to avoid the monkey patching is to convince RubyGems to
> load the appropriate rubygems/rdoc.rb (but this is done via
> require_relative, so this probably won't fly) or provide our own
> rdoc/rubygems_hook and ensure it is loaded earlier then the original
> one (but this could mean keeping our own copy :/).
>
> We could also try to somehow modify the Gem.done_installing hooks and
> remove the RDoc hook and replace it with ours.
>
> Another option might be to provide additional generator, which would
> override the 'rdoc' directory generated by Darkfish.
>
Leaving RDoc as it is and applying patches to the generated
documentation might be easier to maintain. The prototype code on cgit
does this well, but rather than changing RDoc, it may be better to
change the Fedora Ruby documentation build process. In particular:
a) Fonts can be symlinked, there are 652K for each install.
In theory, this should not be needed if the fonts are installed into
system location. In that case, browser should be able to pick them up.
This just needs minor .css modification IMHO. However, I am not CSS
expert. But I am quite confident anyway ;)
b) Standard images should also be symlinked 104K for each install.
One
can use a script to remove standard images and link them to images
from a supplementary Fedora RDoc package.
Right. However, on top of that, I have my doubts the images are actually
used, at least most of them. I think I have found traces about usage of
four of them.
c) Css files similarly can be symlinked. 20K per install.
If we don't install the fonts, the license information from .css files
could be removed and the size possibly reduced.
Finally, it may be good to split the documentation sub package into a
commandline sub package with RI files, and web doc sub package with
RDoc files. Have a few packages for review where have
Right, -ri and -rdoc subpackages would be nice as well as having them
autogenerated. Keeping the -doc just for doc stuff and possibly have
-test subpackage (if I am not mistaken, Perl started to ship -test
subpackages for great benefit).
As you can see, if you start to dig into this, you can quickly find more
issues which would deserve attention to make things better (including
ideas such as [1]). It is not easy to pick a spot where to start to make
things better, which results in paralysis and keeping status quo.
But hopefully, we are moving somewhere finally. So thank you for your
patience and nudging us to make the improvements.
Vít
[1]
https://github.com/rubygems/rubygems/discussions/6021
>
> Just ideas .....
>
>
> Vít
>
>
> _______________________________________________
> ruby-sig mailing list -- ruby-sig(a)lists.fedoraproject.org
> To unsubscribe send an email to ruby-sig-leave(a)lists.fedoraproject.org
> Fedora Code of Conduct:
>
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
> List Guidelines:
https://fedoraproject.org/wiki/Mailing_list_guidelines
> List Archives:
>
https://lists.fedoraproject.org/archives/list/ruby-sig@lists.fedoraprojec...
> Do not reply to spam, report it:
>
https://pagure.io/fedora-infrastructure/new_issue
_______________________________________________
ruby-sig mailing list -- ruby-sig(a)lists.fedoraproject.org
To unsubscribe send an email to ruby-sig-leave(a)lists.fedoraproject.org
Fedora Code of Conduct:
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines:
https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives:
https://lists.fedoraproject.org/archives/list/ruby-sig@lists.fedoraprojec...
Do not reply to spam, report it:
https://pagure.io/fedora-infrastructure/new_issue