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

First pass at setting up documentation. #58

Merged
merged 10 commits into from
Feb 15, 2017

Conversation

arokem
Copy link
Contributor

@arokem arokem commented Jan 9, 2017

Not everything is in place quite yet...

Not everything is in place quite yet...
@coveralls
Copy link

coveralls commented Jan 9, 2017

Coverage Status

Coverage remained the same at 85.987% when pulling ee1975a on arokem:documentation into a890ad0 on uwescience:master.

@arokem
Copy link
Contributor Author

arokem commented Jan 9, 2017

TODO:

  • Place the videos properly on the front page.
  • Examples folder in top level with a couple of example scripts.

Once everything is in place, we can run make upload to get the docs into the gh-pages branch

@coveralls
Copy link

coveralls commented Feb 15, 2017

Coverage Status

Coverage remained the same at 88.275% when pulling e6521e5 on arokem:documentation into 1b86d0a on uwescience:master.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.03%) to 88.304% when pulling c391c9d on arokem:documentation into 1b86d0a on uwescience:master.

@arokem arokem changed the title WIP: First pass at setting up documentation. First pass at setting up documentation. Feb 15, 2017
@arokem
Copy link
Contributor Author

arokem commented Feb 15, 2017

Looks great: http://uwescience.github.io/pulse2percept

The one thing that's still a bit weird is that this page has nothing on it: http://uwescience.github.io/pulse2percept/reference/pulse2percept.html

It looks like it's not picking up the functions in that module :-/

@mbeyeler
Copy link
Member

Well, there is no such module, right? That is, we don't have a high-level pulse2percept module, only a pulse2percept function in the effectivecurrent2brightness module.

Now the Python 3 tests seem to get stuck somehow and then error out... Python 2 tests run fine in my repo. Not sure what's going with Python 3...
There's also a PEP complaint but that's an easy fix.

Michael Beyeler and others added 2 commits February 15, 2017 11:34
@coveralls
Copy link

coveralls commented Feb 15, 2017

Coverage Status

Coverage decreased (-1.0%) to 87.312% when pulling cc780a8 on arokem:documentation into 1b86d0a on uwescience:master.

@arokem
Copy link
Contributor Author

arokem commented Feb 15, 2017 via email

@arokem
Copy link
Contributor Author

arokem commented Feb 15, 2017

I think this is ready to go!

@mbeyeler mbeyeler merged commit 798bdc6 into pulse2percept:master Feb 15, 2017
@arokem arokem mentioned this pull request Feb 20, 2017
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.

None yet

3 participants