Comments (8)
Right now it is targeted only to the boxes of exact type exercise
and solution
:
https://github.com/coderefinery/sphinx-lesson/blob/master/sphinx_lesson/exerciselist.py#L55
I thought about making it adaptable, so that you could specify any directives you might want for inclusion, but left that off in the first version for simplicity.
What do you think we should do?
- nothing, adjust lessons to follow an
exercise
andsolution
model. - Add
discussion
and possibly more boxes into the core directive (this may be good for carpentries lesson compatibility - I thinksolution
was our replacement ofdiscussion
). Most new things I have made haven't included many discussion blocks. - Add an option to the
exerciselist
directive so that each instance can decide what should be included. - Add a way to tag adminitions for inclusion
So, I guess the big picture discussion is how should this directive be used and how should lessons be organized?
I'm thinking do (2) for now, and then (3) when we have time (I think it will require a bit of reshuffling, since right now the list is made separately from looking at the directives - but that won't be too hard overall.).
from sphinx-lesson.
maybe the solutions don't need to be included since there's a link to each exercise?
Separate but related issue: i see now that the "Test your understanding" exercise was left out (only showing the solution) because it uses not exercise
but challenge
- apparently they look identical. Not sure what's best to do with that. Two options:
- Remove
challenge
directive from sphinx-lesson - Make
challenge
look visually different fromexercise
and include it withexerciselist
from sphinx-lesson.
Yeah, I think challenge
was the carpentries format equivalent of exercise
. But I got the idea they have different model, was it that they don't expect any learners to be looking at the lesson materials themselves and everything is hands-on, so there's no real concept of exercise
but only "you can do a bit more if you want". Hearing this, I had the idea we could try to remove challenges and migrate to exercise
.
I can't find much about this except this issue (probably there was more in chat): #12
OK, it's sort of documented here:
https://coderefinery.github.io/sphinx-lesson/directives/#list
... but all of this is open to discussion as we see what is useful.
(I guess git-intro had a direct transliteration to sphinx-lesson from markdown, but not a longer updating).
What do you think now?
(I personally think we can consider it deprecated, but not removed to not break other lessons that might use it)
from sphinx-lesson.
I think some Carpentry instructors walk through the material like we do but other's don't and just expect learners to watch demos or do type-along. Anyways exercise
and challenge
is the same thing and we should keep challenge
only for backwards compatibility like you say. So add that to exerciselist for now i guess!
from sphinx-lesson.
If we are thinking to prepare exercise leaders, I wonder if type-along
should be included, too?
I guess homework
doesn't need to be there, since it's not so critical for preparation?
from sphinx-lesson.
i would say that type-along isn't needed since that's always in the hands of the instructor, and the simpler the task looks to helpers the better.
Agree on homework, it shouldn't be included
from sphinx-lesson.
FWIW when refactoring lessons from Jekyll to Sphinx I have been removing "challenge" and using "exercise" because it wasn't clear to me what a challenge would be that an exercise wasn't.
from sphinx-lesson.
0.8.9 has been released with the changes to support this. Well, it adds challenge
to the list of things to be displayed as the only change, plus some clarification about what to expect. We can continue to do more.
from sphinx-lesson.
Related Issues (20)
- "git checkout s-l-t/master -- conf.py" is outdated HOT 8
- Add .jupyter_cache/ to .gitignore
- Should this repo be a template repo? HOT 3
- Can we color boxes differently? HOT 17
- Dropdown boxes shown by default HOT 2
- Are the symbols emojis? Or something else? HOT 6
- Copy button on code blocks broken in main page HOT 13
- How to make the side menu collapsible? HOT 5
- Is it possible to make the notebooks executable? HOT 13
- Automatic counters for challenges HOT 4
- Build problems on Python 3.9.2 HOT 8
- Unknown directive type "exercise". HOT 2
- Wrong link in PyP HOT 2
- cssname method now missing HOT 2
- The exercise list doesn't work with links in the exercises HOT 1
- error locally after upgrading sphinx_lesson HOT 4
- problem rendering math HOT 3
- Prompt (e.g. `$` is copied with sphinx-copybutton) HOT 1
- should `discussion` be included in the exercise list directive? HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx-lesson.