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

Add support for Jazz Hands #405

Closed
wants to merge 5 commits into from
Closed

Add support for Jazz Hands #405

wants to merge 5 commits into from

Conversation

jemerick
Copy link
Contributor

Adds support for Jazzy to build docs using a custom theme that will later be pulled into the documentation portal.

Installation

[sudo] gem install jazzy

This PR is ready for review.

Risk

This PR makes no API changes, just adds a build step and requires jazzy to be installed.

Testing Plan

  1. Install Jazzy
  2. Build. Ensure Docs are updated to reflect any doc changes.

Summary

Add a build step for jazzy using a custom theme and include the docs in the repo.

@joeljfischer
Copy link
Contributor

joeljfischer commented May 27, 2016

I've been thinking about this some more. I don't think we want jazzy to build on every SDL build, because that would extend the build times dramatically. Second, building SDL is not currently building the docs for me. I think instead there should be a scripts folder that contains a build-documentation script that can be run to generate the documentation easily and integrated into a release script eventually as well. This would mean that random branches wouldn't necessarily have the up to date docs, however I don't want to take the fairly quick rebuild times and extend them to nearly 30 seconds. That would just kill productivity. In the future, we at livio could build a commit bot that would run the documentation parser and modify commits to include it since github just released that capability.

@joeljfischer
Copy link
Contributor

We could also expand Travis to build and upload these for us as well?

@joeljfischer joeljfischer added this to the 4.1.X milestone May 27, 2016
@joeljfischer
Copy link
Contributor

Closed in favor of #417

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

Successfully merging this pull request may close these issues.

None yet

2 participants