Add documentation #10
Open
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
tbekolay
force-pushed
the
docs
branch
2 times, most recently
from
be16e23 to
fd66f84
Compare
This includes a page with Spaun videos, and the list of popular press articles, both of which are ported from nengo.ca. In the future, we can flesh this out with API docs, command line usage, and more.
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 includes a page with Spaun videos, and the list of popular press articles, both of which are ported from nengo.ca.
In the future, we can flesh this out with API docs, command line usage, and more. But for now, it's worth having so that we can point people to this page in lieu of having this content on nengo.ca.
Note that this includes a
.travis.yml, which can be used to build the documentation. Two things have to happen for this to work: enable this project on TravisCI, and to make a security token that TravisCI can use to push to this repository.@xchoo, if you want to do this stuff now, hit me up on Slack, but it doesn't actually have to happen right now as I've also pushed the
gh-pagesbranch that TravisCI would create, so the documentation is already rendered properly at http://xchoo.github.io/spaun2.0/. I don't think these docs will change anytime soon, so we can deal with the TravisCI stuff when we figure out where this repo will live long-term.