Skip to content

Commit

Permalink
deploy: fe05ee5
Browse files Browse the repository at this point in the history
  • Loading branch information
rkdarst committed Oct 30, 2024
0 parents commit 660b972
Show file tree
Hide file tree
Showing 323 changed files with 38,286 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
93 changes: 93 additions & 0 deletions _sources/episode.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Episode template

:::{questions}
- What syntax is used to make a lesson?
- How do you structure a lesson effectively for teaching?
- `questions` are at the top of a lesson and provide a starting
point for what you might learn. It is usually a bulleted list.
:::

:::{objectives}
- Show a complete lesson page with all of the most common
structures.
- ...

This is also a holdover from the carpentries-style. It could
usually be left off.
:::




The introduction should be a high level overview of what is on the
page and why it is interesting.


The lines below (only in the source) will set the default highlighting
language for the entire page.

:::{highlight} python
:::



## Section

A section.

:::{discussion}
Discuss the following.

- A discussion section
- Another discussion topic
:::



## Section

```
print("hello world")
# This uses the default highlighting language
```

```python
print("hello world)
```



## Exercises: description

:::{exercise} Exercise Topic-1: imperative description of exercise
Exercise text here.
:::

:::{solution}
Solution text here
:::



## Summary

A Summary of what you learned and why it might be useful. Maybe a
hint of what comes next.



## See also

- Other relevant links
- Other link



:::{keypoints}
- What the learner should take away
- point 2
- ...

This is another holdover from the carpentries style. This perhaps
is better done in a "summary" section.
:::
17 changes: 17 additions & 0 deletions _sources/guide.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Instructor's guide

## Why we teach this lesson

## Intended learning outcomes

## Timing

## Preparing exercises

e.g. what to do the day before to set up common repositories.

## Other practical aspects

## Interesting questions you might get

## Typical pitfalls
39 changes: 39 additions & 0 deletions _sources/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# LESSON NAME

Intro

:::{prereq}
prerequisites
:::

```{csv-table}
:delim: ;
:widths: auto

20 min ; {doc}`filename`
```

```{toctree}
:caption: The lesson
:maxdepth: 1

episode.md
```

```{toctree}
:caption: Reference
:maxdepth: 1

quick-reference
guide
```

(learner-personas)=

## Who is the course for?

## About the course

## See also

## Credits
1 change: 1 addition & 0 deletions _sources/quick-reference.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Quick Reference
123 changes: 123 additions & 0 deletions _static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit 660b972

Please sign in to comment.