generated from ENCCS/sphinx-lesson-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3034cf5
Showing
242 changed files
with
37,000 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: a7aea37dcfee43616cf0f6546fbe8c5d | ||
tags: d77d1c0d9ca2f4c8421862c7c5a0d620 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
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 | ||
---------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
LESSON NAME | ||
=========== | ||
|
||
Intro | ||
|
||
|
||
|
||
.. prereq:: | ||
|
||
prerequisites | ||
|
||
|
||
|
||
.. csv-table:: | ||
:widths: auto | ||
:delim: ; | ||
|
||
20 min ; :doc:`filename` | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: The lesson | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Reference | ||
|
||
quick-reference | ||
guide | ||
|
||
|
||
|
||
.. _learner-personas: | ||
|
||
Who is the course for? | ||
---------------------- | ||
|
||
|
||
|
||
|
||
|
||
About the course | ||
---------------- | ||
|
||
|
||
|
||
|
||
|
||
|
||
See also | ||
-------- | ||
|
||
|
||
|
||
|
||
|
||
Credits | ||
------- | ||
|
||
The lesson file structure and browsing layout is inspired by and derived from | ||
`work <https://github.com/coderefinery/sphinx-lesson>`__ by `CodeRefinery | ||
<https://coderefinery.org/>`__ licensed under the `MIT license | ||
<http://opensource.org/licenses/mit-license.html>`__. We have copied and adapted | ||
most of their license text. | ||
|
||
Instructional Material | ||
^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
This instructional material is made available under the | ||
`Creative Commons Attribution license (CC-BY-4.0) <https://creativecommons.org/licenses/by/4.0/>`__. | ||
The following is a human-readable summary of (and not a substitute for) the | ||
`full legal text of the CC-BY-4.0 license | ||
<https://creativecommons.org/licenses/by/4.0/legalcode>`__. | ||
You are free to: | ||
|
||
- **share** - copy and redistribute the material in any medium or format | ||
- **adapt** - remix, transform, and build upon the material for any purpose, | ||
even commercially. | ||
|
||
The licensor cannot revoke these freedoms as long as you follow these license terms: | ||
|
||
- **Attribution** - You must give appropriate credit (mentioning that your work | ||
is derived from work that is Copyright (c) ENCCS and individual contributors and, where practical, linking | ||
to `<https://enccs.github.io/sphinx-lesson-template>`_), provide a `link to the license | ||
<https://creativecommons.org/licenses/by/4.0/>`__, and indicate if changes were | ||
made. You may do so in any reasonable manner, but not in any way that suggests | ||
the licensor endorses you or your use. | ||
- **No additional restrictions** - You may not apply legal terms or | ||
technological measures that legally restrict others from doing anything the | ||
license permits. | ||
|
||
With the understanding that: | ||
|
||
- You do not have to comply with the license for elements of the material in | ||
the public domain or where your use is permitted by an applicable exception | ||
or limitation. | ||
- No warranties are given. The license may not give you all of the permissions | ||
necessary for your intended use. For example, other rights such as | ||
publicity, privacy, or moral rights may limit how you use the material. | ||
|
||
|
||
Software | ||
^^^^^^^^ | ||
|
||
Except where otherwise noted, the example programs and other software provided | ||
with this repository are made available under the `OSI <http://opensource.org/>`__-approved | ||
`MIT license <https://opensource.org/licenses/mit-license.html>`__. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Quick Reference | ||
=============== |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
} |
Oops, something went wrong.