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

Temporarily point to a fork of SDoc #30199

Merged
merged 1 commit into from Aug 17, 2017

Conversation

Projects
None yet
2 participants
@robin850
Member

robin850 commented Aug 11, 2017

Hello,

As a beta of Rails 5.2 will be released in the near future, it would be cool to use an "updated" version of SDoc so people testing the beta can also report eventual problems / bugs on the API site to make sure that we won't have any issue with the final release's docs that would get reported a dozen times.

Pull requests have been open on the sdoc repository to bring these changes but they haven't been yet processed and since version 1.0 is still in a release candidate state and these changes would be included in 1.1, I took the liberty to create a fork with all the changes.

This fork brings the following changes:

  • A tiny refresh of the default theme. (zzak/sdoc#108)
  • SEO tags to class files. (zzak/sdoc#109, cross-ref #27633)
  • The removal of HTML tags from search results. (zzak/sdoc#110)
  • Some general template clean-up (HTML 5, removal of the jQuery
    effect library, etc.).
  • A speed up of the generation time. This one hasn't been sent as a pull request as it partly depends on the previous changes.

Regarding this last point, YMMV but on my computer (macOS with an Intel Core i5 @ 2,7 GHz and Ruby 2.4.1), the generation with sdoc 1.0.0rc2 takes ~83s and with the fork ~52s.

If you have any suggestion regarding these changes, feel free to comment or open a pull request against this fork and I will happily cherry-pick commits on the relevant branches to give proper credit on the sdoc side. ❤️

Have a nice day !

@robin850 robin850 added the docs label Aug 11, 2017

@robin850 robin850 added this to the 5.2.0 milestone Aug 11, 2017

Temporarily point to a fork of SDoc
This fork brings:

* A tiny refresh of the default theme.
* SEO tags to class files.
* The removal of HTML tags from search results.
* Some general template clean-up (HTML 5, removal of the jQuery
  effect library, etc.).
* A speed up of the generation time (by ~30 seconds).

@rafaelfranca rafaelfranca merged commit 25ccf03 into rails:master Aug 17, 2017

2 checks passed

codeclimate All good!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@robin850 robin850 deleted the robin850:upgrade-sdoc branch Aug 17, 2017

zzak added a commit that referenced this pull request Aug 26, 2017

Bump SDoc
This release includes commits from @robin850

See #30199 for more info

@zzak zzak referenced this pull request Aug 26, 2017

Closed

Bump SDoc #30420

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment