Conversation
Codecov Report
@@ Coverage Diff @@
## master #445 +/- ##
=======================================
Coverage 75.73% 75.73%
=======================================
Files 65 65
Lines 3820 3820
=======================================
Hits 2893 2893
Misses 927 927
Continue to review full report at Codecov.
|
|
@rbroc do you mind taking a look at the docs to see if theres anything you want to add or improve? just wanted to get the ball rolling. |
|
had a look and pushed a couple of fixes to typos/issues with docstrings.
Re: tutorials and quickstart (though not relevant to this PR), probably worth developing a section for Bert, AudioSet and other DL models where complexity scales a bit. Probably also an example with Let's touch base on these points later, happy to help with fixes to docs and/or tutorials. :) |
|
Yes, I think that's what's missing! Feel free to take a stab if you have some free cycles. |
|
@rbroc have you had any time to work on the changes you wanted to make? |
|
done now - maybe do take a quick look just to make sure I did it right ;) |
|
Roberta, looks good, however now I'm realizing something is going wrong w/ Sphinx. The substitutions are failing at sometimes that I wouldn't expect them to. Also, the autodefinition tables are blank. Take a look at the artifact: https://github.com/PsychoinformaticsLab/pliers/suites/2267564946/artifacts/47272079 I'm not sure what's going on, but some of this stems from the prior PR it seems, so perhaps its a more general issue with the GH Actions. Anyone have any clues? @tyarkoni ? |
|
See how the autodoc is yielding empty docstrings: http://psychoinformaticslab.github.io/pliers/reference.html#module-pliers.extractors |
|
Okay, that was a pain but I fixed it. Sphinx could not find pliers. had to remake the entire action w/ custom code but now we're not relying on an obscure github action that wasn't doing much in the first place. still a few more minor sphinx errors to be fixed but otherwise, this should be close |
| @@ -1,15 +1,9 @@ | |||
| # pliers | |||
There was a problem hiding this comment.
If you want to be even more radical (and recycle the README.md in the docs, you can convert the readme to rst and include the README.rst in index.rst like fmriprep does
There was a problem hiding this comment.
That's basically what I was too lazy to do but its a good idea
Co-authored-by: James Kent <jamesdkent21@gmail.com>
README.rst
Outdated
| (possibly platform-dependent) requirements. For example, python-magic | ||
| requires libmagic and without this, you’ll be relegated to loading all | ||
| your stims explicitly rather than passing in filenames (i.e., | ||
| ``stim = VideoStim('my_video.mp4')`` will work fine, but passi |
There was a problem hiding this comment.
it does look like the README is cut off?!?
There was a problem hiding this comment.
Wild. I've always suspected @adelavega doesn't know how to operate copy and paste ;)
There was a problem hiding this comment.
heh, actually I blame the markdown -> rst converter @jdkent gave me
There was a problem hiding this comment.
sounds right, must be a limit on the website, I guess you need to run pandoc locally.
There was a problem hiding this comment.
I did now. Now something seems to be failing w/ sphinx grr
There was a problem hiding this comment.
that's odd: something to do with this changing?
success: https://github.com/PsychoinformaticsLab/pliers/runs/2169953211?check_suite_focus=true#step:5:15
failure: https://github.com/PsychoinformaticsLab/pliers/runs/2186864097#step:5:14
I wonder why that changed? would manually adding /home/runner/.local/bin to PATH fix it?
5 participants
Closes #402
I updated the docs to reflect new features added in the last few releases. I didn't make any other substantive changes to the docs, a maintenance update.
In a previous commit (already in master), I added GH Actions to build docs & upload as an artifact for PRs, and upload to
gh-pageswhen merged to master.