-
Notifications
You must be signed in to change notification settings - Fork 217
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
Improved docs #147
Improved docs #147
Conversation
@cpennington it would be good to have these on rtfd.org for tomorrow. @mhoeber Not sure if you want to chime in on any aspect of this, maybe you want to at least see the kind of changes I'm making. |
$ cd ~ | ||
$ mkdir edxwork | ||
$ cd edxwork | ||
$ /path/to/XBlock/script/startnew.py |
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.
Not for this PR, but we should use the console_scripts
entry point to just install the startnew script into the virtualenv when you install xblocks. That way, in the future, you'll just be able to pip install XBlock && start_xblock
, or something similar.
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.
Why didn't I think of that!!? :)
👍 |
Thanks @nedbat I'm a little late but if you want me to do specific tasks by datajam, let me know. I have some time this afternoon and evening. I can also deal with the RTD part. However, edX account currently doesn't have admin for XBlock project. My goal is that starting in January when Alison starts is that any tasks like this can be assigned to me. We can talk in detail next week |
@mhoeboer thanks. I have the docs on rtfd.org already (XBlock was the first open source from edX). I'm not looking for you to do anything by the datajam, just wanted to get in the habit of keeping you in the loop at least. |
A number of changes to the docs and docstrings, generally skimming through and cleaning up, modernizing, bringing up-to-date with the code, etc.