-
Notifications
You must be signed in to change notification settings - Fork 5
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
implemented all docstrings for sphinx doc and added doc build to Travis CI #23
base: master
Are you sure you want to change the base?
Conversation
followed format in cesium repo
If you rebase this on master, do the tests still fail? |
I've merged my forked repo with master but the tests are still failing. Failed tests for missing packages (e.g. nibabel, tables) issues. |
Please coordinate with @alvinzz and @MichaelTamaki |
If the packages can be installed with pip, you should be able to just add them to the requirements.txt file |
@@ -10,4 +10,7 @@ install: | |||
#command to run tests | |||
script: nosetests --exe --with-coverage --cover-package=music_feats | |||
|
|||
#command to build sphinx documentations | |||
script: sphinx-build -nW -b html -c ./config -d _build/doctrees . _build/html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For multiple lines in a specific keyword "script", try
script:
- nosetests --exe --with-coverage --cover-package=music_feats
- sphinx-build -nW -b html -c ./config -d _build/doctrees . _build/html
I'm actually not sure if building sphinx docs this way would work however...
I'm not sure if it's possible to auto-generate docs via Travis-CI, I looked online for some solutions... And maybe look at Cesium's implementation? |
thanks guys for the suggestions! I've fixed the import (seems like there were only 3 packages that weren't included yet in the requirements.txt). Now the issue is pip can't update the latest version of pretty_midi package (that accommodates both py2 and py3), because it has an outdated midi package. I'm looking for ways around that. |
|
Yeah I fixed that! @stefanv do you mind checking the current error message? It seems like the sphinx/environment.py can't find "/home/travis/build/weiwzhang/music-features/_build/doctrees/index.doctree". But I tried locally and I do have index.doctree in my _build/doctrees folder...thanks!! (Build#27: https://travis-ci.org/weiwzhang/music-features/builds/184866101) |
have also implemented a LICENSE.txt.
still failing Travis CI tests (package import issues)