Skip to content

implemented all docstrings for sphinx doc and added doc build to Travis CI#23

Open
weiwzhang wants to merge 31 commits into
machine-shop:masterfrom
weiwzhang:master
Open

implemented all docstrings for sphinx doc and added doc build to Travis CI#23
weiwzhang wants to merge 31 commits into
machine-shop:masterfrom
weiwzhang:master

Conversation

@weiwzhang

Copy link
Copy Markdown

have also implemented a LICENSE.txt.
still failing Travis CI tests (package import issues)

@stefanv

stefanv commented Nov 29, 2016

Copy link
Copy Markdown
Contributor

If you rebase this on master, do the tests still fail?

@weiwzhang

Copy link
Copy Markdown
Author

I've merged my forked repo with master but the tests are still failing. Failed tests for missing packages (e.g. nibabel, tables) issues.

@stefanv

stefanv commented Dec 1, 2016

Copy link
Copy Markdown
Contributor

Please coordinate with @alvinzz and @MichaelTamaki

@alvinzz

alvinzz commented Dec 1, 2016

Copy link
Copy Markdown
Contributor

If the packages can be installed with pip, you should be able to just add them to the requirements.txt file

Comment thread .travis.yml Outdated
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

@MichaelTamaki MichaelTamaki Dec 1, 2016

Copy link
Copy Markdown
Contributor

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...

@MichaelTamaki

MichaelTamaki commented Dec 1, 2016

Copy link
Copy Markdown
Contributor

I'm not sure if it's possible to auto-generate docs via Travis-CI, I looked online for some solutions...
https://github.com/Syntaf/travis-sphinx

And maybe look at Cesium's implementation?
https://github.com/cesium-ml/cesium

@weiwzhang

Copy link
Copy Markdown
Author

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.

@stefanv

stefanv commented Dec 14, 2016

Copy link
Copy Markdown
Contributor

numpydoc should be added to the .travis.yml but not the requirements.txt---it is not a music-features requirement directly.

@weiwzhang

weiwzhang commented Dec 14, 2016

Copy link
Copy Markdown
Author

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)

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.

4 participants