Documentation and man page reorganization#246
Merged
Conversation
rfecher
added a commit
that referenced
this pull request
Mar 4, 2015
Documentation and man page reorganization
This file contains hidden or 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
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.
This commit reorganizes the documentation files to get around an earlier issue with the asciidoc maven plugin not generating man pages and contains the configuration to replace the current https://ngageoint.github.io/geowave/ site. The two new content pages, PDAL and GSOC 2015 have also been migrated into the new format.
EPUB3 support has been added with a new (alpha) library. The epub output looks pretty bad at the moment but we can follow along and at the point it's decent we could start distributing in that format. Man pages are still generated but only by the backend Jenkins worker that has the native asciidoc package installed.
For ease of inspection I've pushed the site generated from this commit to my fork and can be viewed at http://spohnan.github.io/geowave/
To generate the documentation locally check out this branch and run the command
mvn -P docs -pl docs installand look under the target/site directory. I ended up using a black on white stylesheet as it seemed more readable but docs/pom.xml line 196 can be changed to<stylesheet>slate.css</stylesheet>or a new stylesheet could be created if the dark theme is desired.