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

DOC: Add basic Neuroscout Documentation #685

Merged
merged 22 commits into from Dec 3, 2019
Merged

DOC: Add basic Neuroscout Documentation #685

merged 22 commits into from Dec 3, 2019

Conversation

adelavega
Copy link
Collaborator

Closes #253

Documentation will be served here: https://neuroscout.github.io/neuroscout/

To edit docs, edit files in docs/ then run: mkdocs serve. This starts a local server to edit the docs.

Finally, to server, usec ommand mkdocs gh-deploy. This will automatically update the gh-pages branch, which will push live changes to the docs.

@codecov-io
Copy link

codecov-io commented Nov 9, 2019

Codecov Report

Merging #685 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #685   +/-   ##
=======================================
  Coverage   85.67%   85.67%           
=======================================
  Files          66       66           
  Lines        2932     2932           
=======================================
  Hits         2512     2512           
  Misses        420      420

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fba6542...1721367. Read the comment docs.

@adelavega
Copy link
Collaborator Author

@tyarkoni I added some basic docs for "Browsing" and the cli. It's live so you can check it out.

@adelavega adelavega merged commit 4ea1e62 into master Dec 3, 2019
@adelavega adelavega deleted the mkdocs branch December 3, 2019 21:13
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.

Model creation tutorials
2 participants