Use ReadTheDocs theme for documentation #2723
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview: https://dropwizard.readthedocs.io/en/rtd/ @dropwizard-committers When somebody wants to port the search bar and the version selection to Dropwizard's original theme, I'm happy to keep using it. |
nickbabcock
approved these changes
Apr 7, 2019
|
Overall, looks good, but one unfortunate downside I see is that the Dropwizard Configuration Reference page becomes much harder to use due to the layout being so narrow. |
|
@pstackle I've made the theme a little bit wider to accommodate wide tables (although the configuration reference still doesn't fit). @dropwizard-committers If you're okay with it, I'd merge this PR and release Dropwizard 2.0.0-rc1 in the next days. The latest version of the docs created from this branch are at https://dropwizard.readthedocs.io/en/rtd/. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of hosting the Dropwizard documentation on GitHub pages and having to update the
gh-pagesbranch (semi-) manually after each release, we can use https://readthedocs.org/ which will take care of building the documentation and serving it in multiple versions.While the original Dropwizard theme could be used on ReadTheDocs, the official RTD theme providers some features which we would have to add to the original theme, such as: