search

tjvr / kurt

Python library for reading/writing MIT's Scratch file format.
https://kurt.tjvr.org
GNU General Public License v3.0
86 stars 24 forks source link

Where are the docs? #37

Closed BookOwl closed 7 years ago

BookOwl commented 7 years ago

Your docs seem to be extremely lacking...

tjvr commented 7 years ago

readthedocs appears to have gone wrong :-(

There's comprehensive API a documentation—or supposed to be!—but something's gone wrong with sphinx or readthedocs somehow. You're welcome to help look into it if you want :-)

BookOwl commented 7 years ago

I remember the API documentation being very good before, that's why I was so surprised when I found it all gone! I'll see if I can find what's wrong.

BookOwl commented 7 years ago

Cloning the repo and running make html in the docs directory makes the right docs.

bates64 commented 7 years ago

@tjvr pls

tjvr commented 7 years ago

I don't have time to fix this right now. If either of you can figure it out I'd appreciate it. :-)

raulperula commented 7 years ago

Hi! How could we fix it? I've done the "make html" in my fork and it works but I do not know to fix the problem in the original repo.

If you can tell me the steps I could try.

tjvr commented 7 years ago

Argh. I’ll try fiddling with the RTD settings later (assuming I can still log in!). :-)

raulperula commented 7 years ago

Perfect. Thank you.

If you need any help, please tell us!

tjvr commented 7 years ago

All fixed. Looks like I didn't specify a version for construct! fcccd80

I have no idea how this worked before...or maybe it's been broken for years? :P

This would've been quicker to resolve if I hadn't forgotten how RTD works—and the ImportErrors it raised were more easily visible in the Settings. Ah well...