-
Notifications
You must be signed in to change notification settings - Fork 1
Add pelican-based webpage #588
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
Merged
Merged
Conversation
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
Include it as the website homepage.
Argh... case-insensitive filesystem led me astray.
We don’t need to talk about building the docs right up front.
It’s already at the top of the page.
Contributor
|
@bgrant this is awesome -- thank you for putting this together, and for adding some polish. Looks like Travis is breaking from the known issue with the update to NumPy 1.9. Does not appear to affect this PR's content. |
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.
Add a pelican-based website for DistArray. It will allow us to easily add content in the future. To see the generated website, see http://docs.enthought.com/distarray.
Requires the python package pelican. Pelican lets us add content as restructuredText, Markdown, or AsciiDoc. I also use the pelican theme pelican-bootstrap3.
I've split up and re-used
.rstfiles from the docs as much as possible for the webpage. I've integrated @kwmsmith'soverview.rstdocument from a branch of his.As part of this PR, I add a
wwwdirectory todocsand rearrange thedocsdirectory a bit. I put all of the sphinx documentation into asphinxsubdirectory ofdocs, and I add another subdirectory fortalks.If you have
pelicaninstalled, you should be able to go to thedocs/wwwdirectory, typeAnd go to
localhost:8000to see the website locally.make githubwill build and push the website to ourgh-pagesbranch (requiresghp-import). See the README document indocs/wwwfor more.Some content highlights
features.ipynbadded as one of our pages (updated and improved in another PR)Talkspage