diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..5a3dbcf9 --- /dev/null +++ b/.buildinfo @@ -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: e21ba9a26a1fa041e43d0d2e9e34e5b6 +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/_images/add-file.png b/_images/add-file.png new file mode 100644 index 00000000..9683b2db Binary files /dev/null and b/_images/add-file.png differ diff --git a/_images/annotate.png b/_images/annotate.png new file mode 100644 index 00000000..8021920a Binary files /dev/null and b/_images/annotate.png differ diff --git a/_images/annotate1.png b/_images/annotate1.png new file mode 100644 index 00000000..93416b2a Binary files /dev/null and b/_images/annotate1.png differ diff --git a/_images/bare-repository.png b/_images/bare-repository.png new file mode 100644 index 00000000..45286f93 Binary files /dev/null and b/_images/bare-repository.png differ diff --git a/_images/browse-files.png b/_images/browse-files.png new file mode 100644 index 00000000..5fcc3528 Binary files /dev/null and b/_images/browse-files.png differ diff --git a/_images/cheat-sheet.jpg b/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/_images/cheat-sheet.jpg differ diff --git a/_images/code-portion.png b/_images/code-portion.png new file mode 100644 index 00000000..39356bd5 Binary files /dev/null and b/_images/code-portion.png differ diff --git a/_images/commit-and-tree.png b/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/_images/commit-and-tree.png differ diff --git a/_images/commit-changes.png b/_images/commit-changes.png new file mode 100644 index 00000000..4c0546c6 Binary files /dev/null and b/_images/commit-changes.png differ diff --git a/_images/commits-and-parents.png b/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/_images/commits-and-parents.png differ diff --git a/_images/commits.png b/_images/commits.png new file mode 100644 index 00000000..b154c666 Binary files /dev/null and b/_images/commits.png differ diff --git a/_images/create-repository-with-readme.png b/_images/create-repository-with-readme.png new file mode 100644 index 00000000..24118344 Binary files /dev/null and b/_images/create-repository-with-readme.png differ diff --git a/_images/create-repository.png b/_images/create-repository.png new file mode 100644 index 00000000..80fb99c2 Binary files /dev/null and b/_images/create-repository.png differ diff --git a/_images/edit-file.png b/_images/edit-file.png new file mode 100644 index 00000000..f7527bd0 Binary files /dev/null and b/_images/edit-file.png differ diff --git a/_images/file-history.png b/_images/file-history.png new file mode 100644 index 00000000..5e42fbe9 Binary files /dev/null and b/_images/file-history.png differ diff --git a/_images/fork.png b/_images/fork.png new file mode 100644 index 00000000..0c992d3d Binary files /dev/null and b/_images/fork.png differ diff --git a/_images/forking.png b/_images/forking.png new file mode 100644 index 00000000..73c4d71a Binary files /dev/null and b/_images/forking.png differ diff --git a/_images/git-annotate.png b/_images/git-annotate.png new file mode 100644 index 00000000..60c6f7c2 Binary files /dev/null and b/_images/git-annotate.png differ diff --git a/_images/git-branch-1.svg b/_images/git-branch-1.svg new file mode 100644 index 00000000..4b735e40 --- /dev/null +++ b/_images/git-branch-1.svg @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + m2 + + + m3 + + + m1 + + + + + main + + + + + HEAD + + + diff --git a/_images/git-branch-2.svg b/_images/git-branch-2.svg new file mode 100644 index 00000000..dde628b6 --- /dev/null +++ b/_images/git-branch-2.svg @@ -0,0 +1,443 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + l1 + + + e2 + + + e1 + + + m5 + + + m4 + + + m2 + + + m3 + + + m1 + + + + + less-salt + + + + + HEAD + + + + + experiment + + + + + main + + + diff --git a/_images/git-branch-3.svg b/_images/git-branch-3.svg new file mode 100644 index 00000000..19231579 --- /dev/null +++ b/_images/git-branch-3.svg @@ -0,0 +1,475 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + e2 + + + m3 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + + + less-salt + + + + + experiment + + + diff --git a/_images/git-collaborative.svg b/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/_images/git-deleted-branches.svg b/_images/git-deleted-branches.svg new file mode 100644 index 00000000..d54c0032 --- /dev/null +++ b/_images/git-deleted-branches.svg @@ -0,0 +1,483 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + m5 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + diff --git a/_images/git-log-github.png b/_images/git-log-github.png new file mode 100644 index 00000000..db44d29b Binary files /dev/null and b/_images/git-log-github.png differ diff --git a/_images/git-log-terminal.png b/_images/git-log-terminal.png new file mode 100644 index 00000000..56493e6e Binary files /dev/null and b/_images/git-log-terminal.png differ diff --git a/_images/git-merge-1.svg b/_images/git-merge-1.svg new file mode 100644 index 00000000..005301ab --- /dev/null +++ b/_images/git-merge-1.svg @@ -0,0 +1,515 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + m3 + + + l1 + + + m7 + + + m4 + + + + + experiment + + + + + less-salt + + + + + main + + + + + HEAD + + + diff --git a/_images/git-merge-2.svg b/_images/git-merge-2.svg new file mode 100644 index 00000000..cb268ee7 --- /dev/null +++ b/_images/git-merge-2.svg @@ -0,0 +1,555 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + l1 + + + m5 + + + m4 + + + + + experiment + + + + + main + + + + + HEAD + + + + + less-salt + + + diff --git a/_images/git-pre-ff.svg b/_images/git-pre-ff.svg new file mode 100644 index 00000000..e4d8bc5b --- /dev/null +++ b/_images/git-pre-ff.svg @@ -0,0 +1,615 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e1 + + + e2 + + + m7 + + + m8 + + + n3 + + + n1 + + + m5 + + + l1 + + + m6 + + + m4 + + + n2 + + + m2 + + + m3 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + main + + + diff --git a/_images/git_stage_commit.svg b/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/_images/github-branches-overview.png b/_images/github-branches-overview.png new file mode 100644 index 00000000..89e0058d Binary files /dev/null and b/_images/github-branches-overview.png differ diff --git a/_images/github-branches.png b/_images/github-branches.png new file mode 100644 index 00000000..3a6a8ff9 Binary files /dev/null and b/_images/github-branches.png differ diff --git a/_images/github-comparing-changes.png b/_images/github-comparing-changes.png new file mode 100644 index 00000000..735b990b Binary files /dev/null and b/_images/github-comparing-changes.png differ diff --git a/_images/github-contribute.png b/_images/github-contribute.png new file mode 100644 index 00000000..a149e9f3 Binary files /dev/null and b/_images/github-contribute.png differ diff --git a/_images/github-create-branch.png b/_images/github-create-branch.png new file mode 100644 index 00000000..e7958ff2 Binary files /dev/null and b/_images/github-create-branch.png differ diff --git a/_images/github-create-tag.png b/_images/github-create-tag.png new file mode 100644 index 00000000..f08f5878 Binary files /dev/null and b/_images/github-create-tag.png differ diff --git a/_images/github-merged.png b/_images/github-merged.png new file mode 100644 index 00000000..eea47d93 Binary files /dev/null and b/_images/github-merged.png differ diff --git a/_images/github-navigate-to-branch.png b/_images/github-navigate-to-branch.png new file mode 100644 index 00000000..42b0f753 Binary files /dev/null and b/_images/github-navigate-to-branch.png differ diff --git a/_images/gophers.png b/_images/gophers.png new file mode 100644 index 00000000..741406ba Binary files /dev/null and b/_images/gophers.png differ diff --git a/_images/history.png b/_images/history.png new file mode 100644 index 00000000..6384e302 Binary files /dev/null and b/_images/history.png differ diff --git a/_images/history1.png b/_images/history1.png new file mode 100644 index 00000000..06662c31 Binary files /dev/null and b/_images/history1.png differ diff --git a/_images/license.png b/_images/license.png new file mode 100644 index 00000000..f4cadf0d Binary files /dev/null and b/_images/license.png differ diff --git a/_images/meld.png b/_images/meld.png new file mode 100644 index 00000000..774f9cd1 Binary files /dev/null and b/_images/meld.png differ diff --git a/_images/mergetool.png b/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/_images/mergetool.png differ diff --git a/_images/network.png b/_images/network.png new file mode 100644 index 00000000..e0fcb2fb Binary files /dev/null and b/_images/network.png differ diff --git a/_images/new-repo-form.png b/_images/new-repo-form.png new file mode 100644 index 00000000..b808ee0b Binary files /dev/null and b/_images/new-repo-form.png differ diff --git a/_images/new-repo-plus.png b/_images/new-repo-plus.png new file mode 100644 index 00000000..e58ba5d8 Binary files /dev/null and b/_images/new-repo-plus.png differ diff --git a/_images/new-repository.png b/_images/new-repository.png new file mode 100644 index 00000000..aff76772 Binary files /dev/null and b/_images/new-repository.png differ diff --git a/_images/pen-symbol.png b/_images/pen-symbol.png new file mode 100644 index 00000000..044902a3 Binary files /dev/null and b/_images/pen-symbol.png differ diff --git a/_images/preview.png b/_images/preview.png new file mode 100644 index 00000000..8a602b66 Binary files /dev/null and b/_images/preview.png differ diff --git a/_images/search.png b/_images/search.png new file mode 100644 index 00000000..4462f71e Binary files /dev/null and b/_images/search.png differ diff --git a/_images/search1.png b/_images/search1.png new file mode 100644 index 00000000..89c0e25a Binary files /dev/null and b/_images/search1.png differ diff --git a/_images/show.png b/_images/show.png new file mode 100644 index 00000000..12d7915c Binary files /dev/null and b/_images/show.png differ diff --git a/_images/staging-basics.svg b/_images/staging-basics.svg new file mode 100644 index 00000000..13df8bf5 --- /dev/null +++ b/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + restore + add + commit + restore + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/_images/stranger.jpg b/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/_images/stranger.jpg differ diff --git a/_images/upload-files.png b/_images/upload-files.png new file mode 100644 index 00000000..fd3ef8cc Binary files /dev/null and b/_images/upload-files.png differ diff --git a/_images/vscode-add-and-commit.png b/_images/vscode-add-and-commit.png new file mode 100644 index 00000000..d9a09c46 Binary files /dev/null and b/_images/vscode-add-and-commit.png differ diff --git a/_images/vscode-authorize.png b/_images/vscode-authorize.png new file mode 100644 index 00000000..4d45dc2d Binary files /dev/null and b/_images/vscode-authorize.png differ diff --git a/_images/vscode-change-branch.png b/_images/vscode-change-branch.png new file mode 100644 index 00000000..c1a5f00a Binary files /dev/null and b/_images/vscode-change-branch.png differ diff --git a/_images/vscode-create-branch.png b/_images/vscode-create-branch.png new file mode 100644 index 00000000..71b275a9 Binary files /dev/null and b/_images/vscode-create-branch.png differ diff --git a/_images/vscode-merging.png b/_images/vscode-merging.png new file mode 100644 index 00000000..7e5880e7 Binary files /dev/null and b/_images/vscode-merging.png differ diff --git a/_images/vscode-open-terminal.png b/_images/vscode-open-terminal.png new file mode 100644 index 00000000..1be92267 Binary files /dev/null and b/_images/vscode-open-terminal.png differ diff --git a/_images/vscode-publish-to-github1.png b/_images/vscode-publish-to-github1.png new file mode 100644 index 00000000..883e756c Binary files /dev/null and b/_images/vscode-publish-to-github1.png differ diff --git a/_images/vscode-publish-to-github2.png b/_images/vscode-publish-to-github2.png new file mode 100644 index 00000000..d0055db4 Binary files /dev/null and b/_images/vscode-publish-to-github2.png differ diff --git a/_images/vscode-publish-to-github3.png b/_images/vscode-publish-to-github3.png new file mode 100644 index 00000000..0f68d0ee Binary files /dev/null and b/_images/vscode-publish-to-github3.png differ diff --git a/_images/vscode-start.png b/_images/vscode-start.png new file mode 100644 index 00000000..e7830807 Binary files /dev/null and b/_images/vscode-start.png differ diff --git a/_sources/aliases.md.txt b/_sources/aliases.md.txt new file mode 100644 index 00000000..a257a1b7 --- /dev/null +++ b/_sources/aliases.md.txt @@ -0,0 +1,156 @@ +(aliases)= + +# Aliases and configuration + +```{objectives} +- Learn to use aliases for most common commands. +``` + +Are you getting tired of typing so much? In Git you can define aliases (shortcuts): +- These are great because they can save you time typing. +- But it's easy to forget them, get confused, or be inconsistent with your colleagues. + +There is plenty of other configuration for Git, that can make it nicer. + + +## Aliases + +- Aliases offer a way to improve the usability of Git: for + example `git ci` instead of `git commit`. +- Aliases are based on simple string replacement in the command. +- Aliases can either be specific to a repository or global. + - Global aliases help you do the things you are used to across Git projects. + - Per-project aliases can also be created. +- Global aliases are stored in `~/.gitconfig`. + + +## Example alias: git graph + +A very useful shortcut which we use a lot in our workshops: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ cd your_git_repository +$ git graph +``` + + +## Using external commands + +It is possible to call external commands using the exclamation mark character "!". +In this example here we create a local alias which is +stored in `.git/config` and not synchronized with remotes: + +```console +$ cd your_git_repository +$ git config alias.hi '!echo hello' +$ git hi +``` + +```{discussion} Food for thought: When to alias? +- How many times should you wait before aliasing a command? +- Do you believe a list of generic two-letter acronyms for common commands will + save your time? +``` + + +## List of aliases the instructors use + +You are welcome to reuse, suggest, improve. +You can see your current aliases in `~/.gitconfig`. + +```console +$ git config --global alias.ap "add --patch" +$ git config --global alias.br branch +$ git config --global alias.ci "commit -v" +$ git config --global alias.cip "commit --patch -v" +$ git config --global alias.cl "clone --recursive" +$ git config --global alias.di diff +$ git config --global alias.dic "diff --staged --color-words" +$ git config --global alias.diw "diff --color-words" +$ git config --global alias.dis "!git --no-pager diff --stat" +$ git config --global alias.fe fetch +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ git config --global alias.rem remote +$ git config --global alias.st status +$ git config --global alias.su "submodule update --init --recursive" +``` + +Here is what they do: +- `ap`: add, selecting parts individually, interactively. +- `br`: branch (obvious) +- `ci`: commit (check in), with `-v` option for clarity +- `cip`: commit, selecting parts individually, interactively. +- `cl`: clone, init submodules (submodules are an advanced topic) +- `di`: diff (obvious) +- `dic`: diff of staging area vs last commit (what is about to be committed) +- `diw`: a word diff, color. Useful for small changes. +- `dis`: a "diffstat": what files are changed, not contents +- `fe`: fetch (obvious) +- `graph`: show whole git graph (so useful, some of us call it `l`) +- `rem`: remote (obvious) +- `st`: status (obvious) +- `su`: submodule update (advanced) + +A useful setting for the `p` aliases: +```console +$ git config --global interactive.singlekey true +``` + + +## Advanced aliases + +These are advanced aliases and configuration options. We won't explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages! + +```console +$ git config --global alias.cif "commit -v -p --fixup" +$ git config --global alias.rb "rebase --autosquash" +$ git config --global alias.rbi "rebase --interactive --autosquash" +$ git config --global alias.rbis "rebase --interactive --autosquash --autostash" +$ git config --global alias.rbs "rebase --autosquash --autostash" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard" +$ git config --global alias.new "log HEAD..HEAD@{upstream}" +$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}" +$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}" +$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all" +$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD" +$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat" +``` + +## Advanced Git configuration + +Besides aliases, you can do plenty of other configuration of `git`. +Here are some of the most common ones: + +```console +$ git config --global interactive.singlekey true +$ git config --global core.pager "less -RS" +$ git config --global core.excludesfile ~/.gitignore +$ git config --global merge.conflictstyle diff3 +$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]" +$ git config --global diff.mnemonicPrefix true +``` + +Do you get tired of typing and copying and pasting your remote names +all the time, like `git@github.com:myusername`? You can create remote +aliases like this: + +```console +$ git config --global url.git@github.com:.insteadOf gh: +$ git config --global url.git@github.com:/username/.insteadOf ghu: +``` + +Then, when you add a remote `ghu:recipe`, it will automatically be +translated to `git@github.com:/username/recipe` using a simple prefix +matching. + + +```{keypoints} +- If you are frustrated about remembering a command, you should create an alias. +``` diff --git a/_sources/archaeology.md.txt b/_sources/archaeology.md.txt new file mode 100644 index 00000000..c8fade0f --- /dev/null +++ b/_sources/archaeology.md.txt @@ -0,0 +1,488 @@ +# Inspecting history + +:::{objectives} +- Be able find a line of code, find out why it was introduced and when. +- Be able to quickly find the commit that changed a behavior. +::: + +:::{instructor-note} +- 30 min teaching/type-along +- 20 min exercise +::: + + +## Command line, GitHub, and VS Code + +As usual, we offer ways to do this with the command line, VS Code, and +GitHub. + +* **Command line** is most powerful and relatively easy with this. + You may also use it along with other things. If you haven't tried + it yet, we'd recommend you to give it a try. +* The **GitHub** web interface allows many things to be done, but not + everything. +* **VS Code** allows some of these, but for some it's easier to open + the VS Code terminal and run git there. + + +## Our toolbox for history inspection + +:::{instructor-note} +First the instructor demonstrates few commands on a real life example +repository (mentioned in the amazing site [The +Programming Historian](https://programminghistorian.org/)). +Later we will practice these in an archaeology exercise (below). +::: + + +### Warm-up: ["Git History" browser](https://githistory.xyz/) + +As a warm-up we can try the ["Git History" browser](https://githistory.xyz/) +on the README.rst file of the [networkx](https://github.com/networkx/networkx) repository: + +- Visit and browse (use left/right keys). +- You can try this on some of your GitHub repositories, too! + + +### Searching text patterns in the repository + +With `git grep` you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or +some error message printed. + +:::::{tabs} + ::::{group-tab} Command line + The Git command is as described above: + ```console + $ git grep TEXT + $ git grep "some text with spaces" + ``` + + In the [networkx](https://github.com/networkx/networkx) repository you can try: + + ```console + $ git clone https://github.com/networkx/networkx + $ cd networkx + $ git grep -i fixme + ``` + + While `git grep` searches the **current state** of the repository, + it is also possible to search through all changes with `git log -S sometext` + which can be useful to find where something got removed. + :::: + + ::::{group-tab} GitHub + We can try the same example in the browser: + + + ```{figure} img/archaeology/search.png + :alt: Searching for "fixme" in a GitHub repository + :width: 100% + :class: with-border + + Searching for "fixme" in a GitHub repository. + ``` + :::: + + ::::{group-tab} VS Code + Our example repository is . + From a new VS Code window, select "Clone Git repository" and enter + that URL. + + Searching with the magnifying glass from the left sidebar is + equivalent to `git grep`. + :::: +::::: + + +### Inspecting individual commits + +:::::{tabs} + ::::{group-tab} Command line + We have seen this one before already. Using `git show` we can inspect an individual commit if + we know its hash: + + ```console + $ git show HASH + ``` + + For instance: + ```console + $ git show 759d589bdfa61aff99e0535938f14f67b01c83f7 + ``` + :::: + + ::::{group-tab} GitHub + We can try the same example in the browser: + + + ```{figure} img/archaeology/show.png + :alt: Inspecting an individual commit on GitHub + :width: 100% + :class: with-border + + Inspecting an individual commit on GitHub. + ``` + :::: + + ::::{group-tab} VS Code + We don't know of a built-in way to see every single Git commit in + order (extensions allow this). You can open the terminal and run + the command line option. + + But, if you open single files, a "Timeline" view under the + explorer shows changes to *that file*. You can click on a change + to see the details. + :::: +::::: + + +### Line-by-line code annotation with metadata + +With `git annotate` you can see line by line who and **when** the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility. + +:::::{tabs} + ::::{group-tab} Command line + ```console + $ git annotate FILE + ``` + + Example: + ```console + $ git annotate networkx/convert_matrix.py + ``` + + If you annotate in a terminal and the file is longer than the screen, Git by default uses the program `less` to + scroll the output. + Use `/sometext` `` to find "sometext" and you can cycle through the results with `n` (next) and `N` (last). + You can also use page up/down to scroll. You can quit with `q`. + :::: + + ::::{group-tab} GitHub + We can try the same example in the browser: + + + ```{figure} img/archaeology/annotate.png + :alt: Screenshot of file annotation on GitHub + :width: 100% + :class: with-border + + Screenshot of file annotation on GitHub. + ``` + :::: + + ::::{group-tab} VS Code + It seems this needs an extension. We'd recommend trying the + command line method for now. + :::: +::::: + +:::{discussion} +Discuss how these relatively trivial changes affect the annotation: +- Wrapping long lines of text/code into shorter lines +- Auto-formatting tools such as `black` +- Editors that automatically remove trailing whitespace +::: + + +### Inspecting code in the past + +:::::{tabs} + ::::{group-tab} Command line + We can create branches pointing to a commit in the past. + This is the recommended mechanism to inspect old code: + + ```console + $ git switch --create BRANCHNAME HASH + ``` + + Example (lines starting with "#" are only comments): + + ```console + $ # create branch called "older-code" from hash 347e6292419b + $ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9 + + $ # now you can navigate and inspect the code as it was back then + $ # ... + + $ # after we are done we can switch back to "main" + $ git switch main + + $ # if we like we can delete the "older-code" branch + $ git branch -d older-code + ``` + + On old Git versions which do not know the `switch` command (before 2.23), you + need to use this instead: + + ```console + $ git checkout -b BRANCHNAME SOMEHASH + ``` + :::: + + ::::{group-tab} GitHub + We now know how to visit a specific commit: + + + Once we are there we can "Browse files" at that point in history. + + ```{figure} img/archaeology/browse-files.png + :alt: Browsing code in the past on GitHub + :width: 100% + :class: with-border + + Browsing code in the past on GitHub. + ``` + :::: + + ::::{group-tab} VS Code + Switch to "Source Control", then the "..." menu, then "Branch", then "Create new branch from..." and now you can type a commit identifier (hash). + + Make sure you change back to the main branch when you are done. + :::: +::::: + + +## Exercise + +This is described with the command line method, but by looking above +you can translate to the other options. + +:::::{exercise} Exercise: Explore basic archaeology commands (20 min) + Let us explore the value of these commands in an exercise. Future + exercises do not depend on this, so it is OK if you do not complete + it fully. + + Exercise steps: + - **Make sure you are not inside another Git repository** when running this + exercise. If you are, first step "outside" of it. + We want to avoid creating a Git repository inside another Git repository. + :::::{tabs} + ::::{group-tab} Command line + You can check if you are inside a Git repository with: + ```console + $ git status + + fatal: not a git repository (or any of the parent directories): .git + ``` + You want to see the above message which tells us that this is not a Git repository. + :::: + + ::::{group-tab} GitHub + This is not a problem in the GitHub web interface since we are not + creating a new local repository. + :::: + + ::::{group-tab} VS Code + "File" -> "New Window". + :::: + ::::: + + - Clone this repository: + . + :::::{tabs} + ::::{group-tab} Command line + ```console + $ git clone https://github.com/networkx/networkx.git + ``` + :::: + + ::::{group-tab} GitHub + Nothing to clone. We will try to inspect the repository directly on GitHub. + :::: + + ::::{group-tab} VS Code + From a new VS Code window, select "Clone Git repository" and enter + that URL. + :::: + ::::: + + - Then let us all **make sure we are working on a well-defined version** of the repository. + :::::{tabs} + ::::{group-tab} Command line + Step into the new directory and create an exercise branch from the + networkx-2.6.3 tag/release: + ```console + $ cd networkx + $ git switch --create exercise networkx-2.6.3 + ``` + On old Git versions which do not know the `switch` command (before 2.23), you + need to use this instead: + ```console + $ git checkout -b exercise networkx-2.6.3 + ``` + :::: + + ::::{group-tab} GitHub + We can visit the version directly: + :::: + + ::::{group-tab} VS Code + Switch to "Source Control", then the "..." menu, then "Branch", then "Create new branch from..." and select "networkx-2.6.3". + :::: + ::::: + + Then using the above toolbox try to: + 1. Find the code line which contains `"Logic error in degree_correlation"`. + 1. Find out when this line was last modified or added. Find the actual commit which modified that line. + 1. Inspect that commit with `git show`. + 1. Create a branch pointing to the past when that commit was created to be + able to browse and use the code as it was back then. + 1. How would you bring the code to the version of the code right before that line was last modified? + + ::::{solution} + We provide here a solution for the command line but we also encourage you to + try to solve this in the browser. + + 1. We use `git grep`: + ```console + $ git grep "Logic error in degree_correlation" + ``` + This gives the output: + ``` + networkx/algorithms/threshold.py: print("Logic error in degree_correlation", i, rdi) + ``` + Maybe you also want to know the line number: + ```console + $ git grep -n "Logic error in degree_correlation" + ``` + 2. We use `git annotate`: + ```console + $ git annotate networkx/algorithms/threshold.py + ``` + Then search for "Logic error" by typing "/Logic error" followed by Enter. + The last commit that modified it was `90544b4fa` (unless that line changed since). + 3. We use `git show`: + ```console + $ git show 90544b4fa + ``` + 4. Create a branch pointing to that commit (here we called the branch "past-code"): + ```console + $ git branch past-code 90544b4fa + ``` + 5. This is a compact way to access the first parent of `90544b4fa` (here we + called the branch "just-before"): + ```console + $ git switch --create just-before 90544b4fa~1 + ``` + :::: +::::: + +--- + +## Finding out when something broke/changed with `git bisect` + +This only works with the command line. + +> *"But I am sure it used to work! Strange."* + +Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke. + +:::{discussion} How would you solve this? +Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now. + +- How would you find the commit which changed it? +- Why could it be useful to know the commit that changed it? +::: + +We will probably arrive at a solution which is similar to `git bisect`: + +- First find out a commit in past when it worked. + ```console + $ git bisect start + $ git bisect good f0ea950 # this is a commit that worked + $ git bisect bad main # last commit is broken + ``` +- Now compile and/or run and/or test and decide whether "good" or "bad". +- This is how you can tell Git that this was a working commit: + ```console + $ git bisect good + ``` +- And this is how you can tell Git that this was not a working commit: + ```console + $ git bisect bad + ``` +- Then bisect/iterate your way until you find the commit that broke it. +- If you want to go back to start, type `git bisect reset`. +- This can even be automatized with `git bisect run SCRIPT`. + For this you write a script that returns zero/non-zero (success/failure). + + +(exercise-bisect)= + +## Optional exercise: Git bisect + +This only works with the command line. + +::::{exercise} (optional) History-2: Use git bisect to find the bad commit + In this exercise, we use `git bisect` on an example repository. It + is OK if you do not complete this exercise fully. + + Begin by cloning [https://github.com/coderefinery/git-bisect-exercise](https://github.com/coderefinery/git-bisect-exercise). + + + **Motivation** + + The motivation for this exercise is to be able to do archaeology with Git on a + source code where the bug is difficult to see visually. **Finding the offending + commit is often more than half the debugging**. + + + **Background** + + The script `get_pi.py` approximates pi using terms of the Nilakantha series. It + should produce 3.14 but it does not. The script broke at some point and + produces 3.57 using the last commit: + + ```console + $ python get_pi.py + + 3.57 + ``` + + At some point within the 500 first commits, an error was introduced. The only + thing we know is that the first commit worked correctly. + + + **Your task** + + - Clone this repository and use `git bisect` to find the commit which + broke the computation + ([solution - spoiler alert!](https://github.com/coderefinery/git-bisect-exercise#solutions-spoiler-alert)). + - Once you have found the offending commit, also practice navigating to the last good commit. + - Bonus exercise: + Write a script that checks for a correct result and use `git bisect run` to + find the offending commit automatically + ([solution - spoiler alert!](https://github.com/coderefinery/git-bisect-exercise#solutions-spoiler-alert)). + + + **Hints** + + Finding the first commit: + + ```console + $ git log --oneline | tail -n 1 + ``` + + How to navigate to the parent of a commit with hash SOMEHASH: + ```console + $ git switch --create BRANCHNAME SOMEHASH~1 + ``` + + Instead of a tilde you can also use this: + ```console + $ git switch --create BRANCHNAME SOMEHASH^ + ``` +:::: + + +## Summary + +- git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project on the command line. +- `git switch --create NAME HASH` is the recommended mechanism to inspect old code on the command line. +- Most of these commands can be used in the GitHub web interface (except `git bisect`). diff --git a/_sources/basics.md.txt b/_sources/basics.md.txt new file mode 100644 index 00000000..fb56e9ca --- /dev/null +++ b/_sources/basics.md.txt @@ -0,0 +1,715 @@ +# Basics + +```{objectives} +- Learn to create Git repositories and make commits. +- Get a grasp of the structure of a repository. +- Learn how to inspect the project history. +- Learn how to write useful commit log messages. +``` + +```{instructor-note} +- 35 min teaching/type-along +- 40 min exercise +``` + + +## What is Git, and what is a Git repository? + +- Git is a version control system: can **record/save snapshots** and track the content of a folder as it changes over time. +- Every time we **commit** a snapshot, Git records a snapshot of the **entire project**, saves it, and assigns it a version. +- These snapshots are kept inside a sub-folder called `.git`. +- If we remove `.git`, we remove the repository and history (but keep the working directory!). +- The directory `.git` uses relative paths - you can move the whole repository somewhere else and it will still work. +- Git doesn't do anything unless you ask it to (it **does not record anything automatically**). +- Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces). + + +## Recording a snapshot with Git + +- Git takes snapshots only if we request it. +- We will record changes in two steps (we will later explain why this is a recommended practice). +- Example (we don't need to type yet): + + ```console + $ git add FILE.txt + $ git commit + + $ git add FILE.txt ANOTHERFILE.txt + $ git commit + ``` + +- We first focus (`git add`, we "stage" the change), then record (`git commit`): + +```{figure} img/git_stage_commit.svg +:alt: Git staging +:width: 100% + +Git staging and committing. +``` + +```{discussion} Question for the more advanced participants +What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end. +``` + + +## Configuring Git command line + +Before we start using Git on the command line, we need to configure Git. +This is also part of the +[installation instructions](https://coderefinery.github.io/installation/shell-and-git/#configuration) +but we need to make sure we all have +set name, email address, editor, and +default branch: +```console +$ git config --global user.name "Your Name" +$ git config --global user.email yourname@example.com +$ git config --global core.editor nano +$ git config --global init.defaultBranch main +``` + +Verify with: +```console +$ git config --list +``` + +```{instructor-note} +Instructors, give learners enough time to do the above configuration steps. +``` + + +## Type-along: Tracking a guacamole recipe with Git + +We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list) + +The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language. + +```{instructor-note} +Instructors, please encourage now that participants type along. +``` + +```{note} +It is possible to go through this lesson in the command line or in the browser +(on GitHub). + +- We recommend to start with the command line but later to also try in the browser. +- If you get really stuck in the command line, try following in the browser and + later you can try to return to the command line. +``` + + +## Creating a repository + +One of the basic principles of Git is that it is **easy to create repositories**: + +`````{tabs} + ````{group-tab} Command line + ```console + $ mkdir recipe + $ cd recipe + $ git init -b main + ``` + + That's it! With `git init -b main` have now created an empty Git repository + where `main` is the default branch (more about branches later). + + We will use `git status` a lot to check out what is going on: + + ```console + $ git status + + On branch main + + No commits yet + + nothing to commit (create/copy files and use "git add" to track) + ``` + + We will make sense of this information during this workshop. + ```` + + ````{group-tab} Browser (GitHub) + First log into GitHub, then follow the screenshots and descriptions below. + + ```{figure} img/basics/new-repo-plus.png + :alt: Screenshot on GitHub before a new repository form is opened + :width: 100% + :class: with-border + + Click on the "plus" symbol on top right, then on "New repository". + ``` + + Another way to create a new repository is to visit + directly. + + ```{figure} img/basics/new-repo-form.png + :alt: Screenshot on GitHub just before creating a new repository + :width: 100% + :class: with-border + + Choose a repository name, add a short description, **check "Add a + README file"**, finally "Create repository". + ``` + + After you have clicked "Create repository" you should see a repository overview + with one file (README.md) and one commit. + ```` +````` + + +## Adding files and committing changes + +Let us now **create two files**. + +One file is called `ingredients.txt` and contains: +```shell +* 2 avocados +* 1 chili +* 1 lime +* 2 tsp salt +``` + +The second file is called `instructions.txt` and contains: +```shell +* chop avocados +* chop onion +* chop chili +* squeeze lime +* add salt +* and mix well +``` + +`````{tabs} + ````{group-tab} Command line + As mentioned above, in Git you can always check the status of files in your repository using + `git status`. It is always a safe command to run and in general a good idea to + do when you are trying to figure out what to do next: + + ```console + $ git status + + On branch main + + No commits yet + + Untracked files: + (use "git add ..." to include in what will be committed) + ingredients.txt + instructions.txt + + nothing added to commit but untracked files present (use "git add" to track) + ``` + + The two files are untracked in the repository (directory). You want to **add the files** (focus the camera) + to the list of files tracked by Git. Git does not track + any files automatically and you need make a conscious decision to add a file. Let's do what + Git hints at, and add the files, one by one: + + ```console + $ git add ingredients.txt + $ git status + + On branch main + + No commits yet + + Changes to be committed: + (use "git rm --cached ..." to unstage) + new file: ingredients.txt + + Untracked files: + (use "git add ..." to include in what will be committed) + instructions.txt + ``` + + Now this change is *staged* and ready to be committed. + Let us now commit the change to the repository: + ```console + $ git commit -m "adding ingredients" + + [main (root-commit) f146d25] adding ingredients + 1 file changed, 4 insertions(+) + create mode 100644 ingredients.txt + ``` + + Right after we query the status to get this useful command into our muscle memory: + ```console + $ git status + ``` + + Now stage and commit also the other file: + ```console + $ git add instructions.txt + $ git commit -m "adding instructions" + ``` + + We will add a third file to the repository, `README.md`, containing: + ```markdown + # recipe + + This is an exercise repository. + ``` + + Now stage and commit also the `README.md` file: + ```console + $ git add README.md + $ git commit -m "adding README" + ``` + + What does the `-m` flag mean? Let us check the help page for that command: + ```console + $ git help commit + ``` + + You should see a very long help page as the tool is very versatile (press q to quit). + Do not worry about this now but keep in mind that you can always read the help files + when in doubt. Searching online can also be useful, but choosing search terms + to find relevant information takes some practice and discussions in some + online threads may be confusing. + Note that help pages also work when you don't have a network connection! + ```` + + ````{group-tab} Browser (GitHub) + ```{figure} img/basics/add-file.png + :alt: Screenshot on GitHub before a new file is created + :width: 100% + :class: with-border + + Click on "Add file", then "Create new file". + ``` + + ```{figure} img/basics/edit-file.png + :alt: Screenshot on GitHub when editing a file + :width: 100% + :class: with-border + + Edit the file and specify the file name. + ``` + + ```{figure} img/basics/commit-changes.png + :alt: Screenshot on GitHub when editing the commit message + :width: 100% + :class: with-border + + Before you commit the change, adjust the commit message. + ``` + + After you have added `ingredients.txt`, add also `instructions.txt` in a similar + way. + + We have added two files, each in one commit. However, we ended up with + three files and three commits since `README.md` was automatically committed + when we created the repository on GitHub. + ```` +````` + + +(exercise-record-changes)= + +## Exercise: Record changes + +``````{exercise} Basic-1: Record changes + Add 1/2 onion to `ingredients.txt` and also the instruction + to "enjoy!" to `instructions.txt`. + + `````{tabs} + ````{group-tab} Command line + After modifying the files, do not stage the changes yet (do not `git add` + yet). + + When you are done editing the files, try `git diff`: + ```console + $ git diff + ``` + + You will see (can you identify in there the two added lines?): + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index 4422a31..ba8854f 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -2,3 +2,4 @@ + * 1 chili + * 1 lime + * 2 tsp salt + +* 1/2 onion + diff --git a/instructions.txt b/instructions.txt + index 7811273..2b11074 100644 + --- a/instructions.txt + +++ b/instructions.txt + @@ -4,3 +4,4 @@ + * squeeze lime + * add salt + * and mix well + +* enjoy! + ``` + + Now first stage and commit each change separately (what happens when we leave out the `-m` flag?): + ```console + $ git add ingredients.txt + $ git commit -m "add half an onion" + $ git add instructions.txt + $ git commit # <-- we have left out -m "..." + ``` + + When you leave out the `-m` flag, Git should open an editor where you can edit + your commit message. This message will be associated and stored with the + changes you made. This message is your chance to explain what you've done and + convince others (and your future self) that the changes you made were + justified. Write a message and save and close the file. + + When you are done committing the changes, experiment with these commands: + ```console + $ git log + $ git log --stat + $ git log --oneline + ``` + ```` + + ````{group-tab} Browser (GitHub) + We can make modifications to a file by clicking on the file and then the + pen symbol: + ```{figure} img/basics/pen-symbol.png + :alt: Screenshot on GitHub before clicking on the pen symbol + :width: 100% + :class: with-border + + By clicking on the pen symbol we can switch to edit mode. + ``` + + ```{figure} img/basics/preview.png + :alt: Screenshot on GitHub when previewing file changes + :width: 100% + :class: with-border + + Before committing the change, click on "Preview". + ``` + + Our goal is to arrive at two new commits: + - "add half an onion" (modifying `ingredients.txt`) + - "don't forget to enjoy" (modifying `instructions.txt`) + + When you are done committing the changes, try to browse commit history + on GitHub. + ```` + ````` +`````` + + +## Git history and log + +`````{tabs} + ````{group-tab} Command line + If you haven't yet, please try now `git log`: + + ```console + $ git log + + commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main) + Author: Radovan Bast + Date: Sun Sep 17 19:12:47 2023 +0200 + + don't forget to enjoy + + commit 79161b6e67c62ad4688a58c1e54183334611a390 + Author: Radovan Bast + Date: Sun Sep 17 19:12:32 2023 +0200 + + add half an onion + + commit a3394e39535343c4dae3bb4f703741a31aa8b78a + Author: Radovan Bast + Date: Sun Sep 17 18:47:14 2023 +0200 + + adding README + + commit 369624674e63de48055a65bf63055bd59c985d22 + Author: Radovan Bast + Date: Sun Sep 17 18:46:58 2023 +0200 + + adding instructions + + commit f146d25b94569a15e94d7f0da6f15d7554f76c49 + Author: Radovan Bast + Date: Sun Sep 17 18:35:52 2023 +0200 + + adding ingredients + ``` + ```` + + ````{group-tab} Browser (GitHub) + ```{figure} img/basics/commits.png + :alt: Screenshot on GitHub before clicking on commit history + :width: 100% + :class: with-border + + Click on the history symbol with (here) 5 commits. + ``` + + ```{figure} img/basics/history.png + :alt: Screenshot of GitHub repository commit history + :width: 100% + :class: with-border + + In this overview you can browse each commit individually. + ``` + + On GitHub you can also compare arbitrary two commits (replace "USER", + "HASH1", and "HASH2"): + `https://github.com/USER/recipe/compare/HASH1..HASH2` + + Try it with two of your commits. + ```` +````` + +- We can browse the development and access each state that we have committed. +- The long hashes uniquely label a state of the code. +- They are not just integers counting 1, 2, 3, 4, ... (why?). +- Output is in reverse chronological order, i.e. **newest commits on top**. +- We will use them when comparing versions and when going back in time. +- `git log --oneline` only shows the first 7 characters of the commit hash and is good to get an overview. +- If the first characters of the hash are unique it is not necessary to type the entire hash. +- `git log --stat` is nice to show which files have been modified. + + +(exercise-diff-and-rename)= + +## Optional exercises: Comparing changes + +``````{exercise} (optional) Basic-2: Comparing and showing commits + `````{tabs} + ````{group-tab} Command line + 1. Have a look at specific commits with `git show HASH`. + 2. Inspect differences between commit hashes with `git diff HASH1 HASH2`. + ```` + + ````{group-tab} Browser (GitHub) + 1. Have a look at specific commits. + 2. Inspect differences between commits. + + Use the screenshots under "Git history and log". + ```` + ````` +`````` + +````{exercise} (optional) Basic-3: Visual diff tools + This exercise is only relevant for the command line. In the browser, + the preview is already side-by-side and "visual". + + - Make further modifications and experiment with `git difftool` (requires installing one of the [visual diff tools](https://coderefinery.github.io/installation/difftools/)): + + On Windows or Linux: + ```console + $ git difftool --tool=meld HASH + ``` + + On macOS: + ```console + $ git difftool --tool=opendiff HASH + ``` + + ```{figure} img/meld.png + :alt: Git difftool using meld + :width: 100% + + Git difftool using meld. + ``` + + You probably want to use the same visual diff tool every time and + you can configure Git for that: + ```console + $ git config --global diff.tool meld + ``` +```` + +```{exercise} (optional) Basic-4: Browser and command line +You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both. + +- If you have managed to do the above in the command line, try now in the browser. +- If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git. +``` + + +## Writing useful commit messages + +Using `git log --oneline` or browsing a repository on the web, we better +understand that the first line of the commit message is very important. + +Good example: +```text +increase threshold alpha to 2.0 + +the motivation for this change is +to enable ... +... +this is based on a discussion in #123 +``` + +Convention: **one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary**. + +- **Why something was changed is more important than what has changed.** +- Cross-reference to issues and discussions if possible/relevant. +- Bad commit messages: "fix", "oops", "save work" +- Bad examples: [http://whatthecommit.com](http://whatthecommit.com) +- Write commit messages in English that will be understood + 15 years from now by someone else than you. Or by your future you. +- Many projects start out as projects "just for me" and end up to be successful projects + that are developed by 50 people over decades. +- [Commits with multiple authors](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) are possible. + +Good references: + +- ["My favourite Git commit"](https://fatbusinessman.com/2019/my-favourite-git-commit) +- ["On commit messages"](https://who-t.blogspot.com/2009/12/on-commit-messages.html) +- ["How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/) + +```{note} +A great way to learn how to write commit messages and to get inspired by their +style choices: **browse repositories of codes that you use/like**: + +Some examples (but there are so many good examples): +- [SciPy](https://github.com/scipy/scipy/commits/main) +- [NumPy](https://github.com/numpy/numpy/commits/main) +- [Pandas](https://github.com/pandas-dev/pandas/commits/main) +- [Julia](https://github.com/JuliaLang/julia/commits/master) +- [ggplot2](https://github.com/tidyverse/ggplot2/commits/main), + compare with their [release + notes](https://github.com/tidyverse/ggplot2/releases) +- [Flask](https://github.com/pallets/flask/commits/main), + compare with their [release + notes](https://github.com/pallets/flask/blob/main/CHANGES.rst) + +When designing commit message styles consider also these: +- How will you easily generate a changelog or release notes? +- During code review, you can help each other improving commit messages. +``` + +But remember: it is better to make any commit, than no commit. Especially in small projects. +**Let not the perfect be the enemy of the good enough**. + + +## Ignoring files and paths with .gitignore + +```{discussion} +- Should we add and track all files in a project? +- How about generated files? +- Why is it considered a bad idea to commit compiled binaries to version control? +- What types of generated files do you know? +``` + +Compiled and generated files are not +committed to version control. There are many reasons for this: + +- These files can make it more difficult to run on different platforms. +- These files are automatically generated and thus do not contribute in any meaningful way. +- When tracking generated files you could see differences in the code although you haven't touched the code. + +For this we use `.gitignore` files. Example: +```shell +# ignore compiled python 2 files +*.pyc +# ignore compiled python 3 files +__pycache__ +``` + +An example taken from the [official Git documentation](https://git-scm.com/docs/gitignore): +```shell +# ignore objects and archives, anywhere in the tree. +*.[oa] +# ignore generated html files, +*.html +# except foo.html which is maintained by hand +!foo.html +# ignore everything under build directory +build/ +``` + +- `.gitignore` should be part of the repository because we want to make sure that all developers see the same behavior. +- **All files should be either tracked or ignored**. +- `.gitignore` uses something called a + [shell glob syntax](https://en.wikipedia.org/wiki/Glob_(programming)) for + determining file patterns to ignore. You can read more about the syntax in the + [documentation](https://git-scm.com/docs/gitignore). +- You can have `.gitignore` files in lower level directories and they affect the paths below. + + +## Graphical user interfaces + +We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI): + +- [GitHub Desktop](https://desktop.github.com) +- [SourceTree](https://www.sourcetreeapp.com) +- [List of third-party GUIs](https://git-scm.com/downloads/guis) + + +## Summary + +Now we know how to save snapshots: + +```console +$ git add FILE(S) +$ git commit +``` + +And this is what we do as we program. + +Every state is then saved and later we will learn how to go back to these "checkpoints" +and how to undo things. + +```console +$ git init -b main # initialize new repository (main is default branch) +$ git add # add files or stage file(s) +$ git commit # commit staged file(s) +$ git status # see what is going on +$ git log # see history +$ git diff # show unstaged/uncommitted modifications +$ git show # show the change for a specific commit +$ git mv # move/rename tracked files +$ git rm # remove tracked files +``` + +Git is not ideal for large binary files +(for this consider [git-annex](http://git-annex.branchable.com)). + +````{challenge} Basic-5: Test your understanding + Which command(s) below would save the changes of `myfile.txt` + to an existing local Git repository? + + 1. ```console + $ git commit -m "my recent changes" + ``` + 2. ```console + $ git init myfile.txt + $ git commit -m "my recent changes" + ``` + 3. ```console + $ git add myfile.txt + $ git commit -m "my recent changes" + ``` + 4. ```console + $ git commit -m myfile.txt "my recent changes" + ``` + ```{solution} + + 1. Would only create a commit if files have already been staged. + 2. Would try to create a new repository in a folder "myfile.txt". + 3. **Is correct: first add the file to the staging area, then commit.** + 4. Would try to commit a file "my recent changes" with the message myfile.txt. + ``` +```` + +```{keypoints} +- It takes only one command to initialize a Git repository: `git init -b main`. +- Commits should be used to tell a story. +- Git uses the .git folder to store the snapshots. +- Don't be afraid to stage and commit often. Better too often than not often enough. +``` diff --git a/_sources/branches.md.txt b/_sources/branches.md.txt new file mode 100644 index 00000000..418e4d67 --- /dev/null +++ b/_sources/branches.md.txt @@ -0,0 +1,624 @@ +# Branching and merging + +```{objectives} +- Be able to create and merge branches. +- Know the difference between a branch and a tag. +``` + +```{instructor-note} +- 30 min teaching/type-along +- 20 min exercise +``` + + +## Motivation for branches + +In the previous section we tracked a guacamole recipe with Git. + +Up until now our repository had only one branch with one commit coming +after the other: + +```{figure} img/gitink/git-branch-1.svg +:alt: Linear Git repository +:width: 40% + +Linear Git repository. +``` + +- Commits are depicted here as little boxes with abbreviated hashes. +- Here the branch `main` points to a commit. +- "HEAD" is the current position (remember the recording head of tape + recorders?). When we say `HEAD`, we mean those literal letters - + this isn't a placeholder for something else. +- When we talk about branches, we often mean all parent commits, not only the commit pointed to. + +**Now we want to do this:** + +```{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +``` + +Software development is often not linear: + +- We typically need at least one version of the code to "work" (to compile, to give expected results, ...). +- At the same time we work on new features, often several features concurrently. + Often they are unfinished. +- We need to be able to separate different lines of work really well. + +The strength of version control is that it permits the researcher to **isolate +different tracks of work**, which can later be merged to create a composite +version that contains all changes: + +```{figure} img/gitink/git-collaborative.svg +:alt: Isolated tracks of work +:width: 100% + +Isolated tracks of work. +``` + +- We see branching points and merging points. +- Main line development is often called `main` or `master`. +- Other than this convention there is nothing special about `main` or `master`, it is a branch like any other. +- Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow). + +A group of commits that create a single narrative are called a **branch**. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. "fast sequence extraction" or "Python interface" or "fixing bug in +matrix inversion algorithm". + +````{admonition} **An important alias** +--- +class: important +--- + +We will now define an *alias* in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). **This is extensively used in the rest of this +and other lessons**: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` +```` + +```{instructor-note} +Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative. +``` + +Let us inspect the project history using the `git graph` alias: + +```console +$ git graph + +* e7cf023 (HEAD -> main) don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +- We have a couple commits and only + one development line (branch) and this branch is called `main`. +- Commits are states characterized by a 40-character hash (checksum). +- `git graph` print abbreviations of these checksums. +- **Branches are pointers that point to a commit.** +- Branch `main` points to a commit (in this example it is `e7cf023efe382340e5284c278c6ae2c087dd3ff7` but on your computer + the hash will be different). +- `HEAD` is another pointer, it points to where we are right now (currently `main`) + +In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards. + + +## Creating and working with branches + +```{instructor-note} +We do the following part together. Encourage participants to type along. +``` + +```{admonition} It is possible to create and merge branches directly on GitHub +- However, we do not have screenshots for that in this episode +- But if you prefer to work in the browser, please try it +- Please contribute screenshots to this lesson +``` + +Let's create a branch called `experiment` where we add cilantro to `ingredients.txt` +(text after "#" are comments and not part of the command). + +```console +$ git branch experiment main # creates branch "experiment" from "main" +$ git switch experiment # switch to branch "experiment" +$ git branch # list all local branches and show on which branch we are +``` + +```{note} +In case `git switch` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git switch`. +``` + +- Verify that you are on the `experiment` branch (note that `git graph` also + makes it clear what branch you are on: `HEAD -> branchname`): + ```console + $ git branch + + * experiment + main + ``` + This command shows where we are, it does not create a branch. + +- Then add 2 tbsp cilantro **on top** of the `ingredients.txt`: + + ```{code-block} shell + --- + emphasize-lines: 1 + --- + * 2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + * 2 tsp salt + * 1/2 onion + ``` + +- Stage this and commit it with the message "let us try with some cilantro". +- Then reduce the amount of cilantro to 1 tbsp, stage and commit again with "maybe little bit less cilantro". + +We have created **two new commits**: + +```{code-block} console +--- +emphasize-lines: 3-4 +--- +$ git graph + +* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro +* f6ec7b7 let us try with some cilantro +* e7cf023 (main) don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +- The branch `experiment` is two commits ahead of `main`. +- We commit our changes to this branch. + + +(exercise-branches)= + +## Exercise: Create and commit to branches + +````{exercise} Branch-1: Create and commit to branches + In this exercise, you will create another new branch and few more commits. + We will use this in the next section, to practice + merging. **The goal of the exercise is to end up with 3 branches**. + + - Change to the branch `main`. + - Create another branch called `less-salt`. + - Note! makes sure you are on main branch when you create the `less-salt` branch. + - A safer way would be to explicitly mention to create from the main branch + as shown below: + ```console + $ git branch less-salt main + ``` + - Switch to the `less-salt` branch. + - On the `less-salt` branch reduce the amount of salt. + - Commit your changes to the `less-salt` branch. + + Use the same commands as we used above. + + We now have three branches (in this case `HEAD` points to `less-salt`): + + ```console + $ git branch + + experiment + * less-salt + main + + $ git graph + + * bf28166 (HEAD -> less-salt) reduce amount of salt + | * bcb8b78 (experiment) maybe little bit less cilantro + | * f6ec7b7 let us try with some cilantro + |/ + * e7cf023 (main) don't forget to enjoy + * 79161b6 add half an onion + * a3394e3 adding README + * 3696246 adding instructions + * f146d25 adding ingredients + ``` + + Here is a graphical representation of what we have created: + + ```{figure} img/gitink/git-branch-2.svg + ``` + + - Now switch to `main`. + - In a new commit, improve the `README.md` file (we added the word "Guacamole"): + + ```markdown + # Guacamole recipe + + This is an exercise repository. + ``` + + Now you should have this situation: + + ```console + $ git graph + + * b4af65b (HEAD -> main) improve the documentation + | * bf28166 (less-salt) reduce amount of salt + |/ + | * bcb8b78 (experiment) maybe little bit less cilantro + | * f6ec7b7 let us try with some cilantro + |/ + * e7cf023 don't forget to enjoy + * 79161b6 add half an onion + * a3394e3 adding README + * 3696246 adding instructions + * f146d25 adding ingredients + ``` + + ```{figure} img/gitink/git-branch-3.svg + ``` + + And for comparison this is how it looks [on GitHub](https://github.com/coderefinery/recipe-before-merge/network). +```` + +(exercise-branches-merging)= + +## Exercise: Merging branches + +It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge `experiment` into `main`. + +```{exercise} Branch-2: Merge branches +Merge `experiment` and `less-salt` back into `main` following the lesson below +until the point where we start deleting branches. +``` + +````{admonition} If you got stuck in the above exercises or joined later + **If you got stuck in the above exercises or joined later**, + you can apply the commands below. + But **skip this box if you managed to create branches**. + + ```console + $ cd .. # step out of the current directory + + $ git clone https://github.com/coderefinery/recipe-before-merge.git + $ cd recipe-before-merge + + $ git switch experiment + $ git switch less-salt + $ git switch main + + $ git remote remove origin + + $ git graph + ``` + + Or call a helper to un-stuck it for you. +```` + +First we make sure we are on the branch we wish to merge **into**: + +```{code-block} console +--- +emphasize-lines: 5 +--- +$ git branch + + experiment + less-salt +* main +``` + +Then we merge `experiment` into `main`: + +```console +$ git merge experiment +``` + +```{figure} img/gitink/git-merge-1.svg +``` + +We can verify the result: + +```console +$ git graph + +* 81fcc0c (HEAD -> main) Merge branch 'experiment' +|\ +| * bcb8b78 (experiment) maybe little bit less cilantro +| * f6ec7b7 let us try with some cilantro +* | b4af65b improve the documentation +|/ +| * bf28166 (less-salt) reduce amount of salt +|/ +* e7cf023 don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents. + +To view the branches that are merged into the current branch we can use the command: + +```console +$ git branch --merged + + experiment +* main +``` + +We are also happy with the work on the `less-salt` branch. Let us merge that +one, too, into `main`: + +```console +$ git branch # make sure you are on main +$ git merge less-salt +``` + +```{figure} img/gitink/git-merge-2.svg +:alt: Commit graph after merge + +Commit graph after merge. +``` + +We can verify the result in the terminal: + +```console +$ git graph + +* 4e03d4b (HEAD -> main) Merge branch 'less-salt' +|\ +| * bf28166 (less-salt) reduce amount of salt +* | 81fcc0c Merge branch 'experiment' +|\ \ +| * | bcb8b78 (experiment) maybe little bit less cilantro +| * | f6ec7b7 let us try with some cilantro +| |/ +* / b4af65b improve the documentation +|/ +* e7cf023 don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +Observe how Git nicely merged the changed amount of salt and the new ingredient **in the same file +without us merging it manually**: + +```console +$ cat ingredients.txt + +* 1 tbsp cilantro +* 2 avocados +* 1 chili +* 1 lime +* 1 tsp salt +* 1/2 onion +``` + +If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually *settle merge conflicts* (we will do that later). + + +## Deleting branches safely + +Both feature branches are merged: + +```console +$ git branch --merged + + experiment + less-salt +* main +``` + +This means we can delete the branches: + +```console +$ git branch -d experiment +$ git branch -d less-salt +``` + +This is the result: + +```{figure} img/gitink/git-deleted-branches.svg +:alt: Commit graph after merged branches were deleted + +Commit graph after merged branches were deleted. +``` + +We observe that when deleting branches, +only the pointers ("sticky notes") disappeared, not the commits. + +Git will not let you delete a branch which has not been reintegrated unless you +insist using `git branch -D`. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them. + + +(exercise-branches-optional)= + +## Optional exercises with branches + +The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section. + +````{exercise} (optional) Branch-3: Perform a fast-forward merge +1. Create a new branch from `main` and switch to it. +2. Create a couple of commits on the new branch (for instance edit `README.md`): + ```{figure} img/gitink/git-pre-ff.svg + ``` +3. Now switch to `main`. +4. Merge the new branch to `main`. +5. Examine the result with `git graph`. +6. Have you expected the result? Discuss what you see. + + ```{solution} + You will see that in this case no merge commit was created and Git merged the + two branches by moving (fast-forwarding) the "main" branch (label) three + commits forward. + + This was possible since one branch is the ancestor of the other and their + developments did not diverge. + + A merge that does not require any merge commit is a fast-forward merge. + ``` +```` + +````{exercise} (optional) Branch-4: Rebase a branch (instead of merge) +As an alternative to merging branches, one can also *rebase* branches. +Rebasing means that the new commits are *replayed* on top of another branch +(instead of creating an explicit merge commit). +**Note that rebasing changes history and should not be done on public commits!** +1. Create a new branch, and make a couple of commits on it. +2. Switch back to `main`, and make a couple of commits on it. +3. Inspect the situation with `git graph`. +4. Now rebase the new branch on top of `main` by first switching to the new branch, and then `git rebase main`. +5. Inspect again the situation with `git graph`. Notice that the commit hashes have changed - think about why! + + ```{solution} + You will notice two things: + - History is now linear and does not contain merge commits. + - All the commit hashes that were on the branch that got rebased, have + changed. This also demonstrates that `git rebase` is a command that alters + history. The commit history looks as if the rebased commits were all done + after the `main` commits. + ``` +```` + + +## Tags + +- A tag is a pointer to a commit but in contrast to a branch it **does not ever + move** when creating new commits later. +- It can be useful to think of branches as sticky notes and of tags as + [commemorative plaques](https://en.wikipedia.org/wiki/Commemorative_plaque). +- We use tags to record particular states or milestones of a project at a given + point in time, like for instance versions (have a look at [semantic versioning](http://semver.org), + v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a). +- There are two basic types of tags: annotated and lightweight. +- **Use annotated tags** since they contain the author and can be cryptographically signed using + GPG, timestamped, and a message attached. + +Let's add an annotated tag to our current state of the guacamole recipe: +```console +$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet" +``` + +As you may have found out already, `git show` is a very versatile command. Try this: + +```console +$ git show nobel-2023 +``` + +For more information about tags see for example +[the Pro Git book](https://git-scm.com/book/en/v2/Git-Basics-Tagging) chapter on the +subject. + +--- + +## Summary + +Let us pause for a moment and recapitulate what we have just learned: + +```console +$ git branch # see where we are +$ git branch NAME # create branch NAME +$ git switch NAME # switch to branch NAME +$ git merge NAME # merge branch NAME (to current branch) +$ git branch -d NAME # delete branch NAME +$ git branch -D NAME # delete unmerged branch NAME +``` + +Since the following command combo is so frequent: + +```console +$ git branch NAME # create branch NAME +$ git switch NAME # switch to branch NAME +``` + +There is a shortcut for it: + +```console +$ git switch --create NAME # create branch NAME and switch to it +``` + +### Typical workflows + +With this there are two typical workflows: + +```console +$ git switch --create new-feature # create branch, switch to it +$ git commit # work, work, work, ..., and test +$ git switch main # once feature is ready, switch to main +$ git merge new-feature # merge work to main +$ git branch -d new-feature # remove branch +``` + +Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging: + +```console +$ git switch --create wild-idea # create branch, switch to it, work, work, work ... +$ git switch main # realize it was a bad idea, back to main +$ git branch -D wild-idea # it is gone, off to a new idea +``` + +--- + +````{challenge} Branch-5: Test your understanding + Which of the following combos (one or more) creates a new branch and makes a commit to it? + 1. ```console + $ git branch new-branch + $ git add file.txt + $ git commit + ``` + 2. ```console + $ git add file.txt + $ git branch new-branch + $ git switch new-branch + $ git commit + ``` + 3. ```console + $ git switch --create new-branch + $ git add file.txt + $ git commit + ``` + 4. ```console + $ git switch new-branch + $ git add file.txt + $ git commit + ``` + + ```{solution} + Both 2 and 3 would do the job. Note that in 2 we first stage the file, and then create the + branch and commit to it. In 1 we create the branch but do not switch to it, while in 4 we + don't give the `--create` flag to `git switch` to create the new branch. + ``` +```` + +```{keypoints} +- A branch is a division unit of work, to be merged with other units of work. +- A tag is a pointer to a moment in the history of a project. +``` diff --git a/_sources/browsing.md.txt b/_sources/browsing.md.txt new file mode 100644 index 00000000..538dfbe9 --- /dev/null +++ b/_sources/browsing.md.txt @@ -0,0 +1,394 @@ +# Copy and browse an existing project + +In this episode, we will look at an **existing repository** to +understand how all the pieces work together. Along the way, we will make a copy +(a {term}`fork`) of the {term}`repository` for us, which will be used for our +own changes in the next episode. + +- We used to start by directly going and creating a repository from scratch. This + was abstract and hard to understand. +- Instead, we'll show you all the cool stuff in a Git repository + first, and then start adding files. +- We use an example recipe book we created just for this course. +- By the end of the course, you'll know how to contribute your own + recipes to it. + +:::{objectives} +* See a real Git repository and understand what is inside of it. +* Understand how version control allows advanced inspection of a + repository. +* See how Git allows multiple people to collaborate easily. +* See the big picture instead of remembering a bunch of commands. +::: + + +## GitHub, VS Code, Command line, and more + +We offer **three different paths** of how to do this exercise: +- **GitHub** (this is the one we will demonstrate on day 1) +- **VS Code** (if you prefer to follow along using an editor; we will + do this on day 2) +- **Command line** (for people comfortable with the command line; you + will see more of this on day 2) + +In the future we'll add more paths, for example Jupyter and RStudio +(contributions welcome!). + + +## Creating a copy of the repository by "forking" + +A {term}`repository` is a collection of files in one directory tracked +by git. A {term}`GitHub repository` is GitHub's copy, which adds +things like access control. Each GitHub repository is owned by a user +or organization, who controls what is in it. + +First, we need to make our own copy of the exercise repository. This will +become important later, when we make our own changes. + +1. Go to the repository view on GitHub: + - : you can use this one if you don't want your fork and contributions + to be visible on the stream or the recording + - : we will use this one for the demonstration which is streamed and recorded +1. First, on GitHub, click the button that says "Fork". It is towards + the top-right of the screen: + :::{figure} img/browsing/forking.png + :alt: Screenshot on GitHub before clicking on "Fork" + :width: 80% + :class: with-border + ::: +1. You should shortly be redirected to your copy of the repository + **YOUR_USER_NAME/recipe-book**. + +At all times you should be aware of if you looking at *your* repository +or the *CodeRefinery {term}`upstream`* repository. +* Your repository: https://github.com/**USERNAME**/recipe-book +* CodeRefinery upstream repository: https://github.com/**coderefinery**/recipe-book + +:::::{tabs} +::::{group-tab} GitHub +You only need to open your own view, as described above. The browser +URL should look like `https://github.com/USER/recipe-book`, where +`USER` is your GitHub username. +:::: + +::::{group-tab} VS Code +You need to have forked the repository as described above. + +We need to start by making a copy of this repository locally. + +1. Start VS Code. +1. If you don't have the default view (you already have a project +open), go to File → New Window. +1. Under "Start" on the screen, select "Clone Git Repository...". Alternatively + navigate to the "Source Control" tab on the left sidebar and click on the "Clone Repository" button. +1. Paste in this URL: `https://github.com/USER/recipe-book`, where + `USER` is your username. You can copy this from the browser. +1. Browse and select the folder in which you want to clone the + repository. +1. Say yes, you want to open this repository. +1. Select "Yes, I trust the authors" (the other option works too). +:::: + +::::{group-tab} Command line +**This path is advanced and we do not include all command line +information: you need to be somewhat +comfortable with the command line already.** + +We need to start by making a copy of this repository locally. You +need to have forked the repository as described above. + +1. Start the terminal in which you use Git (terminal application, or + Git Bash). +1. Change to the directory where you would want the repository to be + (`cd ~/code` for example, if the `~/code` directory is where you + store your files). +1. Run the following command: `git clone + https://github.com/USER/recipe-book`, where `USER` is your + username. You might need to use a SSH clone command instead of + HTTPS, depending on your setup. +1. Change to that directory: `cd recipe-book` +:::: +::::: + + +## Exercise + +Work on this by yourself or in your team. + +:::{instructor-note} +Before starting the exercise session: +- Make sure you have shown how to fork the repository to own account + (above). +::: + +:::{exercise} Exercise: Browsing an existing project (25 min) + +Browse the recipe-book project (introduced above) and explore commits and branches. Take notes +and prepare questions. The hints are for the GitHub path in the +browser. + +1. Browse the **commit history**: Are commit messages understandable? + (Hint: "Commit history", the timeline symbol, above the file list) +1. Compare the commit history with the **network graph** ("Insights" -> "Network"). Can you find the branches? +1. How can you find out when a recipe was **last modified**? +1. **How many changes** did the Guacamole recipe receive (you find it under "sides")? + Try to click on some of the commits to see what changed. + (Hint: "History" in the view of a single file) +1. **Which recipes include the ingredient "salt"**? + (Hint: the GitHub search. From the repository view, it should offer + the filter "repo:USER/recipe-book" by default. What if you + add a search term?) +1. In the Guacamole recipe, find out **who modified each line last and when** + (click on file, then click "Blame" button). Find out who added the cilantro + and in which commit. + (Hint: "Blame" view in the file view) +1. Can you use these recipes yourself? **Are you allowed to share + modifications**? + (Hint: look for a license file) +1. **Browse issues and pull requests** in the {term}`upstream` repository (the + repository you forked from). Any idea what these might be good for? + (Hint: tabs in the repository view) +::: + + +The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren't enough - this is by +design. + + +## Solution and walk-through + +### (1) Basic browsing + +The most basic thing to look at is the history of commits. + +* This is visible from a button in the repository view. We see every + change, when, and who has committed. +* Every change has a unique identifier, such as `554c187`. This can + be used to identify both this change, and the whole project's + version as of that change. +* Clicking on a change in the view shows more. + +:::::{tabs} + +::::{group-tab} GitHub +Click on the timeline symbol in the repository view: + :::{figure} img/browsing/history.png + :alt: Screenshot on GitHub of where to find the commit history + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +This can be done from "Timeline", in the bottom of explorer, but only +for a single file. +:::: + +::::{group-tab} Command line +Run: +```console +$ git log +``` + +Try also: +```console +$ git log --oneline +``` +:::: + +::::: + + +### (2) Compare commit history with network graph + +The commit history we saw above looks linear: one commit after +another. But if we look at the network view, we see some branches and +merges. We'll see how to do these later. This is another one of the +basic Git views. + +:::::{tabs} +::::{group-tab} GitHub +In a new browser tab, open the "Insights" tab, and click on "Network". +You can hover over the commit dots to see the person who committed and +how they correspond with the commits in the other view: + :::{figure} img/browsing/network.png + :alt: Screenshot on GitHub of the network graph + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +We don't know how to do this without an extension. Try starting a terminal and using the +"Command Line" option. +:::: + +::::{group-tab} Command line +If you defined the `git graph` alias as in {doc}`configuration`, you +can view the network graph with: +```console +$ git graph +``` +If not, you can use the basic command: +```console +$ git log --graph --oneline --decorate --all +:::: + +::::: + + +### (3) When was a recipe last modified? + +We see the history for the whole repository, but we can also see it +for a single file. + +:::::{tabs} + +::::{group-tab} GitHub +Navigate to the file view: Main page → sides directory → +guacamole.md. Click the "History" button near the top right: + :::{figure} img/browsing/file-history.png + :alt: Screenshot on GitHub showing the history of a single file + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +Open sides/guacamole.md file in the editor. Under the file browser, +we see a "Timeline" view there. +:::: + +::::{group-tab} Command line +The `git log` command can take a filename and provide the log of only +a single file: + +``` +$ git log sides/guacamole.md +``` +:::: + +::::: + + +### (4) How many changes did the Guacamole recipe receive? + +According to the view above, it seems to have five changes (as of +2024-03-07). This could change later on. + + +### (5) Which recipes include the ingredient "salt" + +Version control makes it very easy to find all occurrences of a single +word. This is useful for things like finding where functions or +variables are defined or used. + +:::::{tabs} +::::{group-tab} GitHub +We go to the main recipe book view. We click the Search magnifying +class at the very top, type "salt", and click enter. We see every +instance, including the context. + ```{admonition} Searching in a forked repository will not work instantaneously! + + It usually takes a few minutes before one can search for keywords in a forked repository + since it first needs to build the search index the very first time we search. + Start it, continue with other steps, then come back to this. + ``` + + :::{figure} img/browsing/search.png + :alt: Screenshot on GitHub performing a search + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +If you use the "Search" magnifying class on the left sidebar, and +search for "Salt" it shows the occurrences in every file. You can +click to see the usage in context. +:::: + +::::{group-tab} Command line +`grep` is the command line tool that searches for lines matching a term +```console +$ git grep salt # only the lines +$ git grep -C 3 salt # three lines of context +$ git grep -i salt # case insensitive +``` +:::: + +::::: + + +### (6) Who modified each line last and when? + +This is called the "annotate" or "blame" view. The name "blame" +is very unfortunate, but it is the standard term for historical reasons +for this functionality and it is not meant to blame anyone. + +:::::{tabs} + +::::{group-tab} GitHub +From a recipe view, change preview to "Blame" towards the top-left. +To get the actual commit, click on the commit message. + :::{figure} img/browsing/annotate.png + :alt: Screenshot on GitHub showing the "Blame" view + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +This requires an extension. We recommend for now you use the command +line version, after opening a terminal. +:::: + +::::{group-tab} Command line +These two commands are similar but have slightly different output. +```console +$ git annotate sides/guacamole.md +$ git blame sides/guacamole.md +``` +:::: + +::::: + + +### (7) Can you use these recipes yourself? Are you allowed to share modifications? + +* Look at the file `LICENSE`. +* It says it is "Creative Commons Zero 1.0", which is equivalent to + public domain. You can use them without conditions. +* Note the GitHub view of the file `LICENSE` gives a nice summary of what it + means. Try it out: + :::{figure} img/browsing/license.png + :alt: Screenshot on GitHub summarizing license terms + :width: 100% + :class: with-border + ::: + + +### (8) Browse issues and pull requests in the {term}`upstream` repository + +This can only be done through the GitHub view. Go to the main +repository **coderefinery/recipe-book**, (not your fork): +. {term}`Issues ` +and {term}`Pull requests ` are different for each GitHub +copy. + +* Click on the "Issues" tab. These are notes that people have added, + which allow discussion about the project. Often they are used to communicate + problems or ideas. +* Click on the "Pull requests" tab. This allows anyone to *propose + changes*, but only the repository owners can accept. + + +## Summary + +- Git allowed us to understand this simple project much better than we + could, if it was just a few files on our own computer. +- It was also very easy to share the project with the course. +- By forking the repository, we created our own copy. This is + important for the next episode, where we will make changes to + our copy. diff --git a/_sources/commits.md.txt b/_sources/commits.md.txt new file mode 100644 index 00000000..20f65d6f --- /dev/null +++ b/_sources/commits.md.txt @@ -0,0 +1,452 @@ +# Committing changes + +The first and most basic task to do in Git is *record changes* using +commits. In this part, we will record changes in two +ways: on a new branch (which supports multiple lines of work at once), and directly +on the "main" branch (which happens to be the default branch here). + +:::{objectives} +* Record new changes to our own copy of the project. +* Understand adding changes in two separate branches. +* See how to compare different versions. +::: + + +## Background + +- In the previous episode we have browsed an existing {term}`repository` and saw {term}`commits ` + and branches. +- Each commit is a snapshot of the entire project at a certain + point in time and has a unique identifier ({term}`hash`) . +- A {term}`branch` is a line of development, and the `main` branch or `master` branch + are often the default branch in Git. +- A branch in Git is like a sticky note that is attached to a commit. When we add + new commits to a branch, the sticky note moves to the new commit. +- {term}`Tags ` are a way to mark a specific commit as important, for example a release + version. They are also like a sticky note, but they don't move when new + commits are added. + +:::{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +What if two people, at the same time, make two different changes? Git +can merge them together easily. Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +::: + + +## Exercise + +We offer **three different paths** of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the **GitHub +path** only and recommend you do that. (You can get experience with +the other paths on day 2) + +:::{exercise} Exercise: Practice creating commits and branches (20 min) +1. Make sure that you now work **on your fork** of the recipe-book + repository (`USER/recipe-book`, *not* `coderefinery/recipe-book`) +1. First create a new branch and then add a recipe to the branch and commit the change. +1. In a new commit, modify the recipe you just added. +1. Switch to the `main` branch and modify a recipe there. +1. Browse the network and locate the commits that you just created ("Insights" -> "Network"). +1. Compare the branch that you created with the `main` branch. Can you find an easy way to see the differences? +1. Can you find a way to compare versions between two arbitrary commits in the repository? +1. Try to rename the branch that you created and then browse the network again. +1. Try to create a tag for one of the commits that you created (on GitHub, + create a "release"). +::: + +The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren't enough - this is by +design. + + +## Solution and walk-through + + +### (1) Make sure you are on your fork + +:::{figure} img/commits/fork.png +:alt: Screenshot on GitHub where we verify that we are on our fork. +:width: 60% +:class: with-border + +You want to see your username in the URL and you want to see the "forked from +..." part. +::: + + +### (2) Create a branch and add a recipe to the branch + +A recipe template is below. This format is called "Markdown", but it +doesn't matter right now. You don't have to use this particular template. +```markdown +# Recipe name + +## Ingredients + +- Ingredient 1 +- Ingredient 2 + + +## Instructions + +- Step 1 +- Step 2 +``` + +There is a {term}`main` branch that is default. We want to create a +*different* {term}`branch` for our new commit, because we will *merge* it later. +{term}`Commit ` is the verb to describe recording more changes, and also the +name of the thing you make. A commit is identified by something such as +`554c187`. + +:::::{tabs} +::::{group-tab} GitHub +1. Where it says "main" at the top left, click, enter a new branch + name `new-recipe`, click on the offer to create the new branch + ("Create branch new-recipe from main"). + :::{figure} img/commits/github-create-branch.png + :alt: Screenshot on GitHub where we create a new branch. + :width: 60% + :class: with-border + ::: +1. Change to some sub-directory, for example `sides` +1. Make sure you are still on the `new-recipe` branch (it should say + it at the top), and click "Add file" → "Create new file" from the + upper right. +1. Enter a filename where it says "Name your file...", with a `.md` at + the end. Example: `mixed-nuts.md`. +1. Enter the recipe. You can use the template above. +1. Click "Commit changes" +1. Enter a commit message. Then click "Commit + changes". + +You should appear back at the file browser view, and see your new +recipe there. +:::: + +::::{group-tab} VS Code +1. Make sure that you are on the main branch. +1. Version control button on left sidebar → Three dots in upper right of source control → Branch → Create branch. +1. VS Code automatically switches to the new branch. + +:::{figure} img/commits/vscode-create-branch.png +:width: 80% +:class: with-border +:alt: VS Code screenshot of create branch + +Creating a new branch in VS Code. +::: + +4. Create a new file, for example `sides/mixed-nuts.md`. +4. In the version control sidebar, click the `+` sign to add the file for the next commit. +4. Enter a brief message and click "Commit". + +:::{figure} img/commits/vscode-add-and-commit.png +:alt: Screenshot of VS Code commit process +:width: 80% +:class: with-border + +Committing a new file in VS Code. +::: +:::: + +::::{group-tab} Command line +Create a new branch called `new-recipe` from `main` and switch to it: +```console +$ git switch --create new-recipe main +``` + +Then create the new file. Finally add and commit the file: +```console +$ git add sides/mixed-nuts.md +$ git commit -m "Add mixed nuts recipe" +``` +:::: +::::: + + +### (3) Modify the recipe with a new commit + +:::::{tabs} +::::{group-tab} GitHub +This is similar to before, but we click on the existing file to +modify. + +1. Click on your new recipe, for example `mixed-nuts.md`. +2. Click the edit button, the pencil icon at top-right. +3. Follow the "Commit changes" instructions as in the previous step. +:::: + +::::{group-tab} VS Code +Repeat as in the previous step. +:::: + +::::{group-tab} Command line +Modify the file. Then commit the new change: +```console +$ git add sides/mixed-nuts.md +$ git commit -m "Short summary of the change" +``` + +Make sure to replace "Short summary of the change" with a meaningful commit +message. +:::: +::::: + + +### (4) Switch to the main branch and modify a recipe there + +:::::{tabs} +::::{group-tab} GitHub +1. Go back to the main repository page (your user's page). +1. In the branch switch view (top left above the file view), switch to + `main`. +1. Modify another recipe that already exists, following the pattern + from above. Don't modify the one you just created (but it shouldn't + even be visible on the `main` branch). +:::: + +::::{group-tab} VS Code +Use the branch selector at the bottom to switch back to the main branch. Repeat the same steps as above. + +:::{figure} img/commits/vscode-change-branch.png +:class: with-border +:width: 80% +:alt: VS Code screenshot + +Switching branch via selector at bottom. +:::: + +::::{group-tab} Command line +First switch to the `main` branch: +```console +$ git switch main +``` + +Then modify a file. Finally `git add` and then commit the change: +```console +$ git commit -m "Short summary of the change" +``` +:::: +::::: + + +### (5) Browse the commits you just made + +Let's look at what we did. Now, the `main` and `new-recipe` branches +have diverged: both have some modifications. Try to find the commits +you created. + +:::::{tabs} +::::{group-tab} GitHub +Insights tab → Network view (just like we have done before). +:::: + +::::{group-tab} VS Code +This requires an extension. Opening the VS Code terminal lets you use the command line method. + +:::{figure} img/commits/vscode-open-terminal.png +:class: with-border +:width: 80% +:alt: VS Code screenshot as described + +View → Terminal will open a terminal at bottom. This is a normal command line interface and very useful for work. (Note the git-aware prompt that shows the current branch. This requires other setup.) +:::: + +::::{group-tab} Command line +```console +$ git graph +$ git log --graph --oneline --decorate --all # If you didn't define git graph yet. +``` + +In my case I got: +```{code-block} +--- +emphasize-lines: 1-3 +--- +* b4de93b (HEAD -> main) add spring onion to poke +| * dc5d6f0 (origin/new-recipe, new-recipe) adding chocolate to the mixed nuts recipe +| * b4035e3 add mixed nuts recipe +|/ +* 554c187 (origin/main, origin/HEAD) Merge branch 'alex/fruit-salad' +|\ +| * 89d5ef9 fruit salad: instructions +| * 3bd2468 fruit salad: ingredients +* | 8bcb766 a todo note to not forget the instructions +|/ +* b950c5c just fixing capitalization +* d18035e fix formatting +* 7051cca add some cilantro +* ae19e81 add categories for easier browsing +* a6fe629 we also need salad +* 30b89c4 document what this is about +* fd12dc1 Merge branch 'radovan/lasagna' +|\ +| * 7753d43 vegetarian lasagna: instructions +| * aa0473e vegetarian lasagna: ingredients +* | 1e5a24a Merge branch 'radovan/poke' +|\ \ +| * | 5aa6687 oh no! forgot onion - adding +| * | cc84e4f working on a poke recipe +| |/ +* | 9500901 a classic pumpkin pie recipe - yum! +* | 34ce939 drafting a recipe for a pasta, so far only ingredients +* | 28e5f26 recipe for a mushroom soup +|/ +* a550963 reduce amount of salt +* f2d6d58 don't forget to enjoy +* 1fde064 add half an onion +* 4c1873e drafting a guacamole recipe +* 2992443 this will be licensed under CC0 +* 084a1ea starting with an almost empty readme +``` +:::: +::::: + + +### (6) Compare the branches + +Comparing changes is an important thing we need to do. When using the +GitHub view only, this may not be so common, but we'll show it so that +it makes sense later on. + +:::::{tabs} + +::::{group-tab} GitHub +Next to the branch name switcher, click on "Branches" to get an overview. + +Another way to compare branches or commits on GitHub is to adjust the following URL: +`https://github.com/USER/recipe-book/compare/VERSION1..VERSION2` + +Replace `USER` with your username and `VERSION1` and `VERSION2` with a commit hash or branch name. +Please try it out. +:::: + +::::{group-tab} VS Code +This seems to require an extension. We recommend you use the command line method. +:::: + +::::{group-tab} Command line +```console +$ git diff main new-recipe +``` + +Try also the other way around: +```console +$ git diff new-recipe main +``` + +Try also this if you only want to see the file names that are different: +```console +$ git diff --name-only main new-recipe +``` +:::: +::::: + + +### (7) Compare two arbitrary commits + +This is similar to above, but not only between branches. + +:::::{tabs} +::::{group-tab} GitHub +Like above, one can compare commits on GitHub by adjusting the following URL: +`https://github.com/USER/recipe-book/compare/VERSION1..VERSION2` + +Replace `USER` with your username and `VERSION1` and `VERSION2` with a commit hash or branch name. +Please try it out. +:::: + +::::{group-tab} VS Code +Again, we recommend using the Command Line method. +:::: + +::::{group-tab} Command line +First try this to get a short overview of the commits: +```console +$ git log --oneline +``` + +Then try to compare any two commit identifiers with `git diff`. +:::: +::::: + + +### (8) Renaming a branch + +:::::{tabs} +::::{group-tab} GitHub + +Branch button → View all branches → three dots at right side → Rename branch. + +:::: +::::{group-tab} VS Code +Version control sidebar → Three dots (same as in step 2) → Branch → Rename branch. Make sure you are on the right branch before you start. +:::: + +::::{group-tab} Command line +Renaming the current branch: +```console +$ git branch -m better-recipe +``` + +Renaming a different branch: +```console +$ git branch -m new-recipe better-recipe +``` +:::: +::::: + + +### (9) Creating a tag + +Tags are a way to mark a specific commit as important, for example a release +version. They are also like a sticky note, but they don't move when new +commits are added. + +:::::{tabs} +::::{group-tab} GitHub +Click on the branch switcher, and then on "Tags", then on "View all tags", then +"Create a new release": + :::{figure} img/commits/github-create-tag.png + :alt: Screenshot on GitHub where we create a new tag. + :width: 60% + :class: with-border + ::: + +What GitHub calls releases are actually tags in Git with additional metadata. +For the purpose of this exercise we can use them interchangeably. +:::: + +::::{group-tab} VS Code +Version control sidebar → Three dots (same as in step 2) → Tags → Creat tag. Make sure you are on the expected commit before you do this. +:::: + +::::{group-tab} Command line +Creating a tag: +```console +$ git tag -a v1.0 -m "New manuscript version of my recipe for the pre-print" +``` +:::: +::::: + + +## Discussion + +In this part, we saw how we can make changes to our files. +With {term}`branches `, we can +track several lines of work at once, and can compare +their differences. + +- You could commit directly to `main` if there is only one single line + of work and it's only you. +- You could commit to branches if there are multiple lines of work at + once, and you don't want them to interfere with each other. +- Tags are useful to mark a specific commit as important, for example a + release version. +- In Git, commits form a so-called "graph". Branches are tags in Git function + like sticky notes that stick to specific commits. What this means for us is + that it does not cost any significant disk space to create new branches. diff --git a/_sources/configuration.md.txt b/_sources/configuration.md.txt new file mode 100644 index 00000000..b00b7a89 --- /dev/null +++ b/_sources/configuration.md.txt @@ -0,0 +1,147 @@ +(configuration)= + +# Configuring Git command line and editor + +We have a longer version of this in the [installation +instructions](https://coderefinery.github.io/installation/git-in-terminal/). +But for clarity, we will review the most important parts here. + +You don't need to set these if you work only through the GitHub web interface. +If you use VS Code or other editors or integrated development environments, +the editor might prompt you to set these up. + +These configuration settings are saved in a file called `.gitconfig` in your +home directory. If this file exists, editors like VS Code will use this +configuration. + +If you want to see your configuration settings, you can use the +command (`--show-origin` means it shows the file *where* each setting +is defined): +```console +$ git config --list --show-origin +``` + + +## Name and email address for Git commit metadata + +Git commits carry metadata about the author and two things you will always need +to define somewhere are: +```console +$ git config --global user.name "Your Name" +$ git config --global user.email yourname@example.com +``` + +For the email address we recommend to use the one you use for your GitHub account. +If you prefer to not use it, you can instead use +`YOUR_GITHUB_USERNAME@users.noreply.github.com` as the email address (replace `YOUR_GITHUB_USERNAME`). +This means that nobody can write to this email address, but GitHub will still +be able to connect your contributions with your GitHub account. + +Note that these can, in theory, be anything: this is just data, not a +registration or identity requirement. + + +## Default branch name + +The default branch name in Git has been `master` for a long time, but it is +changing to `main` in many places. We recommend to set it to `main` for new +repositories that you create locally: +```console +$ git config --global init.defaultbranch main +``` + + +## Useful alias for the command line + +We recommend to define an {term}`alias` in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command: +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` + +We have an own section about aliases: {ref}`aliases`. + + +## Default text editor for commit messages + +Git sometimes needs to start a text editor for you to enter messages (unless you create +commits from inside an editor or on the web). +This may have already been set to something (like VS Code), but if not +`nano` is usually a safe choice: + +```console +$ git config --global core.editor nano +``` + +The [installation instructions text editor page](https://coderefinery.github.io/installation/editors/) gives ways +to set other editors, or do a web search for "git set editor to +[editor name]". + + +% This anchor used for linking from other lessons +(clone-method)= + +## Authenticating to GitHub: SSH or HTTPS or VS Code? + +**How does GitHub know who you are?** There are three options: +- **SSH** is the classic method, using [Secure Shell + Protocol](https://en.wikipedia.org/wiki/Secure_Shell) remote connection + keys. +- **HTTPS** works with the **Git Credential Manager**, which is an + extra add-on that works easily in Windows and Mac. +- **VS Code** editor can authenticate with GitHub using its own + authentication method. + +Read how to install them from the [installation +instructions](https://coderefinery.github.io/installation/ssh/). + +Test which one you should use: + +:::::{tabs} + ::::{group-tab} Command line: SSH + Try this command: + ```console + $ ssh -T git@github.com + ``` + + If it returns `Hi USERNAME! You've successfully authenticated, ...`, + then SSH is configured and the following steps will work with the SSH + cloning. + + See our [installation + instructions](https://coderefinery.github.io/installation/ssh/) to + set up SSH access. + + **From now on, if you know that SSH works, you should always select + SSH as the clone URL from GitHub, or translate the URL to start with + the right thing yourself:** `git@github.com:` (with the `:`). + :::: + + ::::{group-tab} Command line: HTTPS + Try this command: + ```console + $ git config --get credential.helper + ``` + + If this shows something, then the credential manager is probably + configured and HTTPS cloning will work (but you can't verify it until + you try using it). + + From now on, **if you know that HTTPS works, you should always select + HTTPS as the clone URL from GitHub, or translate the URL to start with + the right thing yourself:** `https://github.com/` + :::: + + ::::{group-tab} VS Code + VS Code has its own authentication method and the editor will guide you + through the process. If you are using VS Code, you can skip the SSH and + HTTPS checks. + + From now on, you should **Select HTTPS as the clone URL from + GitHub, or translate the URL to start with the right thing + yourself:** `https://github.com/` + + If you don't want VS Code to be connected to your GitHub account, + set up and use the SSH method instead. + :::: +::::: diff --git a/_sources/conflicts.md.txt b/_sources/conflicts.md.txt new file mode 100644 index 00000000..34b978ad --- /dev/null +++ b/_sources/conflicts.md.txt @@ -0,0 +1,463 @@ +(conflict-resolution)= + +# Conflict resolution + +```{objectives} +- Understand merge conflicts sufficiently well to be able to fix them. +``` + +```{instructor-note} +- 20 min teaching/type-along +- 20 min exercise +``` + + +## Conflicts in Git and why they are good + +Imagine we start with the following text file: +```{code-block} +1 tbsp cilantro +2 avocados +1 chili +1 lime +1 tsp salt +1/2 onion +``` + +On branch A somebody modifies: +```{code-block} +--- +emphasize-lines: 1, 4 +--- +2 tbsp cilantro +2 avocados +1 chili +2 lime +1 tsp salt +1/2 onion +``` + +On branch B somebody else modifies: +```{code-block} +--- +emphasize-lines: 1, 6 +--- +1/2 tbsp cilantro +2 avocados +1 chili +1 lime +1 tsp salt +1 onion +``` + +When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro: +```{code-block} +--- +emphasize-lines: 1 +--- +????????????????? +2 avocados +1 chili +2 lime +1 tsp salt +1 onion +``` + +Git is very good at resolving modifications when merging branches and +in most cases a `git merge` runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see {ref}`exercise-branches-optional`) without you even noticing. + +But sometimes the **same portion** of the code/text is modified on two branches +**in two different ways** and Git issues a **conflict**. +Then you need to tell Git which version to keep (**resolve** it). + +There are several ways to do that as we will see. + +Please remember: + +- It is good that Git conflicts exist: Git will not silently overwrite one of + two differing modifications. +- Conflicts may look scary, but are not that bad after a little bit of + practice. Also they are luckily rare. +- Don't be afraid of Git because of conflicts. You may not meet some conflicts + using other systems because you simply can't do the kinds of things you do + in Git. +- You can take human measures to reduce them. + +--- + +```{discussion} The human side of conflicts +- What does it mean if two people do the same thing in two different ways? +- What if you work on the same file but do two different things in the different sections? +- What if you do something, don't tell someone from 6 months, and then try to combine it with other people's work? +- How are conflicts avoided in other work? (Only one person working at once? + Declaring what you are doing before you start, if there is any chance someone + else might do the same thing, helps.) +- Minor conflicts (two people revise spelling) vs semantic (two people rewrite + a function to add two different new features). How did Git solve these in + branching/merging easily? +``` + +Now we can go to show how Git controls when there is actually a conflict. + + +## Preparing a conflict + +```{instructor-note} +We do the following together as type-along/demo. +``` + +````{admonition} If you got stuck previously or joined later + **If you got stuck previously or joined later**, + you can apply the commands below. + But **skip this box if you managed to create branches**. + + ```console + $ cd .. # step out of the current directory + + $ git clone https://github.com/coderefinery/recipe-before-merge.git + $ cd recipe-before-merge + + $ git remote remove origin + + $ git graph + ``` + + Or call a helper to un-stuck it for you. +```` + +We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together. + +- Create two branches from `main`: one called `like-cilantro`, one called `dislike-cilantro`: + ```console + $ git branch like-cilantro main + $ git branch dislike-cilantro main + ``` + +- On the two branches make **different modifications** to the amount of the **same ingredient**: + +- On the branch `like-cilantro` we have the following change: + ```console + $ git diff main like-cilantro + ``` + + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index e83294b..6cacd50 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -1,4 +1,4 @@ + -* 1 tbsp cilantro + +* 2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + ``` + +- And on the branch `dislike-cilantro` we have the following change: + ```console + $ git diff main dislike-cilantro + ``` + + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index e83294b..6484462 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -1,4 +1,4 @@ + -* 1 tbsp cilantro + +* 1/2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + ``` + + +## Merging conflicting changes + +What do you expect will happen when we try to merge these two branches into +main? + +```{note} +In case `git switch` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git switch`. +``` + +The first merge will work: + +```console +$ git switch main +$ git status +$ git merge like-cilantro + +Updating 4e03d4b..3caa632 +Fast-forward + ingredients.txt | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) +``` + +But the second will fail: + +```console +$ git merge dislike-cilantro + +Auto-merging ingredients.txt +CONFLICT (content): Merge conflict in ingredients.txt +Automatic merge failed; fix conflicts and then commit the result. +``` + +Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit: + +```{code-block} console +--- +emphasize-lines: 9 +--- +$ git status + +You have unmerged paths. + (fix conflicts and run "git commit") + (use "git merge --abort" to abort the merge) + +Unmerged paths: + (use "git add ..." to mark resolution) + both modified: ingredients.txt + +no changes added to commit (use "git add" and/or "git commit -a") +``` + +Git won't decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward. + +Let us inspect the conflicting file: + +```console +$ cat ingredients.txt + +<<<<<<< HEAD +* 2 tbsp cilantro +======= +* 1/2 tbsp cilantro +>>>>>>> dislike-cilantro +* 2 avocados +* 1 chili +* 1 lime +* 1 tsp salt +* 1/2 onion +``` + +Git inserted resolution markers (the `<<<<<<<`, `>>>>>>>`, and `=======`). + +Try also `git diff`: + +```console +$ git diff +``` + +```diff +diff --cc ingredients.txt +index 6cacd50,6484462..0000000 +--- a/ingredients.txt ++++ b/ingredients.txt +@@@ -1,4 -1,4 +1,10 @@@ +++<<<<<<< HEAD + +* 2 tbsp cilantro +++======= ++ * 1/2 tbsp cilantro +++>>>>>>> dislike-cilantro + * 2 avocados + * 1 chili + * 1 lime +``` + +`git diff` now only shows the conflicting part, nothing else. + + +## Conflict resolution + +``` +<<<<<<< HEAD +* 2 tbsp cilantro +======= +* 1/2 tbsp cilantro +>>>>>>> dislike-cilantro +``` + +We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged. + +```{admonition} Steps to resolve a conflict + +- Check status with `git status` and `git diff`. +- Decide what you keep (the one, the other, or both or something + else). Edit the file to do this. + - Remove the resolution markers, if not already done. + - The file(s) should now look exactly how you want them. +- Check status with `git status` and `git diff`. +- Tell Git that you have resolved the conflict with `git add ingredients.txt` + (if you use the Emacs editor with a certain plugin the editor may stage the + change for you after you have removed the conflict markers). +- Verify the result with `git status`. +- Finally commit the merge with only `git commit`. Everything is pre-filled. +``` + +(exercise-conflicts)= + +## Exercise: Create and resolve a conflict + +````{exercise} Conflict-1: Create another conflict and resolve +In this exercise, we repeat almost exactly what we did above with a +different ingredient. + +1. Create two branches before making any modifications. +2. Again modify some ingredient on both branches. +3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge. +4. What happens if you apply the same modification on both branches? +5. If you create a branch `like-avocados`, commit a change, then from this + branch create another banch `dislike-avocados`, commit again, and try to + merge both branches into `main` you will not see a conflict. Can you + explain, why it is different this time? +```{solution} +4: No conflict in this case if the change is the same. + +5: No conflict in this case since in Git history one change happened after the other. The two changes + are related and linked by Git history and one is a Git ancestor of the + other. Git will assume that since we applied one change after the other, + we meant this. There is nothing to resolve. +``` +```` + +(exercise-conflicts-optional)= + +## Optional exercises with conflict resolution + +````{exercise} (optional) Conflict-2: Resolve a conflict when rebasing a branch +1. Create two branches where you anticipate a conflict. +2. Try to merge them and observe that indeed they conflict. +3. Abort the merge with `git merge --abort`. +4. What do you expect will happen if you rebase one branch on top of the + other? Do you anticipate a conflict? Try it out. +```{solution} +Yes, this will conflict. If it conflicts during a merge, it will also conflict +during rebase but the conflict resolution looks slightly different: +You still need to look for conflict markers but you tell Git that you resolved +a conflict with `git add` and then you continue with `git rebase --continue`. +Follow instructions that you get from the Git command line. +``` +```` + +````{exercise} (optional) Conflict-3: Resolve a conflict using mergetool + - Again create a conflict (for instance disagree on the number of avocados). + - Stop at this stage: + + ```markdown + Auto-merging ingredients.txt + CONFLICT (content): Merge conflict in ingredients.txt + Automatic merge failed; fix conflicts and then commit the result. + ``` + + - Instead of resolving the conflict manually, use a visual tool + (requires installing one of the [visual diff tools](https://coderefinery.github.io/installation/difftools/)): + + ```console + $ git mergetool + ``` + + ```{figure} img/conflict-resolution/mergetool.png + :alt: Conflict resolution using mergetool + :width: 100% + ``` + + - Your current branch is left, the branch you merge is right, result is in the middle. + - After you are done, close and commit, `git add` is not needed when using `git mergetool`. + + If you have not instructed Git to avoid creating backups when using mergetool, then to be on + the safe side there will be additional temporary files created. To remove those you can do + a git clean after the merging. + + To view what will be removed: + + ```console + $ git clean -n + ``` + + To remove: + + ```console + $ git clean -f + ``` + + To configure Git to avoid creating backups at all: + + ```console + $ git config --global mergetool.keepBackup false + ``` +```` + +--- + +## Using "ours" or "theirs" strategy + +- Sometimes you know that you want to keep "ours" version (version on the branch you are on) + or "theirs" (version on the merged branch). +- Then you do not have to resolve conflicts manually. +- See [merge strategies](https://git-scm.com/docs/merge-strategies). + +Example (merge and in doubt take the changes from current branch): +```console +$ git merge -s recursive -Xours less-avocados +``` + +Or (merge and in doubt take the changes from less-avocados branch): +```console +$ git merge -s recursive -Xtheirs less-avocados +``` + +--- + +## Aborting a conflicting merge + +Sometimes you get a merge conflict but realize that you can't solve it without +talking to a colleague (who created the other change) first. What to do? + +You can abort the merge and postponing conflict resolution by resetting the +repository to `HEAD` (last committed state): + +```console +$ git merge --abort +``` + +The repository looks then exactly as it was before the merge. + +--- + +## Avoiding conflicts + +- Human measures + - Think and plan to which branch you will commit to. + - Do not put unrelated changes on the same branch. +- Collaboration measures + - Open an issue and discuss with collaborators before starting a long-living + branch. +- Project layout measures + - Modifying global data often causes conflicts. + - Modular programming reduces this risk. +- Technical measures + - **Share your changes early and often** - this is one of the happy, + rare circumstances when everyone doing the selfish thing (e.g. `git push` as + early as practical) results in best case for everyone! + - Pull/rebase often to keep up to date with upstream. + - Resolve conflicts early. + +```{discussion} +Discuss how Git handles conflicts compared to services like Google Drive. +``` + +```{keypoints} +- Conflicts often appear because of not enough communication or not optimal + branching strategy. +``` diff --git a/_sources/customizing.md.txt b/_sources/customizing.md.txt new file mode 100644 index 00000000..c8fdf72b --- /dev/null +++ b/_sources/customizing.md.txt @@ -0,0 +1,25 @@ +# Customizing Git + +## Shell prompt + +```{instructor-note} +Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like. +``` + +You can make your shell display contextual information about +your Git state even at all times. + +Here are few example projects that make this possible and easy: +- (bash) +- (zsh) +- (fish) +- (bash and fish) + + +## More useful "diff" output + +[Delta](https://github.com/dandavison/delta) is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +"diff" output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more. diff --git a/_sources/exercises.md.txt b/_sources/exercises.md.txt new file mode 100644 index 00000000..fe455cfa --- /dev/null +++ b/_sources/exercises.md.txt @@ -0,0 +1,10 @@ +# List of exercises + +This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests. + +```{exerciselist} +``` diff --git a/_sources/guide.md.txt b/_sources/guide.md.txt new file mode 100644 index 00000000..89b3eda7 --- /dev/null +++ b/_sources/guide.md.txt @@ -0,0 +1,221 @@ +# Instructor guide + + +:::warning +## Exercise preparation: one day before the workshop + +- Create two exercise repository from + preserving history + (this means **not** using "generating from template") + - + - +- You can create these using `git clone --mirror` and `git push --mirror` to make sure to copy all branches. +- Create one or two issues to both +- Create one or two pull requests to both +- In both, try to search for something in the recipes to trigger a search index + update +::: + + +## Privacy + +When presenting the material in a streamed and recorded workshop, make sure to +only show the +repository. + + +## Schedule Day 1 + +Times here are in CE(S)T. + +- 08:50 - 09:00 (10 min) Soft start and icebreaker question +- 09:00 - 09:20 (20 min) Welcome and practical information + +- 09:20 - 09:35 (15 min) [Motivation](https://coderefinery.github.io/git-intro/motivation/) +- 09:35 - 10:00 (25 min) [Copy and browse an existing project](https://coderefinery.github.io/git-intro/browsing/) + +- 10:00 - 10:10 (10 min) Break + +- 10:10 - 11:00 (50 min) [Committing changes](https://coderefinery.github.io/git-intro/commits/) + +- 11:00 - 12:00 (60 min) Break + +- 12:00 - 12:50 (50 min) [Merging changes and contributing to the project](https://coderefinery.github.io/git-intro/merging/) + +- 12:50 - 13:00 (10 min) Break + +- 13:00 - 13:30 (20 min) Demonstrating conflict resolution, Q&A, feedback, and what will we be doing tomorrow? + + +## Schedule Day 2 + +Times here are in CE(S)T. + +- 08:50 - 09:00 (10 min) Soft start and icebreaker question +- 09:00 - 09:50 (50 min) [Cloning a Git repository and working locally](https://coderefinery.github.io/git-intro/local-workflow/) + +- 09:50 - 10:00 (10 min) Break + +- 10:00 - 11:00 (60 min) [Inspecting history](https://coderefinery.github.io/git-intro/archaeology/) + +- 11:00 - 12:00 (60 min) Break + +- 12:00 - 12:50 (50 min) [How to turn your project to a Git repo and share it](https://coderefinery.github.io/git-intro/sharing/) + +- 12:50 - 13:00 (10 min) Break + +- 13:00 - 13:30 (20 min) Practical advice, Q&A, feedback, and what will we be doing tomorrow? + + +## Why we teach this lesson + +Everyone should be using a version control system for their work, even if they're working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories. + +Specific motivations: +- Code easily becomes a disaster without version control +- Mistakes happen - Git offers roll-back functionality and easy backup mechanism +- One often needs to work on multiple things in parallel - branches solve that problem +- Git enables people to collaborate on code or text without stepping on each other's toes +- Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, + and if bugs are found one can find out exactly when it was introduced + +Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices. + + +## Intended learning outcomes + +By the end of this lesson, learners should: +- realize that version control is very important and Git is a valuable tool to learn and use +- understand that Git is configurable and know how to set basic configurations +- be able to set up Git repositories and make commits +- know how to write good commit messages +- have an idea of how the staging area can be used to craft good commits +- know how to create branches and switch between branches +- have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way +- know how to merge branches and understand what that means in terms of combining different modifications +- realize that conflicts are generally a good thing since they prevent incorrect merges +- be able to set up a repository on GitHub and connect it with local repository +- push changes to a remote repository +- know a few ways to search through a repository and its history + + +## Inspecting history + +Key lesson is *how to find when something is broken or what commit has broken +the code*. + +It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that `git annotate` +and `git show` are available on GitHub and GitLab. + +When discussing `git annotate` and `git bisect` the "when" is more important +than "who". It is not to blame anybody but rather to find out whether published +results are affected. + +Discuss how one would find out this information without version control. + +**Questions to involve participants:** + +- Have you ever found a bug in your code and wondered whether it has affected published results? +- Have you ever wondered when, and by whom, a particular line of code was introduced? +- Have you ever found out that a code behaves differently than it used to but you are not sure when + precisely this changed? + + +**Confusion during `git bisect` exercise:** + +Learners may get stuck in the `git bisect` exercise if they incorrectly assign a commit +as *bad* or *good*. +To leave the bisect mode and return to the commit before `git bisect start` was issued, +one can do +```shell +$ git bisect reset +``` +and start over if needed. + + +### Live better than reading the website material + +It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier. + + +### Log your history in a separate window + +The screencasting (shell window cheatsheet) hints have been moved to +the [presenting +manual](https://coderefinery.github.io/manuals/instructor-tech-setup/). + + +### Create a cheatsheet on the board + +For in-person workshops, create a "cheatsheet" on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven't forgotten anything. Re-create and expand in future git lessons. +One strategy is: + +- a common section for basic commands: `init`, `config`, `clone`, `help`, `stash` +- info commands, can be run anytime: `status`, `log`, `diff`, `graph` +- A section for all the commands that move code from different states: + `add`, `commit`, etc. See the visual cheat sheet below. + +You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it's probably too confusing to use after this course. But, the idea +of commands moving from the "working dir", "staging area", "commits", +etc is good. + +```{figure} img/cheat-sheet.jpg +:alt: Example cheat sheet +:width: 100% + +Example cheat sheet. +``` + +We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to. + + +### Draw a graph on the board + +Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run `git graph`, then do the command, +then look at `git graph` again. + + +### Repeat the following points + +- Always check `git status`, `git diff`, and `git graph` (our alias) before and + after every command until you get used to things. These give you a clear view + into what is going on, the key to knowing what you are doing. Even + after you are used to things... anytime you do something you do + infrequently, it's good to check. + +- `git graph` is a direct representation of what we are drawing on the + board and should constantly be compared to it. + +- Once you `git add` something, it's almost impossible to lose it. + This is used all the time, for example once you commit or even add + it is hard to lose. Commit before you merge or rebase. And so on. + + +### Start from identical environment + +You probably have a highly optimized bash and git environment - one +that is different from students. Move `.gitconfig` and `.bashrc` out +of the way before you start so that your environment is identical to +what students have. diff --git a/_sources/index.md.txt b/_sources/index.md.txt new file mode 100644 index 00000000..ccbd5471 --- /dev/null +++ b/_sources/index.md.txt @@ -0,0 +1,124 @@ +# Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version + +```{warning} +In February and March 2024 we rewrote this lesson from the ground up. +If you are looking for the previous version, you can browse the +[2023 version of this lesson](https://coderefinery.github.io/git-intro/branch/2023-version/). +``` + +This is the introductory lesson to version control using +[Git](https://git-scm.com/). + +We start with an existing repository on the web to visually explain the basic +concepts of version control. We later move to a local +repository. Our goal there is not only to be able to apply changes to an +existing repository but to also be able to turn own projects into Git +repositories and to share them with others. + +In the separate [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/), we teach more use +of remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with Git to +be able to work well. + +The goals of the module as a whole are that the learner will feel comfortable +about committing changes, branching, and merging. + +```{prereq} +We offer several options to go through the material: **on the web, in an editor, +or in the terminal**. +Please see the [installation instructions](https://coderefinery.github.io/installation/). + +We recommend to have a [GitHub](https://github.com) account. +**Why GitHub?** +Also [GitLab](https://gitlab.com) and [Bitbucket](https://bitbucket.org) would +allow similar workflows and basically everything that we will discuss is +transferable. With this material and these exercises we do not implicitly +endorse the company [GitHub](https://github.com). We have chosen to demonstrate +a number of concepts using examples with [GitHub](https://github.com) because +it is currently the most popular web platform for hosting Git repositories and +the chance is high that you will interact with +[GitHub](https://github.com)-based repositories even if you choose to host your +Git repository on another service. +``` + +```{toctree} +:maxdepth: 1 +:caption: Getting started + +motivation +configuration +``` + +```{toctree} +:maxdepth: 1 +:caption: Modifying an existing project + +browsing +commits +merging +local-workflow +``` + +```{toctree} +:maxdepth: 1 +:caption: Studying an existing project + +archaeology +``` + +```{toctree} +:maxdepth: 1 +:caption: Sharing your work + +sharing +``` + +```{toctree} +:maxdepth: 1 +:caption: Finding the balance + +level +what-to-avoid +``` + +```{toctree} +:maxdepth: 1 +:caption: Older episodes + +basics +branches +conflicts +``` + +```{toctree} +:maxdepth: 1 +:caption: Optional episodes + +staging-area +recovering +interrupted +aliases +under-the-hood +``` + +```{toctree} +:maxdepth: 1 +:caption: Reference + +reference +customizing +resources +exercises +guide +PDF version +``` + +```{toctree} +:maxdepth: 1 +:caption: About + +All lessons +CodeRefinery +Reusing +``` diff --git a/_sources/interrupted.md.txt b/_sources/interrupted.md.txt new file mode 100644 index 00000000..0516cad1 --- /dev/null +++ b/_sources/interrupted.md.txt @@ -0,0 +1,106 @@ +# Interrupted work + +```{objectives} +- Learn to switch context or abort work without panicking. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 15 min exercise +``` + +```{keypoints} +- There is almost never reason to clone a fresh copy to complete a task that + you have in mind. +``` + + +## Frequent situation: interrupted work + +We all wish that we could write beautiful perfect code. But the real world is +much more chaotic: + +- You are in the middle of a "Jackson-Pollock-style" debugging spree with 27 modified files + and debugging prints everywhere. +- Your colleague comes in and wants you to fix/commit something right now. +- What to do? + +Git provides lots of ways to switch tasks without ruining everything. + + +## Option 1: Stashing + +The **stash** is the first and easiest place to temporarily "stash" +things. + +- `git stash` will put working directory and staging area changes + away. Your code will be same as last commit. +- `git stash pop` will return to the state you were before. Can give it a list. +- `git stash list` will list the current stashes. +- `git stash save NAME` is like the first, but will give it a name. + Useful if it might last a while. +- `git stash save [-p] [filename]` will stash certain files files + and/or by patches. +- `git stash drop` will drop the most recent stash (or whichever stash + you give). +- The stashes form a stack, so you can stash several batches of modifications. + + +(exercise-stashing)= + +### Exercise: Stashing + +````{exercise} Interrupted-1: Stash some uncommitted work +1. Make a change. +2. Check status/diff, stash the change with `git stash`, check status/diff again. +3. Make a separate, unrelated change which doesn't touch the same + lines. Commit this change. +4. Pop off the stash you saved with `git stash pop`, and check status/diff. +5. Optional: Do the same but stash twice. Also check `git stash list`. + Can you pop the stashes in the opposite order? +6. Advanced: What happens if stashes conflict with other changes? Make + a change and stash it. Modify the same line or one right above or + below. Pop the stash back. Resolve the conflict. Note there is no + extra commit. +7. Advanced: what does `git graph` show when you have something + stashed? + +```{solution} +5: Yes you can. With `git stash pop INDEX` you can decie which stash +index to pop. + +6: In this case Git will ask us to resolve the conflict the same way +when resolving conflicts between two branches. + +7: It shows an additional commit hash with `refs/stash`. +``` +```` + + +## Option 2: Create branches + +You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch. + +You basically know how to do this: + +```console +$ git switch --create temporary # create a branch and switch to it +$ git add PATHS # stage changes +$ git commit # commit them +$ git switch main # back to main, continue your work there ... +$ git switch temporary # continue again on "temporary" where you left off +``` + +Later you can merge it to main or rebase it on top of main and resume work. + + +## Storing various junk you don't need but don't want to get rid of + +It happens often that you do something and don't need it, but you don't want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still. diff --git a/_sources/level.md.txt b/_sources/level.md.txt new file mode 100644 index 00000000..b191088c --- /dev/null +++ b/_sources/level.md.txt @@ -0,0 +1,120 @@ +# Practical advice: how much Git is necessary? + +:::{instructor-note} +- 20 min teaching/discussion +::: + + +## Writing useful commit messages + +Useful commit messages summarize the change and provide context. + +If you need a commit message that is longer than one line, +then the convention is: **one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary**. + +Good example: +```text +increase alpha to 2.0 for faster convergence + +the motivation for this change is +to enable ... +... +(more context) +... +this is based on a discussion in #123 +``` + +- **Why something was changed is more important than what has changed.** +- Cross-reference to issues and discussions if possible/relevant. +- Bad commit messages: "fix", "oops", "save work" +- Bad examples: [http://whatthecommit.com](http://whatthecommit.com) +- Write commit messages in English that will be understood + 15 years from now by someone else than you. Or by your future you. +- Many projects start out as projects "just for me" and end up to be successful projects + that are developed by 50 people over decades. +- [Commits with multiple authors](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) are possible. + +Good references: + +- ["My favourite Git commit"](https://fatbusinessman.com/2019/my-favourite-git-commit) +- ["On commit messages"](https://who-t.blogspot.com/2009/12/on-commit-messages.html) +- ["How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/) + +```{note} +A great way to learn how to write commit messages and to get inspired by their +style choices: **browse repositories of codes that you use/like**: + +Some examples (but there are so many good examples): +- [SciPy](https://github.com/scipy/scipy/commits/main) +- [NumPy](https://github.com/numpy/numpy/commits/main) +- [Pandas](https://github.com/pandas-dev/pandas/commits/main) +- [Julia](https://github.com/JuliaLang/julia/commits/master) +- [ggplot2](https://github.com/tidyverse/ggplot2/commits/main), + compare with their [release + notes](https://github.com/tidyverse/ggplot2/releases) +- [Flask](https://github.com/pallets/flask/commits/main), + compare with their [release + notes](https://github.com/pallets/flask/blob/main/CHANGES.rst) + +When designing commit message styles consider also these: +- How will you easily generate a changelog or release notes? +- During code review, you can help each other improving commit messages. +``` + +But remember: it is better to make any commit, than no commit. Especially in small projects. +**Let not the perfect be the enemy of the good enough**. + + +## What level of branching complexity is necessary for each project? + +**Simple personal projects**: +- Typically start with just the `main` branch. +- Use branches for unfinished/untested ideas. +- Use branches when you are not sure about a change. +- Use tags to mark important milestones. +- If you are unsure what to do with unfinished and not working code, commit it + to a branch. + +**Projects with few persons: you accept things breaking sometimes** +- It might be reasonable to commit to the `main` branch and feature branches. + +**Projects with few persons: changes are reviewed by others** +- You create new feature branches for changes. +- Changes are reviewed before they are merged to the `main` branch + (more about that in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/)). +- Consider to write-protect the `main` branch so that it can only be changed + with pull requests or merge requests. + + +## How about staging and committing? + +- Commit early and often: rather create too many commits than too few. + You can always combine commits later. +- Once you commit, it is very, very hard to really lose your code. +- Always fully commit (or stash) before you do dangerous things, so that you know you are safe. + Otherwise it can be hard to recover. +- Later you can start using the staging area (where you first stage and then commit in a second step). +- Later start using `git add -p` and/or `git commit -p`. + + +## How large should a commit be? + +- Better too small than too large (easier to combine than to split). +- Often I make a commit at the end of the day (this is a unit I would not like to lose). +- Smaller sized commits may be easier to review for others than huge commits. +- Imperfect commits are better than no commits. +- A commit should not contain unrelated changes to simplify review and possible + repair/adjustments/undo later (but again: imperfect commits are better than no commits). + +--- + +:::{keypoints} +- There is no one size fits all - start simple and grow your project. +::: + +:::{discussion} +How do you [plan to] use Git? + +- Advanced users or beginners, please provide your input in the online collaborative document. +::: diff --git a/_sources/local-workflow.md.txt b/_sources/local-workflow.md.txt new file mode 100644 index 00000000..1414d608 --- /dev/null +++ b/_sources/local-workflow.md.txt @@ -0,0 +1,371 @@ +# Cloning a Git repository and working locally + +If you've been following the main path, you have just had interacted +with repositories on GitHub. This might not be what you usually +do, so now we move to working on your own computer. + +:::{objectives} +- We are able to clone a repository from the web and modify it locally. +- We can do the same things we did before (commit, branch, merge), but locally. +- We get a feeling for remote repositories ([more later](https://coderefinery.github.io/git-collaborative/)). +::: + +:::{instructor-note} +- 10 min introduction and setup +- 25 min exercise +- 15 min discussion +::: + + +## What is in a Git repository and what are we cloning? + +**Git repository**: +- Contains all the files and directories of a project. +- Contains the complete history of all changes (commits) to these files and directories. +- Each commit is a snapshot of the entire project at a certain point in time and has a unique identifier ("hash"). +- Sometimes it contains multiple branches and tags. +- All the commits and history of a local repository are stored in a directory + called `.git` which is located at the root of the repository. + +**Cloning**: +- Copying (downloading) the entire repository with all commits, branches, and tags to your computer. +- It is a full backup of the repository, including all history. +- You can then work on your local clone of the repository. +- Changes on local clone will not automatically appear in the repository where + we cloned from. We have to actively "push" them there (we will practice this + in a later episode: {ref}`sharing-repositories`). + + +## Exercise + +Work on this by yourself or in your teams. Conceptually this episode should +seem familiar, from the browser-based exercises we did yesterday. + +We offer the **Command Line and VS Code** paths for this exercise. +GitHub isn't an option in this episode, since that is what we already +demonstrated in {doc}`commits` and {doc}`merging` and since the point of this +episode is to work **locally**. + +It is also possible to use the command line (terminal) from inside VS Code. + +```{exercise} Exercise: Cloning a Git repository and working locally (25 min) +1. {ref}`Configure Git command line and editor ` if you haven't done that already. +1. **Decide which repository you want to clone**: your fork or the original repository? Both will work for this exercise. + Then, **clone the recipe book**. +1. **Create a new branch**. +1. Make a **commit** on your new branch. +1. **Switch** back to the `main` branch and create one or two commits there. +1. **Merge** the new branch into `main`. +1. Compare the graph locally and on GitHub and observe that the **changes only exist locally on your computer**. +1. Where are the **remote branches**? Practice how you can see all remote branches + also locally and how you can fetch them and make local changes to them. +``` + +The solution below goes over most of the answer and should be used as +your guide (you can't figure it out just from the exercise instructions). + + +## Solution and walk-through + + +### (1) Configure Git command line and editor + +We have an own section for this: {ref}`configuration`. + + +### (2) Cloning a repository + +Now you need to decide which repository you want to clone. All of these options will work for this exercise +since we don't plan to push changes back (for step 8 it might be easier to use the original repository): +- Clone the recipe book from your fork. +- Or clone the recipe book from the original repository: +- Or first fork the original repository and then clone your fork. + +The examples below assume you are cloning the original repository. If you are cloning your fork, you should +replace `coderefinery` with your GitHub username. + +:::::::{tabs} +::::::{group-tab} Command line +If you are unsure whether you are using SSH or HTTPS, please read {ref}`clone-method`. + :::::{tabs} + ::::{group-tab} SSH + ```console + $ git clone git@github.com:coderefinery/recipe-book.git + ``` + :::: + + ::::{group-tab} HTTPS + ```console + $ git clone https://github.com/coderefinery/recipe-book.git + ``` + :::: + ::::: + +This creates a directory called "recipe-book" unless it already exists. You can also specify the target directory +on your computer (in this case "my-recipe-book"): + :::::{tabs} + ::::{group-tab} SSH + ```console + $ git clone git@github.com:coderefinery/recipe-book.git my-recipe-book + ``` + :::: + + ::::{group-tab} HTTPS + ```console + $ git clone https://github.com/coderefinery/recipe-book.git my-recipe-book + ``` + :::: + ::::: +:::::: + +::::::{group-tab} VS Code +Under "Start" on the screen, select "Clone Git Repository...". + +Alternatively navigate to the "Source Control" tab on the left sidebar and +click on the "Clone Repository" button. + +Paste in this URL: `https://github.com/USER/recipe-book` (replace `USER`) +:::::: +::::::: + + +### (3) Creating branches locally + +:::::{tabs} +::::{group-tab} Command line +Create a new branch called `another-recipe` from `main` and switch to it: +```console +$ git switch --create another-recipe main +``` + +If you leave out the last argument, it will create a branch from the current +branch: +```console +$ git switch --create another-recipe +``` +:::: + +::::{group-tab} VS Code +1. Make sure that you are on the main branch. +1. Source Control button on left sidebar → Three dots in upper right of source control → Branch → Create Branch. +1. VS Code automatically switches to the new branch. + +:::{figure} img/commits/vscode-create-branch.png +:width: 80% +:class: with-border +:alt: VS Code screenshot of create branch + +Creating a new branch in VS Code. +:::: +::::: + + +### (4) Creating commits locally + +:::::{tabs} +::::{group-tab} Command line +Create a new file. **After we have created it**, we can stage and commit +the change: +```console +$ git add new-file.md +$ git commit -m "Short summary of the change" +``` + +Make sure to replace "new-file.md" with the actual name of the file you created +and to replace "Short summary of the change" with a meaningful commit message. +:::: + +::::{group-tab} VS Code +1. Create a new file. +1. In the version control sidebar, click the `+` sign to add the file for the next commit. +1. Enter a brief message and click "Commit". + +:::{figure} img/commits/vscode-add-and-commit.png +:alt: Screenshot of VS Code commit process +:width: 80% +:class: with-border + +Committing a new file in VS Code. +::: +:::: +::::: + + +### (5) Switching branches and creating commits + +:::::{tabs} +::::{group-tab} Command line +First switch to the `main` branch: +```console +$ git switch main +``` + +Then modify a file. Finally `git add` and then commit the change: +```console +$ git commit -m "Short summary of the change" +``` +:::: + +::::{group-tab} VS Code +Use the branch selector at the bottom to switch back to the main branch. +Repeat the same steps as above. + +:::{figure} img/commits/vscode-change-branch.png +:class: with-border +:width: 80% +:alt: VS Code screenshot + +Switching branch via selector at bottom. +:::: +::::: + + +### (6) Merging branches locally + +:::::{tabs} +::::{group-tab} Command line +On the command line, when we merge, we always modify our current branch. + +If you are not sure anymore what your current branch is, type: +```console +$ git branch +``` + +Another way to find out where we are in Git: +```console +$ git status +``` + +In this case we merge the `another-recipe` branch into our current branch: +```console +$ git merge another-recipe +``` +:::: + +::::{group-tab} VS Code +Just like with the command line, when we merge we modify our *current* branch. Verify you are on the `main` branch. + +1. Verify current branch at the bottom. +1. From the version control sidebar → Three dots → Branch → Merge +1. In the selector that comes up, choose the branch you want to merge *from*. The commits on that branch will be added to the current branch. + +:::{figure} img/merging/vscode-merging.png +:alt: VSCode screenshot as described +:width: 80% +:class: with-border +:::: +::::: + + +### (7) How to compare the graph locally and on GitHub + +:::::{tabs} +::::{group-tab} Command line +```console +$ git log --graph --oneline --decorate --all +``` + +We recommend to define an {term}`alias` in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command: +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` +Then you can just type `git graph` from there on. We have an own section about +aliases: {ref}`aliases`. + +Compare this with the graph on GitHub: Insights tab → Network view (just like +we have done before). + +The result is that we should not be able to see the new branch and the new +commits on GitHub. +:::: + +::::{group-tab} VS Code +This requires an extension. Opening the VS Code terminal lets you use the command line method. + +:::{figure} img/commits/vscode-open-terminal.png +:class: with-border +:width: 80% +:alt: VS Code screenshot as described + +View → Terminal will open a terminal at bottom. This is a normal command line interface and very useful for work. (Note the git-aware prompt that shows the current branch. This requires other setup.) +:::: +::::: + + +### (8) Browsing remote branches and creating local branches from them + +:::::{tabs} +::::{group-tab} Command line +With `git branch` you can list all local branches: +```console +$ git branch + + another-recipe +* main +``` + +But where are the remote branches? We expect to see [a couple of +them](https://github.com/coderefinery/recipe-book/branches/all). + +We can see them by asking for all branches (your output might vary depending on +where you cloned from): +```console +$ git branch --all + + another-recipe +* main + remotes/origin/HEAD -> origin/main + remotes/origin/alex/fruit-salad + remotes/origin/main + remotes/origin/radovan/lasagna + remotes/origin/radovan/poke +``` + +You can create a local branch from a remote branch which will "track" the remote branch. +For instance, to create a local branch `alex/fruit-salad` from the remote branch `origin/alex/fruit-salad` +and switch to it, you can do: +```console +$ git switch --create alex/fruit-salad origin/alex/fruit-salad +``` + +This shortcut will do the same thing: +```console +$ git switch --track origin/alex/fruit-salad +``` + +Or even shorter: +```console +$ git switch alex/fruit-salad +``` + +If you want to create a branch and not switch to it, you can use `git branch`. +```console +$ git branch alex/fruit-salad +``` +:::: + +::::{group-tab} VS Code +To create a local branch from a remote branch: + +Source Control button on left sidebar → Three dots in upper right of source control → Branch → +"Create Branch From ...". + +Then select the remote branch you want to create a local branch from. +:::: +::::: + + +## Summary + +- When we clone a repository, we get a full backup of the repository, including + all history: all commits, branches, and tags. +- Yesterday we learned about branches and commits, and now we created and used them locally. +- **Creating local branches and commits does not automatically modify the remote + repository**. To "push" our local changes to the remote repository, we have to actively + "push" them there. We will practice this in a later episode: + {ref}`sharing-repositories` +- Remote branches and local branches are not the same thing. If we want to + create local commits, we always need to create a local branch first. But the local branch can + "track" the remote branch and we can push and pull changes to and from the + remote branch. diff --git a/_sources/merging.md.txt b/_sources/merging.md.txt new file mode 100644 index 00000000..8bfba557 --- /dev/null +++ b/_sources/merging.md.txt @@ -0,0 +1,435 @@ +# Merging changes and contributing to the project + +Git allows us to have different development lines where we can try things out. +It also allows different people to work on the same project at the same. This +means that we have to somehow combine the changes later. In this part we will +practice this: {term}`merging`. + +:::{objectives} +- Understand that on GitHub merging is done through a {term}`pull request`. Think of it as a change proposal. +- Create and merge a pull request within your own repository. +- Understand (and optionally) do the same across repositories, to contribute to + the {term}`upstream` public repository. +::: + +:::{instructor-note} +- 10 min introduction and setup +- 25 min exercise +- 15 min discussion +::: + + +## Background + +* In the last episode, we added a new recipe on a branch. This allows + us to test it before it becomes "live". +* Now, we want to bring that change into the "main" branch. +* We will find it's not that hard! But you do have to keep track of the + steps and make sure that you work very precisely. + + +## Exercise + +In this exercise, we will show how we can **propose changes** and **merge +changes** within our own repository. Optionally, you can propose a recipe to +the {term}`upstream` recipe book - which shows the true purpose of this. But +this is only a preview and we will practice collaboration much more in the +[collaborative Git lesson](https://coderefinery.github.io/git-collaborative/). + +We offer **three different paths** of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the **GitHub +path** only and recommend you do that. The exercise text below has +some GitHub-specific notes, but most is possibly with any path. + +:::::{tabs} +::::{group-tab} GitHub + +First, we make something called a {term}`pull request`, which allows +review and commenting before the actual merge. + +:::{exercise} Exercise: Merging branches with pull requests (20 min) +We assume that in the previous exercise you have created a new branch +with a recipe. In our previous example, it is called `new-recipe`. +If not, create it first and add a recipe to your new branch, see +{doc}`commits`. + +We provide basic hints. You should refer to the solution as needed. + +1. Navigate to your branch from the previous episode + (Hint: the same branch view we used last time). + +1. Begin the pull request process. + (Hint: There is a "Contribute" button in the branch view). + +1. Add or modify the pull request title and description, and verify the other data. + In the pull request verify the target repository and the target + branch. Make sure that you are merging within your own repository. + **GitHub: By default, it will offer to make the change to the + upstream repository, `coderefinery`. You should change this**, you + shouldn't contribute your test recipe upstream yet. Where it says + `base repository`, select your own user's repository. + +1. Create the pull request by clicking "Create pull request". Browse + the network view to see if anything has changed yet. + +1. Merge the pull request, or if you are not on GitHub you can merge + the branch locally. Browse the network again. What has changed? + +1. Find out which branches are merged and thus safe to delete. Then remove them + and verify that the commits are still there, only the branch labels are + gone. (Hint: you can delete branches that have been merged into `main`). + +1. Optional: Try to create a new branch with a new change, then open a pull + request but towards the central repository. We will later merge few of + those. + (Hint: this is mostly the same as above, for the GitHub path. But, + you set the base repository as CodeRefinery. You might need to + compare across forks.) +::: +:::: + +::::{group-tab} Local (VS Code, Command line) + +When working locally, it's easier to merge branches: we can just do +the merge, without making a pull request. But we don't have that step +of review and commenting and possibly adjusting. + +:::{exercise} + +1. Switch to the `main` branch that you want to merge the *other* + branch into. (Note that this is the other way around from the + GitHub path). + +Then: + +5. Merge the other branch into `main` (which is then your current branch). + +6. Find out which branches are merged and thus safe to delete. Then remove them + and verify that the commits are still there, only the branch labels are + gone. (Hint: you can delete branches that have been merged into `main`). + +7. (optional, advanced) Try to create a new branch, and make a + GitHub pull request with your recipe, and contribute it to our + upstream repository. *This is very complex right now since your + change has to get to GitHub, and we haven't shown that yet. We + don't give a solution for this.* +::: + +:::: +::::: + +The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren't enough - this is by design. + + +## Solution and walk-through + +### (1) Navigate to your branch + +Before making the pull request, or doing a merge, it's important to +make sure that you are on the right branch. Many people have been +frustrated because they forgot this! + +:::::{tabs} +::::{group-tab} GitHub +On GitHub make sure you are on the branch you want to merge **from**: + :::{figure} img/merging/github-navigate-to-branch.png + :alt: Screenshot on GitHub where we navigate to the branch we wish to merge. + :width: 80% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +Remember, you need to switch to the `main` branch, the branch we want to merge **to**. +This is different from the GitHub path. +:::: + +::::{group-tab} Command line +Remember, you need to switch to the `main` branch, the branch we want to merge **to**. +This is different from the GitHub path: +```console +$ git switch main +``` +:::: +::::: + + +### (2) Begin the pull request process + +In GitHub, the pull request is the way we propose to merge two +branches together. We start the process of making one. + +:::::{tabs} +::::{group-tab} GitHub + :::{figure} img/merging/github-contribute.png + :alt: Screenshot on GitHub where we get to the pull request process. + :width: 80% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +It is possible to open pull requests from the editor, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: + +::::{group-tab} Command line +It is possible to open pull requests from the command line, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: +::::: + + +### (3) Fill out and verify the pull request + +Check that the pull request is directed to the right repository and branch +and that it contains the changes that you meant to merge. + +:::::{tabs} +::::{group-tab} GitHub +Things to check: +- Base repository: this should be your own +- Title: make it descriptive +- Description: make it informative +- Scroll down to see commits: are these the ones you want to merge? +- Scroll down to see the changes: are these the ones you want to merge? + :::{figure} img/merging/github-comparing-changes.png + :alt: Screenshot on GitHub where we verify the changes we want to merge. + :width: 80% + :class: with-border + + This screenshot only shows the top part. If you scroll down, you + can see the commits and the changes. We recommend to do this before + clicking on "Create pull request". + ::: +:::: + +::::{group-tab} VS Code +If you are working locally, continue to step 5. +:::: + +::::{group-tab} Command line +If you are working locally, continue to step 5. +:::: +::::: + + +### (4) Create the pull request + +We actually create the pull request. Don't forget to navigate to the Network +view after opening the pull request. Note that the changes proposed in the +pull request are not yet merged. + +:::::{tabs} +::::{group-tab} GitHub +Click on the green button "Create pull request". + +If you click on the little arrow next to "Create pull request", you can also +see the option to "Create draft pull request". This will be interesting later +when collaborating with others. It allows you to open a pull request that is +not ready to be merged yet, but you want to show it to others and get feedback. +:::: + +::::{group-tab} VS Code +It is possible to create pull requests from the editor, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: + +::::{group-tab} Command line +It is possible to create pull requests from the command line, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: +::::: + + +### (5) Merge the pull request + +Now, we do the actual merging. We see some effects now. + +:::::{tabs} +::::{group-tab} GitHub +Review it again (commits and changes), and then click "Merge pull request". + +After merging, verify the network view. Also navigate then to your "main" +branch and check that your new recipe is there. +:::: + +::::{group-tab} VS Code +Just like with the command line, when we merge we modify our *current* branch. Verify you are on the `main` branch. + +1. Verify current branch at the bottom. +1. From the version control sidebar → Three dots → Branch → Merge +1. In the selector that comes up, choose the branch you want to merge *from*. The commits on that branch will be added to the current branch. + +:::{figure} img/merging/vscode-merging.png +:alt: VSCode screenshot as described +:width: 80% +:class: with-border +:::: + +::::{group-tab} Command line +On the command line, when we merge, we always modify our *current* branch. + +If you are not sure anymore what your current branch is, type: +```console +$ git branch +``` +... or equally useful to see where we are right now: +```console +$ git status +``` + +In this case we merge the `new-recipe` branch into our current branch: +```console +$ git merge new-recipe +``` +:::: +::::: + + +### (6) Delete merged branches + +Before deleting branches, first check whether they are merged. + +If you delete an un-merged branch, it will be difficult to find the commits +that were on that branch. If you delete a merged branch, the commits are now +also part of the branch where we have merged to. + +:::::{tabs} +::::{group-tab} GitHub +One way to delete the branch is to click on the "Delete branch" button after the pull +request is merged: + :::{figure} img/merging/github-merged.png + :alt: Screenshot on GitHub suggesting us to delete a branch after it has been merged. + :width: 80% + :class: with-border + ::: + +But what if we forgot? Then navigate to the branch view: + :::{figure} img/merging/github-branches.png + :alt: Screenshot on GitHub where we navigate to the branches view. + :width: 80% + :class: with-border + ::: + +In the overview we can see that it has been merged and we can delete it: + :::{figure} img/merging/github-branches-overview.png + :alt: Screenshot on GitHub where we see an overview of branches and can delete them. + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +From the Source Control sidebar → the three dots (as before) → Branch → Delete Branch. Select the branch name to delete. +:::: + +::::{group-tab} Command line +Verify which branches are merged to the current branch: +```console +$ git branch --merged + +* main + new-recipe +``` + +This means that it is safe to delete the `new-recipe` branch: +```console +$ git branch -d new-recipe +``` + +Verify then that the branch is gone but that the commits are still there: +```console +$ git branch +$ git log --oneline +``` +:::: +::::: + + +### (7) Contribute to the original repository with a pull request + +Remember, this is an advanced step. If you do this, you are donating +a recipe to everyone. + +:::::{tabs} +::::{group-tab} GitHub +Now that you know how to create branches and opening a pull request, try to +open a new pull request with a new change but this time the base repository +should be the upstream one. + +In other words, you now send a pull request across repositories: from your fork +to the original repository. + +Another thing that is different now is that you might not have permissions to +merge the pull request. We can then together review and browse the pull +request. +:::: + +::::{group-tab} VS Code +Not described. We will return to this in the [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/). + +You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `coderefinery/recipe-book`. Or you do it all through VS Code. +:::: + +::::{group-tab} Command line +Not described. We will return to this in the [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/). + +You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `coderefinery/recipe-book`. + +:::: +::::: + + +## Resolving a conflict (demonstration) + +A conflict is when Git asks humans to decide during a merge which of two +changes to keep if the same portion of a file has been changed in two different +ways on two different branches. + +We will practice conflict resolution in the [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/). + +Here we will only demonstrate how to create a conflict and how to resolve it, +all on GitHub. Once we understand how this works, we will be more confident to +resolve conflicts also in the command line. + +How to create a conflict (please try this in your own time *and just watch now*): +- Create a new branch from `main` and on it make a change to a file. +- On `main`, make a different change to the same part of the same file. +- Now try to merge the new branch to `main`. You will get a conflict. + +How to resolve conflicts: +- On GitHub, you can resolve conflicts by clicking on the "Resolve conflicts" + button. This will open a text editor where you can choose which changes to + keep. + Make sure to remove the conflict markers. + After resolving the conflict, you can commit the changes and merge the + pull request. +- Sometimes a conflict is between your change and somebody else's change. In + that case, you might have to discuss with the other person which changes to + keep. + +How to avoid conflicts: +- We will talk about it in the [collaborative Git + lesson](https://coderefinery.github.io/git-collaborative/). + + +## Summary + +- We learned how to merge two branches together. +- When is this useful? This is not only useful to combine development lines in + your own work. Being able to merge branches also forms a basis for collaboration. +- Branches which are merged to other branches are safe to delete, since we only + delete the "sticky note" next to a commit, not the commits themselves. diff --git a/_sources/motivation.md.txt b/_sources/motivation.md.txt new file mode 100644 index 00000000..60c0e11c --- /dev/null +++ b/_sources/motivation.md.txt @@ -0,0 +1,184 @@ +# Motivation + +```{objectives} +- Make sure nobody leaves the workshop without starting to use some form of version control. +- Discuss the reasons why we advocate distributed version control. +``` + +```{instructor-note} +- 15 min discussion/demonstration +``` + + +## Git is all about keeping track of changes + +We will learn how to keep track of changes first in the web browser. +Below are screenshots of **tracked changes with Git** +(from this [example repository](https://github.com/bast/runtest/commits/main/runtest/run.py)): +```{figure} img/git-log-github.png +:alt: Screenshot of a git log on GitHub +:width: 80% +:class: with-border + +Web browser, GitHub view +``` +Later also using the terminal or the editor +(the same [example repository](https://github.com/bast/runtest/commits/main/runtest/run.py)): +```{figure} img/git-log-terminal.png +:alt: Screenshot of a git log in terminal +:width: 80% + +The same as above, but the terminal view +``` + + +## Why do we need to keep track of versions? + +**Problem: If you have to identify and find your code from 17 days +ago, can you?** + +Version control is an answer to the following questions (do you recognize some +of them?): + +- "It broke ... hopefully I have a working version somewhere?" + +- "Can you please send me the latest version?" + +- "Where is the latest version?" + +- "Which version are you using?" + +- "Which version have the authors used in the paper I am trying to reproduce?" + +- "Found a bug! Since when was it there?" + +- "I am sure it used to work. When did it change?" + +- "My laptop is gone. Is my thesis now gone?" + + +## Features: roll-back, branching, merging, collaboration + +**Problem: Your code worked two days ago, but is giving an error now. +You don't know what you changed.** + +**Problem: You and your colleague want to work on the same code at the +same time.** + + +- **Roll-back**: you can always go back to a previous version and compare + +- **Branching and merging**: + - Work on different ideas at the same time + - Different people can work on the same code/project without interfering + - You can experiment with an idea and discard it if it turns out to be a bad idea + +```{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +``` + +- **Collaboration**: review, compare, share, discuss + +- [Example network graph](https://github.com/coderefinery/git-intro/network) + + +## Reproducibility + +**Problem: Someone asks you about your results from 5 years ago. Can +you get the same results now?** + +- How do you indicate which version of your code you have used in your paper? +- When you find a bug, how do you know **when precisely** this bug was introduced + (Are published results affected? Do you need to inform collaborators or users of your code?). + +With version control we can "annotate" code +([browse this example online](https://github.com/networkx/networkx/blame/main/networkx/algorithms/boundary.py)): + +```{figure} img/git-annotate.png +:alt: Example of a git-annotated code with code and history side-by-side +:width: 100% +:class: with-border + +Example of a git-annotated code with code and history side-by-side. +``` + + +## Talking about code + +**Problem: You want to show someone a few lines from one of your projects.** + +Which of these two is more practical? +- "Clone the code, go to the file 'src/util.rs', and search for 'time_iso8601'". + Oh! But make sure you use the version from August 2023." +- Or I can send you a [permalink](https://github.com/NordicHPC/sonar/blob/75daafc86582feb06299d6a47c82112f39888152/src/util.rs#L40-L44): + +```{figure} img/code-portion.png +:alt: Screen-shot of a code portion +:width: 100% +:class: with-border + +Permalink that points to a code portion. +``` + + +## What we typically like to snapshot + +- Software (this is how it started but Git/GitHub can track a lot more) +- Scripts +- Documents (plain text files much better suitable than Word documents) +- Manuscripts (Git is great for collaborating/sharing LaTeX or [Quarto](https://quarto.org/) manuscripts) +- Configuration files +- Website sources +- Data + +````{discussion} + In this example somebody tried to keep track of versions without a version + control system tool like Git. Discuss the following directory listing. What + possible problems do you anticipate with this kind of "version control": + ```shell + myproject-2019.zip + myproject-2020-February.zip + myproject-2021-August.zip + myproject-2023-09-19-working.zip + myproject-2023-09-21.zip + myproject-2023-09-21-test.zip + myproject-2023-09-21-myversion.zip + myproject-2023-09-21-newfeature.zip + ... + ``` + + ```{solution} + - Giving a version to a collaborator and merging changes later with own + changes sounds like lots of work. + - What if you discover a bug and want to know since when the bug existed? + ``` +```` + + +## Difficulties of version control + +Despite the benefits, let's be honest, there are some difficulties: + +- One more thing to learn (it's probably worth it and will save you more time in the long run; basic career skill). +- Difficult if your collaborators don't want to use it (in the worst case, you can version control on your side and email them versions). +- Advanced things can be difficult, but basics are often enough (ask others for help when needed). + + +## Why Git and not another tool? + +- **Easy to set up**: no server needed. +- **Very popular**: chances are high you will need to contribute to somebody else's code which is tracked with Git. +- **Distributed**: good backup, no single point of failure, you can track and + clean-up changes offline, simplifies collaboration model for open-source + projects. +- Important **platforms** such as [GitHub](https://github.com), [GitLab](https://gitlab.com), and [Bitbucket](https://bitbucket.org) + build on top of Git. + +However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +[Subversion](https://subversion.apache.org), +[Mercurial](https://www.mercurial-scm.org), [Pijul](https://pijul.org/), or others. diff --git a/_sources/recovering.md.txt b/_sources/recovering.md.txt new file mode 100644 index 00000000..3c705f3e --- /dev/null +++ b/_sources/recovering.md.txt @@ -0,0 +1,260 @@ +# Undoing and recovering + +```{objectives} +- Learn to undo changes safely +- See when undone changes are permanently deleted and when they can be retrieved +``` + +```{instructor-note} +- 25 min teaching/type-along +- 25 min exercise +``` + +One of the main points of version control is that you can *go back in +time to recover*. Unlike this xkcd comic implies: + +In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn't a "commit" permanent? + +- You can modify old commit history. +- But if you have shared that history already, *modifying it can make + a huge mess*. + +```{admonition} It is almost always possible to recover +As long as you commit something once (or at least `git add` it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru... *until that guru becomes you*. +``` + +```{admonition} Nice resource to visually simulate Git operation +[git-sim](https://github.com/initialcommit-com/git-sim#video-animation-examples) +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command. +``` + +--- + +## Undoing your recent, uncommitted and unstaged changes (preserves history) + +```{note} +In case `git restore` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git restore`. +``` + +You do some work, and want to **undo your uncommitted and unstaged modifications**. +You can always do that with: + +- `git restore .` (the dot means "here and in all folders below") + +You can also undo things selectively: + +- `git restore -p` (decide which portions of changes to undo) or `git restore PATH` (decide which path/file) + +If you have staged changes, you have at least two options to undo the staging: +- `git restore --staged .` followed by `git status` and `git restore .` +- `git reset --hard HEAD` throws away everything that is not in last + commit (`HEAD` - this literal word, this isn't a placeholder) + +--- + +## Reverting commits (preserves history) + +Imagine we made a few commits. +We realize that the latest commit `e02efcd` was a mistake and we wish to undo it: +```console +$ git log --oneline + +e02efcd (HEAD -> main) not sure this is a good idea +b4af65b improve the documentation +e7cf023 don't forget to enjoy +79161b6 add half an onion +a3394e3 adding README +3696246 adding instructions +f146d25 adding ingredients +``` + +A safe way to undo the commit is to revert the commit with `git revert`: +```console +$ git revert e02efcd +``` + +This creates a **new commit** that does the opposite of the reverted commit. +The old commit remains in the history: +```console +$ git log --oneline + +d3fc63a (HEAD -> main) Revert "not sure this is a good idea" +e02efcd not sure this is a good idea +b4af65b improve the documentation +e7cf023 don't forget to enjoy +79161b6 add half an onion +a3394e3 adding README +3696246 adding instructions +f146d25 adding ingredients +``` + +You can revert any commit, no matter how old it is. It doesn't affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we'll learn about later). + +(exercise-revert)= + +### Exercise: Revert a commit + +```{exercise} Undoing-1: Revert a commit +- Create a commit (commit A). +- Revert the commit with `git revert` (commit B). +- Inspect the history with `git log --oneline`. +- Now try `git show` on both the reverted (commit A) and the newly created commit (commit B). +``` + + +## Adding to the previous commit (modifies history) + +Sometimes we commit but realize we forgot something. +We can amend to the last commit: + +```console +$ git commit --amend +``` + +This can also be used to modify the last commit message. + +Note that this **will change the commit hash**. This command **modifies the history**. +This means that we avoid this command on commits that we have shared with others. + +(exercise-amend)= + +### Exercise: Modify a previous commit + +````{exercise} Undoing-2: Modify a previous commit +1. Make an incomplete change to the recipe or a typo in your change, `git + add` and `git commit` the incomplete/unsatisfactory change. +2. Inspect the unsatisfactory but committed change with `git show`. Remember + or write down the commit hash. +3. Now complete/fix the change but instead of creating a new commit, add the + correction to the previous commit with `git add`, followed by `git commit + --amend`. What changed? + + ```{solution} + One thing that has changed now is the commit hash. Modifying the previous + commit has changed the history. This is OK to do on commits that other people + don't depend on yet. + ``` +```` + + +## Rewinding branches (modifies history) + +You can **reset branch history** to move your branch back to some +point in the past. + +* `git reset --hard HASH` will force a branch label to any other point. All + other changes are lost (but it is possible to recover if you force reset by mistake). +* Be careful if you do this - it can mess stuff up. Use `git graph` a + lot before and after. + + +(exercise-reset)= + +### Exercise: Git reset + +````{exercise} Undoing-3: Destroy our experimentation in this episode + After we have experimented with reverts and amending, let us destroy + all of that and get our repositories to a similar state. + + - First, we will look at our history (`git log`/`git graph`) and + find the last commit `HASH` before our tests. + - Then, we will `git reset --hard HASH` to that. + - Then, `git graph` again to see what happened. + + ```console + $ git log --oneline + + d3fc63a (HEAD -> main) Revert "not sure this is a good idea" + e02efcd not sure this is a good idea + b4af65b improve the documentation + e7cf023 don't forget to enjoy + 79161b6 add half an onion + a3394e3 adding README + 3696246 adding instructions + f146d25 adding ingredients + + $ git reset --hard b4af65b + + HEAD is now at b4af65b improve the documentation + + $ git log --oneline + + b4af65b (HEAD -> main) improve the documentation + e7cf023 don't forget to enjoy + 79161b6 add half an onion + a3394e3 adding README + 3696246 adding instructions + f146d25 adding ingredients + ``` +```` + +--- + +## Recovering from committing to the wrong branch + +It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes. + +Here we assume that we made a couple of commits but we realize they went to the +wrong branch. + +**Solution 1 using git cherry-pick**: +1. Make sure that the correct branch exists and if not, create it. Make sure to + create it from the commit hash where you wish you had created it from: `git + branch BRANCHNAME HASH` +2. Switch to the correct branch. +3. `git cherry-pick HASH` can be used to take a specific commit to the + current branch. Cherry-pick all commits that should have gone to the correct + branch, **from oldest to most recent**. +4. Rewind the branch that accidentally got wrong commits with `git reset --hard` (see also above). + +**Solution 2 using `git reset --hard`** (makes sense if the correct branch should +contain all commits of the accidentally modified branch): +1. Create the correct branch, pointing at the latest commit: `git branch BRANCHNAME`. +2. Check with `git log` or `git graph` that both branches point to the same, latest, commit. +3. Rewind the branch that accidentally got wrong commits with `git reset --hard` (see also above). + + +## Recovering from merging/pulling into the wrong branch + +`git merge`, `git rebase`, and `git pull` modify the **current** branch, never +the other branch. But sometimes we run this command on the wrong branch. + +1. Check with `git log` the commit hash that you would like to rewind the + wrongly modified branch to. +2. Rewind the branch that accidentally got wrong commits with `git reset --hard HASH` (see also above). + + +## Recovering from conflict after pulling changes + +Pulling changes with +`git pull` can create a conflict since `git pull` always also includes a `git merge` (more about this +in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/)). + +The recovery is same as described in {ref}`conflict-resolution`. Either +resolve conflicts or abort the merge with `git merge --abort`. + +--- + +````{challenge} Undoing-4: Test your understanding + 1. What happens if you accidentally remove a tracked file with `git rm`, is it gone forever? + 2. Is it OK to modify commits that nobody has seen yet? + 3. What situations would justify to modify the Git history and possibly remove commits? + + ```{solution} + 1. It is not gone forever since `git rm` creates a new commit. You can revert the commit to get the file back. + 2. If you haven't shared your commits with anyone it can be alright to modify them. + 3. If you have shared your commits with others (e.g. pushed them to GitHub), only extraordinary + conditions would justify modifying history. For example to remove sensitive or secret information. + ``` +```` diff --git a/_sources/reference.md.txt b/_sources/reference.md.txt new file mode 100644 index 00000000..80a5cce8 --- /dev/null +++ b/_sources/reference.md.txt @@ -0,0 +1,158 @@ +# Quick reference + +## Other cheatsheets + +* [Detailed 2-page Git + cheatsheet](https://aaltoscicomp.github.io/cheatsheets/git-the-way-you-need-it-cheatsheet.pdf) +* [Interactive Git cheatsheet](http://www.ndpsoftware.com/git-cheatsheet.html) + + +## Glossary + +:::::{glossary} + +alias + With aliases you can define your own shortcuts for Git commands. + +version control system + A system that records changes to a file or set of files over time so that + you can recall specific versions later. + +git + Implementation of a version control system. Currently the most popular one. + +commit + As a verb, the process of recording more changes. + As a noun, the name of the record of changes. + A commit is identified by something such as `554c187`. + +working directory +workspace + the actual files you see and edit + +staging area + Place files go after `git add` and before `git commit` + +hash + Unique reference of any commit or state. Comes from [hash + functions](https://en.wikipedia.org/wiki/Hash_function) such as MD5 + or SHA1. + +branch + One line of work. Different branches can exist at the same time + and split/merge. Committing on a branch updates that branch. + +tag + Like a {term}`branch` in that it points to a commit for reference. + It is designed to be permanent an not updated. + +HEAD + Pointer to the most recent commit on the current branch. + +remote + Roughly, another server that holds .git. + +origin + Default name for a remote repository. + +repository + One collection of files managed by Git. It contains entire history + of all files managed by git. GitHub has one repository as one + GitHub repository. VS Code has one repository as one directory you + can open. The command line has one repository as one directory. + +clone + As a verb, the process of making a copy of a repository locally. + It brings in all history and all files. (As a noun, the copy that + was made when cloning). + +GitHub repository + The files from the Git repository, but also other things from + GitHub such as access permissions, issues, and pull requests. + +upstream + The original repository from which the code comes. If you + {term}`fork` the repository, it is your upstream and it is easy to + send changes back to there. + +fork + As a noun: a one person's copy of a repository. + As a verb: making that copy. + As a verb on GitHub: Making a copy of a repository linked to the + original. It is easy to send changes to the original + +issue + Within a web repository like GitHub, discussion of a topic, for + example a problem or improvement suggestion. These are a property + of the web platform and not of the Git program itself. + +pull request + A GitHub concept: change proposal. A proposal to merge one branch + into another. Usually used to contribute code back to + {term}`upstream`. + +push + Moving changes from your local copy to another copy + +pull + Getting changes from another copy to your own copy. `git pull` + does this fetch, and also tries to automatically merge. + +master + Default name for main branch on Git. Depending on the configuration and service, + the default branch is sometimes **main**. + In this lesson we configure Git so that the default branch is + called **main** to be more consistent with GitHub and GitLab. + +main + Default name for main branch on GitLab and GitHub. + In this lesson we configure Git so that the default branch is + called **main** to be more consistent with GitHub and GitLab. + +merge +merging + Bringing changes from one branch into another, either as a noun or + verb. + +VS Code + A text editor and development environment by Microsoft. It's quite + popular, partly because it is powerful and easy to use. [VS + Codium](https://vscodium.com/) is the same but without Microsoft + tracking. +::::: + +## Commands we use + +Setup: + +* `git config`: edit configuration options +* `git init -b main`: create new repository with `main` as the default branch + +See our status: + +* `git status`: see status of files - use often! +* `git log`: see history of commits and their messages, newest first +* `git graph`: see a detailed graph of commits. Create this command + with `git config --global alias.graph "log --all --graph --decorate --oneline"` +* `git diff`: show difference between working directory and last commit +* `git diff --staged`: show difference between staging area and last commit +* `git show COMMIT`: inspect individual commits + +General work: + +* `git add FILE`: + - Add a new file + - Add a file to staging +* `git commit`: record a version, add it to current branch +* `git commit --amend`: amend our last commit +* `git branch`: show which branch we're on +* `git branch NAME`: create a new branch called "name" +* `git restore FILE`: restore last committed/staged version of FILE, losing unstaged changes +* `git switch --create BRANCH-NAME`: create a new branch and switch to it +* `git revert HASH`: create a new commit which reverts commit HASH +* `git reset --soft HASH`: remove all commits after HASH, but keep their modifications as staged changes +* `git reset --hard HASH`: remove all commits after HASH, permanently throwing away their changes +* `git merge BRANCH-NAME`: merge branch BRANCH-NAME into current branch +* `git grep PATTERN`: search for patterns in tracked files +* `git annotate FILE`: find out when a specific line got introduced and by whom +* `git bisect`: find a commit which broke some functionality diff --git a/_sources/resources.md.txt b/_sources/resources.md.txt new file mode 100644 index 00000000..564f5247 --- /dev/null +++ b/_sources/resources.md.txt @@ -0,0 +1,11 @@ +# Other resources + +- [Learn Git branching](http://pcottle.github.io/learnGitBranching/) +- [The entire Pro Git book, written by Scott Chacon and Ben Straub](http://git-scm.com/book) +- [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/) +- [Commit Often, Perfect Later, Publish Once: Git Best Practices](http://sethrobertson.github.io/GitBestPractices/) +- [PeepCode Git Internals](https://github.com/pluralsight/git-internals-pdf/releases) +- [Git Workflows for Pros: A Good Git Guide](https://www.toptal.com/git/git-workflows-for-pros-a-good-git-guide) +- [Branch-per-Feature](http://dymitruk.com/blog/2012/02/05/branch-per-feature/) +- [Git on XKCD](http://xkcd.com/1597/) +- [An efficient GIT workflow for mid/long term projects](http://fle.github.io/an-efficient-git-workflow-for-midlong-term-projects.html) diff --git a/_sources/sharing.md.txt b/_sources/sharing.md.txt new file mode 100644 index 00000000..661e96d7 --- /dev/null +++ b/_sources/sharing.md.txt @@ -0,0 +1,300 @@ +(sharing-repositories)= + +# How to turn your project to a Git repo and share it + +:::{objectives} +- Turn our own coding project (small or large, finished or unfinished) into a + Git repository. +- Be able to share a repository on the web to have a backup or so that others + can reuse and collaborate or even just find it. +::: + +:::{instructor-note} +- 10 min introduction and setup +- 25 min exercise +- 15 min discussion +::: + + +## Exercise + +:::::{exercise} Exercise: Turn your project to a Git repo and share it (25 min) + +1. Create a new directory called **myproject** with one or few files in it. + This represents our own project. It is not yet a Git repository. You can try + that with your own project or use a simple placeholder example. +2. Turn this new directory into a Git repository. +3. Share this repository on GitHub (or GitLab, since it really works the same). + +We offer **three different paths** of how to do this exercise. +* Via **GitHub web interface**: easy and can be a good starting point if you are completely + new to Git. +* **VS Code** is quite easy, since VS Code can offer to create the + GitHub repositories for you. +* **Command line**: you need to create the + repository on GitHub and link it yourself. + +::::{tabs} + +:::{group-tab} Only using GitHub +### Create an repository on GitHub + +First log into GitHub, then follow the screenshots and descriptions below. +```{figure} img/sharing/new-repository.png +:alt: Screenshot on GitHub before a new repository form is opened +:width: 60% +:class: with-border + +Click on the "plus" symbol on top right, then on "New repository". +``` + +Then: +```{figure} img/sharing/create-repository-with-readme.png +:alt: Screenshot on GitHub just before a new repository is created +:width: 100% +:class: with-border + +Choose a repository name, add a short description, and in this case **make sure to check** "Add a +README file". Finally "Create repository". +``` + + +### Upload your files + +Now that the repository is created, you can upload your files: +```{figure} img/sharing/upload-files.png +:alt: Screenshot on GitHub just before uploading files +:width: 100% +:class: with-border + +Click on the "+" symbol and then on "Upload files". +``` +::: + +:::{group-tab} VS Code +In VS Code it only takes few clicks. + +First, open the folder in VS Code. My example project here contains two files. +Then click on the source control icon: +```{figure} img/sharing/vscode-start.png +:alt: Screenshot of VS Code before clicking on the source control icon +:width: 100% +:class: with-border + +Open the folder in VS Code. Then click on the source control icon. +``` + +```{figure} img/sharing/vscode-publish-to-github1.png +:alt: Screenshot of VS Code before publishing to GitHub +:width: 100% +:class: with-border + +Choose "Publish to GitHub". In this case I never even clicked on "Initialize Repository". +``` + +```{figure} img/sharing/vscode-publish-to-github2.png +:alt: Screenshot of VS Code before publishing to GitHub +:width: 100% +:class: with-border + +In my case I chose to "Publish to GitHub public repository". Here you can also rename +the repository if needed. +``` + +```{figure} img/sharing/vscode-authorize.png +:alt: Screenshot of VS Code asking for authorization +:width: 50% +:class: with-border + +First time you do this you might need to authorize VS Code to access your +GitHub account by redirecting you to https://github.com/login/oauth/authorize. +``` + +```{figure} img/sharing/vscode-publish-to-github3.png +:alt: Screenshot of VS Code after publishing to GitHub +:width: 100% +:class: with-border + +After it is published, click on "Open on GitHub". +``` +::: + +:::{group-tab} Command line +### Make sure your Git is configured + +We have an own section on this: {ref}`configuration`. + + +### Put your project under version control + +My example project here consists of two files. Replace this with your own +example files: +```console +$ ls -l + +.rw------- 19k user 7 Mar 17:36 LICENSE +.rw------- 21 user 7 Mar 17:36 myscript.py +``` + +I will first initialize a Git repository in this directory. +If you get an error, try without the `-b main` (and your default branch will +then be called `master`, this will happen for Git versions older than +2.28): +```console +$ git init -b main +``` + +Now add and commit the two files to the Git repository: +```console +$ git add LICENSE myscript.py +$ git commit -m "putting my project under version control" +``` + +If you want to add all files in one go, you can use `git +add .` instead of `git add LICENSE myscript.py`. + +Now you have a Git repository with one commit. Verify this with `git log`. +But it's still only on your computer. Let's put it on GitHub next. + + +### Create an empty repository on GitHub + +First log into GitHub, then follow the screenshots and descriptions below. +```{figure} img/sharing/new-repository.png +:alt: Screenshot on GitHub before a new repository form is opened +:width: 60% +:class: with-border + +Click on the "plus" symbol on top right, then on "New repository". +``` + +Then create an empty repository without any files and without any commits: +```{figure} img/sharing/create-repository.png +:alt: Screenshot on GitHub just before a new repository is created +:width: 100% +:class: with-border + +Choose a repository name, add a short description, but please **do not check** "Add a +README file". For "Add .gitignore" and "Choose a license" also leave as "None". Finally "Create repository". +``` + +Once you click the green "Create repository", you will see a page similar to: +```{figure} img/sharing/bare-repository.png +:alt: Screenshot on GitHub after a bare repository was created +:width: 100% +:class: with-border +``` + +What this means is that we have now an empty project with either an HTTPS or an +SSH address: click on the HTTPS and SSH buttons to see what happens. + + +### Push an existing repository from your computer to GitHub + +We now want to follow the "**... or push an existing repository from the command line**": + +1. In your terminal make sure you are still in your myproject directory. +2. Copy paste the three lines below the red arrow to the terminal and execute + those, in my case (**you need to replace the "USER" part and possibly also + the repository name**): + +`````{tabs} + ````{group-tab} SSH + ```console + $ git remote add origin git@github.com:USER/myproject.git + ``` + ```` + ````{group-tab} HTTPS + ```console + $ git remote add origin https://github.com/USER/myproject.git + ``` + ```` +````` + +Then: +```console +$ git branch -M main +$ git push -u origin main +``` + +The meaning of the above lines: +- Add a remote reference with the name "origin" +- Rename current branch to "main" +- Push branch "main" to "origin" + +You should now see: + +```text +Enumerating objects: 4, done. +Counting objects: 100% (4/4), done. +Delta compression using up to 12 threads +Compressing objects: 100% (3/3), done. +Writing objects: 100% (4/4), 6.08 KiB | 6.08 MiB/s, done. +Total 4 (delta 0), reused 0 (delta 0), pack-reused 0 +To github.com:USER/myproject.git + * [new branch] main -> main +branch 'main' set up to track 'origin/main'. +``` + +Reload your GitHub project website and your commits should now be +online! + + +### Troubleshooting + +**error: remote origin already exists** +- Explanation: You probably ran a `git remote add origin ...` command, then changed your + mind about HTTPS or SSH and then tried to run the other `git remote add + origin ...` command but "origin" then already exists. +- Recovery: + - First remove "origin" with `git remote remove origin` + - Then run the correct `git remote add origin ...` command + +**remote contains work that you do not have** +- Explanation: You probably clicked on "Add a README file" and now the + repository on GitHub is not empty but contains one commit and locally you + have a different history. Git now prevents you from accidentally overwriting + the history on GitHub. +- Recovery: + - Use `git push --force` instead of `git push`, which will force Git to overwrite the history on GitHub + - Note that this is a powerful but also possibly dangerous option but here it + helps us. If it's a brand new repo, it probably is fine to do this. For real + repositories, don't do this unless you are very sure what is happening. +::: + +:::: +::::: + + +## Remote repositories + +In this exercise we have pushed our local repository to a remote repository. +We will learn how to work with remote repositories in detail in the +[collaborative distributed version +control](https://coderefinery.github.io/git-collaborative/) lesson. To store +your git data on another server, you use **remotes**. A remote is a repository +on its own, with its own branches. We can **push** changes to the remote and +**pull** from the remote. + +You might use remotes to: +- Back up your own work or make your work findable. +- To collaborate with other people. + +There are different types of remotes: +- If you have a server you can SSH to, you can use that as a remote. +- [GitHub](https://github.com) is a popular, closed-source commercial site. +- [GitLab](https://about.gitlab.com) is a popular, open-core + commercial site. Many universities have their own private GitLab servers + set up. +- [Bitbucket](https://bitbucket.org) is yet another popular commercial site. +- Another option is [NotABug](https://notabug.org). +- There are more ... + + +## Is putting software on GitHub/GitLab/... publishing? + +It is a good first step but to make your code truly **findable and +accessible**, condider making your code **citable and persistent**: Get a +persistent identifier (PID) such as DOI in addition to sharing the code +publicly, by using services like [Zenodo](https://zenodo.org) or similar +services. diff --git a/_sources/staging-area.md.txt b/_sources/staging-area.md.txt new file mode 100644 index 00000000..94d0fe83 --- /dev/null +++ b/_sources/staging-area.md.txt @@ -0,0 +1,330 @@ +# Using the Git staging area + +```{objectives} +- Learn how to tell a story with your commit history. +- Demystify the Git staging area. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 10 min exercise +``` + + +## Commit history is telling a story + +Your *current code* is very important, but the *history* can be just +as important - it tells a story about how your code came to be. + +- Each individual line of code rarely stands alone. +- You often want to see all the related changes together. +- But you also hardly ever do one thing at once. + +Along with your code, Git creates a *history* for you, and if your +history is clear then you are a long way to organized code. + +````{discussion} + Here are five types of history. What are the advantages and + disadvantages of each, when you look at it later? + + **Example 1**: + ```shell + b135ec8 add features A, B, and C + ``` + + **Example 2** (newest commit is on top): + ```shell + 6f0d49f implement feature C + fee1807 implement feature B + 6fe2f23 implement feature A + ``` + + **Example 3**: + ```shell + ab990f4 saving three months of miscellaneous work I forgot to commit + ``` + + **Example 4** (newest commit is on top): + ```shell + bf39f9d more work on feature B + 45831a5 removing debug prints for feature A and add new file + bddb280 more work on feature B and make feature A compile again + 72d78e7 feature A did not work and started work on feature B + b135ec8 now feature A should work + 72e0211 another fix to make it compile + 61dd3a3 forgot file and bugfix + 49dc419 wip (work in progress) + ``` + + **Example 5** (newest commit is on top): + ```shell + 1949dc4 Work of 2020-04-07 + a361dd3 Work of 2020-04-06 + 1172e02 Work of 2020-04-03 + e772d78 Work of 2020-04-02 + ``` + + Discuss these examples. Can you anticipate problems? +```` + +We want to have nice commits. But we also want to "save often" +(checkpointing) - how can we have both? + +- We will now learn to create nice commits using `git commit --patch` and/or the staging area. +- Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits. +- The staging area isn't the only way to organize your history nicely, some alternatives are discussed at the end of the lesson. + + +## Interactive commits + +- The simplest ways to solve this is to do **interactive commits**: + the `git commit --patch` option (or `git commit -p` for short). +- It will present you with every change you have made individually, + and you can decide which ones to commit right now. +- Reference and key commands + - `git commit --patch` to start the interactive commit + - `y` to use the change + - `n` to skip the change + - `s` (split) if there are several changes grouped together, but + separated by a blank line, split them into separate choices. + - `q` aborts everything. + - `?` for more options. +- The `-p` option is also available on `commit`, `restore`, `checkout`, `reset`, and `add`. + + +(exercise-interactive-commits)= + +## Exercise: Interactive commits + +````{exercise} Staging-1: Perform an interactive commit +One option to help us create nice logical commits is to stage *interactively* +with `git commit --patch`: + +1. Make two changes in `instructions.txt`, at the top and bottom + of the file. + **Make sure that they are separated by at least several unmodified lines.** +2. Run `git commit --patch`. Using the keystrokes above, commit one of + the changes. +3. Do it again for the other change. +4. When you're done, inspect the situation with `git log`, `git status`, `git diff` and `git diff --staged`. +5. When would this be useful? + + ```{solution} + This can be useful if you have several modification in a file (or several + files) but you decide that it would be beneficial to save them as two (or + more) separate commits. + ``` +```` + + +## The staging area + +- The interactive commits above are great, but what if there are so + many changes that you can't sort them out in one shot? +- What if you make progress and want to record it somehow, but it's + not ready to be committed? +- The **staging area** is a place to record things before committing. + +```{instructor-note} +We give two examples and the instructor can pick one or both: +- Analogy using moving boxes +- Analogy using shopping receipts +``` + +```{discussion} + **Analogy using moving boxes** + + - You're moving and you have a box to pack your things in. + - You can put stuff into the box, but you can also take stuff out of the box. + - You wouldn't want to mix items from the bathroom, kitchen, and living room + into the same box. + - The box corresponds to the staging area of Git, where you can craft your commits. + - Committing is like sealing the box and sticking a label on it. + - You wouldn't want to label your box with "stuff", but rather give a more + descriptive label. + - See also + + + **Analogy using shopping receipts** + + - You need to go shopping and buy some stuff for work and for home. + You need two separate receipts. + - Bad idea: go through the store get home stuff, pay, start at the + beginning and go through the store again. This is inefficient and + annoying. + - What you actually do: + - Go through the store and put everything you need in your shopping + basket. + - Get to the check-out. Put your home stuff on the conveyor belt + (`git add`). Check both the belt (`git diff --staged`) and your + basket (`git diff`) to make sure you got all your home stuff. + - Pay (`git commit`) + - Repeat for work stuff. + + In order to keep organized, you have to use multiple locations to + stage things in sequence. +``` + + +## Staging area commands + +The staging area is a middle ground between what you have done to your files +(the **working directory**) and what you have last committed (the **HEAD commit**). +Just like the name implies, it lets you prepare (**stage**) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since **you can modify and stage several times before committing**. + +**git add** stages/prepares for the next commit: +```text + git add + [project*] <------------ project* + ^ + | modify with editor + | + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +**git commit** creates a new commit: +```text + + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + HEAD~2 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +**git reset \\--soft HEAD~1** (move HEAD back by one but keep changes and stage +them) would do the opposite of **git commit**. (in this case, `HEAD` +is literally this - not a replacement) + +Going back to the last staged version: +```text + git restore + [project*] ------------> project* + + + + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Unstaging changes with **git restore \\--staged**: +```text + git restore --staged + ------------> project* + + + + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Discarding unstaged changes: +```text + + project* + | + | git restore + v + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Comparing: +```text + git diff + [project*] <-----------> project* + ^ ^ + | git diff --staged | git diff HEAD + v v + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +```{figure} img/staging-basics.svg +:alt: Staging basics +:width: 100% + +The different states of the repository and the commands to move from one to +another. +``` + +(exercise-staging-area)= + +## Exercise: Using the staging area + +```{exercise} Staging-2: Use the staging area to make a commit in two steps +1. In your recipe example, make two different changes to + `ingredients.txt` and `instructions.txt` which do not go together. +2. Use `git add` to stage one of the changes. +3. Use `git status` to see what's going on, and use `git diff` and `git diff --staged` to see the changes. +4. Feel some regret and unstage the staged change. +``` + +```{discussion} +- When is it better to "save" a change as commit, when is it better to "save" + it with `git add`? +- Is it a problem to commit many small changes? +``` + +```{keypoints} +- The staging area helps us to create well-defined commits. +``` diff --git a/_sources/under-the-hood.md.txt b/_sources/under-the-hood.md.txt new file mode 100644 index 00000000..977968da --- /dev/null +++ b/_sources/under-the-hood.md.txt @@ -0,0 +1,185 @@ +# Git under the hood + +```{objectives} +- Verify that branches are pointers to commits and extremely lightweight. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 15 min exercise +``` + +```{figure} img/stranger.jpg +:alt: Git under the hood +:width: 100% +``` + + +## Down the rabbit hole + +When working with Git, **you will never need to go inside .git**, but in this +exercise we will, in order to learn about how branches are implemented in Git. + +For this exercise create a new repository and commit a couple of changes. + +Now that we've made a couple of commits let us look at what is happening under +the hood. + +```console +$ cd .git +$ ls -l + +drwxr-xr-x - user 25 Aug 15:51 branches +.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG +.rw-r--r-- 92 user 25 Aug 15:51 config +.rw-r--r-- 73 user 25 Aug 15:51 description +.rw-r--r-- 21 user 25 Aug 15:51 HEAD +drwxr-xr-x - user 25 Aug 15:51 hooks +.rw-r--r-- 137 user 25 Aug 15:52 index +drwxr-xr-x - user 25 Aug 15:51 info +drwxr-xr-x - user 25 Aug 15:52 logs +drwxr-xr-x - user 25 Aug 15:52 objects +drwxr-xr-x - user 25 Aug 15:51 refs +``` + +Git stores everything under the .git folder in your repository. In fact, **the +.git directory is the Git repository.** + +Previously when you wrote the commit messages using your text editor, they +were in fact saved to `COMMIT_EDITMSG`. + +Each commit in Git is stored as a "blob". This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file. + +Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string). + +```{figure} img/commit-and-tree.png +:alt: A commit inside Git +:width: 100% + +States of a Git file. Image from the [Pro Git book](https://git-scm.com/book/). License CC BY 3.0. +``` + +Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a [directed acyclic +graph](http://eagain.net/articles/git-for-computer-scientists/) (do not worry +if the term is not familiar). + +```{figure} img/commits-and-parents.png +:alt: A commit and its parents +:width: 100% + +A commit and its parents. Image from the [Pro Git book](https://git-scm.com/book/). License CC BY 3.0. +``` + +All branches and tags in Git are pointers to commits. + + +## Git is basically a content-addressed storage system + +- CAS: ["mechanism for storing information that can be retrieved based on its content, not its storage location"](https://en.wikipedia.org/wiki/Content-addressable_storage) +- Content address is the content digest (SHA-1 checksum) +- Stored data does not change - so when we modify commits, we always create new + commits. Git doesn't delete these right away, which is why it is *very hard + to lose data if you commit it once*. + +Let us poke a bit into raw objects! Start with: + +```console +$ git cat-file -p HEAD +``` + +Then explore the `tree` object, then the `file` object, etc. recursively using the hashes you see. + + +## Demonstration: experimenting with branches + +Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an "Aha!" moment and provide us a +good understanding of the underlying model. + +We are starting from the `main` branch and create an `idea` branch: + +```console +$ git status + +On branch main +nothing to commit, working tree clean +``` + +```console +$ git switch --create idea + +Switched to a new branch 'idea' +``` + +```console +$ git branch + +* idea + main +``` + +Now let us go in: + +```console +$ cd .git +$ cd refs/heads +$ ls -l + +.rw-r--r-- 41 user 25 Aug 15:54 idea +.rw-r--r-- 41 user 25 Aug 15:52 main +``` + +Let us check what the `idea` file looks like +(do not worry if the hash is different): +```console +$ cat idea + +045e3db14740c60684d745e5fb891ae71e335611 +``` + +Now let us replicate this file: +```console +$ cp idea idea-2 +$ cp idea idea-3 +$ cp idea idea-4 +$ cp idea idea-5 +``` + +Let us go up two levels and inspect the file `HEAD`: +```console +$ cd ../.. +$ cat HEAD + +ref: refs/heads/idea +``` + +Let us open this file and change it to: +``` +ref: refs/heads/idea-3 +``` + +**Now we are ready for the aha moment!** +First let us go back to the working area: +```console +$ cd .. +``` + +Now - on which branch are we? +```console +$ git branch + + idea + idea-2 +* idea-3 + idea-4 + idea-5 + main +``` + +```{discussion} +Discuss the findings with other course participants. +``` diff --git a/_sources/what-to-avoid.md.txt b/_sources/what-to-avoid.md.txt new file mode 100644 index 00000000..ed76c118 --- /dev/null +++ b/_sources/what-to-avoid.md.txt @@ -0,0 +1,62 @@ +# What to avoid + +The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas. + +**Postponing commits because the changes are "unfinished"/"ugly"**: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all. + +**Not updating your branch before starting new work**: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later. +So update your branch before adding new commits. + +**Commit unrelated changes together**: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects. + +**Too ambitious branch which risks to never get completed**: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere. + +**Committing generated files**: Compiled and generated files are not +committed to version control. There are many reasons for this: + +- These files can make it more difficult to run on different platforms. +- These files are automatically generated and thus do not contribute in any meaningful way. +- When tracking generated files you could see differences in the code although you haven't touched the code. + +For this we use [.gitignore files](https://git-scm.com/docs/gitignore) where +you can list which files and paths should be ignored by Git. You can also use +wild-cards to ignore files with a certain extension or files in a certain +directory. + +**Over-engineering the branch layout and safeguards in small projects**: This +may prevent people from contributing (maybe even including yourself?). Add more +restrictions and safeguards only as the project and the group of collaborators +grows. + +**Commit messages that explain what has been changed but do not explain why it has been +changed**: This is as useful as code comments which describe the "obvious" such +as "this is a loop" instead of explaining why something is done this way. +But don't let perfect commit messages stop you from the most important point, committing often (first point). + +**Commit huge files**: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent `git rm` does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request. + +:::{discussion} +Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements. +::: diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -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; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 00000000..30fee9d0 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/check-solid.svg b/_static/check-solid.svg new file mode 100644 index 00000000..92fad4b5 --- /dev/null +++ b/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/_static/clipboard.min.js b/_static/clipboard.min.js new file mode 100644 index 00000000..54b3c463 --- /dev/null +++ b/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/_static/copybutton.css b/_static/copybutton.css new file mode 100644 index 00000000..40eafe5f --- /dev/null +++ b/_static/copybutton.css @@ -0,0 +1,93 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +.highlight:hover button.copybtn { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/_static/copybutton.js b/_static/copybutton.js new file mode 100644 index 00000000..f3ecd034 --- /dev/null +++ b/_static/copybutton.js @@ -0,0 +1,241 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copié dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for two seconds, then changes it back +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000) + setTimeout(() => el.classList.remove('success'), 2000) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, 2000) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos, .gp'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/_static/copybutton_funcs.js b/_static/copybutton_funcs.js new file mode 100644 index 00000000..dbe1aaad --- /dev/null +++ b/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000..d06a71d7 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 00000000..87fc516a --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'dirhtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/html5shiv.min.js b/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/theme.js b/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minipres.js b/_static/minipres.js new file mode 100644 index 00000000..ad11c871 --- /dev/null +++ b/_static/minipres.js @@ -0,0 +1,223 @@ +// Add goTo method to elements +// http://stackoverflow.com/questions/4801655/how-to-go-to-a-specific-element-on-page +(function($) { + $.fn.goTo = function() { + $('html, body').animate({ + scrollTop: $(this).offset().top //+ 'px' + }, 'fast'); + return this; // for chaining... + } +})(jQuery); + +// NO good way to do this!. Copy a hack from here +// https://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript +// https://stackoverflow.com/a/2880929 +var urlParams; +(window.onpopstate = function () { + var match, + pl = /\+/g, // Regex for replacing addition symbol with a space + search = /([^&=]+)=?([^&]*)/g, + decode = function (s) { return decodeURIComponent(s.replace(pl, " ")); }, + query = window.location.search.substring(1); + urlParams = {}; + while (match = search.exec(query)) + urlParams[decode(match[1])] = decode(match[2]); +})(); + +// Select heading levels +var maxHeading = urlParams['h'] +if (maxHeading === undefined) maxHeading = 2 +var headingLevels = []; +for (h=2 ; h (sections.length-1) ) { + // if we would scroll past bottom, or above top, do nothing + return; + } + + console.log('xxxxxx'); + var targetSection = sections[targetPos]; + console.log(targetSection, typeof(targetSection)); + + // Return targetSection top and height + var secProperties = section_top_and_height(targetSection); + var top = secProperties['top']; + var height = secProperties['height'] + var win_height = window.innerHeight; + //console.info(top, height, win_height) + + var scroll_to = 0; + if (height >= win_height || height == 0) { + scroll_to = top; + } else { + scroll_to = top - (win_height-height)/3.; + } + //console.info(top, height, win_height, scroll_to) + + $('html, body').animate({ + scrollTop: scroll_to //+ 'px' + }, 'fast'); + +} + + +function minipres() { + /* Enable the minipres mode: + - call the hide() function + - set up the scrolling listener + */ + document.addEventListener('keydown', function (event) { + switch(event.which) { + case 37: // left + switch_slide(-1); + event.preventDefault(); + return false; + break; + //case 38: // up + case 39: // right + switch_slide(+1); + event.preventDefault(); + return false; + break; + //case 40: // down + default: + return; // exit this handler for other keys + } + }, true) + + hide() + + // Increase space between sections + //$("div .section").css('margin-bottom', '50%'); + $(sectionSelector).css('margin-top', '50%'); + + // Reduce size/color of other sections + if (hiddenSectionSelector.length > 0) { + var hideNodes = $(hiddenSectionSelector); + console.log(typeof hideNodes, hideNodes); + for (node in hideNodes) { + console.log("a", typeof node, node); + node = hideNodes[node]; // what's right way to iterate values? + console.log("b", typeof node, node); + if (node.parentNode && node.parentNode.className == "section") { + node = node.parentNode; + console.log("c", typeof node, node); + //node.css['transform'] = 'scale(.5)'; + //node.css['transform-origin'] = 'top center'; + $(node).css('color', 'lightgrey'); + //$(node).css('font-size', '20%'); + //$(node).css('visibility', 'collapse'); + //ntahousnatouhasno; + } + } + } +} + +function hide() { + /* Hide all non-essential elements on the page + */ + + // This is for sphinx_rst_theme and readthedocs + $(".wy-nav-side").remove(); + $(".wy-nav-content-wrap").css('margin-left', 0); + $('.rst-versions').remove(); // readthedocs version selector + + // Add other formats here. +} + + +var slideshow = minipres; + +if (window.location.search.match(/[?&](minipres|slideshow|pres)([=&]|$)/) ) { + //minipres() + window.addEventListener("load", minipres); +} else if (window.location.search.match(/[?&](plain)([=&]|$)/) ) { + window.addEventListener("load", hide); +} diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css b/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css new file mode 100644 index 00000000..33566310 --- /dev/null +++ b/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css @@ -0,0 +1,2342 @@ +/* Variables */ +:root { + --mystnb-source-bg-color: #f7f7f7; + --mystnb-stdout-bg-color: #fcfcfc; + --mystnb-stderr-bg-color: #fdd; + --mystnb-traceback-bg-color: #fcfcfc; + --mystnb-source-border-color: #ccc; + --mystnb-source-margin-color: green; + --mystnb-stdout-border-color: #f7f7f7; + --mystnb-stderr-border-color: #f7f7f7; + --mystnb-traceback-border-color: #ffd6d6; + --mystnb-hide-prompt-opacity: 70%; + --mystnb-source-border-radius: .4em; + --mystnb-source-border-width: 1px; +} + +/* Whole cell */ +div.container.cell { + padding-left: 0; + margin-bottom: 1em; +} + +/* Removing all background formatting so we can control at the div level */ +.cell_input div.highlight, +.cell_output pre, +.cell_input pre, +.cell_output .output { + border: none; + box-shadow: none; +} + +.cell_output .output pre, +.cell_input pre { + margin: 0px; +} + +/* Input cells */ +div.cell div.cell_input, +div.cell details.above-input>summary { + padding-left: 0em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + background-color: var(--mystnb-source-bg-color); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; + border-radius: var(--mystnb-source-border-radius); +} + +div.cell_input>div, +div.cell_output div.output>div.highlight { + margin: 0em !important; + border: none !important; +} + +/* All cell outputs */ +.cell_output { + padding-left: 1em; + padding-right: 0em; + margin-top: 1em; +} + +/* Text outputs from cells */ +.cell_output .output.text_plain, +.cell_output .output.traceback, +.cell_output .output.stream, +.cell_output .output.stderr { + margin-top: 1em; + margin-bottom: 0em; + box-shadow: none; +} + +.cell_output .output.text_plain, +.cell_output .output.stream { + background: var(--mystnb-stdout-bg-color); + border: 1px solid var(--mystnb-stdout-border-color); +} + +.cell_output .output.stderr { + background: var(--mystnb-stderr-bg-color); + border: 1px solid var(--mystnb-stderr-border-color); +} + +.cell_output .output.traceback { + background: var(--mystnb-traceback-bg-color); + border: 1px solid var(--mystnb-traceback-border-color); +} + +/* Collapsible cell content */ +div.cell details.above-input div.cell_input { + border-top-left-radius: 0; + border-top-right-radius: 0; + border-top: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; +} + +div.cell div.cell_input.above-output-prompt { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} + +div.cell details.above-input>summary { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + border-bottom: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; + padding-left: 1em; + margin-bottom: 0; +} + +div.cell details.above-output>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.below-input>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-top: none; + border-bottom-left-radius: var(--mystnb-source-border-radius); + border-bottom-right-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.hide>summary>span { + opacity: var(--mystnb-hide-prompt-opacity); +} + +div.cell details.hide[open]>summary>span.collapsed { + display: none; +} + +div.cell details.hide:not([open])>summary>span.expanded { + display: none; +} + +@keyframes collapsed-fade-in { + 0% { + opacity: 0; + } + + 100% { + opacity: 1; + } +} +div.cell details.hide[open]>summary~* { + -moz-animation: collapsed-fade-in 0.3s ease-in-out; + -webkit-animation: collapsed-fade-in 0.3s ease-in-out; + animation: collapsed-fade-in 0.3s ease-in-out; +} + +/* Math align to the left */ +.cell_output .MathJax_Display { + text-align: left !important; +} + +/* Pandas tables. Pulled from the Jupyter / nbsphinx CSS */ +div.cell_output table { + border: none; + border-collapse: collapse; + border-spacing: 0; + color: black; + font-size: 1em; + table-layout: fixed; +} + +div.cell_output thead { + border-bottom: 1px solid black; + vertical-align: bottom; +} + +div.cell_output tr, +div.cell_output th, +div.cell_output td { + text-align: right; + vertical-align: middle; + padding: 0.5em 0.5em; + line-height: normal; + white-space: normal; + max-width: none; + border: none; +} + +div.cell_output th { + font-weight: bold; +} + +div.cell_output tbody tr:nth-child(odd) { + background: #f5f5f5; +} + +div.cell_output tbody tr:hover { + background: rgba(66, 165, 245, 0.2); +} + +/** source code line numbers **/ +span.linenos { + opacity: 0.5; +} + +/* Inline text from `paste` operation */ + +span.pasted-text { + font-weight: bold; +} + +span.pasted-inline img { + max-height: 2em; +} + +tbody span.pasted-inline img { + max-height: none; +} + +/* Font colors for translated ANSI escape sequences +Color values are copied from Jupyter Notebook +https://github.com/jupyter/notebook/blob/52581f8eda9b319eb0390ac77fe5903c38f81e3e/notebook/static/notebook/less/ansicolors.less#L14-L21 +Background colors from +https://nbsphinx.readthedocs.io/en/latest/code-cells.html#ANSI-Colors +*/ +div.highlight .-Color-Bold { + font-weight: bold; +} + +div.highlight .-Color[class*=-Black] { + color: #3E424D +} + +div.highlight .-Color[class*=-Red] { + color: #E75C58 +} + +div.highlight .-Color[class*=-Green] { + color: #00A250 +} + +div.highlight .-Color[class*=-Yellow] { + color: #DDB62B +} + +div.highlight .-Color[class*=-Blue] { + color: #208FFB +} + +div.highlight .-Color[class*=-Magenta] { + color: #D160C4 +} + +div.highlight .-Color[class*=-Cyan] { + color: #60C6C8 +} + +div.highlight .-Color[class*=-White] { + color: #C5C1B4 +} + +div.highlight .-Color[class*=-BGBlack] { + background-color: #3E424D +} + +div.highlight .-Color[class*=-BGRed] { + background-color: #E75C58 +} + +div.highlight .-Color[class*=-BGGreen] { + background-color: #00A250 +} + +div.highlight .-Color[class*=-BGYellow] { + background-color: #DDB62B +} + +div.highlight .-Color[class*=-BGBlue] { + background-color: #208FFB +} + +div.highlight .-Color[class*=-BGMagenta] { + background-color: #D160C4 +} + +div.highlight .-Color[class*=-BGCyan] { + background-color: #60C6C8 +} + +div.highlight .-Color[class*=-BGWhite] { + background-color: #C5C1B4 +} + +/* Font colors for 8-bit ANSI */ + +div.highlight .-Color[class*=-C0] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC0] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C1] { + color: #800000 +} + +div.highlight .-Color[class*=-BGC1] { + background-color: #800000 +} + +div.highlight .-Color[class*=-C2] { + color: #008000 +} + +div.highlight .-Color[class*=-BGC2] { + background-color: #008000 +} + +div.highlight .-Color[class*=-C3] { + color: #808000 +} + +div.highlight .-Color[class*=-BGC3] { + background-color: #808000 +} + +div.highlight .-Color[class*=-C4] { + color: #000080 +} + +div.highlight .-Color[class*=-BGC4] { + background-color: #000080 +} + +div.highlight .-Color[class*=-C5] { + color: #800080 +} + +div.highlight .-Color[class*=-BGC5] { + background-color: #800080 +} + +div.highlight .-Color[class*=-C6] { + color: #008080 +} + +div.highlight .-Color[class*=-BGC6] { + background-color: #008080 +} + +div.highlight .-Color[class*=-C7] { + color: #C0C0C0 +} + +div.highlight .-Color[class*=-BGC7] { + background-color: #C0C0C0 +} + +div.highlight .-Color[class*=-C8] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC8] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C9] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC9] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C10] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC10] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C11] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC11] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C12] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC12] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C13] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC13] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C14] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC14] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C15] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC15] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C16] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC16] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C17] { + color: #00005F +} + +div.highlight .-Color[class*=-BGC17] { + background-color: #00005F +} + +div.highlight .-Color[class*=-C18] { + color: #000087 +} + +div.highlight .-Color[class*=-BGC18] { + background-color: #000087 +} + +div.highlight .-Color[class*=-C19] { + color: #0000AF +} + +div.highlight .-Color[class*=-BGC19] { + background-color: #0000AF +} + +div.highlight .-Color[class*=-C20] { + color: #0000D7 +} + +div.highlight .-Color[class*=-BGC20] { + background-color: #0000D7 +} + +div.highlight .-Color[class*=-C21] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC21] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C22] { + color: #005F00 +} + +div.highlight .-Color[class*=-BGC22] { + background-color: #005F00 +} + +div.highlight .-Color[class*=-C23] { + color: #005F5F +} + +div.highlight .-Color[class*=-BGC23] { + background-color: #005F5F +} + +div.highlight .-Color[class*=-C24] { + color: #005F87 +} + +div.highlight .-Color[class*=-BGC24] { + background-color: #005F87 +} + +div.highlight .-Color[class*=-C25] { + color: #005FAF +} + +div.highlight .-Color[class*=-BGC25] { + background-color: #005FAF +} + +div.highlight .-Color[class*=-C26] { + color: #005FD7 +} + +div.highlight .-Color[class*=-BGC26] { + background-color: #005FD7 +} + +div.highlight .-Color[class*=-C27] { + color: #005FFF +} + +div.highlight .-Color[class*=-BGC27] { + background-color: #005FFF +} + +div.highlight .-Color[class*=-C28] { + color: #008700 +} + +div.highlight .-Color[class*=-BGC28] { + background-color: #008700 +} + +div.highlight .-Color[class*=-C29] { + color: #00875F +} + +div.highlight .-Color[class*=-BGC29] { + background-color: #00875F +} + +div.highlight .-Color[class*=-C30] { + color: #008787 +} + +div.highlight .-Color[class*=-BGC30] { + background-color: #008787 +} + +div.highlight .-Color[class*=-C31] { + color: #0087AF +} + +div.highlight .-Color[class*=-BGC31] { + background-color: #0087AF +} + +div.highlight .-Color[class*=-C32] { + color: #0087D7 +} + +div.highlight .-Color[class*=-BGC32] { + background-color: #0087D7 +} + +div.highlight .-Color[class*=-C33] { + color: #0087FF +} + +div.highlight .-Color[class*=-BGC33] { + background-color: #0087FF +} + +div.highlight .-Color[class*=-C34] { + color: #00AF00 +} + +div.highlight .-Color[class*=-BGC34] { + background-color: #00AF00 +} + +div.highlight .-Color[class*=-C35] { + color: #00AF5F +} + +div.highlight .-Color[class*=-BGC35] { + background-color: #00AF5F +} + +div.highlight .-Color[class*=-C36] { + color: #00AF87 +} + +div.highlight .-Color[class*=-BGC36] { + background-color: #00AF87 +} + +div.highlight .-Color[class*=-C37] { + color: #00AFAF +} + +div.highlight .-Color[class*=-BGC37] { + background-color: #00AFAF +} + +div.highlight .-Color[class*=-C38] { + color: #00AFD7 +} + +div.highlight .-Color[class*=-BGC38] { + background-color: #00AFD7 +} + +div.highlight .-Color[class*=-C39] { + color: #00AFFF +} + +div.highlight .-Color[class*=-BGC39] { + background-color: #00AFFF +} + +div.highlight .-Color[class*=-C40] { + color: #00D700 +} + +div.highlight .-Color[class*=-BGC40] { + background-color: #00D700 +} + +div.highlight .-Color[class*=-C41] { + color: #00D75F +} + +div.highlight .-Color[class*=-BGC41] { + background-color: #00D75F +} + +div.highlight .-Color[class*=-C42] { + color: #00D787 +} + +div.highlight .-Color[class*=-BGC42] { + background-color: #00D787 +} + +div.highlight .-Color[class*=-C43] { + color: #00D7AF +} + +div.highlight .-Color[class*=-BGC43] { + background-color: #00D7AF +} + +div.highlight .-Color[class*=-C44] { + color: #00D7D7 +} + +div.highlight .-Color[class*=-BGC44] { + background-color: #00D7D7 +} + +div.highlight .-Color[class*=-C45] { + color: #00D7FF +} + +div.highlight .-Color[class*=-BGC45] { + background-color: #00D7FF +} + +div.highlight .-Color[class*=-C46] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC46] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C47] { + color: #00FF5F +} + +div.highlight .-Color[class*=-BGC47] { + background-color: #00FF5F +} + +div.highlight .-Color[class*=-C48] { + color: #00FF87 +} + +div.highlight .-Color[class*=-BGC48] { + background-color: #00FF87 +} + +div.highlight .-Color[class*=-C49] { + color: #00FFAF +} + +div.highlight .-Color[class*=-BGC49] { + background-color: #00FFAF +} + +div.highlight .-Color[class*=-C50] { + color: #00FFD7 +} + +div.highlight .-Color[class*=-BGC50] { + background-color: #00FFD7 +} + +div.highlight .-Color[class*=-C51] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC51] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C52] { + color: #5F0000 +} + +div.highlight .-Color[class*=-BGC52] { + background-color: #5F0000 +} + +div.highlight .-Color[class*=-C53] { + color: #5F005F +} + +div.highlight .-Color[class*=-BGC53] { + background-color: #5F005F +} + +div.highlight .-Color[class*=-C54] { + color: #5F0087 +} + +div.highlight .-Color[class*=-BGC54] { + background-color: #5F0087 +} + +div.highlight .-Color[class*=-C55] { + color: #5F00AF +} + +div.highlight .-Color[class*=-BGC55] { + background-color: #5F00AF +} + +div.highlight .-Color[class*=-C56] { + color: #5F00D7 +} + +div.highlight .-Color[class*=-BGC56] { + background-color: #5F00D7 +} + +div.highlight .-Color[class*=-C57] { + color: #5F00FF +} + +div.highlight .-Color[class*=-BGC57] { + background-color: #5F00FF +} + +div.highlight .-Color[class*=-C58] { + color: #5F5F00 +} + +div.highlight .-Color[class*=-BGC58] { + background-color: #5F5F00 +} + +div.highlight .-Color[class*=-C59] { + color: #5F5F5F +} + +div.highlight .-Color[class*=-BGC59] { + background-color: #5F5F5F +} + +div.highlight .-Color[class*=-C60] { + color: #5F5F87 +} + +div.highlight .-Color[class*=-BGC60] { + background-color: #5F5F87 +} + +div.highlight .-Color[class*=-C61] { + color: #5F5FAF +} + +div.highlight .-Color[class*=-BGC61] { + background-color: #5F5FAF +} + +div.highlight .-Color[class*=-C62] { + color: #5F5FD7 +} + +div.highlight .-Color[class*=-BGC62] { + background-color: #5F5FD7 +} + +div.highlight .-Color[class*=-C63] { + color: #5F5FFF +} + +div.highlight .-Color[class*=-BGC63] { + background-color: #5F5FFF +} + +div.highlight .-Color[class*=-C64] { + color: #5F8700 +} + +div.highlight .-Color[class*=-BGC64] { + background-color: #5F8700 +} + +div.highlight .-Color[class*=-C65] { + color: #5F875F +} + +div.highlight .-Color[class*=-BGC65] { + background-color: #5F875F +} + +div.highlight .-Color[class*=-C66] { + color: #5F8787 +} + +div.highlight .-Color[class*=-BGC66] { + background-color: #5F8787 +} + +div.highlight .-Color[class*=-C67] { + color: #5F87AF +} + +div.highlight .-Color[class*=-BGC67] { + background-color: #5F87AF +} + +div.highlight .-Color[class*=-C68] { + color: #5F87D7 +} + +div.highlight .-Color[class*=-BGC68] { + background-color: #5F87D7 +} + +div.highlight .-Color[class*=-C69] { + color: #5F87FF +} + +div.highlight .-Color[class*=-BGC69] { + background-color: #5F87FF +} + +div.highlight .-Color[class*=-C70] { + color: #5FAF00 +} + +div.highlight .-Color[class*=-BGC70] { + background-color: #5FAF00 +} + +div.highlight .-Color[class*=-C71] { + color: #5FAF5F +} + +div.highlight .-Color[class*=-BGC71] { + background-color: #5FAF5F +} + +div.highlight .-Color[class*=-C72] { + color: #5FAF87 +} + +div.highlight .-Color[class*=-BGC72] { + background-color: #5FAF87 +} + +div.highlight .-Color[class*=-C73] { + color: #5FAFAF +} + +div.highlight .-Color[class*=-BGC73] { + background-color: #5FAFAF +} + +div.highlight .-Color[class*=-C74] { + color: #5FAFD7 +} + +div.highlight .-Color[class*=-BGC74] { + background-color: #5FAFD7 +} + +div.highlight .-Color[class*=-C75] { + color: #5FAFFF +} + +div.highlight .-Color[class*=-BGC75] { + background-color: #5FAFFF +} + +div.highlight .-Color[class*=-C76] { + color: #5FD700 +} + +div.highlight .-Color[class*=-BGC76] { + background-color: #5FD700 +} + +div.highlight .-Color[class*=-C77] { + color: #5FD75F +} + +div.highlight .-Color[class*=-BGC77] { + background-color: #5FD75F +} + +div.highlight .-Color[class*=-C78] { + color: #5FD787 +} + +div.highlight .-Color[class*=-BGC78] { + background-color: #5FD787 +} + +div.highlight .-Color[class*=-C79] { + color: #5FD7AF +} + +div.highlight .-Color[class*=-BGC79] { + background-color: #5FD7AF +} + +div.highlight .-Color[class*=-C80] { + color: #5FD7D7 +} + +div.highlight .-Color[class*=-BGC80] { + background-color: #5FD7D7 +} + +div.highlight .-Color[class*=-C81] { + color: #5FD7FF +} + +div.highlight .-Color[class*=-BGC81] { + background-color: #5FD7FF +} + +div.highlight .-Color[class*=-C82] { + color: #5FFF00 +} + +div.highlight .-Color[class*=-BGC82] { + background-color: #5FFF00 +} + +div.highlight .-Color[class*=-C83] { + color: #5FFF5F +} + +div.highlight .-Color[class*=-BGC83] { + background-color: #5FFF5F +} + +div.highlight .-Color[class*=-C84] { + color: #5FFF87 +} + +div.highlight .-Color[class*=-BGC84] { + background-color: #5FFF87 +} + +div.highlight .-Color[class*=-C85] { + color: #5FFFAF +} + +div.highlight .-Color[class*=-BGC85] { + background-color: #5FFFAF +} + +div.highlight .-Color[class*=-C86] { + color: #5FFFD7 +} + +div.highlight .-Color[class*=-BGC86] { + background-color: #5FFFD7 +} + +div.highlight .-Color[class*=-C87] { + color: #5FFFFF +} + +div.highlight .-Color[class*=-BGC87] { + background-color: #5FFFFF +} + +div.highlight .-Color[class*=-C88] { + color: #870000 +} + +div.highlight .-Color[class*=-BGC88] { + background-color: #870000 +} + +div.highlight .-Color[class*=-C89] { + color: #87005F +} + +div.highlight .-Color[class*=-BGC89] { + background-color: #87005F +} + +div.highlight .-Color[class*=-C90] { + color: #870087 +} + +div.highlight .-Color[class*=-BGC90] { + background-color: #870087 +} + +div.highlight .-Color[class*=-C91] { + color: #8700AF +} + +div.highlight .-Color[class*=-BGC91] { + background-color: #8700AF +} + +div.highlight .-Color[class*=-C92] { + color: #8700D7 +} + +div.highlight .-Color[class*=-BGC92] { + background-color: #8700D7 +} + +div.highlight .-Color[class*=-C93] { + color: #8700FF +} + +div.highlight .-Color[class*=-BGC93] { + background-color: #8700FF +} + +div.highlight .-Color[class*=-C94] { + color: #875F00 +} + +div.highlight .-Color[class*=-BGC94] { + background-color: #875F00 +} + +div.highlight .-Color[class*=-C95] { + color: #875F5F +} + +div.highlight .-Color[class*=-BGC95] { + background-color: #875F5F +} + +div.highlight .-Color[class*=-C96] { + color: #875F87 +} + +div.highlight .-Color[class*=-BGC96] { + background-color: #875F87 +} + +div.highlight .-Color[class*=-C97] { + color: #875FAF +} + +div.highlight .-Color[class*=-BGC97] { + background-color: #875FAF +} + +div.highlight .-Color[class*=-C98] { + color: #875FD7 +} + +div.highlight .-Color[class*=-BGC98] { + background-color: #875FD7 +} + +div.highlight .-Color[class*=-C99] { + color: #875FFF +} + +div.highlight .-Color[class*=-BGC99] { + background-color: #875FFF +} + +div.highlight .-Color[class*=-C100] { + color: #878700 +} + +div.highlight .-Color[class*=-BGC100] { + background-color: #878700 +} + +div.highlight .-Color[class*=-C101] { + color: #87875F +} + +div.highlight .-Color[class*=-BGC101] { + background-color: #87875F +} + +div.highlight .-Color[class*=-C102] { + color: #878787 +} + +div.highlight .-Color[class*=-BGC102] { + background-color: #878787 +} + +div.highlight .-Color[class*=-C103] { + color: #8787AF +} + +div.highlight .-Color[class*=-BGC103] { + background-color: #8787AF +} + +div.highlight .-Color[class*=-C104] { + color: #8787D7 +} + +div.highlight .-Color[class*=-BGC104] { + background-color: #8787D7 +} + +div.highlight .-Color[class*=-C105] { + color: #8787FF +} + +div.highlight .-Color[class*=-BGC105] { + background-color: #8787FF +} + +div.highlight .-Color[class*=-C106] { + color: #87AF00 +} + +div.highlight .-Color[class*=-BGC106] { + background-color: #87AF00 +} + +div.highlight .-Color[class*=-C107] { + color: #87AF5F +} + +div.highlight .-Color[class*=-BGC107] { + background-color: #87AF5F +} + +div.highlight .-Color[class*=-C108] { + color: #87AF87 +} + +div.highlight .-Color[class*=-BGC108] { + background-color: #87AF87 +} + +div.highlight .-Color[class*=-C109] { + color: #87AFAF +} + +div.highlight .-Color[class*=-BGC109] { + background-color: #87AFAF +} + +div.highlight .-Color[class*=-C110] { + color: #87AFD7 +} + +div.highlight .-Color[class*=-BGC110] { + background-color: #87AFD7 +} + +div.highlight .-Color[class*=-C111] { + color: #87AFFF +} + +div.highlight .-Color[class*=-BGC111] { + background-color: #87AFFF +} + +div.highlight .-Color[class*=-C112] { + color: #87D700 +} + +div.highlight .-Color[class*=-BGC112] { + background-color: #87D700 +} + +div.highlight .-Color[class*=-C113] { + color: #87D75F +} + +div.highlight .-Color[class*=-BGC113] { + background-color: #87D75F +} + +div.highlight .-Color[class*=-C114] { + color: #87D787 +} + +div.highlight .-Color[class*=-BGC114] { + background-color: #87D787 +} + +div.highlight .-Color[class*=-C115] { + color: #87D7AF +} + +div.highlight .-Color[class*=-BGC115] { + background-color: #87D7AF +} + +div.highlight .-Color[class*=-C116] { + color: #87D7D7 +} + +div.highlight .-Color[class*=-BGC116] { + background-color: #87D7D7 +} + +div.highlight .-Color[class*=-C117] { + color: #87D7FF +} + +div.highlight .-Color[class*=-BGC117] { + background-color: #87D7FF +} + +div.highlight .-Color[class*=-C118] { + color: #87FF00 +} + +div.highlight .-Color[class*=-BGC118] { + background-color: #87FF00 +} + +div.highlight .-Color[class*=-C119] { + color: #87FF5F +} + +div.highlight .-Color[class*=-BGC119] { + background-color: #87FF5F +} + +div.highlight .-Color[class*=-C120] { + color: #87FF87 +} + +div.highlight .-Color[class*=-BGC120] { + background-color: #87FF87 +} + +div.highlight .-Color[class*=-C121] { + color: #87FFAF +} + +div.highlight .-Color[class*=-BGC121] { + background-color: #87FFAF +} + +div.highlight .-Color[class*=-C122] { + color: #87FFD7 +} + +div.highlight .-Color[class*=-BGC122] { + background-color: #87FFD7 +} + +div.highlight .-Color[class*=-C123] { + color: #87FFFF +} + +div.highlight .-Color[class*=-BGC123] { + background-color: #87FFFF +} + +div.highlight .-Color[class*=-C124] { + color: #AF0000 +} + +div.highlight .-Color[class*=-BGC124] { + background-color: #AF0000 +} + +div.highlight .-Color[class*=-C125] { + color: #AF005F +} + +div.highlight .-Color[class*=-BGC125] { + background-color: #AF005F +} + +div.highlight .-Color[class*=-C126] { + color: #AF0087 +} + +div.highlight .-Color[class*=-BGC126] { + background-color: #AF0087 +} + +div.highlight .-Color[class*=-C127] { + color: #AF00AF +} + +div.highlight .-Color[class*=-BGC127] { + background-color: #AF00AF +} + +div.highlight .-Color[class*=-C128] { + color: #AF00D7 +} + +div.highlight .-Color[class*=-BGC128] { + background-color: #AF00D7 +} + +div.highlight .-Color[class*=-C129] { + color: #AF00FF +} + +div.highlight .-Color[class*=-BGC129] { + background-color: #AF00FF +} + +div.highlight .-Color[class*=-C130] { + color: #AF5F00 +} + +div.highlight .-Color[class*=-BGC130] { + background-color: #AF5F00 +} + +div.highlight .-Color[class*=-C131] { + color: #AF5F5F +} + +div.highlight .-Color[class*=-BGC131] { + background-color: #AF5F5F +} + +div.highlight .-Color[class*=-C132] { + color: #AF5F87 +} + +div.highlight .-Color[class*=-BGC132] { + background-color: #AF5F87 +} + +div.highlight .-Color[class*=-C133] { + color: #AF5FAF +} + +div.highlight .-Color[class*=-BGC133] { + background-color: #AF5FAF +} + +div.highlight .-Color[class*=-C134] { + color: #AF5FD7 +} + +div.highlight .-Color[class*=-BGC134] { + background-color: #AF5FD7 +} + +div.highlight .-Color[class*=-C135] { + color: #AF5FFF +} + +div.highlight .-Color[class*=-BGC135] { + background-color: #AF5FFF +} + +div.highlight .-Color[class*=-C136] { + color: #AF8700 +} + +div.highlight .-Color[class*=-BGC136] { + background-color: #AF8700 +} + +div.highlight .-Color[class*=-C137] { + color: #AF875F +} + +div.highlight .-Color[class*=-BGC137] { + background-color: #AF875F +} + +div.highlight .-Color[class*=-C138] { + color: #AF8787 +} + +div.highlight .-Color[class*=-BGC138] { + background-color: #AF8787 +} + +div.highlight .-Color[class*=-C139] { + color: #AF87AF +} + +div.highlight .-Color[class*=-BGC139] { + background-color: #AF87AF +} + +div.highlight .-Color[class*=-C140] { + color: #AF87D7 +} + +div.highlight .-Color[class*=-BGC140] { + background-color: #AF87D7 +} + +div.highlight .-Color[class*=-C141] { + color: #AF87FF +} + +div.highlight .-Color[class*=-BGC141] { + background-color: #AF87FF +} + +div.highlight .-Color[class*=-C142] { + color: #AFAF00 +} + +div.highlight .-Color[class*=-BGC142] { + background-color: #AFAF00 +} + +div.highlight .-Color[class*=-C143] { + color: #AFAF5F +} + +div.highlight .-Color[class*=-BGC143] { + background-color: #AFAF5F +} + +div.highlight .-Color[class*=-C144] { + color: #AFAF87 +} + +div.highlight .-Color[class*=-BGC144] { + background-color: #AFAF87 +} + +div.highlight .-Color[class*=-C145] { + color: #AFAFAF +} + +div.highlight .-Color[class*=-BGC145] { + background-color: #AFAFAF +} + +div.highlight .-Color[class*=-C146] { + color: #AFAFD7 +} + +div.highlight .-Color[class*=-BGC146] { + background-color: #AFAFD7 +} + +div.highlight .-Color[class*=-C147] { + color: #AFAFFF +} + +div.highlight .-Color[class*=-BGC147] { + background-color: #AFAFFF +} + +div.highlight .-Color[class*=-C148] { + color: #AFD700 +} + +div.highlight .-Color[class*=-BGC148] { + background-color: #AFD700 +} + +div.highlight .-Color[class*=-C149] { + color: #AFD75F +} + +div.highlight .-Color[class*=-BGC149] { + background-color: #AFD75F +} + +div.highlight .-Color[class*=-C150] { + color: #AFD787 +} + +div.highlight .-Color[class*=-BGC150] { + background-color: #AFD787 +} + +div.highlight .-Color[class*=-C151] { + color: #AFD7AF +} + +div.highlight .-Color[class*=-BGC151] { + background-color: #AFD7AF +} + +div.highlight .-Color[class*=-C152] { + color: #AFD7D7 +} + +div.highlight .-Color[class*=-BGC152] { + background-color: #AFD7D7 +} + +div.highlight .-Color[class*=-C153] { + color: #AFD7FF +} + +div.highlight .-Color[class*=-BGC153] { + background-color: #AFD7FF +} + +div.highlight .-Color[class*=-C154] { + color: #AFFF00 +} + +div.highlight .-Color[class*=-BGC154] { + background-color: #AFFF00 +} + +div.highlight .-Color[class*=-C155] { + color: #AFFF5F +} + +div.highlight .-Color[class*=-BGC155] { + background-color: #AFFF5F +} + +div.highlight .-Color[class*=-C156] { + color: #AFFF87 +} + +div.highlight .-Color[class*=-BGC156] { + background-color: #AFFF87 +} + +div.highlight .-Color[class*=-C157] { + color: #AFFFAF +} + +div.highlight .-Color[class*=-BGC157] { + background-color: #AFFFAF +} + +div.highlight .-Color[class*=-C158] { + color: #AFFFD7 +} + +div.highlight .-Color[class*=-BGC158] { + background-color: #AFFFD7 +} + +div.highlight .-Color[class*=-C159] { + color: #AFFFFF +} + +div.highlight .-Color[class*=-BGC159] { + background-color: #AFFFFF +} + +div.highlight .-Color[class*=-C160] { + color: #D70000 +} + +div.highlight .-Color[class*=-BGC160] { + background-color: #D70000 +} + +div.highlight .-Color[class*=-C161] { + color: #D7005F +} + +div.highlight .-Color[class*=-BGC161] { + background-color: #D7005F +} + +div.highlight .-Color[class*=-C162] { + color: #D70087 +} + +div.highlight .-Color[class*=-BGC162] { + background-color: #D70087 +} + +div.highlight .-Color[class*=-C163] { + color: #D700AF +} + +div.highlight .-Color[class*=-BGC163] { + background-color: #D700AF +} + +div.highlight .-Color[class*=-C164] { + color: #D700D7 +} + +div.highlight .-Color[class*=-BGC164] { + background-color: #D700D7 +} + +div.highlight .-Color[class*=-C165] { + color: #D700FF +} + +div.highlight .-Color[class*=-BGC165] { + background-color: #D700FF +} + +div.highlight .-Color[class*=-C166] { + color: #D75F00 +} + +div.highlight .-Color[class*=-BGC166] { + background-color: #D75F00 +} + +div.highlight .-Color[class*=-C167] { + color: #D75F5F +} + +div.highlight .-Color[class*=-BGC167] { + background-color: #D75F5F +} + +div.highlight .-Color[class*=-C168] { + color: #D75F87 +} + +div.highlight .-Color[class*=-BGC168] { + background-color: #D75F87 +} + +div.highlight .-Color[class*=-C169] { + color: #D75FAF +} + +div.highlight .-Color[class*=-BGC169] { + background-color: #D75FAF +} + +div.highlight .-Color[class*=-C170] { + color: #D75FD7 +} + +div.highlight .-Color[class*=-BGC170] { + background-color: #D75FD7 +} + +div.highlight .-Color[class*=-C171] { + color: #D75FFF +} + +div.highlight .-Color[class*=-BGC171] { + background-color: #D75FFF +} + +div.highlight .-Color[class*=-C172] { + color: #D78700 +} + +div.highlight .-Color[class*=-BGC172] { + background-color: #D78700 +} + +div.highlight .-Color[class*=-C173] { + color: #D7875F +} + +div.highlight .-Color[class*=-BGC173] { + background-color: #D7875F +} + +div.highlight .-Color[class*=-C174] { + color: #D78787 +} + +div.highlight .-Color[class*=-BGC174] { + background-color: #D78787 +} + +div.highlight .-Color[class*=-C175] { + color: #D787AF +} + +div.highlight .-Color[class*=-BGC175] { + background-color: #D787AF +} + +div.highlight .-Color[class*=-C176] { + color: #D787D7 +} + +div.highlight .-Color[class*=-BGC176] { + background-color: #D787D7 +} + +div.highlight .-Color[class*=-C177] { + color: #D787FF +} + +div.highlight .-Color[class*=-BGC177] { + background-color: #D787FF +} + +div.highlight .-Color[class*=-C178] { + color: #D7AF00 +} + +div.highlight .-Color[class*=-BGC178] { + background-color: #D7AF00 +} + +div.highlight .-Color[class*=-C179] { + color: #D7AF5F +} + +div.highlight .-Color[class*=-BGC179] { + background-color: #D7AF5F +} + +div.highlight .-Color[class*=-C180] { + color: #D7AF87 +} + +div.highlight .-Color[class*=-BGC180] { + background-color: #D7AF87 +} + +div.highlight .-Color[class*=-C181] { + color: #D7AFAF +} + +div.highlight .-Color[class*=-BGC181] { + background-color: #D7AFAF +} + +div.highlight .-Color[class*=-C182] { + color: #D7AFD7 +} + +div.highlight .-Color[class*=-BGC182] { + background-color: #D7AFD7 +} + +div.highlight .-Color[class*=-C183] { + color: #D7AFFF +} + +div.highlight .-Color[class*=-BGC183] { + background-color: #D7AFFF +} + +div.highlight .-Color[class*=-C184] { + color: #D7D700 +} + +div.highlight .-Color[class*=-BGC184] { + background-color: #D7D700 +} + +div.highlight .-Color[class*=-C185] { + color: #D7D75F +} + +div.highlight .-Color[class*=-BGC185] { + background-color: #D7D75F +} + +div.highlight .-Color[class*=-C186] { + color: #D7D787 +} + +div.highlight .-Color[class*=-BGC186] { + background-color: #D7D787 +} + +div.highlight .-Color[class*=-C187] { + color: #D7D7AF +} + +div.highlight .-Color[class*=-BGC187] { + background-color: #D7D7AF +} + +div.highlight .-Color[class*=-C188] { + color: #D7D7D7 +} + +div.highlight .-Color[class*=-BGC188] { + background-color: #D7D7D7 +} + +div.highlight .-Color[class*=-C189] { + color: #D7D7FF +} + +div.highlight .-Color[class*=-BGC189] { + background-color: #D7D7FF +} + +div.highlight .-Color[class*=-C190] { + color: #D7FF00 +} + +div.highlight .-Color[class*=-BGC190] { + background-color: #D7FF00 +} + +div.highlight .-Color[class*=-C191] { + color: #D7FF5F +} + +div.highlight .-Color[class*=-BGC191] { + background-color: #D7FF5F +} + +div.highlight .-Color[class*=-C192] { + color: #D7FF87 +} + +div.highlight .-Color[class*=-BGC192] { + background-color: #D7FF87 +} + +div.highlight .-Color[class*=-C193] { + color: #D7FFAF +} + +div.highlight .-Color[class*=-BGC193] { + background-color: #D7FFAF +} + +div.highlight .-Color[class*=-C194] { + color: #D7FFD7 +} + +div.highlight .-Color[class*=-BGC194] { + background-color: #D7FFD7 +} + +div.highlight .-Color[class*=-C195] { + color: #D7FFFF +} + +div.highlight .-Color[class*=-BGC195] { + background-color: #D7FFFF +} + +div.highlight .-Color[class*=-C196] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC196] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C197] { + color: #FF005F +} + +div.highlight .-Color[class*=-BGC197] { + background-color: #FF005F +} + +div.highlight .-Color[class*=-C198] { + color: #FF0087 +} + +div.highlight .-Color[class*=-BGC198] { + background-color: #FF0087 +} + +div.highlight .-Color[class*=-C199] { + color: #FF00AF +} + +div.highlight .-Color[class*=-BGC199] { + background-color: #FF00AF +} + +div.highlight .-Color[class*=-C200] { + color: #FF00D7 +} + +div.highlight .-Color[class*=-BGC200] { + background-color: #FF00D7 +} + +div.highlight .-Color[class*=-C201] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC201] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C202] { + color: #FF5F00 +} + +div.highlight .-Color[class*=-BGC202] { + background-color: #FF5F00 +} + +div.highlight .-Color[class*=-C203] { + color: #FF5F5F +} + +div.highlight .-Color[class*=-BGC203] { + background-color: #FF5F5F +} + +div.highlight .-Color[class*=-C204] { + color: #FF5F87 +} + +div.highlight .-Color[class*=-BGC204] { + background-color: #FF5F87 +} + +div.highlight .-Color[class*=-C205] { + color: #FF5FAF +} + +div.highlight .-Color[class*=-BGC205] { + background-color: #FF5FAF +} + +div.highlight .-Color[class*=-C206] { + color: #FF5FD7 +} + +div.highlight .-Color[class*=-BGC206] { + background-color: #FF5FD7 +} + +div.highlight .-Color[class*=-C207] { + color: #FF5FFF +} + +div.highlight .-Color[class*=-BGC207] { + background-color: #FF5FFF +} + +div.highlight .-Color[class*=-C208] { + color: #FF8700 +} + +div.highlight .-Color[class*=-BGC208] { + background-color: #FF8700 +} + +div.highlight .-Color[class*=-C209] { + color: #FF875F +} + +div.highlight .-Color[class*=-BGC209] { + background-color: #FF875F +} + +div.highlight .-Color[class*=-C210] { + color: #FF8787 +} + +div.highlight .-Color[class*=-BGC210] { + background-color: #FF8787 +} + +div.highlight .-Color[class*=-C211] { + color: #FF87AF +} + +div.highlight .-Color[class*=-BGC211] { + background-color: #FF87AF +} + +div.highlight .-Color[class*=-C212] { + color: #FF87D7 +} + +div.highlight .-Color[class*=-BGC212] { + background-color: #FF87D7 +} + +div.highlight .-Color[class*=-C213] { + color: #FF87FF +} + +div.highlight .-Color[class*=-BGC213] { + background-color: #FF87FF +} + +div.highlight .-Color[class*=-C214] { + color: #FFAF00 +} + +div.highlight .-Color[class*=-BGC214] { + background-color: #FFAF00 +} + +div.highlight .-Color[class*=-C215] { + color: #FFAF5F +} + +div.highlight .-Color[class*=-BGC215] { + background-color: #FFAF5F +} + +div.highlight .-Color[class*=-C216] { + color: #FFAF87 +} + +div.highlight .-Color[class*=-BGC216] { + background-color: #FFAF87 +} + +div.highlight .-Color[class*=-C217] { + color: #FFAFAF +} + +div.highlight .-Color[class*=-BGC217] { + background-color: #FFAFAF +} + +div.highlight .-Color[class*=-C218] { + color: #FFAFD7 +} + +div.highlight .-Color[class*=-BGC218] { + background-color: #FFAFD7 +} + +div.highlight .-Color[class*=-C219] { + color: #FFAFFF +} + +div.highlight .-Color[class*=-BGC219] { + background-color: #FFAFFF +} + +div.highlight .-Color[class*=-C220] { + color: #FFD700 +} + +div.highlight .-Color[class*=-BGC220] { + background-color: #FFD700 +} + +div.highlight .-Color[class*=-C221] { + color: #FFD75F +} + +div.highlight .-Color[class*=-BGC221] { + background-color: #FFD75F +} + +div.highlight .-Color[class*=-C222] { + color: #FFD787 +} + +div.highlight .-Color[class*=-BGC222] { + background-color: #FFD787 +} + +div.highlight .-Color[class*=-C223] { + color: #FFD7AF +} + +div.highlight .-Color[class*=-BGC223] { + background-color: #FFD7AF +} + +div.highlight .-Color[class*=-C224] { + color: #FFD7D7 +} + +div.highlight .-Color[class*=-BGC224] { + background-color: #FFD7D7 +} + +div.highlight .-Color[class*=-C225] { + color: #FFD7FF +} + +div.highlight .-Color[class*=-BGC225] { + background-color: #FFD7FF +} + +div.highlight .-Color[class*=-C226] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC226] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C227] { + color: #FFFF5F +} + +div.highlight .-Color[class*=-BGC227] { + background-color: #FFFF5F +} + +div.highlight .-Color[class*=-C228] { + color: #FFFF87 +} + +div.highlight .-Color[class*=-BGC228] { + background-color: #FFFF87 +} + +div.highlight .-Color[class*=-C229] { + color: #FFFFAF +} + +div.highlight .-Color[class*=-BGC229] { + background-color: #FFFFAF +} + +div.highlight .-Color[class*=-C230] { + color: #FFFFD7 +} + +div.highlight .-Color[class*=-BGC230] { + background-color: #FFFFD7 +} + +div.highlight .-Color[class*=-C231] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC231] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C232] { + color: #080808 +} + +div.highlight .-Color[class*=-BGC232] { + background-color: #080808 +} + +div.highlight .-Color[class*=-C233] { + color: #121212 +} + +div.highlight .-Color[class*=-BGC233] { + background-color: #121212 +} + +div.highlight .-Color[class*=-C234] { + color: #1C1C1C +} + +div.highlight .-Color[class*=-BGC234] { + background-color: #1C1C1C +} + +div.highlight .-Color[class*=-C235] { + color: #262626 +} + +div.highlight .-Color[class*=-BGC235] { + background-color: #262626 +} + +div.highlight .-Color[class*=-C236] { + color: #303030 +} + +div.highlight .-Color[class*=-BGC236] { + background-color: #303030 +} + +div.highlight .-Color[class*=-C237] { + color: #3A3A3A +} + +div.highlight .-Color[class*=-BGC237] { + background-color: #3A3A3A +} + +div.highlight .-Color[class*=-C238] { + color: #444444 +} + +div.highlight .-Color[class*=-BGC238] { + background-color: #444444 +} + +div.highlight .-Color[class*=-C239] { + color: #4E4E4E +} + +div.highlight .-Color[class*=-BGC239] { + background-color: #4E4E4E +} + +div.highlight .-Color[class*=-C240] { + color: #585858 +} + +div.highlight .-Color[class*=-BGC240] { + background-color: #585858 +} + +div.highlight .-Color[class*=-C241] { + color: #626262 +} + +div.highlight .-Color[class*=-BGC241] { + background-color: #626262 +} + +div.highlight .-Color[class*=-C242] { + color: #6C6C6C +} + +div.highlight .-Color[class*=-BGC242] { + background-color: #6C6C6C +} + +div.highlight .-Color[class*=-C243] { + color: #767676 +} + +div.highlight .-Color[class*=-BGC243] { + background-color: #767676 +} + +div.highlight .-Color[class*=-C244] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC244] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C245] { + color: #8A8A8A +} + +div.highlight .-Color[class*=-BGC245] { + background-color: #8A8A8A +} + +div.highlight .-Color[class*=-C246] { + color: #949494 +} + +div.highlight .-Color[class*=-BGC246] { + background-color: #949494 +} + +div.highlight .-Color[class*=-C247] { + color: #9E9E9E +} + +div.highlight .-Color[class*=-BGC247] { + background-color: #9E9E9E +} + +div.highlight .-Color[class*=-C248] { + color: #A8A8A8 +} + +div.highlight .-Color[class*=-BGC248] { + background-color: #A8A8A8 +} + +div.highlight .-Color[class*=-C249] { + color: #B2B2B2 +} + +div.highlight .-Color[class*=-BGC249] { + background-color: #B2B2B2 +} + +div.highlight .-Color[class*=-C250] { + color: #BCBCBC +} + +div.highlight .-Color[class*=-BGC250] { + background-color: #BCBCBC +} + +div.highlight .-Color[class*=-C251] { + color: #C6C6C6 +} + +div.highlight .-Color[class*=-BGC251] { + background-color: #C6C6C6 +} + +div.highlight .-Color[class*=-C252] { + color: #D0D0D0 +} + +div.highlight .-Color[class*=-BGC252] { + background-color: #D0D0D0 +} + +div.highlight .-Color[class*=-C253] { + color: #DADADA +} + +div.highlight .-Color[class*=-BGC253] { + background-color: #DADADA +} + +div.highlight .-Color[class*=-C254] { + color: #E4E4E4 +} + +div.highlight .-Color[class*=-BGC254] { + background-color: #E4E4E4 +} + +div.highlight .-Color[class*=-C255] { + color: #EEEEEE +} + +div.highlight .-Color[class*=-BGC255] { + background-color: #EEEEEE +} diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 00000000..7918c3fa --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.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: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/_static/sphinx_lesson.css b/_static/sphinx_lesson.css new file mode 100644 index 00000000..14b20c64 --- /dev/null +++ b/_static/sphinx_lesson.css @@ -0,0 +1,51 @@ +/* sphinx_lesson.css */ + +body.wy-body-for-nav img.with-border { + border: 2px solid; +} + +.rst-content .admonition-no-content { + padding-bottom: 0px; +} + +.rst-content .demo > .admonition-title::before { + content: "\01F440"; /* Eyes */ } +.rst-content .type-along > .admonition-title::before { + content: "\02328\0FE0F"; /* Keyboard */ } +.rst-content .exercise > .admonition-title::before { + content: "\0270D\0FE0F"; /* Hand */ } +.rst-content .solution > .admonition-title::before { + content: "\02714\0FE0E"; /* Check mark */ } +.rst-content .homework > .admonition-title::before { + content: "\01F4DD"; /* Memo */ } +.rst-content .discussion > .admonition-title::before { + content: "\01F4AC"; /* Speech balloon */ } +.rst-content .questions > .admonition-title::before { + content: "\02753\0FE0E"; /* Question mark */ } +.rst-content .prerequisites > .admonition-title::before { + content: "\02699"; /* Gear */ } +.rst-content .seealso > .admonition-title::before { + content: "\027A1\0FE0E"; /* Question mark */ } + + +/* instructor-note */ +.rst-content .instructor-note { + background: #e7e7e7; +} +.rst-content .instructor-note > .admonition-title { + background: #6a6a6a; +} +.rst-content .instructor-note > .admonition-title::before { + content: ""; +} + + +/* sphinx_toggle_button, make the font white */ +.rst-content .toggle.admonition button.toggle-button { + color: white; +} + +/* sphinx-togglebutton, remove underflow when toggled to hidden mode */ +.rst-content .admonition.toggle-hidden { + padding-bottom: 0px; +} diff --git a/_static/sphinx_rtd_theme_ext_color_contrast.css b/_static/sphinx_rtd_theme_ext_color_contrast.css new file mode 100644 index 00000000..e68feb82 --- /dev/null +++ b/_static/sphinx_rtd_theme_ext_color_contrast.css @@ -0,0 +1,47 @@ +/* The following are for web accessibility of sphinx_rtd_theme: they + * solve some of the most frequent contrast issues. Remove when this + * solved: + * https://github.com/readthedocs/sphinx_rtd_theme/issues/971 + */ +/* background: #fcfcfc, note boxes #E7F2FA */ +a { color: #2573A7; } /* original #2980B9, #1F5C84; */ +body { color: #242424; } /* original #404040, #383838 */ +.wy-side-nav-search>a, .wy-side-nav-search .wy-dropdown>a { + color: #ffffff; +} /* original #fcfcfc */ +footer { color: #737373; } /* original gray=#808080*/ +footer span.commit code, footer span.commit .rst-content tt, .rst-content footer span.commit tt { + color: #737373; +} /* original gray=#808080*/ +.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { + color: #AB2314; +} +/* Sidebar background */ +.wy-side-nav-search { background-color: #277CB4;} + +/* Same, but for pygments */ +.highlight .ch { color: #3E7A89; } /* #! line */ +.highlight .c1 { color: #3E7A89; } /* also comments */ +.highlight .nv { color: #AD3ECC; } /* variable */ +.highlight .gp { color: #B45608; } /* prompt character, $*/ +.highlight .si { color: #3975B1; } /* ${} variable text */ +.highlight .nc { color: #0C78A7; } + +/* Sphinx admonitions */ +/* warning */ +.wy-alert.wy-alert-warning .wy-alert-title, .rst-content .wy-alert-warning.note .wy-alert-title, .rst-content .attention .wy-alert-title, .rst-content .caution .wy-alert-title, .rst-content .wy-alert-warning.danger .wy-alert-title, .rst-content .wy-alert-warning.error .wy-alert-title, .rst-content .wy-alert-warning.hint .wy-alert-title, .rst-content .wy-alert-warning.important .wy-alert-title, .rst-content .wy-alert-warning.tip .wy-alert-title, .rst-content .warning .wy-alert-title, .rst-content .wy-alert-warning.seealso .wy-alert-title, .rst-content .admonition-todo .wy-alert-title, .rst-content .wy-alert-warning.admonition .wy-alert-title, .wy-alert.wy-alert-warning .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-warning .admonition-title, .rst-content .wy-alert-warning.note .admonition-title, .rst-content .attention .admonition-title, .rst-content .caution .admonition-title, .rst-content .wy-alert-warning.danger .admonition-title, .rst-content .wy-alert-warning.error .admonition-title, .rst-content .wy-alert-warning.hint .admonition-title, .rst-content .wy-alert-warning.important .admonition-title, .rst-content .wy-alert-warning.tip .admonition-title, .rst-content .warning .admonition-title, .rst-content .wy-alert-warning.seealso .admonition-title, .rst-content .admonition-todo .admonition-title, .rst-content .wy-alert-warning.admonition .admonition-title { + background: #B15E16; } +/* important */ +.wy-alert.wy-alert-success .wy-alert-title, .rst-content .wy-alert-success.note .wy-alert-title, .rst-content .wy-alert-success.attention .wy-alert-title, .rst-content .wy-alert-success.caution .wy-alert-title, .rst-content .wy-alert-success.danger .wy-alert-title, .rst-content .wy-alert-success.error .wy-alert-title, .rst-content .hint .wy-alert-title, .rst-content .important .wy-alert-title, .rst-content .tip .wy-alert-title, .rst-content .wy-alert-success.warning .wy-alert-title, .rst-content .wy-alert-success.seealso .wy-alert-title, .rst-content .wy-alert-success.admonition-todo .wy-alert-title, .rst-content .wy-alert-success.admonition .wy-alert-title, .wy-alert.wy-alert-success .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-success .admonition-title, .rst-content .wy-alert-success.note .admonition-title, .rst-content .wy-alert-success.attention .admonition-title, .rst-content .wy-alert-success.caution .admonition-title, .rst-content .wy-alert-success.danger .admonition-title, .rst-content .wy-alert-success.error .admonition-title, .rst-content .hint .admonition-title, .rst-content .important .admonition-title, .rst-content .tip .admonition-title, .rst-content .wy-alert-success.warning .admonition-title, .rst-content .wy-alert-success.seealso .admonition-title, .rst-content .wy-alert-success.admonition-todo .admonition-title, .rst-content .wy-alert-success.admonition .admonition-title { + background: #12826C; } +/* seealso, note, etc */ +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition .admonition-title { + background: #277CB4; } +/* error, danger */ +.rst-content .danger .admonition-title, .rst-content .danger .wy-alert-title, .rst-content .error .admonition-title, .rst-content .error .wy-alert-title, .rst-content .wy-alert-danger.admonition-todo .admonition-title, .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, .rst-content .wy-alert-danger.admonition .admonition-title, .rst-content .wy-alert-danger.admonition .wy-alert-title, .rst-content .wy-alert-danger.attention .admonition-title, .rst-content .wy-alert-danger.attention .wy-alert-title, .rst-content .wy-alert-danger.caution .admonition-title, .rst-content .wy-alert-danger.caution .wy-alert-title, .rst-content .wy-alert-danger.hint .admonition-title, .rst-content .wy-alert-danger.hint .wy-alert-title, .rst-content .wy-alert-danger.important .admonition-title, .rst-content .wy-alert-danger.important .wy-alert-title, .rst-content .wy-alert-danger.note .admonition-title, .rst-content .wy-alert-danger.note .wy-alert-title, .rst-content .wy-alert-danger.seealso .admonition-title, .rst-content .wy-alert-danger.seealso .wy-alert-title, .rst-content .wy-alert-danger.tip .admonition-title, .rst-content .wy-alert-danger.tip .wy-alert-title, .rst-content .wy-alert-danger.warning .admonition-title, .rst-content .wy-alert-danger.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-danger .admonition-title, .wy-alert.wy-alert-danger .rst-content .admonition-title, .wy-alert.wy-alert-danger .wy-alert-title { + background: #e31704; +} + +/* Generic admonition titles */ +.wy-alert-title, .rst-content .admonition-title { + background: #277CB4; } diff --git a/_static/tabs.css b/_static/tabs.css new file mode 100644 index 00000000..957ba60d --- /dev/null +++ b/_static/tabs.css @@ -0,0 +1,89 @@ +.sphinx-tabs { + margin-bottom: 1rem; +} + +[role="tablist"] { + border-bottom: 1px solid #a0b3bf; +} + +.sphinx-tabs-tab { + position: relative; + font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif; + color: #1D5C87; + line-height: 24px; + margin: 0; + font-size: 16px; + font-weight: 400; + background-color: rgba(255, 255, 255, 0); + border-radius: 5px 5px 0 0; + border: 0; + padding: 1rem 1.5rem; + margin-bottom: 0; +} + +.sphinx-tabs-tab[aria-selected="true"] { + font-weight: 700; + border: 1px solid #a0b3bf; + border-bottom: 1px solid white; + margin: -1px; + background-color: white; +} + +.sphinx-tabs-tab:focus { + z-index: 1; + outline-offset: 1px; +} + +.sphinx-tabs-panel { + position: relative; + padding: 1rem; + border: 1px solid #a0b3bf; + margin: 0px -1px -1px -1px; + border-radius: 0 0 5px 5px; + border-top: 0; + background: white; +} + +.sphinx-tabs-panel.code-tab { + padding: 0.4rem; +} + +.sphinx-tab img { + margin-bottom: 24 px; +} + +/* Dark theme preference styling */ + +@media (prefers-color-scheme: dark) { + body[data-theme="auto"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); + } + + body[data-theme="auto"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); + } + + body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 1px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); + } +} + +/* Explicit dark theme styling */ + +body[data-theme="dark"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); +} + +body[data-theme="dark"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); +} + +body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 2px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); +} diff --git a/_static/tabs.js b/_static/tabs.js new file mode 100644 index 00000000..48dc303c --- /dev/null +++ b/_static/tabs.js @@ -0,0 +1,145 @@ +try { + var session = window.sessionStorage || {}; +} catch (e) { + var session = {}; +} + +window.addEventListener("DOMContentLoaded", () => { + const allTabs = document.querySelectorAll('.sphinx-tabs-tab'); + const tabLists = document.querySelectorAll('[role="tablist"]'); + + allTabs.forEach(tab => { + tab.addEventListener("click", changeTabs); + }); + + tabLists.forEach(tabList => { + tabList.addEventListener("keydown", keyTabs); + }); + + // Restore group tab selection from session + const lastSelected = session.getItem('sphinx-tabs-last-selected'); + if (lastSelected != null) selectNamedTabs(lastSelected); +}); + +/** + * Key focus left and right between sibling elements using arrows + * @param {Node} e the element in focus when key was pressed + */ +function keyTabs(e) { + const tab = e.target; + let nextTab = null; + if (e.keyCode === 39 || e.keyCode === 37) { + tab.setAttribute("tabindex", -1); + // Move right + if (e.keyCode === 39) { + nextTab = tab.nextElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.firstElementChild; + } + // Move left + } else if (e.keyCode === 37) { + nextTab = tab.previousElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.lastElementChild; + } + } + } + + if (nextTab !== null) { + nextTab.setAttribute("tabindex", 0); + nextTab.focus(); + } +} + +/** + * Select or deselect clicked tab. If a group tab + * is selected, also select tab in other tabLists. + * @param {Node} e the element that was clicked + */ +function changeTabs(e) { + // Use this instead of the element that was clicked, in case it's a child + const notSelected = this.getAttribute("aria-selected") === "false"; + const positionBefore = this.parentNode.getBoundingClientRect().top; + const notClosable = !this.parentNode.classList.contains("closeable"); + + deselectTabList(this); + + if (notSelected || notClosable) { + selectTab(this); + const name = this.getAttribute("name"); + selectNamedTabs(name, this.id); + + if (this.classList.contains("group-tab")) { + // Persist during session + session.setItem('sphinx-tabs-last-selected', name); + } + } + + const positionAfter = this.parentNode.getBoundingClientRect().top; + const positionDelta = positionAfter - positionBefore; + // Scroll to offset content resizing + window.scrollTo(0, window.scrollY + positionDelta); +} + +/** + * Select tab and show associated panel. + * @param {Node} tab tab to select + */ +function selectTab(tab) { + tab.setAttribute("aria-selected", true); + + // Show the associated panel + document + .getElementById(tab.getAttribute("aria-controls")) + .removeAttribute("hidden"); +} + +/** + * Hide the panels associated with all tabs within the + * tablist containing this tab. + * @param {Node} tab a tab within the tablist to deselect + */ +function deselectTabList(tab) { + const parent = tab.parentNode; + const grandparent = parent.parentNode; + + Array.from(parent.children) + .forEach(t => t.setAttribute("aria-selected", false)); + + Array.from(grandparent.children) + .slice(1) // Skip tablist + .forEach(panel => panel.setAttribute("hidden", true)); +} + +/** + * Select grouped tabs with the same name, but no the tab + * with the given id. + * @param {Node} name name of grouped tab to be selected + * @param {Node} clickedId id of clicked tab + */ +function selectNamedTabs(name, clickedId=null) { + const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`); + const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode); + + tabLists + .forEach(tabList => { + // Don't want to change the tabList containing the clicked tab + const clickedTab = tabList.querySelector(`[id="${clickedId}"]`); + if (clickedTab === null ) { + // Select first tab with matching name + const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`); + deselectTabList(tab); + selectTab(tab); + } + }) +} + +if (typeof exports === 'undefined') { + exports = {}; +} + +exports.keyTabs = keyTabs; +exports.changeTabs = changeTabs; +exports.selectTab = selectTab; +exports.deselectTabList = deselectTabList; +exports.selectNamedTabs = selectNamedTabs; diff --git a/_static/term_role_formatting.css b/_static/term_role_formatting.css new file mode 100644 index 00000000..0b66095c --- /dev/null +++ b/_static/term_role_formatting.css @@ -0,0 +1,4 @@ +/* Make terms bold */ +a.reference span.std-term { + font-weight: bold; +} diff --git a/_static/togglebutton.css b/_static/togglebutton.css new file mode 100644 index 00000000..54a67879 --- /dev/null +++ b/_static/togglebutton.css @@ -0,0 +1,160 @@ +/** + * Admonition-based toggles + */ + +/* Visibility of the target */ +.admonition.toggle .admonition-title ~ * { + transition: opacity .3s, height .3s; +} + +/* Toggle buttons inside admonitions so we see the title */ +.admonition.toggle { + position: relative; +} + +/* Titles should cut off earlier to avoid overlapping w/ button */ +.admonition.toggle .admonition-title { + padding-right: 25%; + cursor: pointer; +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:hover { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 1%); +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:active { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 3%); +} + +/* Remove extra whitespace below the admonition title when hidden */ +.admonition.toggle-hidden { + padding-bottom: 0; +} + +.admonition.toggle-hidden .admonition-title { + margin-bottom: 0; +} + +/* hides all the content of a page until de-toggled */ +.admonition.toggle-hidden .admonition-title ~ * { + height: 0; + margin: 0; + opacity: 0; + visibility: hidden; +} + +/* General button style and position*/ +button.toggle-button { + /** + * Background and shape. By default there's no background + * but users can style as they wish + */ + background: none; + border: none; + outline: none; + + /* Positioning just inside the admonition title */ + position: absolute; + right: 0.5em; + padding: 0px; + border: none; + outline: none; +} + +/* Display the toggle hint on wide screens */ +@media (min-width: 768px) { + button.toggle-button.toggle-button-hidden:before { + content: attr(data-toggle-hint); /* This will be filled in by JS */ + font-size: .8em; + align-self: center; + } +} + +/* Icon behavior */ +.tb-icon { + transition: transform .2s ease-out; + height: 1.5em; + width: 1.5em; + stroke: currentColor; /* So that we inherit the color of other text */ +} + +/* The icon should point right when closed, down when open. */ +/* Open */ +.admonition.toggle button .tb-icon { + transform: rotate(90deg); +} + +/* Closed */ +.admonition.toggle button.toggle-button-hidden .tb-icon { + transform: rotate(0deg); +} + +/* With details toggles, we don't rotate the icon so it points right */ +details.toggle-details .tb-icon { + height: 1.4em; + width: 1.4em; + margin-top: 0.1em; /* To center the button vertically */ +} + + +/** + * Details-based toggles. + * In this case, we wrap elements with `.toggle` in a details block. + */ + +/* Details blocks */ +details.toggle-details { + margin: 1em 0; +} + + +details.toggle-details summary { + display: flex; + align-items: center; + cursor: pointer; + list-style: none; + border-radius: .2em; + border-left: 3px solid #1976d2; + background-color: rgb(204 204 204 / 10%); + padding: 0.2em 0.7em 0.3em 0.5em; /* Less padding on left because the SVG has left margin */ + font-size: 0.9em; +} + +details.toggle-details summary:hover { + background-color: rgb(204 204 204 / 20%); +} + +details.toggle-details summary:active { + background: rgb(204 204 204 / 28%); +} + +.toggle-details__summary-text { + margin-left: 0.2em; +} + +details.toggle-details[open] summary { + margin-bottom: .5em; +} + +details.toggle-details[open] summary .tb-icon { + transform: rotate(90deg); +} + +details.toggle-details[open] summary ~ * { + animation: toggle-fade-in .3s ease-out; +} + +@keyframes toggle-fade-in { + from {opacity: 0%;} + to {opacity: 100%;} +} + +/* Print rules - we hide all toggle button elements at print */ +@media print { + /* Always hide the summary so the button doesn't show up */ + details.toggle-details summary { + display: none; + } +} \ No newline at end of file diff --git a/_static/togglebutton.js b/_static/togglebutton.js new file mode 100644 index 00000000..215a7eef --- /dev/null +++ b/_static/togglebutton.js @@ -0,0 +1,187 @@ +/** + * Add Toggle Buttons to elements + */ + +let toggleChevron = ` + + + +`; + +var initToggleItems = () => { + var itemsToToggle = document.querySelectorAll(togglebuttonSelector); + console.log(`[togglebutton]: Adding toggle buttons to ${itemsToToggle.length} items`) + // Add the button to each admonition and hook up a callback to toggle visibility + itemsToToggle.forEach((item, index) => { + if (item.classList.contains("admonition")) { + // If it's an admonition block, then we'll add a button inside + // Generate unique IDs for this item + var toggleID = `toggle-${index}`; + var buttonID = `button-${toggleID}`; + + item.setAttribute('id', toggleID); + if (!item.classList.contains("toggle")){ + item.classList.add("toggle"); + } + // This is the button that will be added to each item to trigger the toggle + var collapseButton = ` + `; + + title = item.querySelector(".admonition-title") + title.insertAdjacentHTML("beforeend", collapseButton); + thisButton = document.getElementById(buttonID); + + // Add click handlers for the button + admonition title (if admonition) + admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`) + if (admonitionTitle) { + // If an admonition, then make the whole title block clickable + admonitionTitle.addEventListener('click', toggleClickHandler); + admonitionTitle.dataset.target = toggleID + admonitionTitle.dataset.button = buttonID + } else { + // If not an admonition then we'll listen for the button click + thisButton.addEventListener('click', toggleClickHandler); + } + + // Now hide the item for this toggle button unless explicitly noted to show + if (!item.classList.contains("toggle-shown")) { + toggleHidden(thisButton); + } + } else { + // If not an admonition, wrap the block in a
block + // Define the structure of the details block and insert it as a sibling + var detailsBlock = ` +
+ + ${toggleChevron} + ${toggleHintShow} + +
`; + item.insertAdjacentHTML("beforebegin", detailsBlock); + + // Now move the toggle-able content inside of the details block + details = item.previousElementSibling + details.appendChild(item) + item.classList.add("toggle-details__container") + + // Set up a click trigger to change the text as needed + details.addEventListener('click', (click) => { + let parent = click.target.parentElement; + if (parent.tagName.toLowerCase() == "details") { + summary = parent.querySelector("summary"); + details = parent; + } else { + summary = parent; + details = parent.parentElement; + } + // Update the inner text for the proper hint + if (details.open) { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintShow; + } else { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintHide; + } + + }); + + // If we have a toggle-shown class, open details block should be open + if (item.classList.contains("toggle-shown")) { + details.click(); + } + } + }) +}; + +// This should simply add / remove the collapsed class and change the button text +var toggleHidden = (button) => { + target = button.dataset['target'] + var itemToToggle = document.getElementById(target); + if (itemToToggle.classList.contains("toggle-hidden")) { + itemToToggle.classList.remove("toggle-hidden"); + button.classList.remove("toggle-button-hidden"); + } else { + itemToToggle.classList.add("toggle-hidden"); + button.classList.add("toggle-button-hidden"); + } +} + +var toggleClickHandler = (click) => { + // Be cause the admonition title is clickable and extends to the whole admonition + // We only look for a click event on this title to trigger the toggle. + + if (click.target.classList.contains("admonition-title")) { + button = click.target.querySelector(".toggle-button"); + } else if (click.target.classList.contains("tb-icon")) { + // We've clicked the icon and need to search up one parent for the button + button = click.target.parentElement; + } else if (click.target.tagName == "polyline") { + // We've clicked the SVG elements inside the button, need to up 2 layers + button = click.target.parentElement.parentElement; + } else if (click.target.classList.contains("toggle-button")) { + // We've clicked the button itself and so don't need to do anything + button = click.target; + } else { + console.log(`[togglebutton]: Couldn't find button for ${click.target}`) + } + target = document.getElementById(button.dataset['button']); + toggleHidden(target); +} + +// If we want to blanket-add toggle classes to certain cells +var addToggleToSelector = () => { + const selector = ""; + if (selector.length > 0) { + document.querySelectorAll(selector).forEach((item) => { + item.classList.add("toggle"); + }) + } +} + +// Helper function to run when the DOM is finished +const sphinxToggleRunWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} +sphinxToggleRunWhenDOMLoaded(addToggleToSelector) +sphinxToggleRunWhenDOMLoaded(initToggleItems) + +/** Toggle details blocks to be open when printing */ +if (toggleOpenOnPrint == "true") { + window.addEventListener("beforeprint", () => { + // Open the details + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.dataset["togglestatus"] = el.open; + el.open = true; + }); + + // Open the admonitions + document.querySelectorAll(".admonition.toggle.toggle-hidden").forEach((el) => { + console.log(el); + el.querySelector("button.toggle-button").click(); + el.dataset["toggle_after_print"] = "true"; + }); + }); + window.addEventListener("afterprint", () => { + // Re-close the details that were closed + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.open = el.dataset["togglestatus"] == "true"; + delete el.dataset["togglestatus"]; + }); + + // Re-close the admonition toggle buttons + document.querySelectorAll(".admonition.toggle").forEach((el) => { + if (el.dataset["toggle_after_print"] == "true") { + el.querySelector("button.toggle-button").click(); + delete el.dataset["toggle_after_print"]; + } + }); + }); +} diff --git a/aliases/index.html b/aliases/index.html new file mode 100644 index 00000000..6213cc4b --- /dev/null +++ b/aliases/index.html @@ -0,0 +1,337 @@ + + + + + + + Aliases and configuration — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Aliases and configuration

+
+

Objectives

+
    +

  • Learn to use aliases for most common commands.

    • +
+
+

Are you getting tired of typing so much? In Git you can define aliases (shortcuts):

+
    +

  • These are great because they can save you time typing.

    • +

  • But it’s easy to forget them, get confused, or be inconsistent with your colleagues.

    • +
+

There is plenty of other configuration for Git, that can make it nicer.

+
+

Aliases

+
    +

  • Aliases offer a way to improve the usability of Git: for +example git ci instead of git commit.

    • +

  • Aliases are based on simple string replacement in the command.

    • +

  • Aliases can either be specific to a repository or global.

    +
      +

    • Global aliases help you do the things you are used to across Git projects.

      • +

    • Per-project aliases can also be created.

      • +
    +
    • +

  • Global aliases are stored in ~/.gitconfig.

    • +
+
+
+

Example alias: git graph

+

A very useful shortcut which we use a lot in our workshops:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ cd your_git_repository
+$ git graph
+
+
+
+
+

Using external commands

+

It is possible to call external commands using the exclamation mark character “!”. +In this example here we create a local alias which is +stored in .git/config and not synchronized with remotes:

+
$ cd your_git_repository
+$ git config alias.hi '!echo hello'
+$ git hi
+
+
+
+

Food for thought: When to alias?

+
    +

  • How many times should you wait before aliasing a command?

    • +

  • Do you believe a list of generic two-letter acronyms for common commands will +save your time?

    • +
+
+
+
+

List of aliases the instructors use

+

You are welcome to reuse, suggest, improve. +You can see your current aliases in ~/.gitconfig.

+
$ git config --global alias.ap "add --patch"
+$ git config --global alias.br branch
+$ git config --global alias.ci "commit -v"
+$ git config --global alias.cip "commit --patch -v"
+$ git config --global alias.cl "clone --recursive"
+$ git config --global alias.di diff
+$ git config --global alias.dic "diff --staged --color-words"
+$ git config --global alias.diw "diff --color-words"
+$ git config --global alias.dis "!git --no-pager diff --stat"
+$ git config --global alias.fe fetch
+$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ git config --global alias.rem remote
+$ git config --global alias.st status
+$ git config --global alias.su "submodule update --init --recursive"
+
+
+

Here is what they do:

+
    +

  • ap: add, selecting parts individually, interactively.

    • +

  • br: branch (obvious)

    • +

  • ci: commit (check in), with -v option for clarity

    • +

  • cip: commit, selecting parts individually, interactively.

    • +

  • cl: clone, init submodules (submodules are an advanced topic)

    • +

  • di: diff (obvious)

    • +

  • dic: diff of staging area vs last commit (what is about to be committed)

    • +

  • diw: a word diff, color. Useful for small changes.

    • +

  • dis: a “diffstat”: what files are changed, not contents

    • +

  • fe: fetch (obvious)

    • +

  • graph: show whole git graph (so useful, some of us call it l)

    • +

  • rem: remote (obvious)

    • +

  • st: status (obvious)

    • +

  • su: submodule update (advanced)

    • +
+

A useful setting for the p aliases:

+
$ git config --global interactive.singlekey true
+
+
+
+
+

Advanced aliases

+

These are advanced aliases and configuration options. We won’t explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages!

+
$ git config --global alias.cif "commit -v -p --fixup"
+$ git config --global alias.rb "rebase --autosquash"
+$ git config --global alias.rbi "rebase --interactive --autosquash"
+$ git config --global alias.rbis "rebase --interactive --autosquash --autostash"
+$ git config --global alias.rbs "rebase --autosquash --autostash"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard"
+$ git config --global alias.new "log HEAD..HEAD@{upstream}"
+$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}"
+$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}"
+$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all"
+$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD"
+$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat"
+
+
+
+
+

Advanced Git configuration

+

Besides aliases, you can do plenty of other configuration of git. +Here are some of the most common ones:

+
$ git config --global interactive.singlekey true
+$ git config --global core.pager "less -RS"
+$ git config --global core.excludesfile ~/.gitignore
+$ git config --global merge.conflictstyle diff3
+$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]"
+$ git config --global diff.mnemonicPrefix true
+
+
+

Do you get tired of typing and copying and pasting your remote names +all the time, like git@github.com:myusername? You can create remote +aliases like this:

+
$ git config --global url.git@github.com:.insteadOf gh:
+$ git config --global url.git@github.com:/username/.insteadOf ghu:
+
+
+

Then, when you add a remote ghu:recipe, it will automatically be +translated to git@github.com:/username/recipe using a simple prefix +matching.

+
+

Keypoints

+
    +

  • If you are frustrated about remembering a command, you should create an alias.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/archaeology/index.html b/archaeology/index.html new file mode 100644 index 00000000..1855a63a --- /dev/null +++ b/archaeology/index.html @@ -0,0 +1,595 @@ + + + + + + + Inspecting history — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Inspecting history

+
+

Objectives

+
    +

  • Be able find a line of code, find out why it was introduced and when.

    • +

  • Be able to quickly find the commit that changed a behavior.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Command line, GitHub, and VS Code

+

As usual, we offer ways to do this with the command line, VS Code, and +GitHub.

+
    +

  • Command line is most powerful and relatively easy with this. +You may also use it along with other things. If you haven’t tried +it yet, we’d recommend you to give it a try.

    • +

  • The GitHub web interface allows many things to be done, but not +everything.

    • +

  • VS Code allows some of these, but for some it’s easier to open +the VS Code terminal and run git there.

    • +
+
+
+

Our toolbox for history inspection

+
+

Instructor note

+

First the instructor demonstrates few commands on a real life example +repository https://github.com/networkx/networkx (mentioned in the amazing site The +Programming Historian). +Later we will practice these in an archaeology exercise (below).

+
+
+

Warm-up: “Git History” browser

+

As a warm-up we can try the “Git History” browser +on the README.rst file of the networkx repository:

+ +
+
+

Searching text patterns in the repository

+

With git grep you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or +some error message printed.

+
+

The Git command is as described above:

+
$ git grep TEXT
+$ git grep "some text with spaces"
+
+
+

In the networkx repository you can try:

+
$ git clone https://github.com/networkx/networkx
+$ cd networkx
+$ git grep -i fixme
+
+
+

While git grep searches the current state of the repository, +it is also possible to search through all changes with git log -S sometext +which can be useful to find where something got removed.

+
+
+
+

Inspecting individual commits

+
+

We have seen this one before already. Using git show we can inspect an individual commit if +we know its hash:

+
$ git show HASH
+
+
+

For instance:

+
$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7
+
+
+
+
+
+

Line-by-line code annotation with metadata

+

With git annotate you can see line by line who and when the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility.

+
+
$ git annotate FILE
+
+
+

Example:

+
$ git annotate networkx/convert_matrix.py
+
+
+

If you annotate in a terminal and the file is longer than the screen, Git by default uses the program less to +scroll the output. +Use /sometext <ENTER> to find “sometext” and you can cycle through the results with n (next) and N (last). +You can also use page up/down to scroll. You can quit with q.

+
+
+

Discussion

+

Discuss how these relatively trivial changes affect the annotation:

+
    +

  • Wrapping long lines of text/code into shorter lines

    • +

  • Auto-formatting tools such as black

    • +

  • Editors that automatically remove trailing whitespace

    • +
+
+
+
+

Inspecting code in the past

+
+

We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code:

+
$ git switch --create BRANCHNAME HASH
+
+
+

Example (lines starting with “#” are only comments):

+
$ # create branch called "older-code" from hash 347e6292419b
+$ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9
+
+$ # now you can navigate and inspect the code as it was back then
+$ # ...
+
+$ # after we are done we can switch back to "main"
+$ git switch main
+
+$ # if we like we can delete the "older-code" branch
+$ git branch -d older-code
+
+
+

On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

+
$ git checkout -b BRANCHNAME SOMEHASH
+
+
+
+
+
+
+

Exercise

+

This is described with the command line method, but by looking above +you can translate to the other options.

+
+

Exercise: Explore basic archaeology commands (20 min)

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Make sure you are not inside another Git repository when running this +exercise. If you are, first step “outside” of it. +We want to avoid creating a Git repository inside another Git repository.

    +
    +

    You can check if you are inside a Git repository with:

    +
    $ git status
+
+fatal: not a git repository (or any of the parent directories): .git
+
    +
    +

    You want to see the above message which tells us that this is not a Git repository.

    +
    +
    • +

  • Clone this repository: +https://github.com/networkx/networkx.git.

    +
    +
    $ git clone https://github.com/networkx/networkx.git
+
    +
    +
    +
    • +

  • Then let us all make sure we are working on a well-defined version of the repository.

    +
    +

    Step into the new directory and create an exercise branch from the +networkx-2.6.3 tag/release:

    +
    $ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+
+
+
+

Finding out when something broke/changed with git bisect

+

This only works with the command line.

+
+

“But I am sure it used to work! Strange.”

+
+

Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke.

+
+

How would you solve this?

+

Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now.

+
    +

  • How would you find the commit which changed it?

    • +

  • Why could it be useful to know the commit that changed it?

    • +
+
+

We will probably arrive at a solution which is similar to git bisect:

+
    +

  • First find out a commit in past when it worked.

    +
    $ git bisect start
+$ git bisect good f0ea950  # this is a commit that worked
+$ git bisect bad main      # last commit is broken
+
    +
    +
    • +

  • Now compile and/or run and/or test and decide whether “good” or “bad”.

    • +

  • This is how you can tell Git that this was a working commit:

    +
    $ git bisect good
+
    +
    +
    • +

  • And this is how you can tell Git that this was not a working commit:

    +
    $ git bisect bad
+
    +
    +
    • +

  • Then bisect/iterate your way until you find the commit that broke it.

    • +

  • If you want to go back to start, type git bisect reset.

    • +

  • This can even be automatized with git bisect run SCRIPT. +For this you write a script that returns zero/non-zero (success/failure).

    • +
+
+
+

Optional exercise: Git bisect

+

This only works with the command line.

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+
+

Summary

+
    +

  • git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project on the command line.

    • +

  • git switch --create NAME HASH is the recommended mechanism to inspect old code on the command line.

    • +

  • Most of these commands can be used in the GitHub web interface (except git bisect).

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/basics/index.html b/basics/index.html new file mode 100644 index 00000000..e0659e5e --- /dev/null +++ b/basics/index.html @@ -0,0 +1,837 @@ + + + + + + + Basics — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Basics

+
+

Objectives

+
    +

  • Learn to create Git repositories and make commits.

    • +

  • Get a grasp of the structure of a repository.

    • +

  • Learn how to inspect the project history.

    • +

  • Learn how to write useful commit log messages.

    • +
+
+
+

Instructor note

+
    +

  • 35 min teaching/type-along

    • +

  • 40 min exercise

    • +
+
+
+

What is Git, and what is a Git repository?

+
    +

  • Git is a version control system: can record/save snapshots and track the content of a folder as it changes over time.

    • +

  • Every time we commit a snapshot, Git records a snapshot of the entire project, saves it, and assigns it a version.

    • +

  • These snapshots are kept inside a sub-folder called .git.

    • +

  • If we remove .git, we remove the repository and history (but keep the working directory!).

    • +

  • The directory .git uses relative paths - you can move the whole repository somewhere else and it will still work.

    • +

  • Git doesn’t do anything unless you ask it to (it does not record anything automatically).

    • +

  • Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces).

    • +
+
+
+

Recording a snapshot with Git

+
    +

  • Git takes snapshots only if we request it.

    • +

  • We will record changes in two steps (we will later explain why this is a recommended practice).

    • +

  • Example (we don’t need to type yet):

    +
    $ git add FILE.txt
+$ git commit
+
+$ git add FILE.txt ANOTHERFILE.txt
+$ git commit
+
    +
    +
    • +

  • We first focus (git add, we “stage” the change), then record (git commit):

    • +
+
+Git staging +
+

Git staging and committing.

+
+
+
+

Question for the more advanced participants

+

What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end.

+
+
+
+

Configuring Git command line

+

Before we start using Git on the command line, we need to configure Git. +This is also part of the +installation instructions +but we need to make sure we all have +set name, email address, editor, and +default branch:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+$ git config --global core.editor nano
+$ git config --global init.defaultBranch main
+
+
+

Verify with:

+
$ git config --list
+
+
+
+

Instructor note

+

Instructors, give learners enough time to do the above configuration steps.

+
+
+
+

Type-along: Tracking a guacamole recipe with Git

+

We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list)

+

The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language.

+
+

Instructor note

+

Instructors, please encourage now that participants type along.

+
+
+

Note

+

It is possible to go through this lesson in the command line or in the browser +(on GitHub).

+
    +

  • We recommend to start with the command line but later to also try in the browser.

    • +

  • If you get really stuck in the command line, try following in the browser and +later you can try to return to the command line.

    • +
+
+
+
+

Creating a repository

+

One of the basic principles of Git is that it is easy to create repositories:

+
+
$ mkdir recipe
+$ cd recipe
+$ git init -b main
+
+
+

That’s it! With git init -b main have now created an empty Git repository +where main is the default branch (more about branches later).

+

We will use git status a lot to check out what is going on:

+
$ git status
+
+On branch main
+
+No commits yet
+
+nothing to commit (create/copy files and use "git add" to track)
+
+
+

We will make sense of this information during this workshop.

+
+
+
+

Adding files and committing changes

+

Let us now create two files.

+

One file is called ingredients.txt and contains:

+
* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+
+
+

The second file is called instructions.txt and contains:

+
* chop avocados
+* chop onion
+* chop chili
+* squeeze lime
+* add salt
+* and mix well
+
+
+
+

As mentioned above, in Git you can always check the status of files in your repository using +git status. It is always a safe command to run and in general a good idea to +do when you are trying to figure out what to do next:

+
$ git status
+
+On branch main
+
+No commits yet
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    ingredients.txt
+    instructions.txt
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+

The two files are untracked in the repository (directory). You want to add the files (focus the camera) +to the list of files tracked by Git. Git does not track +any files automatically and you need make a conscious decision to add a file. Let’s do what +Git hints at, and add the files, one by one:

+
$ git add ingredients.txt
+$ git status
+
+On branch main
+
+No commits yet
+
+Changes to be committed:
+  (use "git rm --cached <file>..." to unstage)
+    new file:   ingredients.txt
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    instructions.txt
+
+
+

Now this change is staged and ready to be committed. +Let us now commit the change to the repository:

+
$ git commit -m "adding ingredients"
+
+[main (root-commit) f146d25] adding ingredients
+ 1 file changed, 4 insertions(+)
+ create mode 100644 ingredients.txt
+
+
+

Right after we query the status to get this useful command into our muscle memory:

+
$ git status
+
+
+

Now stage and commit also the other file:

+
$ git add instructions.txt
+$ git commit -m "adding instructions"
+
+
+

We will add a third file to the repository, README.md, containing:

+
# recipe
+
+This is an exercise repository.
+
+
+

Now stage and commit also the README.md file:

+
$ git add README.md
+$ git commit -m "adding README"
+
+
+

What does the -m flag mean? Let us check the help page for that command:

+
$ git help commit
+
+
+

You should see a very long help page as the tool is very versatile (press q to quit). +Do not worry about this now but keep in mind that you can always read the help files +when in doubt. Searching online can also be useful, but choosing search terms +to find relevant information takes some practice and discussions in some +online threads may be confusing. +Note that help pages also work when you don’t have a network connection!

+
+
+
+

Exercise: Record changes

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+
+
+

Git history and log

+
+

If you haven’t yet, please try now git log:

+
$ git log
+
+commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main)
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:47 2023 +0200
+
+    don't forget to enjoy
+
+commit 79161b6e67c62ad4688a58c1e54183334611a390
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:32 2023 +0200
+
+    add half an onion
+
+commit a3394e39535343c4dae3bb4f703741a31aa8b78a
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:47:14 2023 +0200
+
+    adding README
+
+commit 369624674e63de48055a65bf63055bd59c985d22
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:46:58 2023 +0200
+
+    adding instructions
+
+commit f146d25b94569a15e94d7f0da6f15d7554f76c49
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:35:52 2023 +0200
+
+    adding ingredients
+
+
+
+
    +

  • We can browse the development and access each state that we have committed.

    • +

  • The long hashes uniquely label a state of the code.

    • +

  • They are not just integers counting 1, 2, 3, 4, … (why?).

    • +

  • Output is in reverse chronological order, i.e. newest commits on top.

    • +

  • We will use them when comparing versions and when going back in time.

    • +

  • git log --oneline only shows the first 7 characters of the commit hash and is good to get an overview.

    • +

  • If the first characters of the hash are unique it is not necessary to type the entire hash.

    • +

  • git log --stat is nice to show which files have been modified.

    • +
+
+
+

Optional exercises: Comparing changes

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+
+
+

Writing useful commit messages

+

Using git log --oneline or browsing a repository on the web, we better +understand that the first line of the commit message is very important.

+

Good example:

+
increase threshold alpha to 2.0
+
+the motivation for this change is
+to enable ...
+...
+this is based on a discussion in #123
+
+
+

Convention: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

Ignoring files and paths with .gitignore

+
+

Discussion

+
    +

  • Should we add and track all files in a project?

    • +

  • How about generated files?

    • +

  • Why is it considered a bad idea to commit compiled binaries to version control?

    • +

  • What types of generated files do you know?

    • +
+
+

Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files. Example:

+
# ignore compiled python 2 files
+*.pyc
+# ignore compiled python 3 files
+__pycache__
+
+
+

An example taken from the official Git documentation:

+
# ignore objects and archives, anywhere in the tree.
+*.[oa]
+# ignore generated html files,
+*.html
+# except foo.html which is maintained by hand
+!foo.html
+# ignore everything under build directory
+build/
+
+
+
    +

  • .gitignore should be part of the repository because we want to make sure that all developers see the same behavior.

    • +

  • All files should be either tracked or ignored.

    • +

  • .gitignore uses something called a +shell glob syntax for +determining file patterns to ignore. You can read more about the syntax in the +documentation.

    • +

  • You can have .gitignore files in lower level directories and they affect the paths below.

    • +
+
+
+

Graphical user interfaces

+

We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI):

+ +
+
+

Summary

+

Now we know how to save snapshots:

+
$ git add FILE(S)
+$ git commit
+
+
+

And this is what we do as we program.

+

Every state is then saved and later we will learn how to go back to these “checkpoints” +and how to undo things.

+
$ git init -b main  # initialize new repository (main is default branch)
+$ git add           # add files or stage file(s)
+$ git commit        # commit staged file(s)
+$ git status        # see what is going on
+$ git log           # see history
+$ git diff          # show unstaged/uncommitted modifications
+$ git show          # show the change for a specific commit
+$ git mv            # move/rename tracked files
+$ git rm            # remove tracked files
+
+
+

Git is not ideal for large binary files +(for this consider git-annex).

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • It takes only one command to initialize a Git repository: git init -b main.

    • +

  • Commits should be used to tell a story.

    • +

  • Git uses the .git folder to store the snapshots.

    • +

  • Don’t be afraid to stage and commit often. Better too often than not often enough.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/.buildinfo b/branch/2023-version/.buildinfo new file mode 100644 index 00000000..e83ecfb1 --- /dev/null +++ b/branch/2023-version/.buildinfo @@ -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: 4202fab30366226cc703d00775a306ce +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/branch/2023-version/.nojekyll b/branch/2023-version/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/branch/2023-version/_images/add-file.png b/branch/2023-version/_images/add-file.png new file mode 100644 index 00000000..9683b2db Binary files /dev/null and b/branch/2023-version/_images/add-file.png differ diff --git a/branch/2023-version/_images/annotate.png b/branch/2023-version/_images/annotate.png new file mode 100644 index 00000000..8021920a Binary files /dev/null and b/branch/2023-version/_images/annotate.png differ diff --git a/branch/2023-version/_images/bare-repo.png b/branch/2023-version/_images/bare-repo.png new file mode 100644 index 00000000..1aa5699d Binary files /dev/null and b/branch/2023-version/_images/bare-repo.png differ diff --git a/branch/2023-version/_images/browse-files.png b/branch/2023-version/_images/browse-files.png new file mode 100644 index 00000000..5fcc3528 Binary files /dev/null and b/branch/2023-version/_images/browse-files.png differ diff --git a/branch/2023-version/_images/cheat-sheet.jpg b/branch/2023-version/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/branch/2023-version/_images/cheat-sheet.jpg differ diff --git a/branch/2023-version/_images/code-portion.png b/branch/2023-version/_images/code-portion.png new file mode 100644 index 00000000..39356bd5 Binary files /dev/null and b/branch/2023-version/_images/code-portion.png differ diff --git a/branch/2023-version/_images/commit-and-tree.png b/branch/2023-version/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/branch/2023-version/_images/commit-and-tree.png differ diff --git a/branch/2023-version/_images/commit-changes.png b/branch/2023-version/_images/commit-changes.png new file mode 100644 index 00000000..4c0546c6 Binary files /dev/null and b/branch/2023-version/_images/commit-changes.png differ diff --git a/branch/2023-version/_images/commits-and-parents.png b/branch/2023-version/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/branch/2023-version/_images/commits-and-parents.png differ diff --git a/branch/2023-version/_images/commits.png b/branch/2023-version/_images/commits.png new file mode 100644 index 00000000..b154c666 Binary files /dev/null and b/branch/2023-version/_images/commits.png differ diff --git a/branch/2023-version/_images/edit-file.png b/branch/2023-version/_images/edit-file.png new file mode 100644 index 00000000..f7527bd0 Binary files /dev/null and b/branch/2023-version/_images/edit-file.png differ diff --git a/branch/2023-version/_images/git-annotate.png b/branch/2023-version/_images/git-annotate.png new file mode 100644 index 00000000..60c6f7c2 Binary files /dev/null and b/branch/2023-version/_images/git-annotate.png differ diff --git a/branch/2023-version/_images/git-branch-1.svg b/branch/2023-version/_images/git-branch-1.svg new file mode 100644 index 00000000..1174a2e9 --- /dev/null +++ b/branch/2023-version/_images/git-branch-1.svg @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + m2 + + + m3 + + + m1 + + + + + main + + + + + HEAD + + + diff --git a/branch/2023-version/_images/git-branch-2.svg b/branch/2023-version/_images/git-branch-2.svg new file mode 100644 index 00000000..e3f7abfc --- /dev/null +++ b/branch/2023-version/_images/git-branch-2.svg @@ -0,0 +1,443 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + l1 + + + e2 + + + e1 + + + m5 + + + m4 + + + m2 + + + m3 + + + m1 + + + + + less-salt + + + + + HEAD + + + + + experiment + + + + + main + + + diff --git a/branch/2023-version/_images/git-branch-3.svg b/branch/2023-version/_images/git-branch-3.svg new file mode 100644 index 00000000..8916d588 --- /dev/null +++ b/branch/2023-version/_images/git-branch-3.svg @@ -0,0 +1,475 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + e2 + + + m3 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + + + less-salt + + + + + experiment + + + diff --git a/branch/2023-version/_images/git-collaborative.svg b/branch/2023-version/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/branch/2023-version/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/branch/2023-version/_images/git-deleted-branches.svg b/branch/2023-version/_images/git-deleted-branches.svg new file mode 100644 index 00000000..2b4b3fd5 --- /dev/null +++ b/branch/2023-version/_images/git-deleted-branches.svg @@ -0,0 +1,483 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + m5 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + diff --git a/branch/2023-version/_images/git-log-github.png b/branch/2023-version/_images/git-log-github.png new file mode 100644 index 00000000..db44d29b Binary files /dev/null and b/branch/2023-version/_images/git-log-github.png differ diff --git a/branch/2023-version/_images/git-log-terminal.png b/branch/2023-version/_images/git-log-terminal.png new file mode 100644 index 00000000..56493e6e Binary files /dev/null and b/branch/2023-version/_images/git-log-terminal.png differ diff --git a/branch/2023-version/_images/git-merge-1.svg b/branch/2023-version/_images/git-merge-1.svg new file mode 100644 index 00000000..34fd0f87 --- /dev/null +++ b/branch/2023-version/_images/git-merge-1.svg @@ -0,0 +1,515 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + m3 + + + l1 + + + m7 + + + m4 + + + + + experiment + + + + + less-salt + + + + + main + + + + + HEAD + + + diff --git a/branch/2023-version/_images/git-merge-2.svg b/branch/2023-version/_images/git-merge-2.svg new file mode 100644 index 00000000..5f5fd6a7 --- /dev/null +++ b/branch/2023-version/_images/git-merge-2.svg @@ -0,0 +1,555 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + l1 + + + m5 + + + m4 + + + + + experiment + + + + + main + + + + + HEAD + + + + + less-salt + + + diff --git a/branch/2023-version/_images/git-pre-ff.svg b/branch/2023-version/_images/git-pre-ff.svg new file mode 100644 index 00000000..df06fc7e --- /dev/null +++ b/branch/2023-version/_images/git-pre-ff.svg @@ -0,0 +1,615 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e1 + + + e2 + + + m7 + + + m8 + + + n3 + + + n1 + + + m5 + + + l1 + + + m6 + + + m4 + + + n2 + + + m2 + + + m3 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + main + + + diff --git a/branch/2023-version/_images/git_stage_commit.svg b/branch/2023-version/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/branch/2023-version/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/2023-version/_images/gophers.png b/branch/2023-version/_images/gophers.png new file mode 100644 index 00000000..741406ba Binary files /dev/null and b/branch/2023-version/_images/gophers.png differ diff --git a/branch/2023-version/_images/history.png b/branch/2023-version/_images/history.png new file mode 100644 index 00000000..6384e302 Binary files /dev/null and b/branch/2023-version/_images/history.png differ diff --git a/branch/2023-version/_images/meld.png b/branch/2023-version/_images/meld.png new file mode 100644 index 00000000..774f9cd1 Binary files /dev/null and b/branch/2023-version/_images/meld.png differ diff --git a/branch/2023-version/_images/mergetool.png b/branch/2023-version/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/branch/2023-version/_images/mergetool.png differ diff --git a/branch/2023-version/_images/new-bare-repo-form.png b/branch/2023-version/_images/new-bare-repo-form.png new file mode 100644 index 00000000..939e4f84 Binary files /dev/null and b/branch/2023-version/_images/new-bare-repo-form.png differ diff --git a/branch/2023-version/_images/new-repo-form.png b/branch/2023-version/_images/new-repo-form.png new file mode 100644 index 00000000..b808ee0b Binary files /dev/null and b/branch/2023-version/_images/new-repo-form.png differ diff --git a/branch/2023-version/_images/new-repo-plus.png b/branch/2023-version/_images/new-repo-plus.png new file mode 100644 index 00000000..e58ba5d8 Binary files /dev/null and b/branch/2023-version/_images/new-repo-plus.png differ diff --git a/branch/2023-version/_images/pen-symbol.png b/branch/2023-version/_images/pen-symbol.png new file mode 100644 index 00000000..044902a3 Binary files /dev/null and b/branch/2023-version/_images/pen-symbol.png differ diff --git a/branch/2023-version/_images/preview.png b/branch/2023-version/_images/preview.png new file mode 100644 index 00000000..8a602b66 Binary files /dev/null and b/branch/2023-version/_images/preview.png differ diff --git a/branch/2023-version/_images/search.png b/branch/2023-version/_images/search.png new file mode 100644 index 00000000..4462f71e Binary files /dev/null and b/branch/2023-version/_images/search.png differ diff --git a/branch/2023-version/_images/show.png b/branch/2023-version/_images/show.png new file mode 100644 index 00000000..12d7915c Binary files /dev/null and b/branch/2023-version/_images/show.png differ diff --git a/branch/2023-version/_images/staging-basics.svg b/branch/2023-version/_images/staging-basics.svg new file mode 100644 index 00000000..13df8bf5 --- /dev/null +++ b/branch/2023-version/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + restore + add + commit + restore + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/branch/2023-version/_images/stranger.jpg b/branch/2023-version/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/branch/2023-version/_images/stranger.jpg differ diff --git a/branch/2023-version/_sources/aliases.md.txt b/branch/2023-version/_sources/aliases.md.txt new file mode 100644 index 00000000..c3fd61ce --- /dev/null +++ b/branch/2023-version/_sources/aliases.md.txt @@ -0,0 +1,154 @@ +# Aliases and configuration + +```{objectives} +- Learn to use aliases for most common commands. +``` + +Are you getting tired of typing so much? In Git you can define aliases (shortcuts): +- These are great because they can save you time typing. +- But it's easy to forget them, get confused, or be inconsistent with your colleagues. + +There is plenty of other configuration for Git, that can make it nicer. + + +## Aliases + +- Aliases offer a way to improve the usability of Git: for + example `git ci` instead of `git commit`. +- Aliases are based on simple string replacement in the command. +- Aliases can either be specific to a repository or global. + - Global aliases help you do the things you are used to across Git projects. + - Per-project aliases can also be created. +- Global aliases are stored in `~/.gitconfig`. + + +## Example alias: git graph + +A very useful shortcut which we use a lot in our workshops: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ cd your_git_repository +$ git graph +``` + + +## Using external commands + +It is possible to call external commands using the exclamation mark character "!". +In this example here we create a local alias which is +stored in `.git/config` and not synchronized with remotes: + +```console +$ cd your_git_repository +$ git config alias.hi '!echo hello' +$ git hi +``` + +```{discussion} Food for thought: When to alias? +- How many times should you wait before aliasing a command? +- Do you believe a list of generic two-letter acronyms for common commands will + save your time? +``` + + +## List of aliases the instructors use + +You are welcome to reuse, suggest, improve. +You can see your current aliases in `~/.gitconfig`. + +```console +$ git config --global alias.ap "add --patch" +$ git config --global alias.br branch +$ git config --global alias.ci "commit -v" +$ git config --global alias.cip "commit --patch -v" +$ git config --global alias.cl "clone --recursive" +$ git config --global alias.di diff +$ git config --global alias.dic "diff --staged --color-words" +$ git config --global alias.diw "diff --color-words" +$ git config --global alias.dis "!git --no-pager diff --stat" +$ git config --global alias.fe fetch +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ git config --global alias.rem remote +$ git config --global alias.st status +$ git config --global alias.su "submodule update --init --recursive" +``` + +Here is what they do: +- `ap`: add, selecting parts individually, interactively. +- `br`: branch (obvious) +- `ci`: commit (check in), with `-v` option for clarity +- `cip`: commit, selecting parts individually, interactively. +- `cl`: clone, init submodules (submodules are an advanced topic) +- `di`: diff (obvious) +- `dic`: diff of staging area vs last commit (what is about to be committed) +- `diw`: a word diff, color. Useful for small changes. +- `dis`: a "diffstat": what files are changed, not contents +- `fe`: fetch (obvious) +- `graph`: show whole git graph (so useful, some of us call it `l`) +- `rem`: remote (obvious) +- `st`: status (obvious) +- `su`: submodule update (advanced) + +A useful setting for the `p` aliases: +```console +$ git config --global interactive.singlekey true +``` + + +## Advanced aliases + +These are advanced aliases and configuration options. We won't explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages! + +```console +$ git config --global alias.cif "commit -v -p --fixup" +$ git config --global alias.rb "rebase --autosquash" +$ git config --global alias.rbi "rebase --interactive --autosquash" +$ git config --global alias.rbis "rebase --interactive --autosquash --autostash" +$ git config --global alias.rbs "rebase --autosquash --autostash" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard" +$ git config --global alias.new "log HEAD..HEAD@{upstream}" +$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}" +$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}" +$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all" +$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD" +$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat" +``` + +## Advanced Git configuration + +Besides aliases, you can do plenty of other configuration of `git`. +Here are some of the most common ones: + +```console +$ git config --global interactive.singlekey true +$ git config --global core.pager "less -RS" +$ git config --global core.excludesfile ~/.gitignore +$ git config --global merge.conflictstyle diff3 +$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]" +$ git config --global diff.mnemonicPrefix true +``` + +Do you get tired of typing and copying and pasting your remote names +all the time, like `git@github.com:myusername`? You can create remote +aliases like this: + +```console +$ git config --global url.git@github.com:.insteadOf gh: +$ git config --global url.git@github.com:/username/.insteadOf ghu: +``` + +Then, when you add a remote `ghu:recipe`, it will automatically be +translated to `git@github.com:/username/recipe` using a simple prefix +matching. + + +```{keypoints} +- If you are frustrated about remembering a command, you should create an alias. +``` diff --git a/branch/2023-version/_sources/archaeology.md.txt b/branch/2023-version/_sources/archaeology.md.txt new file mode 100644 index 00000000..90465855 --- /dev/null +++ b/branch/2023-version/_sources/archaeology.md.txt @@ -0,0 +1,397 @@ +# Inspecting history + +```{objectives} +- Be able find a line of code, find out why it was introduced and when. +- Be able to quickly find the commit that changed a behavior. +``` + +```{instructor-note} +- 30 min teaching/type-along +- 30 min exercise +``` + +````{prereq} Preparation +Please make sure that you do not clone repositories inside an already tracked folder: + +```console +$ git status +``` + +If you are inside an existing Git repository, step out of it. +You need to find a different location since we will clone a new repository. + +If you see this message, this is good in this case: + +```shell +fatal: not a git repository (or any of the parent directories): .git +``` +```` + + +## Our toolbox for history inspection + +```{instructor-note} +First the instructor demonstrates few commands on a real life example +repository (mentioned in the amazing site [The +Programming Historian](https://programminghistorian.org/)). +Later we will practice these in an archaeology exercise (below). +``` + + +### Warm-up: ["Git History" browser](https://githistory.xyz/) + +As a warm-up we can try the ["Git History" browser](https://githistory.xyz/) +on the README.rst file of the [networkx](https://github.com/networkx/networkx) repository: + +- Visit and browse (use left/right keys). +- You can try this on some of your GitHub repositories, too! + + +### Searching text patterns in the repository + +`````{tabs} + ````{group-tab} Command line + With `git grep` you can find all lines in a repository which contain some string or regular expression. + This is useful to find out where in the code some variable is used or some error message printed: + + ```console + $ git grep TEXT + $ git grep "some text with spaces" + ``` + + In the [networkx](https://github.com/networkx/networkx) repository you can try: + + ```console + $ git clone https://github.com/networkx/networkx + $ cd networkx + $ git grep -i fixme + ``` + + While `git grep` searches the **current state** of the repository, + it is also possible to search through all changes with `git log -S sometext` + which can be useful to find where something got removed. + ```` + + ````{group-tab} Browser (GitHub) + We can try the same example in the browser: + + + ```{figure} img/archaeology/search.png + :alt: Searching for "fixme" in a GitHub repository + :width: 100% + :class: with-border + + Searching for "fixme" in a GitHub repository. + ``` + ```` +````` + + +### Inspecting individual commits + +`````{tabs} + ````{group-tab} Command line + We have seen this one before already. Using `git show` we can inspect an individual commit if + we know its hash: + + ```console + $ git show HASH + ``` + + For instance: + ```console + $ git show 759d589bdfa61aff99e0535938f14f67b01c83f7 + ``` + ```` + + ````{group-tab} Browser (GitHub) + We can try the same example in the browser: + + + ```{figure} img/archaeology/show.png + :alt: Inspecting an individual commit on GitHub + :width: 100% + :class: with-border + + Inspecting an individual commit on GitHub. + ``` + ```` +````` + + +### Line-by-line code annotation with metadata + +With `git annotate` you can see line by line who and **when** the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility. + +`````{tabs} + ````{group-tab} Command line + ```console + $ git annotate FILE + ``` + + Example: + ```console + $ git annotate networkx/convert_matrix.py + ``` + + If you annotate in a terminal and the file is longer than the screen, Git by default uses the program `less` to + scroll the output. + Use `/sometext` `` to find "sometext" and you can cycle through the results with `n` (next) and `N` (last). + You can also use page up/down to scroll. You can quit with `q`. + ```` + + ````{group-tab} Browser (GitHub) + We can try the same example in the browser: + + + ```{figure} img/archaeology/annotate.png + :alt: Screenshot of file annotation on GitHub + :width: 100% + :class: with-border + + Screenshot of file annotation on GitHub. + ``` + ```` +````` + +```{discussion} +Discuss how these relatively trivial changes affect the annotation: +- Wrapping long lines of text/code into shorter lines +- Auto-formatting tools such as `black` +- Editors that automatically remove trailing whitespace +``` + + +### Inspecting code in the past + +`````{tabs} + ````{group-tab} Command line + We can create branches pointing to a commit in the past. + This is the recommended mechanism to inspect old code: + + ```console + $ git switch --create BRANCHNAME HASH + ``` + + Example (lines starting with "#" are only comments): + + ```console + $ # create branch called "older-code" from hash 347e6292419b + $ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9 + + $ # now you can navigate and inspect the code as it was back then + $ # ... + + $ # after we are done we can switch back to "main" + $ git switch main + + $ # if we like we can delete the "older-code" branch + $ git branch -d older-code + ``` + + On old Git versions which do not know the `switch` command (before 2.23), you + need to use this instead: + + ```console + $ git checkout -b BRANCHNAME SOMEHASH + ``` + ```` + + ````{group-tab} Browser (GitHub) + We now know how to visit a specific commit: + + + Once we are there we can "Browse files" at that point in history. + + ```{figure} img/archaeology/browse-files.png + :alt: Browsing code in the past on GitHub + :width: 100% + :class: with-border + + Browsing code in the past on GitHub. + ``` + ```` +````` + + +(exercise-history)= + +## Exercise: Basic archaeology commands + +`````{exercise} History-1: Explore basic archaeology commands + Let us explore the value of these commands in an exercise. Future + exercises do not depend on this, so it is OK if you do not complete + it fully. + + Exercise steps: + - Clone this repository: + . + Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release: + ```console + $ git clone https://github.com/networkx/networkx.git + $ cd networkx + $ git switch --create exercise networkx-2.6.3 + ``` + On old Git versions which do not know the `switch` command (before 2.23), you + need to use this instead: + ```console + $ git checkout -b exercise networkx-2.6.3 + ``` + + Then using the above toolbox try to: + 1. Find the code line which contains `"Logic error in degree_correlation"`. + 2. Find out when this line was last modified or added. Find the actual commit which modified that line. + 3. Inspect that commit with `git show`. + 4. Create a branch pointing to the past when that commit was created to be + able to browse and use the code as it was back then. + 5. How would you bring the code to the version of the code right before that line was last modified? + + ````{solution} + We provide here a solution for the command line but we also encourage you to + try to solve this in the browser. + + 1. We use `git grep`: + ```console + $ git grep "Logic error in degree_correlation" + ``` + This gives the output: + ``` + networkx/algorithms/threshold.py: print("Logic error in degree_correlation", i, rdi) + ``` + Maybe you also want to know the line number: + ```console + $ git grep -n "Logic error in degree_correlation" + ``` + 2. We use `git annotate`: + ```console + $ git annotate networkx/algorithms/threshold.py + ``` + Then search for "Logic error" by typing "/Logic error" followed by Enter. + The last commit that modified it was `90544b4fa` (unless that line changed since). + 3. We use `git show`: + ```console + $ git show 90544b4fa + ``` + 4. Create a branch pointing to that commit (here we called the branch "past-code"): + ```console + $ git branch past-code 90544b4fa + ``` + 5. This is a compact way to access the first parent of `90544b4fa` (here we + called the branch "just-before"): + ```console + $ git switch --create just-before 90544b4fa~1 + ``` + ```` +````` + +--- + +## Finding out when something broke/changed with `git bisect` + +> *"But I am sure it used to work! Strange."* + +Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke. + +```{discussion} How would you solve this? +Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now. + +- How would you find the commit which changed it? +- Why could it be useful to know the commit that changed it? +``` + +We will probably arrive at a solution which is similar to `git bisect`: + +- First find out a commit in past when it worked. + ```console + $ git bisect start + $ git bisect good f0ea950 # this is a commit that worked + $ git bisect bad main # last commit is broken + ``` +- Now compile and/or run and/or test and decide whether "good" or "bad". +- This is how you can tell Git that this was a working commit: + ```console + $ git bisect good + ``` +- And this is how you can tell Git that this was not a working commit: + ```console + $ git bisect bad + ``` +- Then bisect/iterate your way until you find the commit that broke it. +- If you want to go back to start, type `git bisect reset`. +- This can even be automatized with `git bisect run SCRIPT`. + For this you write a script that returns zero/non-zero (success/failure). + +(exercise-bisect)= + +## Optional exercise: Git bisect + +````{exercise} (optional) History-2: Use git bisect to find the bad commit + In this exercise, we use `git bisect` on an example repository. It + is OK if you do not complete this exercise fully. + + Begin by cloning [https://github.com/coderefinery/git-bisect-exercise](https://github.com/coderefinery/git-bisect-exercise). + + + **Motivation** + + The motivation for this exercise is to be able to do archaeology with Git on a + source code where the bug is difficult to see visually. **Finding the offending + commit is often more than half the debugging**. + + + **Background** + + The script `get_pi.py` approximates pi using terms of the Nilakantha series. It + should produce 3.14 but it does not. The script broke at some point and + produces 3.57 using the last commit: + + ```console + $ python get_pi.py + + 3.57 + ``` + + At some point within the 500 first commits, an error was introduced. The only + thing we know is that the first commit worked correctly. + + + **Your task** + + - Clone this repository and use `git bisect` to find the commit which + broke the computation + ([solution - spoiler alert!](https://github.com/coderefinery/git-bisect-exercise#solutions-spoiler-alert)). + - Once you have found the offending commit, also practice navigating to the last good commit. + - Bonus exercise: + Write a script that checks for a correct result and use `git bisect run` to + find the offending commit automatically + ([solution - spoiler alert!](https://github.com/coderefinery/git-bisect-exercise#solutions-spoiler-alert)). + + + **Hints** + + Finding the first commit: + + ```console + $ git log --oneline | tail -n 1 + ``` + + How to navigate to the parent of a commit with hash SOMEHASH: + ```console + $ git switch --create BRANCHNAME SOMEHASH~1 + ``` + + Instead of a tilde you can also use this: + ```console + $ git switch --create BRANCHNAME SOMEHASH^ + ``` +```` + +```{keypoints} +- git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project. +- `git switch --create NAME HASH` is the recommended mechanism to inspect old code. +``` diff --git a/branch/2023-version/_sources/basics.md.txt b/branch/2023-version/_sources/basics.md.txt new file mode 100644 index 00000000..94038290 --- /dev/null +++ b/branch/2023-version/_sources/basics.md.txt @@ -0,0 +1,717 @@ +# Basics + +```{objectives} +- Learn to create Git repositories and make commits. +- Get a grasp of the structure of a repository. +- Learn how to inspect the project history. +- Learn how to write useful commit log messages. +``` + +```{instructor-note} +- 35 min teaching/type-along +- 40 min exercise +``` + + +## What is Git, and what is a Git repository? + +- Git is a version control system: can **record/save snapshots** and track the content of a folder as it changes over time. +- Every time we **commit** a snapshot, Git records a snapshot of the **entire project**, saves it, and assigns it a version. +- These snapshots are kept inside a sub-folder called `.git`. +- If we remove `.git`, we remove the repository and history (but keep the working directory!). +- The directory `.git` uses relative paths - you can move the whole repository somewhere else and it will still work. +- Git doesn't do anything unless you ask it to (it **does not record anything automatically**). +- Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces). + + +## Recording a snapshot with Git + +- Git takes snapshots only if we request it. +- We will record changes in two steps (we will later explain why this is a recommended practice). +- Example (we don't need to type yet): + + ```console + $ git add FILE.txt + $ git commit + + $ git add FILE.txt ANOTHERFILE.txt + $ git commit + ``` + +- We first focus (`git add`, we "stage" the change), then record (`git commit`): + +```{figure} img/git_stage_commit.svg +:alt: Git staging +:width: 100% + +Git staging and committing. +``` + +```{discussion} Question for the more advanced participants +What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end. +``` + + +## Configuring Git command line + +Before we start using Git on the command line, we need to configure Git. +This is also part of the +[installation instructions](https://coderefinery.github.io/installation/shell-and-git/#configuration) +but we need to make sure we all have +set name, email address, editor, and +default branch: +```console +$ git config --global user.name "Your Name" +$ git config --global user.email yourname@example.com +$ git config --global core.editor nano +$ git config --global init.defaultBranch main +``` + +Verify with: +```console +$ git config --list +``` + +```{instructor-note} +Instructors, give learners enough time to do the above configuration steps. +``` + + +## Type-along: Tracking a guacamole recipe with Git + +We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list) + +The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language. + +```{instructor-note} +Instructors, please encourage now that participants type along. +``` + +```{note} +It is possible to go through this lesson in the command line or in the browser +(on GitHub). + +- We recommend to start with the command line but later to also try in the browser. +- If you get really stuck in the command line, try following in the browser and + later you can try to return to the command line. +``` + + +## Creating a repository + +One of the basic principles of Git is that it is **easy to create repositories**: + +`````{tabs} + ````{group-tab} Command line + ```console + $ mkdir recipe + $ cd recipe + $ git init -b main + ``` + + That's it! With `git init -b main` have now created an empty Git repository + where `main` is the default branch (more about branches later). + + We will use `git status` a lot to check out what is going on: + + ```console + $ git status + + On branch main + + No commits yet + + nothing to commit (create/copy files and use "git add" to track) + ``` + + We will make sense of this information during this workshop. + ```` + + ````{group-tab} Browser (GitHub) + First log into GitHub, then follow the screenshots and descriptions below. + + ```{figure} img/basics/new-repo-plus.png + :alt: Screenshot on GitHub before a new repository form is opened + :width: 100% + :class: with-border + + Click on the "plus" symbol on top right, then on "New repository". + ``` + + Another way to create a new repository is to visit + directly. + + ```{figure} img/basics/new-repo-form.png + :alt: Screenshot on GitHub just before creating a new repository + :width: 100% + :class: with-border + + Choose a repository name, add a short description, **check "Add a + README file"**, finally "Create repository". + ``` + + After you have clicked "Create repository" you should see a repository overview + with one file (README.md) and one commit. + ```` +````` + + +## Adding files and committing changes + +Let us now **create two files**. + +One file is called `ingredients.txt` and contains: +```shell +* 2 avocados +* 1 chili +* 1 lime +* 2 tsp salt +``` + +The second file is called `instructions.txt` and contains: +```shell +* chop avocados +* chop onion +* chop chili +* squeeze lime +* add salt +* and mix well +``` + +`````{tabs} + ````{group-tab} Command line + As mentioned above, in Git you can always check the status of files in your repository using + `git status`. It is always a safe command to run and in general a good idea to + do when you are trying to figure out what to do next: + + ```console + $ git status + + On branch main + + No commits yet + + Untracked files: + (use "git add ..." to include in what will be committed) + ingredients.txt + instructions.txt + + nothing added to commit but untracked files present (use "git add" to track) + ``` + + The two files are untracked in the repository (directory). You want to **add the files** (focus the camera) + to the list of files tracked by Git. Git does not track + any files automatically and you need make a conscious decision to add a file. Let's do what + Git hints at, and add the files, one by one: + + ```console + $ git add ingredients.txt + $ git status + + On branch main + + No commits yet + + Changes to be committed: + (use "git rm --cached ..." to unstage) + new file: ingredients.txt + + Untracked files: + (use "git add ..." to include in what will be committed) + instructions.txt + ``` + + Now this change is *staged* and ready to be committed. + Let us now commit the change to the repository: + ```console + $ git commit -m "adding ingredients" + + [main (root-commit) f146d25] adding ingredients + 1 file changed, 4 insertions(+) + create mode 100644 ingredients.txt + ``` + + Right after we query the status to get this useful command into our muscle memory: + ```console + $ git status + ``` + + Now stage and commit also the other file: + ```console + $ git add instructions.txt + $ git commit -m "adding instructions" + ``` + + We will add a third file to the repository, `README.md`, containing: + ```markdown + # recipe + + This is an exercise repository. + ``` + + Now stage and commit also the `README.md` file: + ```console + $ git add README.md + $ git commit -m "adding README" + ``` + + What does the `-m` flag mean? Let us check the help page for that command: + ```console + $ git help commit + ``` + + You should see a very long help page as the tool is very versatile (press q to quit). + Do not worry about this now but keep in mind that you can always read the help files + when in doubt. Searching online can also be useful, but choosing search terms + to find relevant information takes some practice and discussions in some + online threads may be confusing. + Note that help pages also work when you don't have a network connection! + ```` + + ````{group-tab} Browser (GitHub) + ```{figure} img/basics/add-file.png + :alt: Screenshot on GitHub before a new file is created + :width: 100% + :class: with-border + + Click on "Add file", then "Create new file". + ``` + + ```{figure} img/basics/edit-file.png + :alt: Screenshot on GitHub when editing a file + :width: 100% + :class: with-border + + Edit the file and specify the file name. + ``` + + ```{figure} img/basics/commit-changes.png + :alt: Screenshot on GitHub when editing the commit message + :width: 100% + :class: with-border + + Before you commit the change, adjust the commit message. + ``` + + After you have added `ingredients.txt`, add also `instructions.txt` in a similar + way. + + We have added two files, each in one commit. However, we ended up with + three files and three commits since `README.md` was automatically committed + when we created the repository on GitHub. + ```` +````` + + +(exercise-record-changes)= + +## Exercise: Record changes + +``````{exercise} Basic-1: Record changes + Add 1/2 onion to `ingredients.txt` and also the instruction + to "enjoy!" to `instructions.txt`. + + `````{tabs} + ````{group-tab} Command line + After modifying the files, do not stage the changes yet (do not `git add` + yet). + + When you are done editing the files, try `git diff`: + ```console + $ git diff + ``` + + You will see (can you identify in there the two added lines?): + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index 4422a31..ba8854f 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -2,3 +2,4 @@ + * 1 chili + * 1 lime + * 2 tsp salt + +* 1/2 onion + diff --git a/instructions.txt b/instructions.txt + index 7811273..2b11074 100644 + --- a/instructions.txt + +++ b/instructions.txt + @@ -4,3 +4,4 @@ + * squeeze lime + * add salt + * and mix well + +* enjoy! + ``` + + Now first stage and commit each change separately (what happens when we leave out the `-m` flag?): + ```console + $ git add ingredients.txt + $ git commit -m "add half an onion" + $ git add instructions.txt + $ git commit # <-- we have left out -m "..." + ``` + + When you leave out the `-m` flag, Git should open an editor where you can edit + your commit message. This message will be associated and stored with the + changes you made. This message is your chance to explain what you've done and + convince others (and your future self) that the changes you made were + justified. Write a message and save and close the file. + + When you are done committing the changes, experiment with these commands: + ```console + $ git log + $ git log --stat + $ git log --oneline + ``` + ```` + + ````{group-tab} Browser (GitHub) + We can make modifications to a file by clicking on the file and then the + pen symbol: + ```{figure} img/basics/pen-symbol.png + :alt: Screenshot on GitHub before clicking on the pen symbol + :width: 100% + :class: with-border + + By clicking on the pen symbol we can switch to edit mode. + ``` + + ```{figure} img/basics/preview.png + :alt: Screenshot on GitHub when previewing file changes + :width: 100% + :class: with-border + + Before committing the change, click on "Preview". + ``` + + Our goal is to arrive at two new commits: + - "add half an onion" (modifying `ingredients.txt`) + - "don't forget to enjoy" (modifying `instructions.txt`) + + When you are done committing the changes, try to browse commit history + on GitHub. + ```` + ````` +`````` + + +## Git history and log + +`````{tabs} + ````{group-tab} Command line + If you haven't yet, please try now `git log`: + + ```console + $ git log + + commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main) + Author: Radovan Bast + Date: Sun Sep 17 19:12:47 2023 +0200 + + don't forget to enjoy + + commit 79161b6e67c62ad4688a58c1e54183334611a390 + Author: Radovan Bast + Date: Sun Sep 17 19:12:32 2023 +0200 + + add half an onion + + commit a3394e39535343c4dae3bb4f703741a31aa8b78a + Author: Radovan Bast + Date: Sun Sep 17 18:47:14 2023 +0200 + + adding README + + commit 369624674e63de48055a65bf63055bd59c985d22 + Author: Radovan Bast + Date: Sun Sep 17 18:46:58 2023 +0200 + + adding instructions + + commit f146d25b94569a15e94d7f0da6f15d7554f76c49 + Author: Radovan Bast + Date: Sun Sep 17 18:35:52 2023 +0200 + + adding ingredients + ``` + ```` + + ````{group-tab} Browser (GitHub) + ```{figure} img/basics/commits.png + :alt: Screenshot on GitHub before clicking on commit history + :width: 100% + :class: with-border + + Click on the history symbol with (here) 5 commits. + ``` + + ```{figure} img/basics/history.png + :alt: Screenshot of GitHub repository commit history + :width: 100% + :class: with-border + + In this overview you can browse each commit individually. + ``` + + On GitHub you can also compare arbitrary two commits (replace "USER", + "HASH1", and "HASH2"): + `https://github.com/USER/recipe/compare/HASH1..HASH2` + + Try it with two of your commits. + ```` +````` + +- We can browse the development and access each state that we have committed. +- The long hashes uniquely label a state of the code. +- They are not just integers counting 1, 2, 3, 4, ... (why?). +- Output is in reverse chronological order, i.e. **newest commits on top**. +- We will use them when comparing versions and when going back in time. +- `git log --oneline` only shows the first 7 characters of the commit hash and is good to get an overview. +- If the first characters of the hash are unique it is not necessary to type the entire hash. +- `git log --stat` is nice to show which files have been modified. + + +(exercise-diff-and-rename)= + +## Optional exercises: Comparing changes + +``````{exercise} (optional) Basic-2: Comparing and showing commits + `````{tabs} + ````{group-tab} Command line + 1. Have a look at specific commits with `git show HASH`. + 2. Inspect differences between commit hashes with `git diff HASH1 HASH2`. + ```` + + ````{group-tab} Browser (GitHub) + 1. Have a look at specific commits. + 2. Inspect differences between commits. + + Use the screenshots under "Git history and log". + ```` + ````` +`````` + +````{exercise} (optional) Basic-3: Visual diff tools + This exercise is only relevant for the command line. In the browser, + the preview is already side-by-side and "visual". + + - Make further modifications and experiment with `git difftool` (requires installing one of the [visual diff tools](https://coderefinery.github.io/installation/difftools/)): + + On Windows or Linux: + ```console + $ git difftool --tool=meld HASH + ``` + + On macOS: + ```console + $ git difftool --tool=opendiff HASH + ``` + + ```{figure} img/meld.png + :alt: Git difftool using meld + :width: 100% + + Git difftool using meld. + ``` + + You probably want to use the same visual diff tool every time and + you can configure Git for that: + ```console + $ git config --global diff.tool meld + ``` +```` + +```{exercise} (optional) Basic-4: Browser and command line +You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both. + +- If you have managed to do the above in the command line, try now in the browser. +- If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git. +``` + + +## Writing useful commit messages + +Using `git log --oneline` or browsing a repository on the web, we better +understand that the first line of the commit message is very important. + +Good example: +```text +increase threshold alpha to 2.0 + +the motivation for this change is +to enable ... +... +this is based on a discussion in #123 +``` + +Convention: **one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary**. + +- **Why something was changed is more important than what has changed.** +- Cross-reference to issues and discussions if possible/relevant. +- Bad commit messages: "fix", "oops", "save work" +- Bad examples: [http://whatthecommit.com](http://whatthecommit.com) +- Write commit messages in English that will be understood + 15 years from now by someone else than you. Or by your future you. +- Many projects start out as projects "just for me" and end up to be successful projects + that are developed by 50 people over decades. +- [Commits with multiple authors](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) are possible. + +Good references: + +- ["My favourite Git commit"](https://fatbusinessman.com/2019/my-favourite-git-commit) +- ["On commit messages"](https://who-t.blogspot.com/2009/12/on-commit-messages.html) +- ["How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/) + +```{note} +A great way to learn how to write commit messages and to get inspired by their +style choices: **browse repositories of codes that you use/like**: + +Some examples (but there are so many good examples): +- [SciPy](https://github.com/scipy/scipy/commits/main) +- [NumPy](https://github.com/numpy/numpy/commits/main) +- [Pandas](https://github.com/pandas-dev/pandas/commits/main) +- [Julia](https://github.com/JuliaLang/julia/commits/master) +- [ggplot2](https://github.com/tidyverse/ggplot2/commits/main), + compare with their [release + notes](https://github.com/tidyverse/ggplot2/releases) +- [Flask](https://github.com/pallets/flask/commits/main), + compare with their [release + notes](https://github.com/pallets/flask/blob/main/CHANGES.rst) + +When designing commit message styles consider also these: +- How will you easily generate a changelog or release notes? +- During code review, you can help each other improving commit messages. +``` + +But remember: it is better to make any commit, than no commit. Especially in small projects. +**Let not the perfect be the enemy of the good enough**. + + +(gitignore)= + +## Ignoring files and paths with .gitignore + +```{discussion} +- Should we add and track all files in a project? +- How about generated files? +- Why is it considered a bad idea to commit compiled binaries to version control? +- What types of generated files do you know? +``` + +Compiled and generated files are not +committed to version control. There are many reasons for this: + +- These files can make it more difficult to run on different platforms. +- These files are automatically generated and thus do not contribute in any meaningful way. +- When tracking generated files you could see differences in the code although you haven't touched the code. + +For this we use `.gitignore` files. Example: +```shell +# ignore compiled python 2 files +*.pyc +# ignore compiled python 3 files +__pycache__ +``` + +An example taken from the [official Git documentation](https://git-scm.com/docs/gitignore): +```shell +# ignore objects and archives, anywhere in the tree. +*.[oa] +# ignore generated html files, +*.html +# except foo.html which is maintained by hand +!foo.html +# ignore everything under build directory +build/ +``` + +- `.gitignore` should be part of the repository because we want to make sure that all developers see the same behavior. +- **All files should be either tracked or ignored**. +- `.gitignore` uses something called a + [shell glob syntax](https://en.wikipedia.org/wiki/Glob_(programming)) for + determining file patterns to ignore. You can read more about the syntax in the + [documentation](https://git-scm.com/docs/gitignore). +- You can have `.gitignore` files in lower level directories and they affect the paths below. + + +## Graphical user interfaces + +We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI): + +- [GitHub Desktop](https://desktop.github.com) +- [SourceTree](https://www.sourcetreeapp.com) +- [List of third-party GUIs](https://git-scm.com/downloads/guis) + + +## Summary + +Now we know how to save snapshots: + +```console +$ git add FILE(S) +$ git commit +``` + +And this is what we do as we program. + +Every state is then saved and later we will learn how to go back to these "checkpoints" +and how to undo things. + +```console +$ git init -b main # initialize new repository (main is default branch) +$ git add # add files or stage file(s) +$ git commit # commit staged file(s) +$ git status # see what is going on +$ git log # see history +$ git diff # show unstaged/uncommitted modifications +$ git show # show the change for a specific commit +$ git mv # move/rename tracked files +$ git rm # remove tracked files +``` + +Git is not ideal for large binary files +(for this consider [git-annex](http://git-annex.branchable.com)). + +````{challenge} Basic-5: Test your understanding + Which command(s) below would save the changes of `myfile.txt` + to an existing local Git repository? + + 1. ```console + $ git commit -m "my recent changes" + ``` + 2. ```console + $ git init myfile.txt + $ git commit -m "my recent changes" + ``` + 3. ```console + $ git add myfile.txt + $ git commit -m "my recent changes" + ``` + 4. ```console + $ git commit -m myfile.txt "my recent changes" + ``` + ```{solution} + + 1. Would only create a commit if files have already been staged. + 2. Would try to create a new repository in a folder "myfile.txt". + 3. **Is correct: first add the file to the staging area, then commit.** + 4. Would try to commit a file "my recent changes" with the message myfile.txt. + ``` +```` + +```{keypoints} +- It takes only one command to initialize a Git repository: `git init -b main`. +- Commits should be used to tell a story. +- Git uses the .git folder to store the snapshots. +- Don't be afraid to stage and commit often. Better too often than not often enough. +``` diff --git a/branch/2023-version/_sources/branches.md.txt b/branch/2023-version/_sources/branches.md.txt new file mode 100644 index 00000000..418e4d67 --- /dev/null +++ b/branch/2023-version/_sources/branches.md.txt @@ -0,0 +1,624 @@ +# Branching and merging + +```{objectives} +- Be able to create and merge branches. +- Know the difference between a branch and a tag. +``` + +```{instructor-note} +- 30 min teaching/type-along +- 20 min exercise +``` + + +## Motivation for branches + +In the previous section we tracked a guacamole recipe with Git. + +Up until now our repository had only one branch with one commit coming +after the other: + +```{figure} img/gitink/git-branch-1.svg +:alt: Linear Git repository +:width: 40% + +Linear Git repository. +``` + +- Commits are depicted here as little boxes with abbreviated hashes. +- Here the branch `main` points to a commit. +- "HEAD" is the current position (remember the recording head of tape + recorders?). When we say `HEAD`, we mean those literal letters - + this isn't a placeholder for something else. +- When we talk about branches, we often mean all parent commits, not only the commit pointed to. + +**Now we want to do this:** + +```{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +``` + +Software development is often not linear: + +- We typically need at least one version of the code to "work" (to compile, to give expected results, ...). +- At the same time we work on new features, often several features concurrently. + Often they are unfinished. +- We need to be able to separate different lines of work really well. + +The strength of version control is that it permits the researcher to **isolate +different tracks of work**, which can later be merged to create a composite +version that contains all changes: + +```{figure} img/gitink/git-collaborative.svg +:alt: Isolated tracks of work +:width: 100% + +Isolated tracks of work. +``` + +- We see branching points and merging points. +- Main line development is often called `main` or `master`. +- Other than this convention there is nothing special about `main` or `master`, it is a branch like any other. +- Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow). + +A group of commits that create a single narrative are called a **branch**. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. "fast sequence extraction" or "Python interface" or "fixing bug in +matrix inversion algorithm". + +````{admonition} **An important alias** +--- +class: important +--- + +We will now define an *alias* in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). **This is extensively used in the rest of this +and other lessons**: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` +```` + +```{instructor-note} +Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative. +``` + +Let us inspect the project history using the `git graph` alias: + +```console +$ git graph + +* e7cf023 (HEAD -> main) don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +- We have a couple commits and only + one development line (branch) and this branch is called `main`. +- Commits are states characterized by a 40-character hash (checksum). +- `git graph` print abbreviations of these checksums. +- **Branches are pointers that point to a commit.** +- Branch `main` points to a commit (in this example it is `e7cf023efe382340e5284c278c6ae2c087dd3ff7` but on your computer + the hash will be different). +- `HEAD` is another pointer, it points to where we are right now (currently `main`) + +In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards. + + +## Creating and working with branches + +```{instructor-note} +We do the following part together. Encourage participants to type along. +``` + +```{admonition} It is possible to create and merge branches directly on GitHub +- However, we do not have screenshots for that in this episode +- But if you prefer to work in the browser, please try it +- Please contribute screenshots to this lesson +``` + +Let's create a branch called `experiment` where we add cilantro to `ingredients.txt` +(text after "#" are comments and not part of the command). + +```console +$ git branch experiment main # creates branch "experiment" from "main" +$ git switch experiment # switch to branch "experiment" +$ git branch # list all local branches and show on which branch we are +``` + +```{note} +In case `git switch` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git switch`. +``` + +- Verify that you are on the `experiment` branch (note that `git graph` also + makes it clear what branch you are on: `HEAD -> branchname`): + ```console + $ git branch + + * experiment + main + ``` + This command shows where we are, it does not create a branch. + +- Then add 2 tbsp cilantro **on top** of the `ingredients.txt`: + + ```{code-block} shell + --- + emphasize-lines: 1 + --- + * 2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + * 2 tsp salt + * 1/2 onion + ``` + +- Stage this and commit it with the message "let us try with some cilantro". +- Then reduce the amount of cilantro to 1 tbsp, stage and commit again with "maybe little bit less cilantro". + +We have created **two new commits**: + +```{code-block} console +--- +emphasize-lines: 3-4 +--- +$ git graph + +* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro +* f6ec7b7 let us try with some cilantro +* e7cf023 (main) don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +- The branch `experiment` is two commits ahead of `main`. +- We commit our changes to this branch. + + +(exercise-branches)= + +## Exercise: Create and commit to branches + +````{exercise} Branch-1: Create and commit to branches + In this exercise, you will create another new branch and few more commits. + We will use this in the next section, to practice + merging. **The goal of the exercise is to end up with 3 branches**. + + - Change to the branch `main`. + - Create another branch called `less-salt`. + - Note! makes sure you are on main branch when you create the `less-salt` branch. + - A safer way would be to explicitly mention to create from the main branch + as shown below: + ```console + $ git branch less-salt main + ``` + - Switch to the `less-salt` branch. + - On the `less-salt` branch reduce the amount of salt. + - Commit your changes to the `less-salt` branch. + + Use the same commands as we used above. + + We now have three branches (in this case `HEAD` points to `less-salt`): + + ```console + $ git branch + + experiment + * less-salt + main + + $ git graph + + * bf28166 (HEAD -> less-salt) reduce amount of salt + | * bcb8b78 (experiment) maybe little bit less cilantro + | * f6ec7b7 let us try with some cilantro + |/ + * e7cf023 (main) don't forget to enjoy + * 79161b6 add half an onion + * a3394e3 adding README + * 3696246 adding instructions + * f146d25 adding ingredients + ``` + + Here is a graphical representation of what we have created: + + ```{figure} img/gitink/git-branch-2.svg + ``` + + - Now switch to `main`. + - In a new commit, improve the `README.md` file (we added the word "Guacamole"): + + ```markdown + # Guacamole recipe + + This is an exercise repository. + ``` + + Now you should have this situation: + + ```console + $ git graph + + * b4af65b (HEAD -> main) improve the documentation + | * bf28166 (less-salt) reduce amount of salt + |/ + | * bcb8b78 (experiment) maybe little bit less cilantro + | * f6ec7b7 let us try with some cilantro + |/ + * e7cf023 don't forget to enjoy + * 79161b6 add half an onion + * a3394e3 adding README + * 3696246 adding instructions + * f146d25 adding ingredients + ``` + + ```{figure} img/gitink/git-branch-3.svg + ``` + + And for comparison this is how it looks [on GitHub](https://github.com/coderefinery/recipe-before-merge/network). +```` + +(exercise-branches-merging)= + +## Exercise: Merging branches + +It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge `experiment` into `main`. + +```{exercise} Branch-2: Merge branches +Merge `experiment` and `less-salt` back into `main` following the lesson below +until the point where we start deleting branches. +``` + +````{admonition} If you got stuck in the above exercises or joined later + **If you got stuck in the above exercises or joined later**, + you can apply the commands below. + But **skip this box if you managed to create branches**. + + ```console + $ cd .. # step out of the current directory + + $ git clone https://github.com/coderefinery/recipe-before-merge.git + $ cd recipe-before-merge + + $ git switch experiment + $ git switch less-salt + $ git switch main + + $ git remote remove origin + + $ git graph + ``` + + Or call a helper to un-stuck it for you. +```` + +First we make sure we are on the branch we wish to merge **into**: + +```{code-block} console +--- +emphasize-lines: 5 +--- +$ git branch + + experiment + less-salt +* main +``` + +Then we merge `experiment` into `main`: + +```console +$ git merge experiment +``` + +```{figure} img/gitink/git-merge-1.svg +``` + +We can verify the result: + +```console +$ git graph + +* 81fcc0c (HEAD -> main) Merge branch 'experiment' +|\ +| * bcb8b78 (experiment) maybe little bit less cilantro +| * f6ec7b7 let us try with some cilantro +* | b4af65b improve the documentation +|/ +| * bf28166 (less-salt) reduce amount of salt +|/ +* e7cf023 don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents. + +To view the branches that are merged into the current branch we can use the command: + +```console +$ git branch --merged + + experiment +* main +``` + +We are also happy with the work on the `less-salt` branch. Let us merge that +one, too, into `main`: + +```console +$ git branch # make sure you are on main +$ git merge less-salt +``` + +```{figure} img/gitink/git-merge-2.svg +:alt: Commit graph after merge + +Commit graph after merge. +``` + +We can verify the result in the terminal: + +```console +$ git graph + +* 4e03d4b (HEAD -> main) Merge branch 'less-salt' +|\ +| * bf28166 (less-salt) reduce amount of salt +* | 81fcc0c Merge branch 'experiment' +|\ \ +| * | bcb8b78 (experiment) maybe little bit less cilantro +| * | f6ec7b7 let us try with some cilantro +| |/ +* / b4af65b improve the documentation +|/ +* e7cf023 don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +Observe how Git nicely merged the changed amount of salt and the new ingredient **in the same file +without us merging it manually**: + +```console +$ cat ingredients.txt + +* 1 tbsp cilantro +* 2 avocados +* 1 chili +* 1 lime +* 1 tsp salt +* 1/2 onion +``` + +If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually *settle merge conflicts* (we will do that later). + + +## Deleting branches safely + +Both feature branches are merged: + +```console +$ git branch --merged + + experiment + less-salt +* main +``` + +This means we can delete the branches: + +```console +$ git branch -d experiment +$ git branch -d less-salt +``` + +This is the result: + +```{figure} img/gitink/git-deleted-branches.svg +:alt: Commit graph after merged branches were deleted + +Commit graph after merged branches were deleted. +``` + +We observe that when deleting branches, +only the pointers ("sticky notes") disappeared, not the commits. + +Git will not let you delete a branch which has not been reintegrated unless you +insist using `git branch -D`. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them. + + +(exercise-branches-optional)= + +## Optional exercises with branches + +The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section. + +````{exercise} (optional) Branch-3: Perform a fast-forward merge +1. Create a new branch from `main` and switch to it. +2. Create a couple of commits on the new branch (for instance edit `README.md`): + ```{figure} img/gitink/git-pre-ff.svg + ``` +3. Now switch to `main`. +4. Merge the new branch to `main`. +5. Examine the result with `git graph`. +6. Have you expected the result? Discuss what you see. + + ```{solution} + You will see that in this case no merge commit was created and Git merged the + two branches by moving (fast-forwarding) the "main" branch (label) three + commits forward. + + This was possible since one branch is the ancestor of the other and their + developments did not diverge. + + A merge that does not require any merge commit is a fast-forward merge. + ``` +```` + +````{exercise} (optional) Branch-4: Rebase a branch (instead of merge) +As an alternative to merging branches, one can also *rebase* branches. +Rebasing means that the new commits are *replayed* on top of another branch +(instead of creating an explicit merge commit). +**Note that rebasing changes history and should not be done on public commits!** +1. Create a new branch, and make a couple of commits on it. +2. Switch back to `main`, and make a couple of commits on it. +3. Inspect the situation with `git graph`. +4. Now rebase the new branch on top of `main` by first switching to the new branch, and then `git rebase main`. +5. Inspect again the situation with `git graph`. Notice that the commit hashes have changed - think about why! + + ```{solution} + You will notice two things: + - History is now linear and does not contain merge commits. + - All the commit hashes that were on the branch that got rebased, have + changed. This also demonstrates that `git rebase` is a command that alters + history. The commit history looks as if the rebased commits were all done + after the `main` commits. + ``` +```` + + +## Tags + +- A tag is a pointer to a commit but in contrast to a branch it **does not ever + move** when creating new commits later. +- It can be useful to think of branches as sticky notes and of tags as + [commemorative plaques](https://en.wikipedia.org/wiki/Commemorative_plaque). +- We use tags to record particular states or milestones of a project at a given + point in time, like for instance versions (have a look at [semantic versioning](http://semver.org), + v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a). +- There are two basic types of tags: annotated and lightweight. +- **Use annotated tags** since they contain the author and can be cryptographically signed using + GPG, timestamped, and a message attached. + +Let's add an annotated tag to our current state of the guacamole recipe: +```console +$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet" +``` + +As you may have found out already, `git show` is a very versatile command. Try this: + +```console +$ git show nobel-2023 +``` + +For more information about tags see for example +[the Pro Git book](https://git-scm.com/book/en/v2/Git-Basics-Tagging) chapter on the +subject. + +--- + +## Summary + +Let us pause for a moment and recapitulate what we have just learned: + +```console +$ git branch # see where we are +$ git branch NAME # create branch NAME +$ git switch NAME # switch to branch NAME +$ git merge NAME # merge branch NAME (to current branch) +$ git branch -d NAME # delete branch NAME +$ git branch -D NAME # delete unmerged branch NAME +``` + +Since the following command combo is so frequent: + +```console +$ git branch NAME # create branch NAME +$ git switch NAME # switch to branch NAME +``` + +There is a shortcut for it: + +```console +$ git switch --create NAME # create branch NAME and switch to it +``` + +### Typical workflows + +With this there are two typical workflows: + +```console +$ git switch --create new-feature # create branch, switch to it +$ git commit # work, work, work, ..., and test +$ git switch main # once feature is ready, switch to main +$ git merge new-feature # merge work to main +$ git branch -d new-feature # remove branch +``` + +Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging: + +```console +$ git switch --create wild-idea # create branch, switch to it, work, work, work ... +$ git switch main # realize it was a bad idea, back to main +$ git branch -D wild-idea # it is gone, off to a new idea +``` + +--- + +````{challenge} Branch-5: Test your understanding + Which of the following combos (one or more) creates a new branch and makes a commit to it? + 1. ```console + $ git branch new-branch + $ git add file.txt + $ git commit + ``` + 2. ```console + $ git add file.txt + $ git branch new-branch + $ git switch new-branch + $ git commit + ``` + 3. ```console + $ git switch --create new-branch + $ git add file.txt + $ git commit + ``` + 4. ```console + $ git switch new-branch + $ git add file.txt + $ git commit + ``` + + ```{solution} + Both 2 and 3 would do the job. Note that in 2 we first stage the file, and then create the + branch and commit to it. In 1 we create the branch but do not switch to it, while in 4 we + don't give the `--create` flag to `git switch` to create the new branch. + ``` +```` + +```{keypoints} +- A branch is a division unit of work, to be merged with other units of work. +- A tag is a pointer to a moment in the history of a project. +``` diff --git a/branch/2023-version/_sources/conflicts.md.txt b/branch/2023-version/_sources/conflicts.md.txt new file mode 100644 index 00000000..34b978ad --- /dev/null +++ b/branch/2023-version/_sources/conflicts.md.txt @@ -0,0 +1,463 @@ +(conflict-resolution)= + +# Conflict resolution + +```{objectives} +- Understand merge conflicts sufficiently well to be able to fix them. +``` + +```{instructor-note} +- 20 min teaching/type-along +- 20 min exercise +``` + + +## Conflicts in Git and why they are good + +Imagine we start with the following text file: +```{code-block} +1 tbsp cilantro +2 avocados +1 chili +1 lime +1 tsp salt +1/2 onion +``` + +On branch A somebody modifies: +```{code-block} +--- +emphasize-lines: 1, 4 +--- +2 tbsp cilantro +2 avocados +1 chili +2 lime +1 tsp salt +1/2 onion +``` + +On branch B somebody else modifies: +```{code-block} +--- +emphasize-lines: 1, 6 +--- +1/2 tbsp cilantro +2 avocados +1 chili +1 lime +1 tsp salt +1 onion +``` + +When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro: +```{code-block} +--- +emphasize-lines: 1 +--- +????????????????? +2 avocados +1 chili +2 lime +1 tsp salt +1 onion +``` + +Git is very good at resolving modifications when merging branches and +in most cases a `git merge` runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see {ref}`exercise-branches-optional`) without you even noticing. + +But sometimes the **same portion** of the code/text is modified on two branches +**in two different ways** and Git issues a **conflict**. +Then you need to tell Git which version to keep (**resolve** it). + +There are several ways to do that as we will see. + +Please remember: + +- It is good that Git conflicts exist: Git will not silently overwrite one of + two differing modifications. +- Conflicts may look scary, but are not that bad after a little bit of + practice. Also they are luckily rare. +- Don't be afraid of Git because of conflicts. You may not meet some conflicts + using other systems because you simply can't do the kinds of things you do + in Git. +- You can take human measures to reduce them. + +--- + +```{discussion} The human side of conflicts +- What does it mean if two people do the same thing in two different ways? +- What if you work on the same file but do two different things in the different sections? +- What if you do something, don't tell someone from 6 months, and then try to combine it with other people's work? +- How are conflicts avoided in other work? (Only one person working at once? + Declaring what you are doing before you start, if there is any chance someone + else might do the same thing, helps.) +- Minor conflicts (two people revise spelling) vs semantic (two people rewrite + a function to add two different new features). How did Git solve these in + branching/merging easily? +``` + +Now we can go to show how Git controls when there is actually a conflict. + + +## Preparing a conflict + +```{instructor-note} +We do the following together as type-along/demo. +``` + +````{admonition} If you got stuck previously or joined later + **If you got stuck previously or joined later**, + you can apply the commands below. + But **skip this box if you managed to create branches**. + + ```console + $ cd .. # step out of the current directory + + $ git clone https://github.com/coderefinery/recipe-before-merge.git + $ cd recipe-before-merge + + $ git remote remove origin + + $ git graph + ``` + + Or call a helper to un-stuck it for you. +```` + +We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together. + +- Create two branches from `main`: one called `like-cilantro`, one called `dislike-cilantro`: + ```console + $ git branch like-cilantro main + $ git branch dislike-cilantro main + ``` + +- On the two branches make **different modifications** to the amount of the **same ingredient**: + +- On the branch `like-cilantro` we have the following change: + ```console + $ git diff main like-cilantro + ``` + + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index e83294b..6cacd50 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -1,4 +1,4 @@ + -* 1 tbsp cilantro + +* 2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + ``` + +- And on the branch `dislike-cilantro` we have the following change: + ```console + $ git diff main dislike-cilantro + ``` + + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index e83294b..6484462 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -1,4 +1,4 @@ + -* 1 tbsp cilantro + +* 1/2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + ``` + + +## Merging conflicting changes + +What do you expect will happen when we try to merge these two branches into +main? + +```{note} +In case `git switch` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git switch`. +``` + +The first merge will work: + +```console +$ git switch main +$ git status +$ git merge like-cilantro + +Updating 4e03d4b..3caa632 +Fast-forward + ingredients.txt | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) +``` + +But the second will fail: + +```console +$ git merge dislike-cilantro + +Auto-merging ingredients.txt +CONFLICT (content): Merge conflict in ingredients.txt +Automatic merge failed; fix conflicts and then commit the result. +``` + +Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit: + +```{code-block} console +--- +emphasize-lines: 9 +--- +$ git status + +You have unmerged paths. + (fix conflicts and run "git commit") + (use "git merge --abort" to abort the merge) + +Unmerged paths: + (use "git add ..." to mark resolution) + both modified: ingredients.txt + +no changes added to commit (use "git add" and/or "git commit -a") +``` + +Git won't decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward. + +Let us inspect the conflicting file: + +```console +$ cat ingredients.txt + +<<<<<<< HEAD +* 2 tbsp cilantro +======= +* 1/2 tbsp cilantro +>>>>>>> dislike-cilantro +* 2 avocados +* 1 chili +* 1 lime +* 1 tsp salt +* 1/2 onion +``` + +Git inserted resolution markers (the `<<<<<<<`, `>>>>>>>`, and `=======`). + +Try also `git diff`: + +```console +$ git diff +``` + +```diff +diff --cc ingredients.txt +index 6cacd50,6484462..0000000 +--- a/ingredients.txt ++++ b/ingredients.txt +@@@ -1,4 -1,4 +1,10 @@@ +++<<<<<<< HEAD + +* 2 tbsp cilantro +++======= ++ * 1/2 tbsp cilantro +++>>>>>>> dislike-cilantro + * 2 avocados + * 1 chili + * 1 lime +``` + +`git diff` now only shows the conflicting part, nothing else. + + +## Conflict resolution + +``` +<<<<<<< HEAD +* 2 tbsp cilantro +======= +* 1/2 tbsp cilantro +>>>>>>> dislike-cilantro +``` + +We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged. + +```{admonition} Steps to resolve a conflict + +- Check status with `git status` and `git diff`. +- Decide what you keep (the one, the other, or both or something + else). Edit the file to do this. + - Remove the resolution markers, if not already done. + - The file(s) should now look exactly how you want them. +- Check status with `git status` and `git diff`. +- Tell Git that you have resolved the conflict with `git add ingredients.txt` + (if you use the Emacs editor with a certain plugin the editor may stage the + change for you after you have removed the conflict markers). +- Verify the result with `git status`. +- Finally commit the merge with only `git commit`. Everything is pre-filled. +``` + +(exercise-conflicts)= + +## Exercise: Create and resolve a conflict + +````{exercise} Conflict-1: Create another conflict and resolve +In this exercise, we repeat almost exactly what we did above with a +different ingredient. + +1. Create two branches before making any modifications. +2. Again modify some ingredient on both branches. +3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge. +4. What happens if you apply the same modification on both branches? +5. If you create a branch `like-avocados`, commit a change, then from this + branch create another banch `dislike-avocados`, commit again, and try to + merge both branches into `main` you will not see a conflict. Can you + explain, why it is different this time? +```{solution} +4: No conflict in this case if the change is the same. + +5: No conflict in this case since in Git history one change happened after the other. The two changes + are related and linked by Git history and one is a Git ancestor of the + other. Git will assume that since we applied one change after the other, + we meant this. There is nothing to resolve. +``` +```` + +(exercise-conflicts-optional)= + +## Optional exercises with conflict resolution + +````{exercise} (optional) Conflict-2: Resolve a conflict when rebasing a branch +1. Create two branches where you anticipate a conflict. +2. Try to merge them and observe that indeed they conflict. +3. Abort the merge with `git merge --abort`. +4. What do you expect will happen if you rebase one branch on top of the + other? Do you anticipate a conflict? Try it out. +```{solution} +Yes, this will conflict. If it conflicts during a merge, it will also conflict +during rebase but the conflict resolution looks slightly different: +You still need to look for conflict markers but you tell Git that you resolved +a conflict with `git add` and then you continue with `git rebase --continue`. +Follow instructions that you get from the Git command line. +``` +```` + +````{exercise} (optional) Conflict-3: Resolve a conflict using mergetool + - Again create a conflict (for instance disagree on the number of avocados). + - Stop at this stage: + + ```markdown + Auto-merging ingredients.txt + CONFLICT (content): Merge conflict in ingredients.txt + Automatic merge failed; fix conflicts and then commit the result. + ``` + + - Instead of resolving the conflict manually, use a visual tool + (requires installing one of the [visual diff tools](https://coderefinery.github.io/installation/difftools/)): + + ```console + $ git mergetool + ``` + + ```{figure} img/conflict-resolution/mergetool.png + :alt: Conflict resolution using mergetool + :width: 100% + ``` + + - Your current branch is left, the branch you merge is right, result is in the middle. + - After you are done, close and commit, `git add` is not needed when using `git mergetool`. + + If you have not instructed Git to avoid creating backups when using mergetool, then to be on + the safe side there will be additional temporary files created. To remove those you can do + a git clean after the merging. + + To view what will be removed: + + ```console + $ git clean -n + ``` + + To remove: + + ```console + $ git clean -f + ``` + + To configure Git to avoid creating backups at all: + + ```console + $ git config --global mergetool.keepBackup false + ``` +```` + +--- + +## Using "ours" or "theirs" strategy + +- Sometimes you know that you want to keep "ours" version (version on the branch you are on) + or "theirs" (version on the merged branch). +- Then you do not have to resolve conflicts manually. +- See [merge strategies](https://git-scm.com/docs/merge-strategies). + +Example (merge and in doubt take the changes from current branch): +```console +$ git merge -s recursive -Xours less-avocados +``` + +Or (merge and in doubt take the changes from less-avocados branch): +```console +$ git merge -s recursive -Xtheirs less-avocados +``` + +--- + +## Aborting a conflicting merge + +Sometimes you get a merge conflict but realize that you can't solve it without +talking to a colleague (who created the other change) first. What to do? + +You can abort the merge and postponing conflict resolution by resetting the +repository to `HEAD` (last committed state): + +```console +$ git merge --abort +``` + +The repository looks then exactly as it was before the merge. + +--- + +## Avoiding conflicts + +- Human measures + - Think and plan to which branch you will commit to. + - Do not put unrelated changes on the same branch. +- Collaboration measures + - Open an issue and discuss with collaborators before starting a long-living + branch. +- Project layout measures + - Modifying global data often causes conflicts. + - Modular programming reduces this risk. +- Technical measures + - **Share your changes early and often** - this is one of the happy, + rare circumstances when everyone doing the selfish thing (e.g. `git push` as + early as practical) results in best case for everyone! + - Pull/rebase often to keep up to date with upstream. + - Resolve conflicts early. + +```{discussion} +Discuss how Git handles conflicts compared to services like Google Drive. +``` + +```{keypoints} +- Conflicts often appear because of not enough communication or not optimal + branching strategy. +``` diff --git a/branch/2023-version/_sources/customizing.md.txt b/branch/2023-version/_sources/customizing.md.txt new file mode 100644 index 00000000..c8fdf72b --- /dev/null +++ b/branch/2023-version/_sources/customizing.md.txt @@ -0,0 +1,25 @@ +# Customizing Git + +## Shell prompt + +```{instructor-note} +Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like. +``` + +You can make your shell display contextual information about +your Git state even at all times. + +Here are few example projects that make this possible and easy: +- (bash) +- (zsh) +- (fish) +- (bash and fish) + + +## More useful "diff" output + +[Delta](https://github.com/dandavison/delta) is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +"diff" output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more. diff --git a/branch/2023-version/_sources/exercises.md.txt b/branch/2023-version/_sources/exercises.md.txt new file mode 100644 index 00000000..c7b63f59 --- /dev/null +++ b/branch/2023-version/_sources/exercises.md.txt @@ -0,0 +1,44 @@ +# List of exercises + +## Summary + +Basics: +- {ref}`exercise-record-changes` +- {ref}`exercise-diff-and-rename` + +Branching and merging: +- {ref}`exercise-branches` +- {ref}`exercise-branches-merging` +- {ref}`exercise-branches-optional` + +Conflict resolution: +- {ref}`exercise-conflicts` +- {ref}`exercise-conflicts-optional` + +Inspecting history: +- {ref}`exercise-history` +- {ref}`exercise-bisect` + +Using the Git staging area: +- {ref}`exercise-interactive-commits` +- {ref}`exercise-staging-area` + +Undoing and recovering: +- {ref}`exercise-revert` +- {ref}`exercise-amend` +- {ref}`exercise-reset` + +Interrupted work: +- {ref}`exercise-stashing` + + +## Full list + +This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests. + +```{exerciselist} +``` diff --git a/branch/2023-version/_sources/guide.md.txt b/branch/2023-version/_sources/guide.md.txt new file mode 100644 index 00000000..0561e2c9 --- /dev/null +++ b/branch/2023-version/_sources/guide.md.txt @@ -0,0 +1,261 @@ +# Instructor guide + +## Schedule Day 1 + +Times here are in CE(S)T. + +- 08:50 - 09:00 (10 min) Soft start and icebreaker question +- 09:00 - 09:20 (20 min) Welcome and practical information + +- 09:20 - 09:35 (15 min) [Motivation](https://coderefinery.github.io/git-intro/motivation/) +- 09:35 - 09:50 (15 min) [Basics - configuration and first commits](https://coderefinery.github.io/git-intro/basics/) +- 09:50 - 10:00 (10 min) Break +- **10:00 - 10:20 (20 min) [Exercise](https://coderefinery.github.io/git-intro/basics/#exercise-record-changes)** + - Record changes + - Optional exercises +- 10:20 - 10:40 (20 min) [Basics - history, commit log, ignoring](https://coderefinery.github.io/git-intro/basics/#git-history-and-log) +- **10:40 - 11:00 (20 min) [Exercise](https://coderefinery.github.io/git-intro/basics/#optional-exercises-comparing-changes)** + - One or all optional exercises + +- 11:00 - 12:00: Lunch break + +- 12:00 - 12:15 (15 min) [Branching and merging](https://coderefinery.github.io/git-intro/branches/) +- **12:15 - 12:35 (20 min) [Exercise](https://coderefinery.github.io/git-intro/branches/#exercise-create-and-commit-to-branches)** + - Branch-1 + - Branch-2 +- 12:35 - 12:50 (15 min) Summarize/discuss branching and merging +- 12:50 - 13:00 (10 min) Break +- 13:00 - 13:20 (20 min) [Conflict resolution](https://coderefinery.github.io/git-intro/conflicts/) + +- 13:20 - 13:30 (10 min) Q&A, feedback, and what will we be doing tomorrow? + + +## Schedule Day 2 + +Times here are in CE(S)T. + +- 08:50 - 09:00 (10 min) Soft start and icebreaker question +- 09:00 - 09:10 (10 min) Recap and Q&A from day 1 + +- 09:10 - 09:25 (15 min) [Sharing repositories online](https://coderefinery.github.io/git-intro/remotes/) +- **09:25 - 09:50 (25 min) Exercise** + - Set up SSH keys + - Pushing our guacamole recipe repository to GitHub + - Clone repository +- 09:50 - 10:00 (10 min) Break +- 10:00 - 10:15 (15 min) [Inspecting history](https://coderefinery.github.io/git-intro/archaeology/) +- **10:15 - 10:45 (30 min) [Exercise](https://coderefinery.github.io/git-intro/archaeology/#exercise-basic-archaeology-commands)** + - History-1 + - History-2 is optional +- 10:45 - 11:00 (15 min) Summarize/discuss inspecting history + +- 11:00 - 12:00: Lunch break + +- 12:00 - 12:15 (15 min) [Undoing and recovering](https://coderefinery.github.io/git-intro/recovering/) +- **12:15 - 12:40 (25 min) [Exercises](https://coderefinery.github.io/git-intro/recovering/)** + - Undoing-1 + - Undoing-2 + - Undoing-3 +- 12:40 - 11:50 (10 min) Summarize undoing and recovering and discussion and mention that staging area exists +- 12:50 - 13:00 (10 min) Break +- 13:00 - 13:20 (20 min) [How much Git is necessary?](https://coderefinery.github.io/git-intro/level/) + +- 13:20 - 13:30 (10 min) Q&A, feedback, and what will we be doing tomorrow? + + +## Installation reminders for each day + +- Day 1: Git configuration +- Day 2: SSH set up (if you don't, sharing repositories online will be demo) + + +## Why we teach this lesson + +Everyone should be using a version control system for their work, even if they're working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories. + +Specific motivations: +- Code easily becomes a disaster without version control +- Mistakes happen - Git offers roll-back functionality and easy backup mechanism +- One often needs to work on multiple things in parallel - branches solve that problem +- Git enables people to collaborate on code or text without stepping on each other's toes +- Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, + and if bugs are found one can find out exactly when it was introduced + +Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices (e.g. how to use the staging area), which is useful for more experienced users. + + +## Intended learning outcomes + +By the end of this lesson, learners should: +- realize that version control is very important and Git is a valuable tool to learn and use +- understand that Git is configurable and know how to set basic configurations +- be able to set up Git repositories and make commits +- understand that information on commits, branches etc. are stored under `.git/`, and have a + mental model of how that relates to the working directory +- have a mental model of the different states a file can have in Git (untracked, modified, staged, unmodified) +- know how to write good commit messages +- have an idea of how the staging area can be used to craft good commits +- know how to undo commits using `git revert` and discard changes using `git restore` +- understand that `git restore` can be dangerous if changes have not been staged +- know how to create branches and switch between branches +- have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way +- know how to merge branches and understand what that means in terms of combining different modifications +- know how to resolve conflicts, or to abort conflicting merges +- realize that conflicts are generally a good thing since they prevent incorrect merges +- be able to set up a repository on GitHub and connect it with local repository +- push changes to a remote repository +- know a few ways to search through a repository and its history + + +## How to teach this lesson + +### Take first editor steps slowly + +Some participants will be new to using a terminal text editor so please open, +edit, and close the editor (Nano) slowly in first type-along sessions and +exercises to avoid that participants will fall behind the instructor. At one +point a student did not follow the file edits of the instructor, and to correct +the mistake they had to do a manual merge, which they were not ready for. + + +### How to use the exercises + +Most episodes have standard exercises followed by optional (often more advanced) exercises +for more experienced learners so they don't get bored waiting for the newcomers. +The instructor should briefly introduce the exercises and mention that after finishing the +standard exercise (and indicating that using the green sticky) the learners can move on to the +optional ones if they wish. When at least half of the learners have raised the green sticky +the instructor should go through the standard exercise to describe its most important take-home messages. +It's also fine to briefly go though important points from the optional exercises, but don't spend +too much time on it since everyone will not have attempted them. + + +### "Test your understanding" exercises + +Some episodes have a "test your understanding" exercise at the end which is intended as *formative assessment*, +i.e. an activity that provides feedback to instructors and learners on whether learning objectives are being met. +The instructor should end each episode by posing the "test your understanding" multiple-choice question, +giving learners a minute to think about it, and then asking for the right answer or asking learners to raise their +hands to signal which answer they think is correct. + + +### Inspecting history + +Key lesson is *how to find when something is broken or what commit has broken +the code*. + +It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that `git annotate` +and `git show` are available on GitHub and GitLab. + +When discussing `git annotate` and `git bisect` the "when" is more important +than "who". It is not to blame anybody but rather to find out whether published +results are affected. + +Discuss how one would find out this information without version control. + +**Questions to involve participants:** + +- Have you ever found a bug in your code and wondered whether it has affected published results? +- Have you ever wondered when, and by whom, a particular line of code was introduced? +- Have you ever found out that a code behaves differently than it used to but you are not sure when + precisely this changed? + + +**Confusion during `git bisect` exercise:** + +Learners may get stuck in the `git bisect` exercise if they incorrectly assign a commit +as *bad* or *good*. +To leave the bisect mode and return to the commit before `git bisect start` was issued, +one can do +```shell +$ git bisect reset +``` +and start over if needed. + + +### Live better than reading the website material + +It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier. + + +### Log your history in a separate window + +The screencasting (shell window cheatsheet) hints have been moved to +the [presenting +manual](https://coderefinery.github.io/manuals/instructor-tech-setup/). + + +### Create a cheatsheet on the board + +For in-person workshops, create a "cheatsheet" on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven't forgotten anything. Re-create and expand in future git lessons. +One strategy is: + +- a common section for basic commands: `init`, `config`, `clone`, `help`, `stash` +- info commands, can be run anytime: `status`, `log`, `diff`, `graph` +- A section for all the commands that move code from different states: + `add`, `commit`, etc. See the visual cheat sheet below. + +You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it's probably too confusing to use after this course. But, the idea +of commands moving from the "working dir", "staging area", "commits", +etc is good. + +```{figure} img/cheat-sheet.jpg +:alt: Example cheat sheet +:width: 100% + +Example cheat sheet. +``` + +We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to. + + +### Draw a graph on the board + +Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run `git graph`, then do the command, +then look at `git graph` again. + + +### Repeat the following points + +- Always check `git status`, `git diff`, and `git graph` (our alias) before and + after every command until you get used to things. These give you a clear view + into what is going on, the key to knowing what you are doing. Even + after you are used to things... anytime you do something you do + infrequently, it's good to check. + +- `git graph` is a direct representation of what we are drawing on the + board and should constantly be compared to it. + +- Once you `git add` something, it's almost impossible to lose it. + This is used all the time, for example once you commit or even add + it is hard to lose. Commit before you merge or rebase. And so on. + + +### Start from identical environment + +You probably have a highly optimized bash and git environment - one +that is different from students. Move `.gitconfig` and `.bashrc` out +of the way before you start so that your environment is identical to +what students have. diff --git a/branch/2023-version/_sources/index.md.txt b/branch/2023-version/_sources/index.md.txt new file mode 100644 index 00000000..851541d9 --- /dev/null +++ b/branch/2023-version/_sources/index.md.txt @@ -0,0 +1,95 @@ +# Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version + +This is the introductory lesson to version control using +[Git](https://git-scm.com/). It is assumed to be the very first thing +done in a course. + +Our philosophy is that we start from own local repository, branching and +merging (locally), and a brief introduction to pushing to remotes. In +the separate [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/), we teach more use of +remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with +Git to be able to work well. We try to avoid commands which might get +you into a confusing state. + +The goals of the module as a whole are that the user will feel +comfortable about staging changes, committing them, merging, and +branching. + +```{prereq} +- A reasonably recent version of Git (ideal is 2.28 or newer but we + recommend at least 2.23) is installed **and configured** ([installation + instructions](https://coderefinery.github.io/installation/)). But also on older + Git (2.0) the workshop will work and we will offer workarounds for Git below 2.28 + or 2.23. +- For one of the episodes we need a [GitHub](https://github.com) user + account (but alternatives exist, see below). +- Being comfortable with the command line. No expertise is required, but + the lesson will be mostly taken from the command line. For most commands, where reasonable, + we also offer the possibility to participate through the browser. +- To edit files on the local computer, learners should be familiar with + using a **text editor** on their system. If you are new to text editors, + we recommend to start with Nano or VS Code. +``` + +```{toctree} +:maxdepth: 1 +:caption: Core episodes + +motivation +basics +branches +conflicts +remotes +archaeology +level +what-to-avoid +``` + +```{toctree} +:maxdepth: 1 +:caption: Optional episodes + +staging-area +recovering +interrupted +aliases +under-the-hood +``` + +```{toctree} +:maxdepth: 1 +:caption: Reference + +reference +customizing +resources +exercises +guide +``` + +```{toctree} +:maxdepth: 1 +:caption: About + +All lessons +CodeRefinery +Reusing +``` + +```{admonition} Why GitHub? +In this introduction we will mention and use +[GitHub](https://github.com) but also +[GitLab](https://gitlab.com) and +[Bitbucket](https://bitbucket.org) allow similar workflows and +basically everything that we will discuss is transferable. With this +material and these exercises we do not implicitly endorse the company +[GitHub](https://github.com). We have chosen to demonstrate a +number of concepts using examples with +[GitHub](https://github.com) because it is currently the most +popular web platform for hosting Git repositories and the chance is +high that you will interact with +[GitHub](https://github.com)-based repositories even if you choose +to host your Git repository on another platform. +``` diff --git a/branch/2023-version/_sources/interrupted.md.txt b/branch/2023-version/_sources/interrupted.md.txt new file mode 100644 index 00000000..0516cad1 --- /dev/null +++ b/branch/2023-version/_sources/interrupted.md.txt @@ -0,0 +1,106 @@ +# Interrupted work + +```{objectives} +- Learn to switch context or abort work without panicking. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 15 min exercise +``` + +```{keypoints} +- There is almost never reason to clone a fresh copy to complete a task that + you have in mind. +``` + + +## Frequent situation: interrupted work + +We all wish that we could write beautiful perfect code. But the real world is +much more chaotic: + +- You are in the middle of a "Jackson-Pollock-style" debugging spree with 27 modified files + and debugging prints everywhere. +- Your colleague comes in and wants you to fix/commit something right now. +- What to do? + +Git provides lots of ways to switch tasks without ruining everything. + + +## Option 1: Stashing + +The **stash** is the first and easiest place to temporarily "stash" +things. + +- `git stash` will put working directory and staging area changes + away. Your code will be same as last commit. +- `git stash pop` will return to the state you were before. Can give it a list. +- `git stash list` will list the current stashes. +- `git stash save NAME` is like the first, but will give it a name. + Useful if it might last a while. +- `git stash save [-p] [filename]` will stash certain files files + and/or by patches. +- `git stash drop` will drop the most recent stash (or whichever stash + you give). +- The stashes form a stack, so you can stash several batches of modifications. + + +(exercise-stashing)= + +### Exercise: Stashing + +````{exercise} Interrupted-1: Stash some uncommitted work +1. Make a change. +2. Check status/diff, stash the change with `git stash`, check status/diff again. +3. Make a separate, unrelated change which doesn't touch the same + lines. Commit this change. +4. Pop off the stash you saved with `git stash pop`, and check status/diff. +5. Optional: Do the same but stash twice. Also check `git stash list`. + Can you pop the stashes in the opposite order? +6. Advanced: What happens if stashes conflict with other changes? Make + a change and stash it. Modify the same line or one right above or + below. Pop the stash back. Resolve the conflict. Note there is no + extra commit. +7. Advanced: what does `git graph` show when you have something + stashed? + +```{solution} +5: Yes you can. With `git stash pop INDEX` you can decie which stash +index to pop. + +6: In this case Git will ask us to resolve the conflict the same way +when resolving conflicts between two branches. + +7: It shows an additional commit hash with `refs/stash`. +``` +```` + + +## Option 2: Create branches + +You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch. + +You basically know how to do this: + +```console +$ git switch --create temporary # create a branch and switch to it +$ git add PATHS # stage changes +$ git commit # commit them +$ git switch main # back to main, continue your work there ... +$ git switch temporary # continue again on "temporary" where you left off +``` + +Later you can merge it to main or rebase it on top of main and resume work. + + +## Storing various junk you don't need but don't want to get rid of + +It happens often that you do something and don't need it, but you don't want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still. diff --git a/branch/2023-version/_sources/level.md.txt b/branch/2023-version/_sources/level.md.txt new file mode 100644 index 00000000..83fdcfee --- /dev/null +++ b/branch/2023-version/_sources/level.md.txt @@ -0,0 +1,73 @@ +# Practical advice: how much Git is necessary? + +```{instructor-note} +- 20 min teaching/discussion +``` + + +## What level of branching complexity is necessary for each project? + + +### Simple personal projects + +- Typically start with just the `main` branch. +- Use branches for unfinished/untested ideas. +- Use branches when you are not sure about a change. +- Use tags to mark important milestones. + + +### Projects with few persons: you accept things breaking sometimes + +- It might be reasonable to commit to the `main` branch and feature branches. + + +### Projects with few persons: changes are reviewed by others + +- You create new feature branches for changes. +- Changes are reviewed before they are merged to the `main` branch + (more about that in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/)). +- The `main` branch is write-protected and can only be changed with pull requests or merge requests. + + +### When you distribute releases + +- If you want to patch releases, you probably need release branches. +- The `main` branch and release branches are read-only. +- Many [branching models](https://coderefinery.github.io/git-branch-design/05-branching-models/) exist. + +--- + +## How about staging and committing? + +- It is OK to start committing directly by doing `git commit SOMEFILE`. +- Commit early and often: rather create too many commits than too few. + You can always combine commits later. +- Once you commit, it is very, very hard to really lose your code. +- Always fully commit (or stash) before you do dangerous things, so that you know you are safe. + Otherwise it can be hard to recover. +- Later you can start using the staging area. +- Later start using `git add -p` and/or `git commit -p`. + +--- + +## How large should a commit be? + +- Better too small than too large (easier to combine than to split). +- Often I make a commit at the end of the day (this is a unit I would not like to lose). +- Smaller sized commits may be easier to review for others than huge commits. +- Imperfect commits are better than no commits. +- A commit should not contain unrelated changes to simplify review and possible + repair/adjustments/undo later (but again: imperfect commits are better than no commits). + +--- + +```{keypoints} +- There is no one size fits all - start simple and grow your project. +``` + +```{discussion} +How do you [plan to] use Git? + +- Advanced users or beginners, please provide your input in the online collaborative document. +``` + diff --git a/branch/2023-version/_sources/motivation.md.txt b/branch/2023-version/_sources/motivation.md.txt new file mode 100644 index 00000000..df854ef4 --- /dev/null +++ b/branch/2023-version/_sources/motivation.md.txt @@ -0,0 +1,166 @@ +# Motivation + +```{objectives} +- Make sure nobody leaves the workshop without starting to use some form of version control. +- Discuss the reasons why we advocate distributed version control. +``` + +```{instructor-note} +- 15 min teaching/demonstration +``` + + +## Git is all about keeping track of changes + +We will learn how to keep track of changes first in a terminal ([example +repository](https://github.com/bast/runtest/commits/main/runtest/run.py)): + +```{figure} img/git-log-terminal.png +:alt: Screenshot of a git log in terminal +:width: 80% +``` + +Later also via web interface ([example +repository](https://github.com/bast/runtest/commits/main/runtest/run.py)): + +```{figure} img/git-log-github.png +:alt: Screenshot of a git log on GitHub +:width: 80% +:class: with-border +``` + + +## Why do we need to keep track of versions? + +Version control is an answer to these questions (do you recognize some of them?): + +- "It broke ... hopefully I have a working version somewhere?" + +- "Can you please send me the latest version?" + +- "Where is the latest version?" + +- "Which version are you using?" + +- "Which version have the authors used in the paper I am trying to reproduce?" + +- "Found a bug! Since when was it there?" + +- "I am sure it used to work. When did it change?" + +- "My laptop is gone. Is my thesis now gone?" + + +## Features: roll-back, branching, merging, collaboration + +- **Roll-back**: you can always go back to a previous version and compare + +- **Branching and merging**: + - Work on different ideas at the same time + - Different people can work on the same code/project without interfering + - You can experiment with an idea and discard it if it turns out to be a bad idea + +```{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +``` + +- **Collaboration**: review, compare, share, discuss + +- [Example network graph](https://github.com/coderefinery/git-intro/network) + + +## Reproducibility + +- How do you indicate which version of your code you have used in your paper? +- When you find a bug, how do you know **when precisely** this bug was introduced + (Are published results affected? Do you need to inform collaborators or users of your code?). + +With version control we can "annotate" code ([browse this example online](https://github.com/networkx/networkx/blame/main/networkx/algorithms/boundary.py)): + +```{figure} img/git-annotate.png +:alt: Example of a git-annotated code with code and history side-by-side +:width: 100% +:class: with-border + +Example of a git-annotated code with code and history side-by-side. +``` + + +## Talking about code + +Which of these two is more practical? +- "Clone the code, go to the file 'src/util.rs', and search for 'time_iso8601'". + Oh! But make sure you use the version from August 2023." +- Or I can send you a [permalink](https://github.com/NordicHPC/sonar/blob/75daafc86582feb06299d6a47c82112f39888152/src/util.rs#L40-L44): + +```{figure} img/code-portion.png +:alt: Screen-shot of a code portion +:width: 100% +:class: with-border + +Permalink that points to a code portion. +``` + + +## What we typically like to snapshot + +- Software (this is how it started but Git/GitHub can track a lot more) +- Scripts +- Documents (plain text files much better suitable than Word documents) +- Manuscripts (Git is great for collaborating/sharing LaTeX or [Quarto](https://quarto.org/) manuscripts) +- Configuration files +- Website sources +- Data + +````{discussion} + In this example somebody tried to keep track of versions without a version + control system tool like Git. Discuss the following directory listing. What + possible problems do you anticipate with this kind of "version control": + ```shell + myproject-2019.zip + myproject-2020-February.zip + myproject-2021-August.zip + myproject-2023-09-19-working.zip + myproject-2023-09-21.zip + myproject-2023-09-21-test.zip + myproject-2023-09-21-myversion.zip + myproject-2023-09-21-newfeature.zip + ... + ``` + + ```{solution} + - Giving a version to a collaborator and merging changes later with own + changes sounds like lots of work. + - What if you discover a bug and want to know since when the bug existed? + ``` +```` + + +## Difficulties of version control + +Despite the benefits, let's be honest, there are some difficulties: + +- One more thing to learn (it's probably worth it and will save you more time in the long run; basic career skill). +- Difficult if your collaborators don't want to use it (in the worst case, you can version control on your side and email them versions). +- Advanced things can be difficult, but basics are often enough (ask others for help when needed). + +--- + +```{discussion} Why Git and not another tool? +- **Easy to set up**: no server needed. +- **Very popular**: chances are high you will need to contribute to somebody else's code which is tracked with Git. +- **Distributed**: good backup, no single point of failure, you can track and + clean-up changes offline, simplifies collaboration model for open-source + projects. +- Important **platforms** such as [GitHub](https://github.com), [GitLab](https://gitlab.com), and [Bitbucket](https://bitbucket.org) + build on top of Git. + +However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +[Subversion](https://subversion.apache.org), +[Mercurial](https://www.mercurial-scm.org), [Pijul](https://pijul.org/), or others. +``` diff --git a/branch/2023-version/_sources/recovering.md.txt b/branch/2023-version/_sources/recovering.md.txt new file mode 100644 index 00000000..3c705f3e --- /dev/null +++ b/branch/2023-version/_sources/recovering.md.txt @@ -0,0 +1,260 @@ +# Undoing and recovering + +```{objectives} +- Learn to undo changes safely +- See when undone changes are permanently deleted and when they can be retrieved +``` + +```{instructor-note} +- 25 min teaching/type-along +- 25 min exercise +``` + +One of the main points of version control is that you can *go back in +time to recover*. Unlike this xkcd comic implies: + +In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn't a "commit" permanent? + +- You can modify old commit history. +- But if you have shared that history already, *modifying it can make + a huge mess*. + +```{admonition} It is almost always possible to recover +As long as you commit something once (or at least `git add` it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru... *until that guru becomes you*. +``` + +```{admonition} Nice resource to visually simulate Git operation +[git-sim](https://github.com/initialcommit-com/git-sim#video-animation-examples) +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command. +``` + +--- + +## Undoing your recent, uncommitted and unstaged changes (preserves history) + +```{note} +In case `git restore` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git restore`. +``` + +You do some work, and want to **undo your uncommitted and unstaged modifications**. +You can always do that with: + +- `git restore .` (the dot means "here and in all folders below") + +You can also undo things selectively: + +- `git restore -p` (decide which portions of changes to undo) or `git restore PATH` (decide which path/file) + +If you have staged changes, you have at least two options to undo the staging: +- `git restore --staged .` followed by `git status` and `git restore .` +- `git reset --hard HEAD` throws away everything that is not in last + commit (`HEAD` - this literal word, this isn't a placeholder) + +--- + +## Reverting commits (preserves history) + +Imagine we made a few commits. +We realize that the latest commit `e02efcd` was a mistake and we wish to undo it: +```console +$ git log --oneline + +e02efcd (HEAD -> main) not sure this is a good idea +b4af65b improve the documentation +e7cf023 don't forget to enjoy +79161b6 add half an onion +a3394e3 adding README +3696246 adding instructions +f146d25 adding ingredients +``` + +A safe way to undo the commit is to revert the commit with `git revert`: +```console +$ git revert e02efcd +``` + +This creates a **new commit** that does the opposite of the reverted commit. +The old commit remains in the history: +```console +$ git log --oneline + +d3fc63a (HEAD -> main) Revert "not sure this is a good idea" +e02efcd not sure this is a good idea +b4af65b improve the documentation +e7cf023 don't forget to enjoy +79161b6 add half an onion +a3394e3 adding README +3696246 adding instructions +f146d25 adding ingredients +``` + +You can revert any commit, no matter how old it is. It doesn't affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we'll learn about later). + +(exercise-revert)= + +### Exercise: Revert a commit + +```{exercise} Undoing-1: Revert a commit +- Create a commit (commit A). +- Revert the commit with `git revert` (commit B). +- Inspect the history with `git log --oneline`. +- Now try `git show` on both the reverted (commit A) and the newly created commit (commit B). +``` + + +## Adding to the previous commit (modifies history) + +Sometimes we commit but realize we forgot something. +We can amend to the last commit: + +```console +$ git commit --amend +``` + +This can also be used to modify the last commit message. + +Note that this **will change the commit hash**. This command **modifies the history**. +This means that we avoid this command on commits that we have shared with others. + +(exercise-amend)= + +### Exercise: Modify a previous commit + +````{exercise} Undoing-2: Modify a previous commit +1. Make an incomplete change to the recipe or a typo in your change, `git + add` and `git commit` the incomplete/unsatisfactory change. +2. Inspect the unsatisfactory but committed change with `git show`. Remember + or write down the commit hash. +3. Now complete/fix the change but instead of creating a new commit, add the + correction to the previous commit with `git add`, followed by `git commit + --amend`. What changed? + + ```{solution} + One thing that has changed now is the commit hash. Modifying the previous + commit has changed the history. This is OK to do on commits that other people + don't depend on yet. + ``` +```` + + +## Rewinding branches (modifies history) + +You can **reset branch history** to move your branch back to some +point in the past. + +* `git reset --hard HASH` will force a branch label to any other point. All + other changes are lost (but it is possible to recover if you force reset by mistake). +* Be careful if you do this - it can mess stuff up. Use `git graph` a + lot before and after. + + +(exercise-reset)= + +### Exercise: Git reset + +````{exercise} Undoing-3: Destroy our experimentation in this episode + After we have experimented with reverts and amending, let us destroy + all of that and get our repositories to a similar state. + + - First, we will look at our history (`git log`/`git graph`) and + find the last commit `HASH` before our tests. + - Then, we will `git reset --hard HASH` to that. + - Then, `git graph` again to see what happened. + + ```console + $ git log --oneline + + d3fc63a (HEAD -> main) Revert "not sure this is a good idea" + e02efcd not sure this is a good idea + b4af65b improve the documentation + e7cf023 don't forget to enjoy + 79161b6 add half an onion + a3394e3 adding README + 3696246 adding instructions + f146d25 adding ingredients + + $ git reset --hard b4af65b + + HEAD is now at b4af65b improve the documentation + + $ git log --oneline + + b4af65b (HEAD -> main) improve the documentation + e7cf023 don't forget to enjoy + 79161b6 add half an onion + a3394e3 adding README + 3696246 adding instructions + f146d25 adding ingredients + ``` +```` + +--- + +## Recovering from committing to the wrong branch + +It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes. + +Here we assume that we made a couple of commits but we realize they went to the +wrong branch. + +**Solution 1 using git cherry-pick**: +1. Make sure that the correct branch exists and if not, create it. Make sure to + create it from the commit hash where you wish you had created it from: `git + branch BRANCHNAME HASH` +2. Switch to the correct branch. +3. `git cherry-pick HASH` can be used to take a specific commit to the + current branch. Cherry-pick all commits that should have gone to the correct + branch, **from oldest to most recent**. +4. Rewind the branch that accidentally got wrong commits with `git reset --hard` (see also above). + +**Solution 2 using `git reset --hard`** (makes sense if the correct branch should +contain all commits of the accidentally modified branch): +1. Create the correct branch, pointing at the latest commit: `git branch BRANCHNAME`. +2. Check with `git log` or `git graph` that both branches point to the same, latest, commit. +3. Rewind the branch that accidentally got wrong commits with `git reset --hard` (see also above). + + +## Recovering from merging/pulling into the wrong branch + +`git merge`, `git rebase`, and `git pull` modify the **current** branch, never +the other branch. But sometimes we run this command on the wrong branch. + +1. Check with `git log` the commit hash that you would like to rewind the + wrongly modified branch to. +2. Rewind the branch that accidentally got wrong commits with `git reset --hard HASH` (see also above). + + +## Recovering from conflict after pulling changes + +Pulling changes with +`git pull` can create a conflict since `git pull` always also includes a `git merge` (more about this +in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/)). + +The recovery is same as described in {ref}`conflict-resolution`. Either +resolve conflicts or abort the merge with `git merge --abort`. + +--- + +````{challenge} Undoing-4: Test your understanding + 1. What happens if you accidentally remove a tracked file with `git rm`, is it gone forever? + 2. Is it OK to modify commits that nobody has seen yet? + 3. What situations would justify to modify the Git history and possibly remove commits? + + ```{solution} + 1. It is not gone forever since `git rm` creates a new commit. You can revert the commit to get the file back. + 2. If you haven't shared your commits with anyone it can be alright to modify them. + 3. If you have shared your commits with others (e.g. pushed them to GitHub), only extraordinary + conditions would justify modifying history. For example to remove sensitive or secret information. + ``` +```` diff --git a/branch/2023-version/_sources/reference.md.txt b/branch/2023-version/_sources/reference.md.txt new file mode 100644 index 00000000..b3e3d2e9 --- /dev/null +++ b/branch/2023-version/_sources/reference.md.txt @@ -0,0 +1,64 @@ +# Quick reference + +## Other cheatsheets + +* [Detailed 2-page Git + cheatsheet](https://aaltoscicomp.github.io/cheatsheets/git-the-way-you-need-it-cheatsheet.pdf) +* [Interactive Git cheatsheet](http://www.ndpsoftware.com/git-cheatsheet.html) + + +## Glossary + +* **working directory/ workspace**: the actual files you see and edit +* **staging area**: Place files go after `git add` and before `git + commit` +* **hash**: unique reference of any commit or state +* **branch**: One line of work. Different branches can exist at the + same time and split/merge. +* **HEAD**: Pointer to the most recent commit on the current branch. +* **remote**: Roughly, another server that holds .git. +* **origin**: Default name for a remote repository. +* **master**: Default name for main branch on Git. Depending on the configuration and service, + the default branch is sometimes **main**. + In this lesson we configure Git so that the default branch is + called **main** to be more consistent with GitHub and GitLab. +* **main**: Default name for main branch on GitLab and GitHub. + In this lesson we configure Git so that the default branch is + called **main** to be more consistent with GitHub and GitLab. + + +## Commands we use + +Setup: + +* `git config`: edit configuration options +* `git init -b main`: create new repository with `main` as the default branch + +See our status: + +* `git status`: see status of files - use often! +* `git log`: see history of commits and their messages, newest first +* `git graph`: see a detailed graph of commits. Create this command + with `git config --global alias.graph "log --all --graph --decorate --oneline"` +* `git diff`: show difference between working directory and last commit +* `git diff --staged`: show difference between staging area and last commit +* `git show COMMIT`: inspect individual commits + +General work: + +* `git add FILE`: + - Add a new file + - Add a file to staging +* `git commit`: record a version, add it to current branch +* `git commit --amend`: amend our last commit +* `git branch`: show which branch we're on +* `git branch NAME`: create a new branch called "name" +* `git restore FILE`: restore last committed/staged version of FILE, losing unstaged changes +* `git switch --create BRANCH-NAME`: create a new branch and switch to it +* `git revert HASH`: create a new commit which reverts commit HASH +* `git reset --soft HASH`: remove all commits after HASH, but keep their modifications as staged changes +* `git reset --hard HASH`: remove all commits after HASH, permanently throwing away their changes +* `git merge BRANCH-NAME`: merge branch BRANCH-NAME into current branch +* `git grep PATTERN`: search for patterns in tracked files +* `git annotate FILE`: find out when a specific line got introduced and by whom +* `git bisect`: find a commit which broke some functionality diff --git a/branch/2023-version/_sources/remotes.md.txt b/branch/2023-version/_sources/remotes.md.txt new file mode 100644 index 00000000..4143527f --- /dev/null +++ b/branch/2023-version/_sources/remotes.md.txt @@ -0,0 +1,318 @@ +# Sharing repositories online + +```{objectives} +- We get a feeling for remote repositories ([more later](https://coderefinery.github.io/git-collaborative/)). +- We are able to publish a repository on the web. +- We are able to fetch and track a repository from the web. +``` + +```{instructor-note} +- 15 min demonstration/type-along +- 25 min exercise +``` + + +## From our laptops to the web + +We have seen that **creating Git repositories and moving them around is +relatively simple** and that is great. + +So far, if you only worked in the command line, everything was local and all +snapshots, branches, and tags are saved under `.git`. + +If we remove `.git`, we remove all Git history of a project. + +```{discussion} +- What if the hard disk fails? +- What if somebody steals my laptop? +- How can we collaborate with others across the web? +``` + + +## Remotes + +We will learn how to work with remote repositories in detail in the +[collaborative distributed version control](https://coderefinery.github.io/git-collaborative/) lesson. + +In this section we only want to get a taste to prepare us for other lessons +where we will employ GitHub. Our goal is to publish our exercise guacamole recipe +which we prepared in the previous episodes on +the web. Don't worry, you will be able to remove it afterwards. + +````{admonition} If you don't have the recipe repository from previous episodes +Maybe you joined the workshop later or got stuck somewhere? **No problem**! + +**If you don't have the recipe repository from previous episodes**, you can +clone our version of the repository using (please **skip this if you have the recipe +repository on your computer already**): +```console +$ git clone https://github.com/coderefinery/recipe-before-merge.git recipe +$ cd recipe +$ git remote remove origin +``` + +Now you have a repository called `recipe` on your computer with a couple of +commits. Further down we will also clarify what `git clone` does. +```` + +To store your git data on another server, you use **remotes**. +A remote is a repository on its own, with its own branches +We can **push** changes to the remote and **pull** +from the remote. + +You might use remotes to: +- Back up your own work. +- To collaborate with other people. + +There are different types of remotes: +- If you have a server you can ssh to, you can use that as a remote. +- [GitHub](https://github.com) is a popular, closed-source commercial site. +- [GitLab](https://about.gitlab.com) is a popular, open-core + commercial site. Many universities have their own private GitLab servers + set up. +- [Bitbucket](https://bitbucket.org) is yet another popular commercial site. +- Another option is [NotABug](https://notabug.org). +- We also operate a [Nordic + research software repository + platform](https://coderefinery.org/repository/). + This is GitLab, free for researchers and allows private, + cross-university sharing. + +--- + +% This anchor used for linking from other lessons +(clone-method)= + +## Authenticating to GitHub: SSH or HTTPS? + +**How does Github know who you are?** This is hard and there are two +options. + +* **SSH** is the classic method, using Secure Shell remote connection + keys. +* **HTTPS** works with the **Git Credential Manager**, which is an + extra add-on that works easily in Windows and Mac. + +Read how to install them from the [installation +instructions](https://coderefinery.github.io/installation/ssh/). + +Test which one you should use: + +`````{tabs} + ````{group-tab} SSH + Try this command: + ```console + $ ssh -T git@github.com + ``` + + If it returns `Hi USERNAME! You've successfully authenticated, ...`, + then SSH is configured and the following steps will work with the SSH + cloning. + + See our [installation + instructions](https://coderefinery.github.io/installation/ssh/) to + set up SSH access. + + **From now on, if you know that SSH works, you should always select + SSH as the clone URL from GitHub, or translate the URL to start with + the right thing yourself:** `git@github.com:` (with the trailing + `:`). + ```` + ````{group-tab} HTTPS + Try this command: + ```console + $ git config --get credential.helper + ``` + + If this shows something, then the credential manager is probably + configured and HTTPS cloning will work (but you can't verify it until + you try using it). + + From now on, **if you know that HTTPS works, you should always select + HTTPS as the clone URL from Github, or translate the URL to start with + the right thing yourself:** `https://github.com/` + ```` +````` + +If you do not have these configured, please watch as we do this episode and you +can check the [installation +instructions](https://coderefinery.github.io/installation/ssh/) +before the next [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/), where we will need +one of these set up. + +--- + +## Publishing an existing repository from laptop to GitHub + +```{admonition} If you started in the browser and have nothing on your laptop yet +It is possible, that you already have a repository on GitHub if you followed +the examples and exercises in previous episodes in the browser. In this case, +please watch others publish their repository and try to clone your repository +to the laptop using instructions at the bottom of this page. +``` + +First log into GitHub, then follow the screenshots and descriptions below. + +```{figure} img/basics/new-repo-plus.png + :alt: Screenshot on GitHub before a new repository form is opened + :width: 100% + :class: with-border + + Click on the "plus" symbol on top right, then on "New repository". +``` + +Another way to create a new repository is to visit + directly. + +```{figure} img/remotes/new-bare-repo-form.png + :alt: Screenshot on GitHub just before a new repository is created + :width: 100% + :class: with-border + + Choose a repository name, add a short description, but please **do not check** "Add a + README file"**. For "Add .gitignore" and "Choose a license" also leave as "None". Finally "Create repository". +``` + +Once you click the green "Create repository", you will see a page similar to: +```{figure} img/remotes/bare-repo.png + :alt: Screenshot on GitHub after a bare repository was created + :width: 100% + :class: with-border +``` + +What this means is that we have now an empty project with either an HTTPS or an +SSH address: click on the HTTPS and SSH buttons to see what happens. + +We now want to follow the "**... or push an existing repository from the command line**: + +1. Now go to your guacamole repository on your computer. +2. Check that you are in the right place with `git status`. +3. Copy paste the three lines to the terminal and execute those, in my case (**you + need to replace the "USER" part and possibly also the repository name**): + + +`````{tabs} + ````{group-tab} SSH + See above for if SSH is the right option for you. + ```console + $ git remote add origin git@github.com:USER/recipe.git + ``` + ```` + ````{group-tab} HTTPS + See above for if HTTPS is the right option for you. + ```console + $ git remote add origin https://github.com/USER/recipe.git + ``` + ```` +````` + +Then: +```console +$ git branch -M main +$ git push -u origin main +``` + +The meaning of the above lines: +- Add a remote reference with the name "origin" +- Rename current branch to "main" +- Push branch "main" to "origin" + +You should now see: + +```text +Enumerating objects: 3, done. +Counting objects: 100% (3/3), done. +Writing objects: 100% (3/3), 221 bytes | 221.00 KiB/s, done. +Total 3 (delta 0), reused 0 (delta 0), pack-reused 0 +To github.com:USER/recipe.git + * [new branch] main -> main +Branch 'main' set up to track remote branch 'main' from 'origin'. +``` + +**Reload your GitHub project website** and - taa-daa - your commits should now be +online! What just happened? **Think of publishing a repository as uploading +the `.git` part online**. + + +```{admonition} Troubleshooting +**error: remote origin already exists.** +- Explanation: You probably ran a `git remote add origin ...` command, then changed your + mind about HTTPS or SSH and then tried to run the other `git remote add + origin ...` command but "origin" then already exists. +- Recovery: + - First remove "origin" with `git remote remove origin` + - Then run the correct `git remote add origin ...` command + +**remote contains work that you do not have** +- Explanation: You probably clicked on "Add a README file" and now the + repository on GitHub is not empty but contains one commit and locally you + have a different history. Git now prevents you from accidentally overwriting + the history on GitHub. +- Recovery: + - Use `git push --force` instead of `git push`, which will force Git to overwrite the history on GitHub + - Note that this is a powerful but also possibly dangerous option but here it + helps us. If it's a brand new repo, it probably is fine to do this. For real + repositories, don't do this unless you are very sure what is happening. +``` + +--- + +## Cloning a repository from GitHub to laptop + +Now other people can clone this repository and contribute changes. In the +[collaborative distributed version control](https://coderefinery.github.io/git-collaborative/) lesson +we will learn how this works. + +At this point only a brief demo - if you copy the SSH or HTTPS address, you can clone repositories like this +(again adapt the `USER` in the "USER/repository.git" part): + + +`````{tabs} +````{group-tab} SSH +```console +$ git clone git@github.com:USER/recipe.git +``` + +**From now on, if you are using SSH, you should pay attention and make +sure your clone URLs start with `git@github.com:` now and in future +lessons.** +```` +````{group-tab} HTTPS +```console +$ git clone https://github.com/USER/recipe.git +``` + +**From now on, if you are using HTTPS, you should pay attention and make +sure your clone URLs start with `https://github.com/` now and in future +lessons.** +```` +````` + +This creates a directory called "recipe" unless it already exists. You can also specify the target directory +on your computer: + +`````{tabs} +````{group-tab} SSH +```console +$ git clone git@github.com:USER/recipe.git myrecipe +``` +```` +````{group-tab} HTTPS +```console +$ git clone https://github.com/user/recipe.git myrecipe +``` +```` +````` + +What just happened? **Think of cloning as downloading the `.git` part to your +computer**. After downloading the `.git` part, the default branch (the branch pointed to by HEAD) is +automatically checked out. + +```{keypoints} +- A repository can have one or multiple remotes (we will revisit these later). +- Local branches often track remote branches. +- A remote serves as a full backup of your work. +- We'll properly learn how to use these in the + [collaborative distributed version control](https://coderefinery.github.io/git-collaborative/). +``` diff --git a/branch/2023-version/_sources/resources.md.txt b/branch/2023-version/_sources/resources.md.txt new file mode 100644 index 00000000..53899032 --- /dev/null +++ b/branch/2023-version/_sources/resources.md.txt @@ -0,0 +1,12 @@ +# Other resources + +- [Learn Git branching](http://pcottle.github.io/learnGitBranching/) +- [The entire Pro Git book, written by Scott Chacon and Ben Straub](http://git-scm.com/book) +- [Learn git one commit at a time](http://gitready.com) +- [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/) +- [Commit Often, Perfect Later, Publish Once: Git Best Practices](http://sethrobertson.github.io/GitBestPractices/) +- [PeepCode Git Internals](https://github.com/pluralsight/git-internals-pdf/releases) +- [Git Workflows for Pros: A Good Git Guide](https://www.toptal.com/git/git-workflows-for-pros-a-good-git-guide) +- [Branch-per-Feature](http://dymitruk.com/blog/2012/02/05/branch-per-feature/) +- [Git on XKCD](http://xkcd.com/1597/) +- [An efficient GIT workflow for mid/long term projects](http://fle.github.io/an-efficient-git-workflow-for-midlong-term-projects.html) diff --git a/branch/2023-version/_sources/staging-area.md.txt b/branch/2023-version/_sources/staging-area.md.txt new file mode 100644 index 00000000..94d0fe83 --- /dev/null +++ b/branch/2023-version/_sources/staging-area.md.txt @@ -0,0 +1,330 @@ +# Using the Git staging area + +```{objectives} +- Learn how to tell a story with your commit history. +- Demystify the Git staging area. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 10 min exercise +``` + + +## Commit history is telling a story + +Your *current code* is very important, but the *history* can be just +as important - it tells a story about how your code came to be. + +- Each individual line of code rarely stands alone. +- You often want to see all the related changes together. +- But you also hardly ever do one thing at once. + +Along with your code, Git creates a *history* for you, and if your +history is clear then you are a long way to organized code. + +````{discussion} + Here are five types of history. What are the advantages and + disadvantages of each, when you look at it later? + + **Example 1**: + ```shell + b135ec8 add features A, B, and C + ``` + + **Example 2** (newest commit is on top): + ```shell + 6f0d49f implement feature C + fee1807 implement feature B + 6fe2f23 implement feature A + ``` + + **Example 3**: + ```shell + ab990f4 saving three months of miscellaneous work I forgot to commit + ``` + + **Example 4** (newest commit is on top): + ```shell + bf39f9d more work on feature B + 45831a5 removing debug prints for feature A and add new file + bddb280 more work on feature B and make feature A compile again + 72d78e7 feature A did not work and started work on feature B + b135ec8 now feature A should work + 72e0211 another fix to make it compile + 61dd3a3 forgot file and bugfix + 49dc419 wip (work in progress) + ``` + + **Example 5** (newest commit is on top): + ```shell + 1949dc4 Work of 2020-04-07 + a361dd3 Work of 2020-04-06 + 1172e02 Work of 2020-04-03 + e772d78 Work of 2020-04-02 + ``` + + Discuss these examples. Can you anticipate problems? +```` + +We want to have nice commits. But we also want to "save often" +(checkpointing) - how can we have both? + +- We will now learn to create nice commits using `git commit --patch` and/or the staging area. +- Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits. +- The staging area isn't the only way to organize your history nicely, some alternatives are discussed at the end of the lesson. + + +## Interactive commits + +- The simplest ways to solve this is to do **interactive commits**: + the `git commit --patch` option (or `git commit -p` for short). +- It will present you with every change you have made individually, + and you can decide which ones to commit right now. +- Reference and key commands + - `git commit --patch` to start the interactive commit + - `y` to use the change + - `n` to skip the change + - `s` (split) if there are several changes grouped together, but + separated by a blank line, split them into separate choices. + - `q` aborts everything. + - `?` for more options. +- The `-p` option is also available on `commit`, `restore`, `checkout`, `reset`, and `add`. + + +(exercise-interactive-commits)= + +## Exercise: Interactive commits + +````{exercise} Staging-1: Perform an interactive commit +One option to help us create nice logical commits is to stage *interactively* +with `git commit --patch`: + +1. Make two changes in `instructions.txt`, at the top and bottom + of the file. + **Make sure that they are separated by at least several unmodified lines.** +2. Run `git commit --patch`. Using the keystrokes above, commit one of + the changes. +3. Do it again for the other change. +4. When you're done, inspect the situation with `git log`, `git status`, `git diff` and `git diff --staged`. +5. When would this be useful? + + ```{solution} + This can be useful if you have several modification in a file (or several + files) but you decide that it would be beneficial to save them as two (or + more) separate commits. + ``` +```` + + +## The staging area + +- The interactive commits above are great, but what if there are so + many changes that you can't sort them out in one shot? +- What if you make progress and want to record it somehow, but it's + not ready to be committed? +- The **staging area** is a place to record things before committing. + +```{instructor-note} +We give two examples and the instructor can pick one or both: +- Analogy using moving boxes +- Analogy using shopping receipts +``` + +```{discussion} + **Analogy using moving boxes** + + - You're moving and you have a box to pack your things in. + - You can put stuff into the box, but you can also take stuff out of the box. + - You wouldn't want to mix items from the bathroom, kitchen, and living room + into the same box. + - The box corresponds to the staging area of Git, where you can craft your commits. + - Committing is like sealing the box and sticking a label on it. + - You wouldn't want to label your box with "stuff", but rather give a more + descriptive label. + - See also + + + **Analogy using shopping receipts** + + - You need to go shopping and buy some stuff for work and for home. + You need two separate receipts. + - Bad idea: go through the store get home stuff, pay, start at the + beginning and go through the store again. This is inefficient and + annoying. + - What you actually do: + - Go through the store and put everything you need in your shopping + basket. + - Get to the check-out. Put your home stuff on the conveyor belt + (`git add`). Check both the belt (`git diff --staged`) and your + basket (`git diff`) to make sure you got all your home stuff. + - Pay (`git commit`) + - Repeat for work stuff. + + In order to keep organized, you have to use multiple locations to + stage things in sequence. +``` + + +## Staging area commands + +The staging area is a middle ground between what you have done to your files +(the **working directory**) and what you have last committed (the **HEAD commit**). +Just like the name implies, it lets you prepare (**stage**) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since **you can modify and stage several times before committing**. + +**git add** stages/prepares for the next commit: +```text + git add + [project*] <------------ project* + ^ + | modify with editor + | + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +**git commit** creates a new commit: +```text + + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + HEAD~2 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +**git reset \\--soft HEAD~1** (move HEAD back by one but keep changes and stage +them) would do the opposite of **git commit**. (in this case, `HEAD` +is literally this - not a replacement) + +Going back to the last staged version: +```text + git restore + [project*] ------------> project* + + + + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Unstaging changes with **git restore \\--staged**: +```text + git restore --staged + ------------> project* + + + + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Discarding unstaged changes: +```text + + project* + | + | git restore + v + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Comparing: +```text + git diff + [project*] <-----------> project* + ^ ^ + | git diff --staged | git diff HEAD + v v + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +```{figure} img/staging-basics.svg +:alt: Staging basics +:width: 100% + +The different states of the repository and the commands to move from one to +another. +``` + +(exercise-staging-area)= + +## Exercise: Using the staging area + +```{exercise} Staging-2: Use the staging area to make a commit in two steps +1. In your recipe example, make two different changes to + `ingredients.txt` and `instructions.txt` which do not go together. +2. Use `git add` to stage one of the changes. +3. Use `git status` to see what's going on, and use `git diff` and `git diff --staged` to see the changes. +4. Feel some regret and unstage the staged change. +``` + +```{discussion} +- When is it better to "save" a change as commit, when is it better to "save" + it with `git add`? +- Is it a problem to commit many small changes? +``` + +```{keypoints} +- The staging area helps us to create well-defined commits. +``` diff --git a/branch/2023-version/_sources/under-the-hood.md.txt b/branch/2023-version/_sources/under-the-hood.md.txt new file mode 100644 index 00000000..977968da --- /dev/null +++ b/branch/2023-version/_sources/under-the-hood.md.txt @@ -0,0 +1,185 @@ +# Git under the hood + +```{objectives} +- Verify that branches are pointers to commits and extremely lightweight. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 15 min exercise +``` + +```{figure} img/stranger.jpg +:alt: Git under the hood +:width: 100% +``` + + +## Down the rabbit hole + +When working with Git, **you will never need to go inside .git**, but in this +exercise we will, in order to learn about how branches are implemented in Git. + +For this exercise create a new repository and commit a couple of changes. + +Now that we've made a couple of commits let us look at what is happening under +the hood. + +```console +$ cd .git +$ ls -l + +drwxr-xr-x - user 25 Aug 15:51 branches +.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG +.rw-r--r-- 92 user 25 Aug 15:51 config +.rw-r--r-- 73 user 25 Aug 15:51 description +.rw-r--r-- 21 user 25 Aug 15:51 HEAD +drwxr-xr-x - user 25 Aug 15:51 hooks +.rw-r--r-- 137 user 25 Aug 15:52 index +drwxr-xr-x - user 25 Aug 15:51 info +drwxr-xr-x - user 25 Aug 15:52 logs +drwxr-xr-x - user 25 Aug 15:52 objects +drwxr-xr-x - user 25 Aug 15:51 refs +``` + +Git stores everything under the .git folder in your repository. In fact, **the +.git directory is the Git repository.** + +Previously when you wrote the commit messages using your text editor, they +were in fact saved to `COMMIT_EDITMSG`. + +Each commit in Git is stored as a "blob". This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file. + +Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string). + +```{figure} img/commit-and-tree.png +:alt: A commit inside Git +:width: 100% + +States of a Git file. Image from the [Pro Git book](https://git-scm.com/book/). License CC BY 3.0. +``` + +Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a [directed acyclic +graph](http://eagain.net/articles/git-for-computer-scientists/) (do not worry +if the term is not familiar). + +```{figure} img/commits-and-parents.png +:alt: A commit and its parents +:width: 100% + +A commit and its parents. Image from the [Pro Git book](https://git-scm.com/book/). License CC BY 3.0. +``` + +All branches and tags in Git are pointers to commits. + + +## Git is basically a content-addressed storage system + +- CAS: ["mechanism for storing information that can be retrieved based on its content, not its storage location"](https://en.wikipedia.org/wiki/Content-addressable_storage) +- Content address is the content digest (SHA-1 checksum) +- Stored data does not change - so when we modify commits, we always create new + commits. Git doesn't delete these right away, which is why it is *very hard + to lose data if you commit it once*. + +Let us poke a bit into raw objects! Start with: + +```console +$ git cat-file -p HEAD +``` + +Then explore the `tree` object, then the `file` object, etc. recursively using the hashes you see. + + +## Demonstration: experimenting with branches + +Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an "Aha!" moment and provide us a +good understanding of the underlying model. + +We are starting from the `main` branch and create an `idea` branch: + +```console +$ git status + +On branch main +nothing to commit, working tree clean +``` + +```console +$ git switch --create idea + +Switched to a new branch 'idea' +``` + +```console +$ git branch + +* idea + main +``` + +Now let us go in: + +```console +$ cd .git +$ cd refs/heads +$ ls -l + +.rw-r--r-- 41 user 25 Aug 15:54 idea +.rw-r--r-- 41 user 25 Aug 15:52 main +``` + +Let us check what the `idea` file looks like +(do not worry if the hash is different): +```console +$ cat idea + +045e3db14740c60684d745e5fb891ae71e335611 +``` + +Now let us replicate this file: +```console +$ cp idea idea-2 +$ cp idea idea-3 +$ cp idea idea-4 +$ cp idea idea-5 +``` + +Let us go up two levels and inspect the file `HEAD`: +```console +$ cd ../.. +$ cat HEAD + +ref: refs/heads/idea +``` + +Let us open this file and change it to: +``` +ref: refs/heads/idea-3 +``` + +**Now we are ready for the aha moment!** +First let us go back to the working area: +```console +$ cd .. +``` + +Now - on which branch are we? +```console +$ git branch + + idea + idea-2 +* idea-3 + idea-4 + idea-5 + main +``` + +```{discussion} +Discuss the findings with other course participants. +``` diff --git a/branch/2023-version/_sources/what-to-avoid.md.txt b/branch/2023-version/_sources/what-to-avoid.md.txt new file mode 100644 index 00000000..778d27d0 --- /dev/null +++ b/branch/2023-version/_sources/what-to-avoid.md.txt @@ -0,0 +1,50 @@ +# What to avoid + +The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas. + +**Postponing commits because the changes are "unfinished"/"ugly"**: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all. + +**Not updating your branch before starting new work**: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later. + +**Commit unrelated changes together**: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects. + +**Too ambitious branch which risks to never get completed**: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere. + +**Committing generated files**: See {ref}`gitignore`. + +**Over-engineering the branch layout and safeguards in small projects**: This +may prevent people from contributing (maybe even including yourself?). Add more restrictions and safeguards as +the project and the group of collaborators grows. + +**Commit messages that explain what has been changed but do not explain why it has been +changed**: This is as useful as code comments which describe the "obvious" such +as "this is a loop" instead of explaining why something is done this way. +But don't let perfect commit messages stop you from the most important point, committing often (first point). + +**Commit huge files**: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent `git rm` does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request. + +```{discussion} +Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements. +``` diff --git a/branch/2023-version/_static/_sphinx_javascript_frameworks_compat.js b/branch/2023-version/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/branch/2023-version/_static/_sphinx_javascript_frameworks_compat.js @@ -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; +} diff --git a/branch/2023-version/_static/basic.css b/branch/2023-version/_static/basic.css new file mode 100644 index 00000000..30fee9d0 --- /dev/null +++ b/branch/2023-version/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/branch/2023-version/_static/check-solid.svg b/branch/2023-version/_static/check-solid.svg new file mode 100644 index 00000000..92fad4b5 --- /dev/null +++ b/branch/2023-version/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/2023-version/_static/clipboard.min.js b/branch/2023-version/_static/clipboard.min.js new file mode 100644 index 00000000..54b3c463 --- /dev/null +++ b/branch/2023-version/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/branch/2023-version/_static/copybutton.css b/branch/2023-version/_static/copybutton.css new file mode 100644 index 00000000..40eafe5f --- /dev/null +++ b/branch/2023-version/_static/copybutton.css @@ -0,0 +1,93 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +.highlight:hover button.copybtn { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/branch/2023-version/_static/copybutton.js b/branch/2023-version/_static/copybutton.js new file mode 100644 index 00000000..f3ecd034 --- /dev/null +++ b/branch/2023-version/_static/copybutton.js @@ -0,0 +1,241 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copié dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for two seconds, then changes it back +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000) + setTimeout(() => el.classList.remove('success'), 2000) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, 2000) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos, .gp'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/branch/2023-version/_static/copybutton_funcs.js b/branch/2023-version/_static/copybutton_funcs.js new file mode 100644 index 00000000..dbe1aaad --- /dev/null +++ b/branch/2023-version/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/branch/2023-version/_static/css/badge_only.css b/branch/2023-version/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/branch/2023-version/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/branch/2023-version/_static/css/fonts/Roboto-Slab-Bold.woff b/branch/2023-version/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/branch/2023-version/_static/css/fonts/Roboto-Slab-Bold.woff2 b/branch/2023-version/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/branch/2023-version/_static/css/fonts/Roboto-Slab-Regular.woff b/branch/2023-version/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/branch/2023-version/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/branch/2023-version/_static/css/fonts/Roboto-Slab-Regular.woff2 b/branch/2023-version/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/branch/2023-version/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/branch/2023-version/_static/css/fonts/fontawesome-webfont.eot b/branch/2023-version/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/branch/2023-version/_static/css/fonts/fontawesome-webfont.svg b/branch/2023-version/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/branch/2023-version/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/2023-version/_static/css/fonts/fontawesome-webfont.ttf b/branch/2023-version/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/branch/2023-version/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/branch/2023-version/_static/css/fonts/fontawesome-webfont.woff b/branch/2023-version/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/branch/2023-version/_static/css/fonts/fontawesome-webfont.woff2 b/branch/2023-version/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/branch/2023-version/_static/css/fonts/lato-bold-italic.woff b/branch/2023-version/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-bold-italic.woff differ diff --git a/branch/2023-version/_static/css/fonts/lato-bold-italic.woff2 b/branch/2023-version/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/branch/2023-version/_static/css/fonts/lato-bold.woff b/branch/2023-version/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-bold.woff differ diff --git a/branch/2023-version/_static/css/fonts/lato-bold.woff2 b/branch/2023-version/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-bold.woff2 differ diff --git a/branch/2023-version/_static/css/fonts/lato-normal-italic.woff b/branch/2023-version/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-normal-italic.woff differ diff --git a/branch/2023-version/_static/css/fonts/lato-normal-italic.woff2 b/branch/2023-version/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/branch/2023-version/_static/css/fonts/lato-normal.woff b/branch/2023-version/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-normal.woff differ diff --git a/branch/2023-version/_static/css/fonts/lato-normal.woff2 b/branch/2023-version/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/branch/2023-version/_static/css/fonts/lato-normal.woff2 differ diff --git a/branch/2023-version/_static/css/theme.css b/branch/2023-version/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/branch/2023-version/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/branch/2023-version/_static/doctools.js b/branch/2023-version/_static/doctools.js new file mode 100644 index 00000000..d06a71d7 --- /dev/null +++ b/branch/2023-version/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/branch/2023-version/_static/documentation_options.js b/branch/2023-version/_static/documentation_options.js new file mode 100644 index 00000000..87fc516a --- /dev/null +++ b/branch/2023-version/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'dirhtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/branch/2023-version/_static/file.png b/branch/2023-version/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/branch/2023-version/_static/file.png differ diff --git a/branch/2023-version/_static/jquery.js b/branch/2023-version/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/branch/2023-version/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/2023-version/_static/js/html5shiv.min.js b/branch/2023-version/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/branch/2023-version/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/2023-version/_static/js/theme.js b/branch/2023-version/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/branch/2023-version/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/branch/2023-version/_static/minipres.js b/branch/2023-version/_static/minipres.js new file mode 100644 index 00000000..ad11c871 --- /dev/null +++ b/branch/2023-version/_static/minipres.js @@ -0,0 +1,223 @@ +// Add goTo method to elements +// http://stackoverflow.com/questions/4801655/how-to-go-to-a-specific-element-on-page +(function($) { + $.fn.goTo = function() { + $('html, body').animate({ + scrollTop: $(this).offset().top //+ 'px' + }, 'fast'); + return this; // for chaining... + } +})(jQuery); + +// NO good way to do this!. Copy a hack from here +// https://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript +// https://stackoverflow.com/a/2880929 +var urlParams; +(window.onpopstate = function () { + var match, + pl = /\+/g, // Regex for replacing addition symbol with a space + search = /([^&=]+)=?([^&]*)/g, + decode = function (s) { return decodeURIComponent(s.replace(pl, " ")); }, + query = window.location.search.substring(1); + urlParams = {}; + while (match = search.exec(query)) + urlParams[decode(match[1])] = decode(match[2]); +})(); + +// Select heading levels +var maxHeading = urlParams['h'] +if (maxHeading === undefined) maxHeading = 2 +var headingLevels = []; +for (h=2 ; h (sections.length-1) ) { + // if we would scroll past bottom, or above top, do nothing + return; + } + + console.log('xxxxxx'); + var targetSection = sections[targetPos]; + console.log(targetSection, typeof(targetSection)); + + // Return targetSection top and height + var secProperties = section_top_and_height(targetSection); + var top = secProperties['top']; + var height = secProperties['height'] + var win_height = window.innerHeight; + //console.info(top, height, win_height) + + var scroll_to = 0; + if (height >= win_height || height == 0) { + scroll_to = top; + } else { + scroll_to = top - (win_height-height)/3.; + } + //console.info(top, height, win_height, scroll_to) + + $('html, body').animate({ + scrollTop: scroll_to //+ 'px' + }, 'fast'); + +} + + +function minipres() { + /* Enable the minipres mode: + - call the hide() function + - set up the scrolling listener + */ + document.addEventListener('keydown', function (event) { + switch(event.which) { + case 37: // left + switch_slide(-1); + event.preventDefault(); + return false; + break; + //case 38: // up + case 39: // right + switch_slide(+1); + event.preventDefault(); + return false; + break; + //case 40: // down + default: + return; // exit this handler for other keys + } + }, true) + + hide() + + // Increase space between sections + //$("div .section").css('margin-bottom', '50%'); + $(sectionSelector).css('margin-top', '50%'); + + // Reduce size/color of other sections + if (hiddenSectionSelector.length > 0) { + var hideNodes = $(hiddenSectionSelector); + console.log(typeof hideNodes, hideNodes); + for (node in hideNodes) { + console.log("a", typeof node, node); + node = hideNodes[node]; // what's right way to iterate values? + console.log("b", typeof node, node); + if (node.parentNode && node.parentNode.className == "section") { + node = node.parentNode; + console.log("c", typeof node, node); + //node.css['transform'] = 'scale(.5)'; + //node.css['transform-origin'] = 'top center'; + $(node).css('color', 'lightgrey'); + //$(node).css('font-size', '20%'); + //$(node).css('visibility', 'collapse'); + //ntahousnatouhasno; + } + } + } +} + +function hide() { + /* Hide all non-essential elements on the page + */ + + // This is for sphinx_rst_theme and readthedocs + $(".wy-nav-side").remove(); + $(".wy-nav-content-wrap").css('margin-left', 0); + $('.rst-versions').remove(); // readthedocs version selector + + // Add other formats here. +} + + +var slideshow = minipres; + +if (window.location.search.match(/[?&](minipres|slideshow|pres)([=&]|$)/) ) { + //minipres() + window.addEventListener("load", minipres); +} else if (window.location.search.match(/[?&](plain)([=&]|$)/) ) { + window.addEventListener("load", hide); +} diff --git a/branch/2023-version/_static/minus.png b/branch/2023-version/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/branch/2023-version/_static/minus.png differ diff --git a/branch/2023-version/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css b/branch/2023-version/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css new file mode 100644 index 00000000..33566310 --- /dev/null +++ b/branch/2023-version/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css @@ -0,0 +1,2342 @@ +/* Variables */ +:root { + --mystnb-source-bg-color: #f7f7f7; + --mystnb-stdout-bg-color: #fcfcfc; + --mystnb-stderr-bg-color: #fdd; + --mystnb-traceback-bg-color: #fcfcfc; + --mystnb-source-border-color: #ccc; + --mystnb-source-margin-color: green; + --mystnb-stdout-border-color: #f7f7f7; + --mystnb-stderr-border-color: #f7f7f7; + --mystnb-traceback-border-color: #ffd6d6; + --mystnb-hide-prompt-opacity: 70%; + --mystnb-source-border-radius: .4em; + --mystnb-source-border-width: 1px; +} + +/* Whole cell */ +div.container.cell { + padding-left: 0; + margin-bottom: 1em; +} + +/* Removing all background formatting so we can control at the div level */ +.cell_input div.highlight, +.cell_output pre, +.cell_input pre, +.cell_output .output { + border: none; + box-shadow: none; +} + +.cell_output .output pre, +.cell_input pre { + margin: 0px; +} + +/* Input cells */ +div.cell div.cell_input, +div.cell details.above-input>summary { + padding-left: 0em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + background-color: var(--mystnb-source-bg-color); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; + border-radius: var(--mystnb-source-border-radius); +} + +div.cell_input>div, +div.cell_output div.output>div.highlight { + margin: 0em !important; + border: none !important; +} + +/* All cell outputs */ +.cell_output { + padding-left: 1em; + padding-right: 0em; + margin-top: 1em; +} + +/* Text outputs from cells */ +.cell_output .output.text_plain, +.cell_output .output.traceback, +.cell_output .output.stream, +.cell_output .output.stderr { + margin-top: 1em; + margin-bottom: 0em; + box-shadow: none; +} + +.cell_output .output.text_plain, +.cell_output .output.stream { + background: var(--mystnb-stdout-bg-color); + border: 1px solid var(--mystnb-stdout-border-color); +} + +.cell_output .output.stderr { + background: var(--mystnb-stderr-bg-color); + border: 1px solid var(--mystnb-stderr-border-color); +} + +.cell_output .output.traceback { + background: var(--mystnb-traceback-bg-color); + border: 1px solid var(--mystnb-traceback-border-color); +} + +/* Collapsible cell content */ +div.cell details.above-input div.cell_input { + border-top-left-radius: 0; + border-top-right-radius: 0; + border-top: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; +} + +div.cell div.cell_input.above-output-prompt { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} + +div.cell details.above-input>summary { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + border-bottom: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; + padding-left: 1em; + margin-bottom: 0; +} + +div.cell details.above-output>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.below-input>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-top: none; + border-bottom-left-radius: var(--mystnb-source-border-radius); + border-bottom-right-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.hide>summary>span { + opacity: var(--mystnb-hide-prompt-opacity); +} + +div.cell details.hide[open]>summary>span.collapsed { + display: none; +} + +div.cell details.hide:not([open])>summary>span.expanded { + display: none; +} + +@keyframes collapsed-fade-in { + 0% { + opacity: 0; + } + + 100% { + opacity: 1; + } +} +div.cell details.hide[open]>summary~* { + -moz-animation: collapsed-fade-in 0.3s ease-in-out; + -webkit-animation: collapsed-fade-in 0.3s ease-in-out; + animation: collapsed-fade-in 0.3s ease-in-out; +} + +/* Math align to the left */ +.cell_output .MathJax_Display { + text-align: left !important; +} + +/* Pandas tables. Pulled from the Jupyter / nbsphinx CSS */ +div.cell_output table { + border: none; + border-collapse: collapse; + border-spacing: 0; + color: black; + font-size: 1em; + table-layout: fixed; +} + +div.cell_output thead { + border-bottom: 1px solid black; + vertical-align: bottom; +} + +div.cell_output tr, +div.cell_output th, +div.cell_output td { + text-align: right; + vertical-align: middle; + padding: 0.5em 0.5em; + line-height: normal; + white-space: normal; + max-width: none; + border: none; +} + +div.cell_output th { + font-weight: bold; +} + +div.cell_output tbody tr:nth-child(odd) { + background: #f5f5f5; +} + +div.cell_output tbody tr:hover { + background: rgba(66, 165, 245, 0.2); +} + +/** source code line numbers **/ +span.linenos { + opacity: 0.5; +} + +/* Inline text from `paste` operation */ + +span.pasted-text { + font-weight: bold; +} + +span.pasted-inline img { + max-height: 2em; +} + +tbody span.pasted-inline img { + max-height: none; +} + +/* Font colors for translated ANSI escape sequences +Color values are copied from Jupyter Notebook +https://github.com/jupyter/notebook/blob/52581f8eda9b319eb0390ac77fe5903c38f81e3e/notebook/static/notebook/less/ansicolors.less#L14-L21 +Background colors from +https://nbsphinx.readthedocs.io/en/latest/code-cells.html#ANSI-Colors +*/ +div.highlight .-Color-Bold { + font-weight: bold; +} + +div.highlight .-Color[class*=-Black] { + color: #3E424D +} + +div.highlight .-Color[class*=-Red] { + color: #E75C58 +} + +div.highlight .-Color[class*=-Green] { + color: #00A250 +} + +div.highlight .-Color[class*=-Yellow] { + color: #DDB62B +} + +div.highlight .-Color[class*=-Blue] { + color: #208FFB +} + +div.highlight .-Color[class*=-Magenta] { + color: #D160C4 +} + +div.highlight .-Color[class*=-Cyan] { + color: #60C6C8 +} + +div.highlight .-Color[class*=-White] { + color: #C5C1B4 +} + +div.highlight .-Color[class*=-BGBlack] { + background-color: #3E424D +} + +div.highlight .-Color[class*=-BGRed] { + background-color: #E75C58 +} + +div.highlight .-Color[class*=-BGGreen] { + background-color: #00A250 +} + +div.highlight .-Color[class*=-BGYellow] { + background-color: #DDB62B +} + +div.highlight .-Color[class*=-BGBlue] { + background-color: #208FFB +} + +div.highlight .-Color[class*=-BGMagenta] { + background-color: #D160C4 +} + +div.highlight .-Color[class*=-BGCyan] { + background-color: #60C6C8 +} + +div.highlight .-Color[class*=-BGWhite] { + background-color: #C5C1B4 +} + +/* Font colors for 8-bit ANSI */ + +div.highlight .-Color[class*=-C0] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC0] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C1] { + color: #800000 +} + +div.highlight .-Color[class*=-BGC1] { + background-color: #800000 +} + +div.highlight .-Color[class*=-C2] { + color: #008000 +} + +div.highlight .-Color[class*=-BGC2] { + background-color: #008000 +} + +div.highlight .-Color[class*=-C3] { + color: #808000 +} + +div.highlight .-Color[class*=-BGC3] { + background-color: #808000 +} + +div.highlight .-Color[class*=-C4] { + color: #000080 +} + +div.highlight .-Color[class*=-BGC4] { + background-color: #000080 +} + +div.highlight .-Color[class*=-C5] { + color: #800080 +} + +div.highlight .-Color[class*=-BGC5] { + background-color: #800080 +} + +div.highlight .-Color[class*=-C6] { + color: #008080 +} + +div.highlight .-Color[class*=-BGC6] { + background-color: #008080 +} + +div.highlight .-Color[class*=-C7] { + color: #C0C0C0 +} + +div.highlight .-Color[class*=-BGC7] { + background-color: #C0C0C0 +} + +div.highlight .-Color[class*=-C8] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC8] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C9] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC9] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C10] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC10] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C11] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC11] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C12] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC12] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C13] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC13] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C14] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC14] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C15] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC15] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C16] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC16] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C17] { + color: #00005F +} + +div.highlight .-Color[class*=-BGC17] { + background-color: #00005F +} + +div.highlight .-Color[class*=-C18] { + color: #000087 +} + +div.highlight .-Color[class*=-BGC18] { + background-color: #000087 +} + +div.highlight .-Color[class*=-C19] { + color: #0000AF +} + +div.highlight .-Color[class*=-BGC19] { + background-color: #0000AF +} + +div.highlight .-Color[class*=-C20] { + color: #0000D7 +} + +div.highlight .-Color[class*=-BGC20] { + background-color: #0000D7 +} + +div.highlight .-Color[class*=-C21] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC21] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C22] { + color: #005F00 +} + +div.highlight .-Color[class*=-BGC22] { + background-color: #005F00 +} + +div.highlight .-Color[class*=-C23] { + color: #005F5F +} + +div.highlight .-Color[class*=-BGC23] { + background-color: #005F5F +} + +div.highlight .-Color[class*=-C24] { + color: #005F87 +} + +div.highlight .-Color[class*=-BGC24] { + background-color: #005F87 +} + +div.highlight .-Color[class*=-C25] { + color: #005FAF +} + +div.highlight .-Color[class*=-BGC25] { + background-color: #005FAF +} + +div.highlight .-Color[class*=-C26] { + color: #005FD7 +} + +div.highlight .-Color[class*=-BGC26] { + background-color: #005FD7 +} + +div.highlight .-Color[class*=-C27] { + color: #005FFF +} + +div.highlight .-Color[class*=-BGC27] { + background-color: #005FFF +} + +div.highlight .-Color[class*=-C28] { + color: #008700 +} + +div.highlight .-Color[class*=-BGC28] { + background-color: #008700 +} + +div.highlight .-Color[class*=-C29] { + color: #00875F +} + +div.highlight .-Color[class*=-BGC29] { + background-color: #00875F +} + +div.highlight .-Color[class*=-C30] { + color: #008787 +} + +div.highlight .-Color[class*=-BGC30] { + background-color: #008787 +} + +div.highlight .-Color[class*=-C31] { + color: #0087AF +} + +div.highlight .-Color[class*=-BGC31] { + background-color: #0087AF +} + +div.highlight .-Color[class*=-C32] { + color: #0087D7 +} + +div.highlight .-Color[class*=-BGC32] { + background-color: #0087D7 +} + +div.highlight .-Color[class*=-C33] { + color: #0087FF +} + +div.highlight .-Color[class*=-BGC33] { + background-color: #0087FF +} + +div.highlight .-Color[class*=-C34] { + color: #00AF00 +} + +div.highlight .-Color[class*=-BGC34] { + background-color: #00AF00 +} + +div.highlight .-Color[class*=-C35] { + color: #00AF5F +} + +div.highlight .-Color[class*=-BGC35] { + background-color: #00AF5F +} + +div.highlight .-Color[class*=-C36] { + color: #00AF87 +} + +div.highlight .-Color[class*=-BGC36] { + background-color: #00AF87 +} + +div.highlight .-Color[class*=-C37] { + color: #00AFAF +} + +div.highlight .-Color[class*=-BGC37] { + background-color: #00AFAF +} + +div.highlight .-Color[class*=-C38] { + color: #00AFD7 +} + +div.highlight .-Color[class*=-BGC38] { + background-color: #00AFD7 +} + +div.highlight .-Color[class*=-C39] { + color: #00AFFF +} + +div.highlight .-Color[class*=-BGC39] { + background-color: #00AFFF +} + +div.highlight .-Color[class*=-C40] { + color: #00D700 +} + +div.highlight .-Color[class*=-BGC40] { + background-color: #00D700 +} + +div.highlight .-Color[class*=-C41] { + color: #00D75F +} + +div.highlight .-Color[class*=-BGC41] { + background-color: #00D75F +} + +div.highlight .-Color[class*=-C42] { + color: #00D787 +} + +div.highlight .-Color[class*=-BGC42] { + background-color: #00D787 +} + +div.highlight .-Color[class*=-C43] { + color: #00D7AF +} + +div.highlight .-Color[class*=-BGC43] { + background-color: #00D7AF +} + +div.highlight .-Color[class*=-C44] { + color: #00D7D7 +} + +div.highlight .-Color[class*=-BGC44] { + background-color: #00D7D7 +} + +div.highlight .-Color[class*=-C45] { + color: #00D7FF +} + +div.highlight .-Color[class*=-BGC45] { + background-color: #00D7FF +} + +div.highlight .-Color[class*=-C46] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC46] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C47] { + color: #00FF5F +} + +div.highlight .-Color[class*=-BGC47] { + background-color: #00FF5F +} + +div.highlight .-Color[class*=-C48] { + color: #00FF87 +} + +div.highlight .-Color[class*=-BGC48] { + background-color: #00FF87 +} + +div.highlight .-Color[class*=-C49] { + color: #00FFAF +} + +div.highlight .-Color[class*=-BGC49] { + background-color: #00FFAF +} + +div.highlight .-Color[class*=-C50] { + color: #00FFD7 +} + +div.highlight .-Color[class*=-BGC50] { + background-color: #00FFD7 +} + +div.highlight .-Color[class*=-C51] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC51] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C52] { + color: #5F0000 +} + +div.highlight .-Color[class*=-BGC52] { + background-color: #5F0000 +} + +div.highlight .-Color[class*=-C53] { + color: #5F005F +} + +div.highlight .-Color[class*=-BGC53] { + background-color: #5F005F +} + +div.highlight .-Color[class*=-C54] { + color: #5F0087 +} + +div.highlight .-Color[class*=-BGC54] { + background-color: #5F0087 +} + +div.highlight .-Color[class*=-C55] { + color: #5F00AF +} + +div.highlight .-Color[class*=-BGC55] { + background-color: #5F00AF +} + +div.highlight .-Color[class*=-C56] { + color: #5F00D7 +} + +div.highlight .-Color[class*=-BGC56] { + background-color: #5F00D7 +} + +div.highlight .-Color[class*=-C57] { + color: #5F00FF +} + +div.highlight .-Color[class*=-BGC57] { + background-color: #5F00FF +} + +div.highlight .-Color[class*=-C58] { + color: #5F5F00 +} + +div.highlight .-Color[class*=-BGC58] { + background-color: #5F5F00 +} + +div.highlight .-Color[class*=-C59] { + color: #5F5F5F +} + +div.highlight .-Color[class*=-BGC59] { + background-color: #5F5F5F +} + +div.highlight .-Color[class*=-C60] { + color: #5F5F87 +} + +div.highlight .-Color[class*=-BGC60] { + background-color: #5F5F87 +} + +div.highlight .-Color[class*=-C61] { + color: #5F5FAF +} + +div.highlight .-Color[class*=-BGC61] { + background-color: #5F5FAF +} + +div.highlight .-Color[class*=-C62] { + color: #5F5FD7 +} + +div.highlight .-Color[class*=-BGC62] { + background-color: #5F5FD7 +} + +div.highlight .-Color[class*=-C63] { + color: #5F5FFF +} + +div.highlight .-Color[class*=-BGC63] { + background-color: #5F5FFF +} + +div.highlight .-Color[class*=-C64] { + color: #5F8700 +} + +div.highlight .-Color[class*=-BGC64] { + background-color: #5F8700 +} + +div.highlight .-Color[class*=-C65] { + color: #5F875F +} + +div.highlight .-Color[class*=-BGC65] { + background-color: #5F875F +} + +div.highlight .-Color[class*=-C66] { + color: #5F8787 +} + +div.highlight .-Color[class*=-BGC66] { + background-color: #5F8787 +} + +div.highlight .-Color[class*=-C67] { + color: #5F87AF +} + +div.highlight .-Color[class*=-BGC67] { + background-color: #5F87AF +} + +div.highlight .-Color[class*=-C68] { + color: #5F87D7 +} + +div.highlight .-Color[class*=-BGC68] { + background-color: #5F87D7 +} + +div.highlight .-Color[class*=-C69] { + color: #5F87FF +} + +div.highlight .-Color[class*=-BGC69] { + background-color: #5F87FF +} + +div.highlight .-Color[class*=-C70] { + color: #5FAF00 +} + +div.highlight .-Color[class*=-BGC70] { + background-color: #5FAF00 +} + +div.highlight .-Color[class*=-C71] { + color: #5FAF5F +} + +div.highlight .-Color[class*=-BGC71] { + background-color: #5FAF5F +} + +div.highlight .-Color[class*=-C72] { + color: #5FAF87 +} + +div.highlight .-Color[class*=-BGC72] { + background-color: #5FAF87 +} + +div.highlight .-Color[class*=-C73] { + color: #5FAFAF +} + +div.highlight .-Color[class*=-BGC73] { + background-color: #5FAFAF +} + +div.highlight .-Color[class*=-C74] { + color: #5FAFD7 +} + +div.highlight .-Color[class*=-BGC74] { + background-color: #5FAFD7 +} + +div.highlight .-Color[class*=-C75] { + color: #5FAFFF +} + +div.highlight .-Color[class*=-BGC75] { + background-color: #5FAFFF +} + +div.highlight .-Color[class*=-C76] { + color: #5FD700 +} + +div.highlight .-Color[class*=-BGC76] { + background-color: #5FD700 +} + +div.highlight .-Color[class*=-C77] { + color: #5FD75F +} + +div.highlight .-Color[class*=-BGC77] { + background-color: #5FD75F +} + +div.highlight .-Color[class*=-C78] { + color: #5FD787 +} + +div.highlight .-Color[class*=-BGC78] { + background-color: #5FD787 +} + +div.highlight .-Color[class*=-C79] { + color: #5FD7AF +} + +div.highlight .-Color[class*=-BGC79] { + background-color: #5FD7AF +} + +div.highlight .-Color[class*=-C80] { + color: #5FD7D7 +} + +div.highlight .-Color[class*=-BGC80] { + background-color: #5FD7D7 +} + +div.highlight .-Color[class*=-C81] { + color: #5FD7FF +} + +div.highlight .-Color[class*=-BGC81] { + background-color: #5FD7FF +} + +div.highlight .-Color[class*=-C82] { + color: #5FFF00 +} + +div.highlight .-Color[class*=-BGC82] { + background-color: #5FFF00 +} + +div.highlight .-Color[class*=-C83] { + color: #5FFF5F +} + +div.highlight .-Color[class*=-BGC83] { + background-color: #5FFF5F +} + +div.highlight .-Color[class*=-C84] { + color: #5FFF87 +} + +div.highlight .-Color[class*=-BGC84] { + background-color: #5FFF87 +} + +div.highlight .-Color[class*=-C85] { + color: #5FFFAF +} + +div.highlight .-Color[class*=-BGC85] { + background-color: #5FFFAF +} + +div.highlight .-Color[class*=-C86] { + color: #5FFFD7 +} + +div.highlight .-Color[class*=-BGC86] { + background-color: #5FFFD7 +} + +div.highlight .-Color[class*=-C87] { + color: #5FFFFF +} + +div.highlight .-Color[class*=-BGC87] { + background-color: #5FFFFF +} + +div.highlight .-Color[class*=-C88] { + color: #870000 +} + +div.highlight .-Color[class*=-BGC88] { + background-color: #870000 +} + +div.highlight .-Color[class*=-C89] { + color: #87005F +} + +div.highlight .-Color[class*=-BGC89] { + background-color: #87005F +} + +div.highlight .-Color[class*=-C90] { + color: #870087 +} + +div.highlight .-Color[class*=-BGC90] { + background-color: #870087 +} + +div.highlight .-Color[class*=-C91] { + color: #8700AF +} + +div.highlight .-Color[class*=-BGC91] { + background-color: #8700AF +} + +div.highlight .-Color[class*=-C92] { + color: #8700D7 +} + +div.highlight .-Color[class*=-BGC92] { + background-color: #8700D7 +} + +div.highlight .-Color[class*=-C93] { + color: #8700FF +} + +div.highlight .-Color[class*=-BGC93] { + background-color: #8700FF +} + +div.highlight .-Color[class*=-C94] { + color: #875F00 +} + +div.highlight .-Color[class*=-BGC94] { + background-color: #875F00 +} + +div.highlight .-Color[class*=-C95] { + color: #875F5F +} + +div.highlight .-Color[class*=-BGC95] { + background-color: #875F5F +} + +div.highlight .-Color[class*=-C96] { + color: #875F87 +} + +div.highlight .-Color[class*=-BGC96] { + background-color: #875F87 +} + +div.highlight .-Color[class*=-C97] { + color: #875FAF +} + +div.highlight .-Color[class*=-BGC97] { + background-color: #875FAF +} + +div.highlight .-Color[class*=-C98] { + color: #875FD7 +} + +div.highlight .-Color[class*=-BGC98] { + background-color: #875FD7 +} + +div.highlight .-Color[class*=-C99] { + color: #875FFF +} + +div.highlight .-Color[class*=-BGC99] { + background-color: #875FFF +} + +div.highlight .-Color[class*=-C100] { + color: #878700 +} + +div.highlight .-Color[class*=-BGC100] { + background-color: #878700 +} + +div.highlight .-Color[class*=-C101] { + color: #87875F +} + +div.highlight .-Color[class*=-BGC101] { + background-color: #87875F +} + +div.highlight .-Color[class*=-C102] { + color: #878787 +} + +div.highlight .-Color[class*=-BGC102] { + background-color: #878787 +} + +div.highlight .-Color[class*=-C103] { + color: #8787AF +} + +div.highlight .-Color[class*=-BGC103] { + background-color: #8787AF +} + +div.highlight .-Color[class*=-C104] { + color: #8787D7 +} + +div.highlight .-Color[class*=-BGC104] { + background-color: #8787D7 +} + +div.highlight .-Color[class*=-C105] { + color: #8787FF +} + +div.highlight .-Color[class*=-BGC105] { + background-color: #8787FF +} + +div.highlight .-Color[class*=-C106] { + color: #87AF00 +} + +div.highlight .-Color[class*=-BGC106] { + background-color: #87AF00 +} + +div.highlight .-Color[class*=-C107] { + color: #87AF5F +} + +div.highlight .-Color[class*=-BGC107] { + background-color: #87AF5F +} + +div.highlight .-Color[class*=-C108] { + color: #87AF87 +} + +div.highlight .-Color[class*=-BGC108] { + background-color: #87AF87 +} + +div.highlight .-Color[class*=-C109] { + color: #87AFAF +} + +div.highlight .-Color[class*=-BGC109] { + background-color: #87AFAF +} + +div.highlight .-Color[class*=-C110] { + color: #87AFD7 +} + +div.highlight .-Color[class*=-BGC110] { + background-color: #87AFD7 +} + +div.highlight .-Color[class*=-C111] { + color: #87AFFF +} + +div.highlight .-Color[class*=-BGC111] { + background-color: #87AFFF +} + +div.highlight .-Color[class*=-C112] { + color: #87D700 +} + +div.highlight .-Color[class*=-BGC112] { + background-color: #87D700 +} + +div.highlight .-Color[class*=-C113] { + color: #87D75F +} + +div.highlight .-Color[class*=-BGC113] { + background-color: #87D75F +} + +div.highlight .-Color[class*=-C114] { + color: #87D787 +} + +div.highlight .-Color[class*=-BGC114] { + background-color: #87D787 +} + +div.highlight .-Color[class*=-C115] { + color: #87D7AF +} + +div.highlight .-Color[class*=-BGC115] { + background-color: #87D7AF +} + +div.highlight .-Color[class*=-C116] { + color: #87D7D7 +} + +div.highlight .-Color[class*=-BGC116] { + background-color: #87D7D7 +} + +div.highlight .-Color[class*=-C117] { + color: #87D7FF +} + +div.highlight .-Color[class*=-BGC117] { + background-color: #87D7FF +} + +div.highlight .-Color[class*=-C118] { + color: #87FF00 +} + +div.highlight .-Color[class*=-BGC118] { + background-color: #87FF00 +} + +div.highlight .-Color[class*=-C119] { + color: #87FF5F +} + +div.highlight .-Color[class*=-BGC119] { + background-color: #87FF5F +} + +div.highlight .-Color[class*=-C120] { + color: #87FF87 +} + +div.highlight .-Color[class*=-BGC120] { + background-color: #87FF87 +} + +div.highlight .-Color[class*=-C121] { + color: #87FFAF +} + +div.highlight .-Color[class*=-BGC121] { + background-color: #87FFAF +} + +div.highlight .-Color[class*=-C122] { + color: #87FFD7 +} + +div.highlight .-Color[class*=-BGC122] { + background-color: #87FFD7 +} + +div.highlight .-Color[class*=-C123] { + color: #87FFFF +} + +div.highlight .-Color[class*=-BGC123] { + background-color: #87FFFF +} + +div.highlight .-Color[class*=-C124] { + color: #AF0000 +} + +div.highlight .-Color[class*=-BGC124] { + background-color: #AF0000 +} + +div.highlight .-Color[class*=-C125] { + color: #AF005F +} + +div.highlight .-Color[class*=-BGC125] { + background-color: #AF005F +} + +div.highlight .-Color[class*=-C126] { + color: #AF0087 +} + +div.highlight .-Color[class*=-BGC126] { + background-color: #AF0087 +} + +div.highlight .-Color[class*=-C127] { + color: #AF00AF +} + +div.highlight .-Color[class*=-BGC127] { + background-color: #AF00AF +} + +div.highlight .-Color[class*=-C128] { + color: #AF00D7 +} + +div.highlight .-Color[class*=-BGC128] { + background-color: #AF00D7 +} + +div.highlight .-Color[class*=-C129] { + color: #AF00FF +} + +div.highlight .-Color[class*=-BGC129] { + background-color: #AF00FF +} + +div.highlight .-Color[class*=-C130] { + color: #AF5F00 +} + +div.highlight .-Color[class*=-BGC130] { + background-color: #AF5F00 +} + +div.highlight .-Color[class*=-C131] { + color: #AF5F5F +} + +div.highlight .-Color[class*=-BGC131] { + background-color: #AF5F5F +} + +div.highlight .-Color[class*=-C132] { + color: #AF5F87 +} + +div.highlight .-Color[class*=-BGC132] { + background-color: #AF5F87 +} + +div.highlight .-Color[class*=-C133] { + color: #AF5FAF +} + +div.highlight .-Color[class*=-BGC133] { + background-color: #AF5FAF +} + +div.highlight .-Color[class*=-C134] { + color: #AF5FD7 +} + +div.highlight .-Color[class*=-BGC134] { + background-color: #AF5FD7 +} + +div.highlight .-Color[class*=-C135] { + color: #AF5FFF +} + +div.highlight .-Color[class*=-BGC135] { + background-color: #AF5FFF +} + +div.highlight .-Color[class*=-C136] { + color: #AF8700 +} + +div.highlight .-Color[class*=-BGC136] { + background-color: #AF8700 +} + +div.highlight .-Color[class*=-C137] { + color: #AF875F +} + +div.highlight .-Color[class*=-BGC137] { + background-color: #AF875F +} + +div.highlight .-Color[class*=-C138] { + color: #AF8787 +} + +div.highlight .-Color[class*=-BGC138] { + background-color: #AF8787 +} + +div.highlight .-Color[class*=-C139] { + color: #AF87AF +} + +div.highlight .-Color[class*=-BGC139] { + background-color: #AF87AF +} + +div.highlight .-Color[class*=-C140] { + color: #AF87D7 +} + +div.highlight .-Color[class*=-BGC140] { + background-color: #AF87D7 +} + +div.highlight .-Color[class*=-C141] { + color: #AF87FF +} + +div.highlight .-Color[class*=-BGC141] { + background-color: #AF87FF +} + +div.highlight .-Color[class*=-C142] { + color: #AFAF00 +} + +div.highlight .-Color[class*=-BGC142] { + background-color: #AFAF00 +} + +div.highlight .-Color[class*=-C143] { + color: #AFAF5F +} + +div.highlight .-Color[class*=-BGC143] { + background-color: #AFAF5F +} + +div.highlight .-Color[class*=-C144] { + color: #AFAF87 +} + +div.highlight .-Color[class*=-BGC144] { + background-color: #AFAF87 +} + +div.highlight .-Color[class*=-C145] { + color: #AFAFAF +} + +div.highlight .-Color[class*=-BGC145] { + background-color: #AFAFAF +} + +div.highlight .-Color[class*=-C146] { + color: #AFAFD7 +} + +div.highlight .-Color[class*=-BGC146] { + background-color: #AFAFD7 +} + +div.highlight .-Color[class*=-C147] { + color: #AFAFFF +} + +div.highlight .-Color[class*=-BGC147] { + background-color: #AFAFFF +} + +div.highlight .-Color[class*=-C148] { + color: #AFD700 +} + +div.highlight .-Color[class*=-BGC148] { + background-color: #AFD700 +} + +div.highlight .-Color[class*=-C149] { + color: #AFD75F +} + +div.highlight .-Color[class*=-BGC149] { + background-color: #AFD75F +} + +div.highlight .-Color[class*=-C150] { + color: #AFD787 +} + +div.highlight .-Color[class*=-BGC150] { + background-color: #AFD787 +} + +div.highlight .-Color[class*=-C151] { + color: #AFD7AF +} + +div.highlight .-Color[class*=-BGC151] { + background-color: #AFD7AF +} + +div.highlight .-Color[class*=-C152] { + color: #AFD7D7 +} + +div.highlight .-Color[class*=-BGC152] { + background-color: #AFD7D7 +} + +div.highlight .-Color[class*=-C153] { + color: #AFD7FF +} + +div.highlight .-Color[class*=-BGC153] { + background-color: #AFD7FF +} + +div.highlight .-Color[class*=-C154] { + color: #AFFF00 +} + +div.highlight .-Color[class*=-BGC154] { + background-color: #AFFF00 +} + +div.highlight .-Color[class*=-C155] { + color: #AFFF5F +} + +div.highlight .-Color[class*=-BGC155] { + background-color: #AFFF5F +} + +div.highlight .-Color[class*=-C156] { + color: #AFFF87 +} + +div.highlight .-Color[class*=-BGC156] { + background-color: #AFFF87 +} + +div.highlight .-Color[class*=-C157] { + color: #AFFFAF +} + +div.highlight .-Color[class*=-BGC157] { + background-color: #AFFFAF +} + +div.highlight .-Color[class*=-C158] { + color: #AFFFD7 +} + +div.highlight .-Color[class*=-BGC158] { + background-color: #AFFFD7 +} + +div.highlight .-Color[class*=-C159] { + color: #AFFFFF +} + +div.highlight .-Color[class*=-BGC159] { + background-color: #AFFFFF +} + +div.highlight .-Color[class*=-C160] { + color: #D70000 +} + +div.highlight .-Color[class*=-BGC160] { + background-color: #D70000 +} + +div.highlight .-Color[class*=-C161] { + color: #D7005F +} + +div.highlight .-Color[class*=-BGC161] { + background-color: #D7005F +} + +div.highlight .-Color[class*=-C162] { + color: #D70087 +} + +div.highlight .-Color[class*=-BGC162] { + background-color: #D70087 +} + +div.highlight .-Color[class*=-C163] { + color: #D700AF +} + +div.highlight .-Color[class*=-BGC163] { + background-color: #D700AF +} + +div.highlight .-Color[class*=-C164] { + color: #D700D7 +} + +div.highlight .-Color[class*=-BGC164] { + background-color: #D700D7 +} + +div.highlight .-Color[class*=-C165] { + color: #D700FF +} + +div.highlight .-Color[class*=-BGC165] { + background-color: #D700FF +} + +div.highlight .-Color[class*=-C166] { + color: #D75F00 +} + +div.highlight .-Color[class*=-BGC166] { + background-color: #D75F00 +} + +div.highlight .-Color[class*=-C167] { + color: #D75F5F +} + +div.highlight .-Color[class*=-BGC167] { + background-color: #D75F5F +} + +div.highlight .-Color[class*=-C168] { + color: #D75F87 +} + +div.highlight .-Color[class*=-BGC168] { + background-color: #D75F87 +} + +div.highlight .-Color[class*=-C169] { + color: #D75FAF +} + +div.highlight .-Color[class*=-BGC169] { + background-color: #D75FAF +} + +div.highlight .-Color[class*=-C170] { + color: #D75FD7 +} + +div.highlight .-Color[class*=-BGC170] { + background-color: #D75FD7 +} + +div.highlight .-Color[class*=-C171] { + color: #D75FFF +} + +div.highlight .-Color[class*=-BGC171] { + background-color: #D75FFF +} + +div.highlight .-Color[class*=-C172] { + color: #D78700 +} + +div.highlight .-Color[class*=-BGC172] { + background-color: #D78700 +} + +div.highlight .-Color[class*=-C173] { + color: #D7875F +} + +div.highlight .-Color[class*=-BGC173] { + background-color: #D7875F +} + +div.highlight .-Color[class*=-C174] { + color: #D78787 +} + +div.highlight .-Color[class*=-BGC174] { + background-color: #D78787 +} + +div.highlight .-Color[class*=-C175] { + color: #D787AF +} + +div.highlight .-Color[class*=-BGC175] { + background-color: #D787AF +} + +div.highlight .-Color[class*=-C176] { + color: #D787D7 +} + +div.highlight .-Color[class*=-BGC176] { + background-color: #D787D7 +} + +div.highlight .-Color[class*=-C177] { + color: #D787FF +} + +div.highlight .-Color[class*=-BGC177] { + background-color: #D787FF +} + +div.highlight .-Color[class*=-C178] { + color: #D7AF00 +} + +div.highlight .-Color[class*=-BGC178] { + background-color: #D7AF00 +} + +div.highlight .-Color[class*=-C179] { + color: #D7AF5F +} + +div.highlight .-Color[class*=-BGC179] { + background-color: #D7AF5F +} + +div.highlight .-Color[class*=-C180] { + color: #D7AF87 +} + +div.highlight .-Color[class*=-BGC180] { + background-color: #D7AF87 +} + +div.highlight .-Color[class*=-C181] { + color: #D7AFAF +} + +div.highlight .-Color[class*=-BGC181] { + background-color: #D7AFAF +} + +div.highlight .-Color[class*=-C182] { + color: #D7AFD7 +} + +div.highlight .-Color[class*=-BGC182] { + background-color: #D7AFD7 +} + +div.highlight .-Color[class*=-C183] { + color: #D7AFFF +} + +div.highlight .-Color[class*=-BGC183] { + background-color: #D7AFFF +} + +div.highlight .-Color[class*=-C184] { + color: #D7D700 +} + +div.highlight .-Color[class*=-BGC184] { + background-color: #D7D700 +} + +div.highlight .-Color[class*=-C185] { + color: #D7D75F +} + +div.highlight .-Color[class*=-BGC185] { + background-color: #D7D75F +} + +div.highlight .-Color[class*=-C186] { + color: #D7D787 +} + +div.highlight .-Color[class*=-BGC186] { + background-color: #D7D787 +} + +div.highlight .-Color[class*=-C187] { + color: #D7D7AF +} + +div.highlight .-Color[class*=-BGC187] { + background-color: #D7D7AF +} + +div.highlight .-Color[class*=-C188] { + color: #D7D7D7 +} + +div.highlight .-Color[class*=-BGC188] { + background-color: #D7D7D7 +} + +div.highlight .-Color[class*=-C189] { + color: #D7D7FF +} + +div.highlight .-Color[class*=-BGC189] { + background-color: #D7D7FF +} + +div.highlight .-Color[class*=-C190] { + color: #D7FF00 +} + +div.highlight .-Color[class*=-BGC190] { + background-color: #D7FF00 +} + +div.highlight .-Color[class*=-C191] { + color: #D7FF5F +} + +div.highlight .-Color[class*=-BGC191] { + background-color: #D7FF5F +} + +div.highlight .-Color[class*=-C192] { + color: #D7FF87 +} + +div.highlight .-Color[class*=-BGC192] { + background-color: #D7FF87 +} + +div.highlight .-Color[class*=-C193] { + color: #D7FFAF +} + +div.highlight .-Color[class*=-BGC193] { + background-color: #D7FFAF +} + +div.highlight .-Color[class*=-C194] { + color: #D7FFD7 +} + +div.highlight .-Color[class*=-BGC194] { + background-color: #D7FFD7 +} + +div.highlight .-Color[class*=-C195] { + color: #D7FFFF +} + +div.highlight .-Color[class*=-BGC195] { + background-color: #D7FFFF +} + +div.highlight .-Color[class*=-C196] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC196] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C197] { + color: #FF005F +} + +div.highlight .-Color[class*=-BGC197] { + background-color: #FF005F +} + +div.highlight .-Color[class*=-C198] { + color: #FF0087 +} + +div.highlight .-Color[class*=-BGC198] { + background-color: #FF0087 +} + +div.highlight .-Color[class*=-C199] { + color: #FF00AF +} + +div.highlight .-Color[class*=-BGC199] { + background-color: #FF00AF +} + +div.highlight .-Color[class*=-C200] { + color: #FF00D7 +} + +div.highlight .-Color[class*=-BGC200] { + background-color: #FF00D7 +} + +div.highlight .-Color[class*=-C201] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC201] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C202] { + color: #FF5F00 +} + +div.highlight .-Color[class*=-BGC202] { + background-color: #FF5F00 +} + +div.highlight .-Color[class*=-C203] { + color: #FF5F5F +} + +div.highlight .-Color[class*=-BGC203] { + background-color: #FF5F5F +} + +div.highlight .-Color[class*=-C204] { + color: #FF5F87 +} + +div.highlight .-Color[class*=-BGC204] { + background-color: #FF5F87 +} + +div.highlight .-Color[class*=-C205] { + color: #FF5FAF +} + +div.highlight .-Color[class*=-BGC205] { + background-color: #FF5FAF +} + +div.highlight .-Color[class*=-C206] { + color: #FF5FD7 +} + +div.highlight .-Color[class*=-BGC206] { + background-color: #FF5FD7 +} + +div.highlight .-Color[class*=-C207] { + color: #FF5FFF +} + +div.highlight .-Color[class*=-BGC207] { + background-color: #FF5FFF +} + +div.highlight .-Color[class*=-C208] { + color: #FF8700 +} + +div.highlight .-Color[class*=-BGC208] { + background-color: #FF8700 +} + +div.highlight .-Color[class*=-C209] { + color: #FF875F +} + +div.highlight .-Color[class*=-BGC209] { + background-color: #FF875F +} + +div.highlight .-Color[class*=-C210] { + color: #FF8787 +} + +div.highlight .-Color[class*=-BGC210] { + background-color: #FF8787 +} + +div.highlight .-Color[class*=-C211] { + color: #FF87AF +} + +div.highlight .-Color[class*=-BGC211] { + background-color: #FF87AF +} + +div.highlight .-Color[class*=-C212] { + color: #FF87D7 +} + +div.highlight .-Color[class*=-BGC212] { + background-color: #FF87D7 +} + +div.highlight .-Color[class*=-C213] { + color: #FF87FF +} + +div.highlight .-Color[class*=-BGC213] { + background-color: #FF87FF +} + +div.highlight .-Color[class*=-C214] { + color: #FFAF00 +} + +div.highlight .-Color[class*=-BGC214] { + background-color: #FFAF00 +} + +div.highlight .-Color[class*=-C215] { + color: #FFAF5F +} + +div.highlight .-Color[class*=-BGC215] { + background-color: #FFAF5F +} + +div.highlight .-Color[class*=-C216] { + color: #FFAF87 +} + +div.highlight .-Color[class*=-BGC216] { + background-color: #FFAF87 +} + +div.highlight .-Color[class*=-C217] { + color: #FFAFAF +} + +div.highlight .-Color[class*=-BGC217] { + background-color: #FFAFAF +} + +div.highlight .-Color[class*=-C218] { + color: #FFAFD7 +} + +div.highlight .-Color[class*=-BGC218] { + background-color: #FFAFD7 +} + +div.highlight .-Color[class*=-C219] { + color: #FFAFFF +} + +div.highlight .-Color[class*=-BGC219] { + background-color: #FFAFFF +} + +div.highlight .-Color[class*=-C220] { + color: #FFD700 +} + +div.highlight .-Color[class*=-BGC220] { + background-color: #FFD700 +} + +div.highlight .-Color[class*=-C221] { + color: #FFD75F +} + +div.highlight .-Color[class*=-BGC221] { + background-color: #FFD75F +} + +div.highlight .-Color[class*=-C222] { + color: #FFD787 +} + +div.highlight .-Color[class*=-BGC222] { + background-color: #FFD787 +} + +div.highlight .-Color[class*=-C223] { + color: #FFD7AF +} + +div.highlight .-Color[class*=-BGC223] { + background-color: #FFD7AF +} + +div.highlight .-Color[class*=-C224] { + color: #FFD7D7 +} + +div.highlight .-Color[class*=-BGC224] { + background-color: #FFD7D7 +} + +div.highlight .-Color[class*=-C225] { + color: #FFD7FF +} + +div.highlight .-Color[class*=-BGC225] { + background-color: #FFD7FF +} + +div.highlight .-Color[class*=-C226] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC226] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C227] { + color: #FFFF5F +} + +div.highlight .-Color[class*=-BGC227] { + background-color: #FFFF5F +} + +div.highlight .-Color[class*=-C228] { + color: #FFFF87 +} + +div.highlight .-Color[class*=-BGC228] { + background-color: #FFFF87 +} + +div.highlight .-Color[class*=-C229] { + color: #FFFFAF +} + +div.highlight .-Color[class*=-BGC229] { + background-color: #FFFFAF +} + +div.highlight .-Color[class*=-C230] { + color: #FFFFD7 +} + +div.highlight .-Color[class*=-BGC230] { + background-color: #FFFFD7 +} + +div.highlight .-Color[class*=-C231] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC231] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C232] { + color: #080808 +} + +div.highlight .-Color[class*=-BGC232] { + background-color: #080808 +} + +div.highlight .-Color[class*=-C233] { + color: #121212 +} + +div.highlight .-Color[class*=-BGC233] { + background-color: #121212 +} + +div.highlight .-Color[class*=-C234] { + color: #1C1C1C +} + +div.highlight .-Color[class*=-BGC234] { + background-color: #1C1C1C +} + +div.highlight .-Color[class*=-C235] { + color: #262626 +} + +div.highlight .-Color[class*=-BGC235] { + background-color: #262626 +} + +div.highlight .-Color[class*=-C236] { + color: #303030 +} + +div.highlight .-Color[class*=-BGC236] { + background-color: #303030 +} + +div.highlight .-Color[class*=-C237] { + color: #3A3A3A +} + +div.highlight .-Color[class*=-BGC237] { + background-color: #3A3A3A +} + +div.highlight .-Color[class*=-C238] { + color: #444444 +} + +div.highlight .-Color[class*=-BGC238] { + background-color: #444444 +} + +div.highlight .-Color[class*=-C239] { + color: #4E4E4E +} + +div.highlight .-Color[class*=-BGC239] { + background-color: #4E4E4E +} + +div.highlight .-Color[class*=-C240] { + color: #585858 +} + +div.highlight .-Color[class*=-BGC240] { + background-color: #585858 +} + +div.highlight .-Color[class*=-C241] { + color: #626262 +} + +div.highlight .-Color[class*=-BGC241] { + background-color: #626262 +} + +div.highlight .-Color[class*=-C242] { + color: #6C6C6C +} + +div.highlight .-Color[class*=-BGC242] { + background-color: #6C6C6C +} + +div.highlight .-Color[class*=-C243] { + color: #767676 +} + +div.highlight .-Color[class*=-BGC243] { + background-color: #767676 +} + +div.highlight .-Color[class*=-C244] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC244] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C245] { + color: #8A8A8A +} + +div.highlight .-Color[class*=-BGC245] { + background-color: #8A8A8A +} + +div.highlight .-Color[class*=-C246] { + color: #949494 +} + +div.highlight .-Color[class*=-BGC246] { + background-color: #949494 +} + +div.highlight .-Color[class*=-C247] { + color: #9E9E9E +} + +div.highlight .-Color[class*=-BGC247] { + background-color: #9E9E9E +} + +div.highlight .-Color[class*=-C248] { + color: #A8A8A8 +} + +div.highlight .-Color[class*=-BGC248] { + background-color: #A8A8A8 +} + +div.highlight .-Color[class*=-C249] { + color: #B2B2B2 +} + +div.highlight .-Color[class*=-BGC249] { + background-color: #B2B2B2 +} + +div.highlight .-Color[class*=-C250] { + color: #BCBCBC +} + +div.highlight .-Color[class*=-BGC250] { + background-color: #BCBCBC +} + +div.highlight .-Color[class*=-C251] { + color: #C6C6C6 +} + +div.highlight .-Color[class*=-BGC251] { + background-color: #C6C6C6 +} + +div.highlight .-Color[class*=-C252] { + color: #D0D0D0 +} + +div.highlight .-Color[class*=-BGC252] { + background-color: #D0D0D0 +} + +div.highlight .-Color[class*=-C253] { + color: #DADADA +} + +div.highlight .-Color[class*=-BGC253] { + background-color: #DADADA +} + +div.highlight .-Color[class*=-C254] { + color: #E4E4E4 +} + +div.highlight .-Color[class*=-BGC254] { + background-color: #E4E4E4 +} + +div.highlight .-Color[class*=-C255] { + color: #EEEEEE +} + +div.highlight .-Color[class*=-BGC255] { + background-color: #EEEEEE +} diff --git a/branch/2023-version/_static/plus.png b/branch/2023-version/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/branch/2023-version/_static/plus.png differ diff --git a/branch/2023-version/_static/pygments.css b/branch/2023-version/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/branch/2023-version/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/branch/2023-version/_static/searchtools.js b/branch/2023-version/_static/searchtools.js new file mode 100644 index 00000000..7918c3fa --- /dev/null +++ b/branch/2023-version/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/branch/2023-version/_static/sphinx_highlight.js b/branch/2023-version/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/branch/2023-version/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.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: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/branch/2023-version/_static/sphinx_lesson.css b/branch/2023-version/_static/sphinx_lesson.css new file mode 100644 index 00000000..14b20c64 --- /dev/null +++ b/branch/2023-version/_static/sphinx_lesson.css @@ -0,0 +1,51 @@ +/* sphinx_lesson.css */ + +body.wy-body-for-nav img.with-border { + border: 2px solid; +} + +.rst-content .admonition-no-content { + padding-bottom: 0px; +} + +.rst-content .demo > .admonition-title::before { + content: "\01F440"; /* Eyes */ } +.rst-content .type-along > .admonition-title::before { + content: "\02328\0FE0F"; /* Keyboard */ } +.rst-content .exercise > .admonition-title::before { + content: "\0270D\0FE0F"; /* Hand */ } +.rst-content .solution > .admonition-title::before { + content: "\02714\0FE0E"; /* Check mark */ } +.rst-content .homework > .admonition-title::before { + content: "\01F4DD"; /* Memo */ } +.rst-content .discussion > .admonition-title::before { + content: "\01F4AC"; /* Speech balloon */ } +.rst-content .questions > .admonition-title::before { + content: "\02753\0FE0E"; /* Question mark */ } +.rst-content .prerequisites > .admonition-title::before { + content: "\02699"; /* Gear */ } +.rst-content .seealso > .admonition-title::before { + content: "\027A1\0FE0E"; /* Question mark */ } + + +/* instructor-note */ +.rst-content .instructor-note { + background: #e7e7e7; +} +.rst-content .instructor-note > .admonition-title { + background: #6a6a6a; +} +.rst-content .instructor-note > .admonition-title::before { + content: ""; +} + + +/* sphinx_toggle_button, make the font white */ +.rst-content .toggle.admonition button.toggle-button { + color: white; +} + +/* sphinx-togglebutton, remove underflow when toggled to hidden mode */ +.rst-content .admonition.toggle-hidden { + padding-bottom: 0px; +} diff --git a/branch/2023-version/_static/sphinx_rtd_theme_ext_color_contrast.css b/branch/2023-version/_static/sphinx_rtd_theme_ext_color_contrast.css new file mode 100644 index 00000000..e68feb82 --- /dev/null +++ b/branch/2023-version/_static/sphinx_rtd_theme_ext_color_contrast.css @@ -0,0 +1,47 @@ +/* The following are for web accessibility of sphinx_rtd_theme: they + * solve some of the most frequent contrast issues. Remove when this + * solved: + * https://github.com/readthedocs/sphinx_rtd_theme/issues/971 + */ +/* background: #fcfcfc, note boxes #E7F2FA */ +a { color: #2573A7; } /* original #2980B9, #1F5C84; */ +body { color: #242424; } /* original #404040, #383838 */ +.wy-side-nav-search>a, .wy-side-nav-search .wy-dropdown>a { + color: #ffffff; +} /* original #fcfcfc */ +footer { color: #737373; } /* original gray=#808080*/ +footer span.commit code, footer span.commit .rst-content tt, .rst-content footer span.commit tt { + color: #737373; +} /* original gray=#808080*/ +.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { + color: #AB2314; +} +/* Sidebar background */ +.wy-side-nav-search { background-color: #277CB4;} + +/* Same, but for pygments */ +.highlight .ch { color: #3E7A89; } /* #! line */ +.highlight .c1 { color: #3E7A89; } /* also comments */ +.highlight .nv { color: #AD3ECC; } /* variable */ +.highlight .gp { color: #B45608; } /* prompt character, $*/ +.highlight .si { color: #3975B1; } /* ${} variable text */ +.highlight .nc { color: #0C78A7; } + +/* Sphinx admonitions */ +/* warning */ +.wy-alert.wy-alert-warning .wy-alert-title, .rst-content .wy-alert-warning.note .wy-alert-title, .rst-content .attention .wy-alert-title, .rst-content .caution .wy-alert-title, .rst-content .wy-alert-warning.danger .wy-alert-title, .rst-content .wy-alert-warning.error .wy-alert-title, .rst-content .wy-alert-warning.hint .wy-alert-title, .rst-content .wy-alert-warning.important .wy-alert-title, .rst-content .wy-alert-warning.tip .wy-alert-title, .rst-content .warning .wy-alert-title, .rst-content .wy-alert-warning.seealso .wy-alert-title, .rst-content .admonition-todo .wy-alert-title, .rst-content .wy-alert-warning.admonition .wy-alert-title, .wy-alert.wy-alert-warning .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-warning .admonition-title, .rst-content .wy-alert-warning.note .admonition-title, .rst-content .attention .admonition-title, .rst-content .caution .admonition-title, .rst-content .wy-alert-warning.danger .admonition-title, .rst-content .wy-alert-warning.error .admonition-title, .rst-content .wy-alert-warning.hint .admonition-title, .rst-content .wy-alert-warning.important .admonition-title, .rst-content .wy-alert-warning.tip .admonition-title, .rst-content .warning .admonition-title, .rst-content .wy-alert-warning.seealso .admonition-title, .rst-content .admonition-todo .admonition-title, .rst-content .wy-alert-warning.admonition .admonition-title { + background: #B15E16; } +/* important */ +.wy-alert.wy-alert-success .wy-alert-title, .rst-content .wy-alert-success.note .wy-alert-title, .rst-content .wy-alert-success.attention .wy-alert-title, .rst-content .wy-alert-success.caution .wy-alert-title, .rst-content .wy-alert-success.danger .wy-alert-title, .rst-content .wy-alert-success.error .wy-alert-title, .rst-content .hint .wy-alert-title, .rst-content .important .wy-alert-title, .rst-content .tip .wy-alert-title, .rst-content .wy-alert-success.warning .wy-alert-title, .rst-content .wy-alert-success.seealso .wy-alert-title, .rst-content .wy-alert-success.admonition-todo .wy-alert-title, .rst-content .wy-alert-success.admonition .wy-alert-title, .wy-alert.wy-alert-success .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-success .admonition-title, .rst-content .wy-alert-success.note .admonition-title, .rst-content .wy-alert-success.attention .admonition-title, .rst-content .wy-alert-success.caution .admonition-title, .rst-content .wy-alert-success.danger .admonition-title, .rst-content .wy-alert-success.error .admonition-title, .rst-content .hint .admonition-title, .rst-content .important .admonition-title, .rst-content .tip .admonition-title, .rst-content .wy-alert-success.warning .admonition-title, .rst-content .wy-alert-success.seealso .admonition-title, .rst-content .wy-alert-success.admonition-todo .admonition-title, .rst-content .wy-alert-success.admonition .admonition-title { + background: #12826C; } +/* seealso, note, etc */ +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition .admonition-title { + background: #277CB4; } +/* error, danger */ +.rst-content .danger .admonition-title, .rst-content .danger .wy-alert-title, .rst-content .error .admonition-title, .rst-content .error .wy-alert-title, .rst-content .wy-alert-danger.admonition-todo .admonition-title, .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, .rst-content .wy-alert-danger.admonition .admonition-title, .rst-content .wy-alert-danger.admonition .wy-alert-title, .rst-content .wy-alert-danger.attention .admonition-title, .rst-content .wy-alert-danger.attention .wy-alert-title, .rst-content .wy-alert-danger.caution .admonition-title, .rst-content .wy-alert-danger.caution .wy-alert-title, .rst-content .wy-alert-danger.hint .admonition-title, .rst-content .wy-alert-danger.hint .wy-alert-title, .rst-content .wy-alert-danger.important .admonition-title, .rst-content .wy-alert-danger.important .wy-alert-title, .rst-content .wy-alert-danger.note .admonition-title, .rst-content .wy-alert-danger.note .wy-alert-title, .rst-content .wy-alert-danger.seealso .admonition-title, .rst-content .wy-alert-danger.seealso .wy-alert-title, .rst-content .wy-alert-danger.tip .admonition-title, .rst-content .wy-alert-danger.tip .wy-alert-title, .rst-content .wy-alert-danger.warning .admonition-title, .rst-content .wy-alert-danger.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-danger .admonition-title, .wy-alert.wy-alert-danger .rst-content .admonition-title, .wy-alert.wy-alert-danger .wy-alert-title { + background: #e31704; +} + +/* Generic admonition titles */ +.wy-alert-title, .rst-content .admonition-title { + background: #277CB4; } diff --git a/branch/2023-version/_static/tabs.css b/branch/2023-version/_static/tabs.css new file mode 100644 index 00000000..957ba60d --- /dev/null +++ b/branch/2023-version/_static/tabs.css @@ -0,0 +1,89 @@ +.sphinx-tabs { + margin-bottom: 1rem; +} + +[role="tablist"] { + border-bottom: 1px solid #a0b3bf; +} + +.sphinx-tabs-tab { + position: relative; + font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif; + color: #1D5C87; + line-height: 24px; + margin: 0; + font-size: 16px; + font-weight: 400; + background-color: rgba(255, 255, 255, 0); + border-radius: 5px 5px 0 0; + border: 0; + padding: 1rem 1.5rem; + margin-bottom: 0; +} + +.sphinx-tabs-tab[aria-selected="true"] { + font-weight: 700; + border: 1px solid #a0b3bf; + border-bottom: 1px solid white; + margin: -1px; + background-color: white; +} + +.sphinx-tabs-tab:focus { + z-index: 1; + outline-offset: 1px; +} + +.sphinx-tabs-panel { + position: relative; + padding: 1rem; + border: 1px solid #a0b3bf; + margin: 0px -1px -1px -1px; + border-radius: 0 0 5px 5px; + border-top: 0; + background: white; +} + +.sphinx-tabs-panel.code-tab { + padding: 0.4rem; +} + +.sphinx-tab img { + margin-bottom: 24 px; +} + +/* Dark theme preference styling */ + +@media (prefers-color-scheme: dark) { + body[data-theme="auto"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); + } + + body[data-theme="auto"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); + } + + body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 1px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); + } +} + +/* Explicit dark theme styling */ + +body[data-theme="dark"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); +} + +body[data-theme="dark"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); +} + +body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 2px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); +} diff --git a/branch/2023-version/_static/tabs.js b/branch/2023-version/_static/tabs.js new file mode 100644 index 00000000..48dc303c --- /dev/null +++ b/branch/2023-version/_static/tabs.js @@ -0,0 +1,145 @@ +try { + var session = window.sessionStorage || {}; +} catch (e) { + var session = {}; +} + +window.addEventListener("DOMContentLoaded", () => { + const allTabs = document.querySelectorAll('.sphinx-tabs-tab'); + const tabLists = document.querySelectorAll('[role="tablist"]'); + + allTabs.forEach(tab => { + tab.addEventListener("click", changeTabs); + }); + + tabLists.forEach(tabList => { + tabList.addEventListener("keydown", keyTabs); + }); + + // Restore group tab selection from session + const lastSelected = session.getItem('sphinx-tabs-last-selected'); + if (lastSelected != null) selectNamedTabs(lastSelected); +}); + +/** + * Key focus left and right between sibling elements using arrows + * @param {Node} e the element in focus when key was pressed + */ +function keyTabs(e) { + const tab = e.target; + let nextTab = null; + if (e.keyCode === 39 || e.keyCode === 37) { + tab.setAttribute("tabindex", -1); + // Move right + if (e.keyCode === 39) { + nextTab = tab.nextElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.firstElementChild; + } + // Move left + } else if (e.keyCode === 37) { + nextTab = tab.previousElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.lastElementChild; + } + } + } + + if (nextTab !== null) { + nextTab.setAttribute("tabindex", 0); + nextTab.focus(); + } +} + +/** + * Select or deselect clicked tab. If a group tab + * is selected, also select tab in other tabLists. + * @param {Node} e the element that was clicked + */ +function changeTabs(e) { + // Use this instead of the element that was clicked, in case it's a child + const notSelected = this.getAttribute("aria-selected") === "false"; + const positionBefore = this.parentNode.getBoundingClientRect().top; + const notClosable = !this.parentNode.classList.contains("closeable"); + + deselectTabList(this); + + if (notSelected || notClosable) { + selectTab(this); + const name = this.getAttribute("name"); + selectNamedTabs(name, this.id); + + if (this.classList.contains("group-tab")) { + // Persist during session + session.setItem('sphinx-tabs-last-selected', name); + } + } + + const positionAfter = this.parentNode.getBoundingClientRect().top; + const positionDelta = positionAfter - positionBefore; + // Scroll to offset content resizing + window.scrollTo(0, window.scrollY + positionDelta); +} + +/** + * Select tab and show associated panel. + * @param {Node} tab tab to select + */ +function selectTab(tab) { + tab.setAttribute("aria-selected", true); + + // Show the associated panel + document + .getElementById(tab.getAttribute("aria-controls")) + .removeAttribute("hidden"); +} + +/** + * Hide the panels associated with all tabs within the + * tablist containing this tab. + * @param {Node} tab a tab within the tablist to deselect + */ +function deselectTabList(tab) { + const parent = tab.parentNode; + const grandparent = parent.parentNode; + + Array.from(parent.children) + .forEach(t => t.setAttribute("aria-selected", false)); + + Array.from(grandparent.children) + .slice(1) // Skip tablist + .forEach(panel => panel.setAttribute("hidden", true)); +} + +/** + * Select grouped tabs with the same name, but no the tab + * with the given id. + * @param {Node} name name of grouped tab to be selected + * @param {Node} clickedId id of clicked tab + */ +function selectNamedTabs(name, clickedId=null) { + const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`); + const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode); + + tabLists + .forEach(tabList => { + // Don't want to change the tabList containing the clicked tab + const clickedTab = tabList.querySelector(`[id="${clickedId}"]`); + if (clickedTab === null ) { + // Select first tab with matching name + const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`); + deselectTabList(tab); + selectTab(tab); + } + }) +} + +if (typeof exports === 'undefined') { + exports = {}; +} + +exports.keyTabs = keyTabs; +exports.changeTabs = changeTabs; +exports.selectTab = selectTab; +exports.deselectTabList = deselectTabList; +exports.selectNamedTabs = selectNamedTabs; diff --git a/branch/2023-version/_static/term_role_formatting.css b/branch/2023-version/_static/term_role_formatting.css new file mode 100644 index 00000000..0b66095c --- /dev/null +++ b/branch/2023-version/_static/term_role_formatting.css @@ -0,0 +1,4 @@ +/* Make terms bold */ +a.reference span.std-term { + font-weight: bold; +} diff --git a/branch/2023-version/_static/togglebutton.css b/branch/2023-version/_static/togglebutton.css new file mode 100644 index 00000000..54a67879 --- /dev/null +++ b/branch/2023-version/_static/togglebutton.css @@ -0,0 +1,160 @@ +/** + * Admonition-based toggles + */ + +/* Visibility of the target */ +.admonition.toggle .admonition-title ~ * { + transition: opacity .3s, height .3s; +} + +/* Toggle buttons inside admonitions so we see the title */ +.admonition.toggle { + position: relative; +} + +/* Titles should cut off earlier to avoid overlapping w/ button */ +.admonition.toggle .admonition-title { + padding-right: 25%; + cursor: pointer; +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:hover { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 1%); +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:active { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 3%); +} + +/* Remove extra whitespace below the admonition title when hidden */ +.admonition.toggle-hidden { + padding-bottom: 0; +} + +.admonition.toggle-hidden .admonition-title { + margin-bottom: 0; +} + +/* hides all the content of a page until de-toggled */ +.admonition.toggle-hidden .admonition-title ~ * { + height: 0; + margin: 0; + opacity: 0; + visibility: hidden; +} + +/* General button style and position*/ +button.toggle-button { + /** + * Background and shape. By default there's no background + * but users can style as they wish + */ + background: none; + border: none; + outline: none; + + /* Positioning just inside the admonition title */ + position: absolute; + right: 0.5em; + padding: 0px; + border: none; + outline: none; +} + +/* Display the toggle hint on wide screens */ +@media (min-width: 768px) { + button.toggle-button.toggle-button-hidden:before { + content: attr(data-toggle-hint); /* This will be filled in by JS */ + font-size: .8em; + align-self: center; + } +} + +/* Icon behavior */ +.tb-icon { + transition: transform .2s ease-out; + height: 1.5em; + width: 1.5em; + stroke: currentColor; /* So that we inherit the color of other text */ +} + +/* The icon should point right when closed, down when open. */ +/* Open */ +.admonition.toggle button .tb-icon { + transform: rotate(90deg); +} + +/* Closed */ +.admonition.toggle button.toggle-button-hidden .tb-icon { + transform: rotate(0deg); +} + +/* With details toggles, we don't rotate the icon so it points right */ +details.toggle-details .tb-icon { + height: 1.4em; + width: 1.4em; + margin-top: 0.1em; /* To center the button vertically */ +} + + +/** + * Details-based toggles. + * In this case, we wrap elements with `.toggle` in a details block. + */ + +/* Details blocks */ +details.toggle-details { + margin: 1em 0; +} + + +details.toggle-details summary { + display: flex; + align-items: center; + cursor: pointer; + list-style: none; + border-radius: .2em; + border-left: 3px solid #1976d2; + background-color: rgb(204 204 204 / 10%); + padding: 0.2em 0.7em 0.3em 0.5em; /* Less padding on left because the SVG has left margin */ + font-size: 0.9em; +} + +details.toggle-details summary:hover { + background-color: rgb(204 204 204 / 20%); +} + +details.toggle-details summary:active { + background: rgb(204 204 204 / 28%); +} + +.toggle-details__summary-text { + margin-left: 0.2em; +} + +details.toggle-details[open] summary { + margin-bottom: .5em; +} + +details.toggle-details[open] summary .tb-icon { + transform: rotate(90deg); +} + +details.toggle-details[open] summary ~ * { + animation: toggle-fade-in .3s ease-out; +} + +@keyframes toggle-fade-in { + from {opacity: 0%;} + to {opacity: 100%;} +} + +/* Print rules - we hide all toggle button elements at print */ +@media print { + /* Always hide the summary so the button doesn't show up */ + details.toggle-details summary { + display: none; + } +} \ No newline at end of file diff --git a/branch/2023-version/_static/togglebutton.js b/branch/2023-version/_static/togglebutton.js new file mode 100644 index 00000000..215a7eef --- /dev/null +++ b/branch/2023-version/_static/togglebutton.js @@ -0,0 +1,187 @@ +/** + * Add Toggle Buttons to elements + */ + +let toggleChevron = ` + + + +`; + +var initToggleItems = () => { + var itemsToToggle = document.querySelectorAll(togglebuttonSelector); + console.log(`[togglebutton]: Adding toggle buttons to ${itemsToToggle.length} items`) + // Add the button to each admonition and hook up a callback to toggle visibility + itemsToToggle.forEach((item, index) => { + if (item.classList.contains("admonition")) { + // If it's an admonition block, then we'll add a button inside + // Generate unique IDs for this item + var toggleID = `toggle-${index}`; + var buttonID = `button-${toggleID}`; + + item.setAttribute('id', toggleID); + if (!item.classList.contains("toggle")){ + item.classList.add("toggle"); + } + // This is the button that will be added to each item to trigger the toggle + var collapseButton = ` + `; + + title = item.querySelector(".admonition-title") + title.insertAdjacentHTML("beforeend", collapseButton); + thisButton = document.getElementById(buttonID); + + // Add click handlers for the button + admonition title (if admonition) + admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`) + if (admonitionTitle) { + // If an admonition, then make the whole title block clickable + admonitionTitle.addEventListener('click', toggleClickHandler); + admonitionTitle.dataset.target = toggleID + admonitionTitle.dataset.button = buttonID + } else { + // If not an admonition then we'll listen for the button click + thisButton.addEventListener('click', toggleClickHandler); + } + + // Now hide the item for this toggle button unless explicitly noted to show + if (!item.classList.contains("toggle-shown")) { + toggleHidden(thisButton); + } + } else { + // If not an admonition, wrap the block in a
block + // Define the structure of the details block and insert it as a sibling + var detailsBlock = ` +
+ + ${toggleChevron} + ${toggleHintShow} + +
`; + item.insertAdjacentHTML("beforebegin", detailsBlock); + + // Now move the toggle-able content inside of the details block + details = item.previousElementSibling + details.appendChild(item) + item.classList.add("toggle-details__container") + + // Set up a click trigger to change the text as needed + details.addEventListener('click', (click) => { + let parent = click.target.parentElement; + if (parent.tagName.toLowerCase() == "details") { + summary = parent.querySelector("summary"); + details = parent; + } else { + summary = parent; + details = parent.parentElement; + } + // Update the inner text for the proper hint + if (details.open) { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintShow; + } else { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintHide; + } + + }); + + // If we have a toggle-shown class, open details block should be open + if (item.classList.contains("toggle-shown")) { + details.click(); + } + } + }) +}; + +// This should simply add / remove the collapsed class and change the button text +var toggleHidden = (button) => { + target = button.dataset['target'] + var itemToToggle = document.getElementById(target); + if (itemToToggle.classList.contains("toggle-hidden")) { + itemToToggle.classList.remove("toggle-hidden"); + button.classList.remove("toggle-button-hidden"); + } else { + itemToToggle.classList.add("toggle-hidden"); + button.classList.add("toggle-button-hidden"); + } +} + +var toggleClickHandler = (click) => { + // Be cause the admonition title is clickable and extends to the whole admonition + // We only look for a click event on this title to trigger the toggle. + + if (click.target.classList.contains("admonition-title")) { + button = click.target.querySelector(".toggle-button"); + } else if (click.target.classList.contains("tb-icon")) { + // We've clicked the icon and need to search up one parent for the button + button = click.target.parentElement; + } else if (click.target.tagName == "polyline") { + // We've clicked the SVG elements inside the button, need to up 2 layers + button = click.target.parentElement.parentElement; + } else if (click.target.classList.contains("toggle-button")) { + // We've clicked the button itself and so don't need to do anything + button = click.target; + } else { + console.log(`[togglebutton]: Couldn't find button for ${click.target}`) + } + target = document.getElementById(button.dataset['button']); + toggleHidden(target); +} + +// If we want to blanket-add toggle classes to certain cells +var addToggleToSelector = () => { + const selector = ""; + if (selector.length > 0) { + document.querySelectorAll(selector).forEach((item) => { + item.classList.add("toggle"); + }) + } +} + +// Helper function to run when the DOM is finished +const sphinxToggleRunWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} +sphinxToggleRunWhenDOMLoaded(addToggleToSelector) +sphinxToggleRunWhenDOMLoaded(initToggleItems) + +/** Toggle details blocks to be open when printing */ +if (toggleOpenOnPrint == "true") { + window.addEventListener("beforeprint", () => { + // Open the details + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.dataset["togglestatus"] = el.open; + el.open = true; + }); + + // Open the admonitions + document.querySelectorAll(".admonition.toggle.toggle-hidden").forEach((el) => { + console.log(el); + el.querySelector("button.toggle-button").click(); + el.dataset["toggle_after_print"] = "true"; + }); + }); + window.addEventListener("afterprint", () => { + // Re-close the details that were closed + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.open = el.dataset["togglestatus"] == "true"; + delete el.dataset["togglestatus"]; + }); + + // Re-close the admonition toggle buttons + document.querySelectorAll(".admonition.toggle").forEach((el) => { + if (el.dataset["toggle_after_print"] == "true") { + el.querySelector("button.toggle-button").click(); + delete el.dataset["toggle_after_print"]; + } + }); + }); +} diff --git a/branch/2023-version/aliases/index.html b/branch/2023-version/aliases/index.html new file mode 100644 index 00000000..0d9da583 --- /dev/null +++ b/branch/2023-version/aliases/index.html @@ -0,0 +1,315 @@ + + + + + + + Aliases and configuration — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Aliases and configuration

+
+

Objectives

+
    +

  • Learn to use aliases for most common commands.

    • +
+
+

Are you getting tired of typing so much? In Git you can define aliases (shortcuts):

+
    +

  • These are great because they can save you time typing.

    • +

  • But it’s easy to forget them, get confused, or be inconsistent with your colleagues.

    • +
+

There is plenty of other configuration for Git, that can make it nicer.

+
+

Aliases

+
    +

  • Aliases offer a way to improve the usability of Git: for +example git ci instead of git commit.

    • +

  • Aliases are based on simple string replacement in the command.

    • +

  • Aliases can either be specific to a repository or global.

    +
      +

    • Global aliases help you do the things you are used to across Git projects.

      • +

    • Per-project aliases can also be created.

      • +
    +
    • +

  • Global aliases are stored in ~/.gitconfig.

    • +
+
+
+

Example alias: git graph

+

A very useful shortcut which we use a lot in our workshops:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ cd your_git_repository
+$ git graph
+
+
+
+
+

Using external commands

+

It is possible to call external commands using the exclamation mark character “!”. +In this example here we create a local alias which is +stored in .git/config and not synchronized with remotes:

+
$ cd your_git_repository
+$ git config alias.hi '!echo hello'
+$ git hi
+
+
+
+

Food for thought: When to alias?

+
    +

  • How many times should you wait before aliasing a command?

    • +

  • Do you believe a list of generic two-letter acronyms for common commands will +save your time?

    • +
+
+
+
+

List of aliases the instructors use

+

You are welcome to reuse, suggest, improve. +You can see your current aliases in ~/.gitconfig.

+
$ git config --global alias.ap "add --patch"
+$ git config --global alias.br branch
+$ git config --global alias.ci "commit -v"
+$ git config --global alias.cip "commit --patch -v"
+$ git config --global alias.cl "clone --recursive"
+$ git config --global alias.di diff
+$ git config --global alias.dic "diff --staged --color-words"
+$ git config --global alias.diw "diff --color-words"
+$ git config --global alias.dis "!git --no-pager diff --stat"
+$ git config --global alias.fe fetch
+$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ git config --global alias.rem remote
+$ git config --global alias.st status
+$ git config --global alias.su "submodule update --init --recursive"
+
+
+

Here is what they do:

+
    +

  • ap: add, selecting parts individually, interactively.

    • +

  • br: branch (obvious)

    • +

  • ci: commit (check in), with -v option for clarity

    • +

  • cip: commit, selecting parts individually, interactively.

    • +

  • cl: clone, init submodules (submodules are an advanced topic)

    • +

  • di: diff (obvious)

    • +

  • dic: diff of staging area vs last commit (what is about to be committed)

    • +

  • diw: a word diff, color. Useful for small changes.

    • +

  • dis: a “diffstat”: what files are changed, not contents

    • +

  • fe: fetch (obvious)

    • +

  • graph: show whole git graph (so useful, some of us call it l)

    • +

  • rem: remote (obvious)

    • +

  • st: status (obvious)

    • +

  • su: submodule update (advanced)

    • +
+

A useful setting for the p aliases:

+
$ git config --global interactive.singlekey true
+
+
+
+
+

Advanced aliases

+

These are advanced aliases and configuration options. We won’t explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages!

+
$ git config --global alias.cif "commit -v -p --fixup"
+$ git config --global alias.rb "rebase --autosquash"
+$ git config --global alias.rbi "rebase --interactive --autosquash"
+$ git config --global alias.rbis "rebase --interactive --autosquash --autostash"
+$ git config --global alias.rbs "rebase --autosquash --autostash"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard"
+$ git config --global alias.new "log HEAD..HEAD@{upstream}"
+$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}"
+$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}"
+$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all"
+$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD"
+$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat"
+
+
+
+
+

Advanced Git configuration

+

Besides aliases, you can do plenty of other configuration of git. +Here are some of the most common ones:

+
$ git config --global interactive.singlekey true
+$ git config --global core.pager "less -RS"
+$ git config --global core.excludesfile ~/.gitignore
+$ git config --global merge.conflictstyle diff3
+$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]"
+$ git config --global diff.mnemonicPrefix true
+
+
+

Do you get tired of typing and copying and pasting your remote names +all the time, like git@github.com:myusername? You can create remote +aliases like this:

+
$ git config --global url.git@github.com:.insteadOf gh:
+$ git config --global url.git@github.com:/username/.insteadOf ghu:
+
+
+

Then, when you add a remote ghu:recipe, it will automatically be +translated to git@github.com:/username/recipe using a simple prefix +matching.

+
+

Keypoints

+
    +

  • If you are frustrated about remembering a command, you should create an alias.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/archaeology/index.html b/branch/2023-version/archaeology/index.html new file mode 100644 index 00000000..00d46b4c --- /dev/null +++ b/branch/2023-version/archaeology/index.html @@ -0,0 +1,518 @@ + + + + + + + Inspecting history — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Inspecting history

+
+

Objectives

+
    +

  • Be able find a line of code, find out why it was introduced and when.

    • +

  • Be able to quickly find the commit that changed a behavior.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 30 min exercise

    • +
+
+
+

Preparation

+

Please make sure that you do not clone repositories inside an already tracked folder:

+
$ git status
+
+
+

If you are inside an existing Git repository, step out of it. +You need to find a different location since we will clone a new repository.

+

If you see this message, this is good in this case:

+
fatal: not a git repository (or any of the parent directories): .git
+
+
+
+
+

Our toolbox for history inspection

+
+

Instructor note

+

First the instructor demonstrates few commands on a real life example +repository https://github.com/networkx/networkx (mentioned in the amazing site The +Programming Historian). +Later we will practice these in an archaeology exercise (below).

+
+
+

Warm-up: “Git History” browser

+

As a warm-up we can try the “Git History” browser +on the README.rst file of the networkx repository:

+ +
+
+

Searching text patterns in the repository

+
+

With git grep you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or some error message printed:

+
$ git grep TEXT
+$ git grep "some text with spaces"
+
+
+

In the networkx repository you can try:

+
$ git clone https://github.com/networkx/networkx
+$ cd networkx
+$ git grep -i fixme
+
+
+

While git grep searches the current state of the repository, +it is also possible to search through all changes with git log -S sometext +which can be useful to find where something got removed.

+
+
+
+

Inspecting individual commits

+
+

We have seen this one before already. Using git show we can inspect an individual commit if +we know its hash:

+
$ git show HASH
+
+
+

For instance:

+
$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7
+
+
+
+
+
+

Line-by-line code annotation with metadata

+

With git annotate you can see line by line who and when the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility.

+
+
$ git annotate FILE
+
+
+

Example:

+
$ git annotate networkx/convert_matrix.py
+
+
+

If you annotate in a terminal and the file is longer than the screen, Git by default uses the program less to +scroll the output. +Use /sometext <ENTER> to find “sometext” and you can cycle through the results with n (next) and N (last). +You can also use page up/down to scroll. You can quit with q.

+
+
+

Discussion

+

Discuss how these relatively trivial changes affect the annotation:

+
    +

  • Wrapping long lines of text/code into shorter lines

    • +

  • Auto-formatting tools such as black

    • +

  • Editors that automatically remove trailing whitespace

    • +
+
+
+
+

Inspecting code in the past

+
+

We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code:

+
$ git switch --create BRANCHNAME HASH
+
+
+

Example (lines starting with “#” are only comments):

+
$ # create branch called "older-code" from hash 347e6292419b
+$ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9
+
+$ # now you can navigate and inspect the code as it was back then
+$ # ...
+
+$ # after we are done we can switch back to "main"
+$ git switch main
+
+$ # if we like we can delete the "older-code" branch
+$ git branch -d older-code
+
+
+

On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

+
$ git checkout -b BRANCHNAME SOMEHASH
+
+
+
+
+
+
+

Exercise: Basic archaeology commands

+
+

History-1: Explore basic archaeology commands

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Clone this repository: +https://github.com/networkx/networkx.git. +Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release:

    +
    $ git clone https://github.com/networkx/networkx.git
+$ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+
+
+
+

Finding out when something broke/changed with git bisect

+
+

“But I am sure it used to work! Strange.”

+
+

Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke.

+
+

How would you solve this?

+

Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now.

+
    +

  • How would you find the commit which changed it?

    • +

  • Why could it be useful to know the commit that changed it?

    • +
+
+

We will probably arrive at a solution which is similar to git bisect:

+
    +

  • First find out a commit in past when it worked.

    +
    $ git bisect start
+$ git bisect good f0ea950  # this is a commit that worked
+$ git bisect bad main      # last commit is broken
+
    +
    +
    • +

  • Now compile and/or run and/or test and decide whether “good” or “bad”.

    • +

  • This is how you can tell Git that this was a working commit:

    +
    $ git bisect good
+
    +
    +
    • +

  • And this is how you can tell Git that this was not a working commit:

    +
    $ git bisect bad
+
    +
    +
    • +

  • Then bisect/iterate your way until you find the commit that broke it.

    • +

  • If you want to go back to start, type git bisect reset.

    • +

  • This can even be automatized with git bisect run SCRIPT. +For this you write a script that returns zero/non-zero (success/failure).

    • +
+
+
+

Optional exercise: Git bisect

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+

Keypoints

+
    +

  • git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project.

    • +

  • git switch --create NAME HASH is the recommended mechanism to inspect old code.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/basics/index.html b/branch/2023-version/basics/index.html new file mode 100644 index 00000000..915af9a7 --- /dev/null +++ b/branch/2023-version/basics/index.html @@ -0,0 +1,815 @@ + + + + + + + Basics — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Basics

+
+

Objectives

+
    +

  • Learn to create Git repositories and make commits.

    • +

  • Get a grasp of the structure of a repository.

    • +

  • Learn how to inspect the project history.

    • +

  • Learn how to write useful commit log messages.

    • +
+
+
+

Instructor note

+
    +

  • 35 min teaching/type-along

    • +

  • 40 min exercise

    • +
+
+
+

What is Git, and what is a Git repository?

+
    +

  • Git is a version control system: can record/save snapshots and track the content of a folder as it changes over time.

    • +

  • Every time we commit a snapshot, Git records a snapshot of the entire project, saves it, and assigns it a version.

    • +

  • These snapshots are kept inside a sub-folder called .git.

    • +

  • If we remove .git, we remove the repository and history (but keep the working directory!).

    • +

  • The directory .git uses relative paths - you can move the whole repository somewhere else and it will still work.

    • +

  • Git doesn’t do anything unless you ask it to (it does not record anything automatically).

    • +

  • Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces).

    • +
+
+
+

Recording a snapshot with Git

+
    +

  • Git takes snapshots only if we request it.

    • +

  • We will record changes in two steps (we will later explain why this is a recommended practice).

    • +

  • Example (we don’t need to type yet):

    +
    $ git add FILE.txt
+$ git commit
+
+$ git add FILE.txt ANOTHERFILE.txt
+$ git commit
+
    +
    +
    • +

  • We first focus (git add, we “stage” the change), then record (git commit):

    • +
+
+Git staging +
+

Git staging and committing.

+
+
+
+

Question for the more advanced participants

+

What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end.

+
+
+
+

Configuring Git command line

+

Before we start using Git on the command line, we need to configure Git. +This is also part of the +installation instructions +but we need to make sure we all have +set name, email address, editor, and +default branch:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+$ git config --global core.editor nano
+$ git config --global init.defaultBranch main
+
+
+

Verify with:

+
$ git config --list
+
+
+
+

Instructor note

+

Instructors, give learners enough time to do the above configuration steps.

+
+
+
+

Type-along: Tracking a guacamole recipe with Git

+

We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list)

+

The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language.

+
+

Instructor note

+

Instructors, please encourage now that participants type along.

+
+
+

Note

+

It is possible to go through this lesson in the command line or in the browser +(on GitHub).

+
    +

  • We recommend to start with the command line but later to also try in the browser.

    • +

  • If you get really stuck in the command line, try following in the browser and +later you can try to return to the command line.

    • +
+
+
+
+

Creating a repository

+

One of the basic principles of Git is that it is easy to create repositories:

+
+
$ mkdir recipe
+$ cd recipe
+$ git init -b main
+
+
+

That’s it! With git init -b main have now created an empty Git repository +where main is the default branch (more about branches later).

+

We will use git status a lot to check out what is going on:

+
$ git status
+
+On branch main
+
+No commits yet
+
+nothing to commit (create/copy files and use "git add" to track)
+
+
+

We will make sense of this information during this workshop.

+
+
+
+

Adding files and committing changes

+

Let us now create two files.

+

One file is called ingredients.txt and contains:

+
* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+
+
+

The second file is called instructions.txt and contains:

+
* chop avocados
+* chop onion
+* chop chili
+* squeeze lime
+* add salt
+* and mix well
+
+
+
+

As mentioned above, in Git you can always check the status of files in your repository using +git status. It is always a safe command to run and in general a good idea to +do when you are trying to figure out what to do next:

+
$ git status
+
+On branch main
+
+No commits yet
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    ingredients.txt
+    instructions.txt
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+

The two files are untracked in the repository (directory). You want to add the files (focus the camera) +to the list of files tracked by Git. Git does not track +any files automatically and you need make a conscious decision to add a file. Let’s do what +Git hints at, and add the files, one by one:

+
$ git add ingredients.txt
+$ git status
+
+On branch main
+
+No commits yet
+
+Changes to be committed:
+  (use "git rm --cached <file>..." to unstage)
+    new file:   ingredients.txt
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    instructions.txt
+
+
+

Now this change is staged and ready to be committed. +Let us now commit the change to the repository:

+
$ git commit -m "adding ingredients"
+
+[main (root-commit) f146d25] adding ingredients
+ 1 file changed, 4 insertions(+)
+ create mode 100644 ingredients.txt
+
+
+

Right after we query the status to get this useful command into our muscle memory:

+
$ git status
+
+
+

Now stage and commit also the other file:

+
$ git add instructions.txt
+$ git commit -m "adding instructions"
+
+
+

We will add a third file to the repository, README.md, containing:

+
# recipe
+
+This is an exercise repository.
+
+
+

Now stage and commit also the README.md file:

+
$ git add README.md
+$ git commit -m "adding README"
+
+
+

What does the -m flag mean? Let us check the help page for that command:

+
$ git help commit
+
+
+

You should see a very long help page as the tool is very versatile (press q to quit). +Do not worry about this now but keep in mind that you can always read the help files +when in doubt. Searching online can also be useful, but choosing search terms +to find relevant information takes some practice and discussions in some +online threads may be confusing. +Note that help pages also work when you don’t have a network connection!

+
+
+
+

Exercise: Record changes

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+
+
+

Git history and log

+
+

If you haven’t yet, please try now git log:

+
$ git log
+
+commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main)
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:47 2023 +0200
+
+    don't forget to enjoy
+
+commit 79161b6e67c62ad4688a58c1e54183334611a390
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:32 2023 +0200
+
+    add half an onion
+
+commit a3394e39535343c4dae3bb4f703741a31aa8b78a
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:47:14 2023 +0200
+
+    adding README
+
+commit 369624674e63de48055a65bf63055bd59c985d22
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:46:58 2023 +0200
+
+    adding instructions
+
+commit f146d25b94569a15e94d7f0da6f15d7554f76c49
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:35:52 2023 +0200
+
+    adding ingredients
+
+
+
+
    +

  • We can browse the development and access each state that we have committed.

    • +

  • The long hashes uniquely label a state of the code.

    • +

  • They are not just integers counting 1, 2, 3, 4, … (why?).

    • +

  • Output is in reverse chronological order, i.e. newest commits on top.

    • +

  • We will use them when comparing versions and when going back in time.

    • +

  • git log --oneline only shows the first 7 characters of the commit hash and is good to get an overview.

    • +

  • If the first characters of the hash are unique it is not necessary to type the entire hash.

    • +

  • git log --stat is nice to show which files have been modified.

    • +
+
+
+

Optional exercises: Comparing changes

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+
+
+

Writing useful commit messages

+

Using git log --oneline or browsing a repository on the web, we better +understand that the first line of the commit message is very important.

+

Good example:

+
increase threshold alpha to 2.0
+
+the motivation for this change is
+to enable ...
+...
+this is based on a discussion in #123
+
+
+

Convention: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

Ignoring files and paths with .gitignore

+
+

Discussion

+
    +

  • Should we add and track all files in a project?

    • +

  • How about generated files?

    • +

  • Why is it considered a bad idea to commit compiled binaries to version control?

    • +

  • What types of generated files do you know?

    • +
+
+

Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files. Example:

+
# ignore compiled python 2 files
+*.pyc
+# ignore compiled python 3 files
+__pycache__
+
+
+

An example taken from the official Git documentation:

+
# ignore objects and archives, anywhere in the tree.
+*.[oa]
+# ignore generated html files,
+*.html
+# except foo.html which is maintained by hand
+!foo.html
+# ignore everything under build directory
+build/
+
+
+
    +

  • .gitignore should be part of the repository because we want to make sure that all developers see the same behavior.

    • +

  • All files should be either tracked or ignored.

    • +

  • .gitignore uses something called a +shell glob syntax for +determining file patterns to ignore. You can read more about the syntax in the +documentation.

    • +

  • You can have .gitignore files in lower level directories and they affect the paths below.

    • +
+
+
+

Graphical user interfaces

+

We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI):

+ +
+
+

Summary

+

Now we know how to save snapshots:

+
$ git add FILE(S)
+$ git commit
+
+
+

And this is what we do as we program.

+

Every state is then saved and later we will learn how to go back to these “checkpoints” +and how to undo things.

+
$ git init -b main  # initialize new repository (main is default branch)
+$ git add           # add files or stage file(s)
+$ git commit        # commit staged file(s)
+$ git status        # see what is going on
+$ git log           # see history
+$ git diff          # show unstaged/uncommitted modifications
+$ git show          # show the change for a specific commit
+$ git mv            # move/rename tracked files
+$ git rm            # remove tracked files
+
+
+

Git is not ideal for large binary files +(for this consider git-annex).

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • It takes only one command to initialize a Git repository: git init -b main.

    • +

  • Commits should be used to tell a story.

    • +

  • Git uses the .git folder to store the snapshots.

    • +

  • Don’t be afraid to stage and commit often. Better too often than not often enough.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/branches/index.html b/branch/2023-version/branches/index.html new file mode 100644 index 00000000..5e00f590 --- /dev/null +++ b/branch/2023-version/branches/index.html @@ -0,0 +1,736 @@ + + + + + + + Branching and merging — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Branching and merging

+
+

Objectives

+
    +

  • Be able to create and merge branches.

    • +

  • Know the difference between a branch and a tag.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Motivation for branches

+

In the previous section we tracked a guacamole recipe with Git.

+

Up until now our repository had only one branch with one commit coming +after the other:

+
+Linear Git repository +
+

Linear Git repository.

+
+
+
    +

  • Commits are depicted here as little boxes with abbreviated hashes.

    • +

  • Here the branch main points to a commit.

    • +

  • “HEAD” is the current position (remember the recording head of tape +recorders?). When we say HEAD, we mean those literal letters - +this isn’t a placeholder for something else.

    • +

  • When we talk about branches, we often mean all parent commits, not only the commit pointed to.

    • +
+

Now we want to do this:

+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+

Software development is often not linear:

+
    +

  • We typically need at least one version of the code to “work” (to compile, to give expected results, …).

    • +

  • At the same time we work on new features, often several features concurrently. +Often they are unfinished.

    • +

  • We need to be able to separate different lines of work really well.

    • +
+

The strength of version control is that it permits the researcher to isolate +different tracks of work, which can later be merged to create a composite +version that contains all changes:

+
+Isolated tracks of work +
+

Isolated tracks of work.

+
+
+
    +

  • We see branching points and merging points.

    • +

  • Main line development is often called main or master.

    • +

  • Other than this convention there is nothing special about main or master, it is a branch like any other.

    • +

  • Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow).

    • +
+

A group of commits that create a single narrative are called a branch. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. “fast sequence extraction” or “Python interface” or “fixing bug in +matrix inversion algorithm”.

+
+

An important alias

+

We will now define an alias in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). This is extensively used in the rest of this +and other lessons:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+
+
+

Instructor note

+

Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative.

+
+

Let us inspect the project history using the git graph alias:

+
$ git graph
+
+* e7cf023 (HEAD -> main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • We have a couple commits and only +one development line (branch) and this branch is called main.

    • +

  • Commits are states characterized by a 40-character hash (checksum).

    • +

  • git graph print abbreviations of these checksums.

    • +

  • Branches are pointers that point to a commit.

    • +

  • Branch main points to a commit (in this example it is e7cf023efe382340e5284c278c6ae2c087dd3ff7 but on your computer +the hash will be different).

    • +

  • HEAD is another pointer, it points to where we are right now (currently main)

    • +
+

In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards.

+
+
+

Creating and working with branches

+
+

Instructor note

+

We do the following part together. Encourage participants to type along.

+
+
+

It is possible to create and merge branches directly on GitHub

+
    +

  • However, we do not have screenshots for that in this episode

    • +

  • But if you prefer to work in the browser, please try it

    • +

  • Please contribute screenshots to this lesson

    • +
+
+

Let’s create a branch called experiment where we add cilantro to ingredients.txt +(text after “#” are comments and not part of the command).

+
$ git branch experiment main  # creates branch "experiment" from "main"
+$ git switch experiment       # switch to branch "experiment"
+$ git branch                  # list all local branches and show on which branch we are
+
+
+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+
    +

  • Verify that you are on the experiment branch (note that git graph also +makes it clear what branch you are on: HEAD -> branchname):

    +
    $ git branch
+
+* experiment
+  main
+
    +
    +

    This command shows where we are, it does not create a branch.

    +
    • +

  • Then add 2 tbsp cilantro on top of the ingredients.txt:

    +
    * 2 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+* 1/2 onion
+
    +
    +
    • +

  • Stage this and commit it with the message “let us try with some cilantro”.

    • +

  • Then reduce the amount of cilantro to 1 tbsp, stage and commit again with “maybe little bit less cilantro”.

    • +
+

We have created two new commits:

+
$ git graph
+
+* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro
+* f6ec7b7 let us try with some cilantro
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • The branch experiment is two commits ahead of main.

    • +

  • We commit our changes to this branch.

    • +
+
+
+

Exercise: Create and commit to branches

+
+

Branch-1: Create and commit to branches

+

In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging. The goal of the exercise is to end up with 3 branches.

+
    +

  • Change to the branch main.

    • +

  • Create another branch called less-salt.

    +
      +

    • Note! makes sure you are on main branch when you create the less-salt branch.

      • +

    • A safer way would be to explicitly mention to create from the main branch +as shown below:

      +
      $ git branch less-salt main
+
      +
      +
      • +
    +
    • +

  • Switch to the less-salt branch.

    • +

  • On the less-salt branch reduce the amount of salt.

    • +

  • Commit your changes to the less-salt branch.

    • +
+

Use the same commands as we used above.

+

We now have three branches (in this case HEAD points to less-salt):

+
$ git branch
+
+  experiment
+* less-salt
+  main
+
+$ git graph
+
+* bf28166 (HEAD -> less-salt) reduce amount of salt
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Here is a graphical representation of what we have created:

+
+../_images/git-branch-2.svg
+
    +

  • Now switch to main.

    • +

  • In a new commit, improve the README.md file (we added the word “Guacamole”):

    +
    # Guacamole recipe
+
+This is an exercise repository.
+
    +
    +
    • +
+

Now you should have this situation:

+
$ git graph
+
+* b4af65b (HEAD -> main) improve the documentation
+| * bf28166 (less-salt) reduce amount of salt
+|/
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
+../_images/git-branch-3.svg
+

And for comparison this is how it looks on GitHub.

+
+
+
+

Exercise: Merging branches

+

It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge experiment into main.

+
+

Branch-2: Merge branches

+

Merge experiment and less-salt back into main following the lesson below +until the point where we start deleting branches.

+
+
+

If you got stuck in the above exercises or joined later

+

If you got stuck in the above exercises or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git switch experiment
+$ git switch less-salt
+$ git switch main
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

First we make sure we are on the branch we wish to merge into:

+
$ git branch
+
+  experiment
+  less-salt
+* main
+
+
+

Then we merge experiment into main:

+
$ git merge experiment
+
+
+
+../_images/git-merge-1.svg
+

We can verify the result:

+
$ git graph
+
+*   81fcc0c (HEAD -> main) Merge branch 'experiment'
+|\
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+* | b4af65b improve the documentation
+|/
+| * bf28166 (less-salt) reduce amount of salt
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents.

+

To view the branches that are merged into the current branch we can use the command:

+
$ git branch --merged
+
+  experiment
+* main
+
+
+

We are also happy with the work on the less-salt branch. Let us merge that +one, too, into main:

+
$ git branch  # make sure you are on main
+$ git merge less-salt
+
+
+
+Commit graph after merge
+

Commit graph after merge.

+
+
+

We can verify the result in the terminal:

+
$ git graph
+
+*   4e03d4b (HEAD -> main) Merge branch 'less-salt'
+|\
+| * bf28166 (less-salt) reduce amount of salt
+* |   81fcc0c Merge branch 'experiment'
+|\ \
+| * | bcb8b78 (experiment) maybe little bit less cilantro
+| * | f6ec7b7 let us try with some cilantro
+| |/
+* / b4af65b improve the documentation
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Observe how Git nicely merged the changed amount of salt and the new ingredient in the same file +without us merging it manually:

+
$ cat ingredients.txt
+
+* 1 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually settle merge conflicts (we will do that later).

+
+
+

Deleting branches safely

+

Both feature branches are merged:

+
$ git branch --merged
+
+  experiment
+  less-salt
+* main
+
+
+

This means we can delete the branches:

+
$ git branch -d experiment
+$ git branch -d less-salt
+
+
+

This is the result:

+
+Commit graph after merged branches were deleted
+

Commit graph after merged branches were deleted.

+
+
+

We observe that when deleting branches, +only the pointers (“sticky notes”) disappeared, not the commits.

+

Git will not let you delete a branch which has not been reintegrated unless you +insist using git branch -D. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them.

+
+
+

Optional exercises with branches

+

The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section.

+
+

(optional) Branch-3: Perform a fast-forward merge

+
    +

  1. Create a new branch from main and switch to it.

    2. +

  2. Create a couple of commits on the new branch (for instance edit README.md):

    +
    +../_images/git-pre-ff.svg
    +
    3. +

  3. Now switch to main.

    4. +

  4. Merge the new branch to main.

    5. +

  5. Examine the result with git graph.

    6. +

  6. Have you expected the result? Discuss what you see.

    7. +
+ +
+
+

(optional) Branch-4: Rebase a branch (instead of merge)

+

As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

+
    +

  1. Create a new branch, and make a couple of commits on it.

    2. +

  2. Switch back to main, and make a couple of commits on it.

    3. +

  3. Inspect the situation with git graph.

    4. +

  4. Now rebase the new branch on top of main by first switching to the new branch, and then git rebase main.

    5. +

  5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

    6. +
+ +
+
+
+

Tags

+
    +

  • A tag is a pointer to a commit but in contrast to a branch it does not ever +move when creating new commits later.

    • +

  • It can be useful to think of branches as sticky notes and of tags as +commemorative plaques.

    • +

  • We use tags to record particular states or milestones of a project at a given +point in time, like for instance versions (have a look at semantic versioning, +v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a).

    • +

  • There are two basic types of tags: annotated and lightweight.

    • +

  • Use annotated tags since they contain the author and can be cryptographically signed using +GPG, timestamped, and a message attached.

    • +
+

Let’s add an annotated tag to our current state of the guacamole recipe:

+
$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet"
+
+
+

As you may have found out already, git show is a very versatile command. Try this:

+
$ git show nobel-2023
+
+
+

For more information about tags see for example +the Pro Git book chapter on the +subject.

+
+
+
+

Summary

+

Let us pause for a moment and recapitulate what we have just learned:

+
$ git branch               # see where we are
+$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+$ git merge NAME           # merge branch NAME (to current branch)
+$ git branch -d NAME       # delete branch NAME
+$ git branch -D NAME       # delete unmerged branch NAME
+
+
+

Since the following command combo is so frequent:

+
$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+
+
+

There is a shortcut for it:

+
$ git switch --create NAME  # create branch NAME and switch to it
+
+
+
+

Typical workflows

+

With this there are two typical workflows:

+
$ git switch --create new-feature  # create branch, switch to it
+$ git commit                       # work, work, work, ..., and test
+$ git switch main                  # once feature is ready, switch to main
+$ git merge new-feature            # merge work to main
+$ git branch -d new-feature        # remove branch
+
+
+

Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging:

+
$ git switch --create wild-idea    # create branch, switch to it, work, work, work ...
+$ git switch main                  # realize it was a bad idea, back to main
+$ git branch -D wild-idea          # it is gone, off to a new idea
+
+
+
+
+

Branch-5: Test your understanding

+

Which of the following combos (one or more) creates a new branch and makes a commit to it?

+
    +
  1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    2. +
  2. $ git add file.txt
+$ git branch new-branch
+$ git switch new-branch
+$ git commit
+
    +
    +
    3. +
  3. $ git switch --create new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    4. +
  4. $ git switch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • A branch is a division unit of work, to be merged with other units of work.

    • +

  • A tag is a pointer to a moment in the history of a project.

    • +
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/conflicts/index.html b/branch/2023-version/conflicts/index.html new file mode 100644 index 00000000..d5e3ba0e --- /dev/null +++ b/branch/2023-version/conflicts/index.html @@ -0,0 +1,599 @@ + + + + + + + Conflict resolution — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Conflict resolution

+
+

Objectives

+
    +

  • Understand merge conflicts sufficiently well to be able to fix them.

    • +
+
+
+

Instructor note

+
    +

  • 20 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Conflicts in Git and why they are good

+

Imagine we start with the following text file:

+
1 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch A somebody modifies:

+
2 tbsp cilantro
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch B somebody else modifies:

+
1/2 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1 onion
+
+
+

When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro:

+
?????????????????
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1 onion
+
+
+

Git is very good at resolving modifications when merging branches and +in most cases a git merge runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see Optional exercises with branches) without you even noticing.

+

But sometimes the same portion of the code/text is modified on two branches +in two different ways and Git issues a conflict. +Then you need to tell Git which version to keep (resolve it).

+

There are several ways to do that as we will see.

+

Please remember:

+
    +

  • It is good that Git conflicts exist: Git will not silently overwrite one of +two differing modifications.

    • +

  • Conflicts may look scary, but are not that bad after a little bit of +practice. Also they are luckily rare.

    • +

  • Don’t be afraid of Git because of conflicts. You may not meet some conflicts +using other systems because you simply can’t do the kinds of things you do +in Git.

    • +

  • You can take human measures to reduce them.

    • +
+
+
+

The human side of conflicts

+
    +

  • What does it mean if two people do the same thing in two different ways?

    • +

  • What if you work on the same file but do two different things in the different sections?

    • +

  • What if you do something, don’t tell someone from 6 months, and then try to combine it with other people’s work?

    • +

  • How are conflicts avoided in other work? (Only one person working at once? +Declaring what you are doing before you start, if there is any chance someone +else might do the same thing, helps.)

    • +

  • Minor conflicts (two people revise spelling) vs semantic (two people rewrite +a function to add two different new features). How did Git solve these in +branching/merging easily?

    • +
+
+

Now we can go to show how Git controls when there is actually a conflict.

+
+
+

Preparing a conflict

+
+

Instructor note

+

We do the following together as type-along/demo.

+
+
+

If you got stuck previously or joined later

+

If you got stuck previously or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together.

+
    +

  • Create two branches from main: one called like-cilantro, one called dislike-cilantro:

    +
    $ git branch like-cilantro main
+$ git branch dislike-cilantro main
+
    +
    +
    • +

  • On the two branches make different modifications to the amount of the same ingredient:

    • +

  • On the branch like-cilantro we have the following change:

    +
    $ git diff main like-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6cacd50 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +

  • And on the branch dislike-cilantro we have the following change:

    +
    $ git diff main dislike-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6484462 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 1/2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +
+
+
+

Merging conflicting changes

+

What do you expect will happen when we try to merge these two branches into +main?

+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+

The first merge will work:

+
$ git switch main
+$ git status
+$ git merge like-cilantro
+
+Updating 4e03d4b..3caa632
+Fast-forward
+ ingredients.txt | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+

But the second will fail:

+
$ git merge dislike-cilantro
+
+Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+

Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit:

+
$ git status
+
+You have unmerged paths.
+  (fix conflicts and run "git commit")
+  (use "git merge --abort" to abort the merge)
+
+Unmerged paths:
+  (use "git add <file>..." to mark resolution)
+	both modified:   ingredients.txt
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+

Git won’t decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward.

+

Let us inspect the conflicting file:

+
$ cat ingredients.txt
+
+<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

Git inserted resolution markers (the <<<<<<<, >>>>>>>, and =======).

+

Try also git diff:

+
$ git diff
+
+
+
diff --cc ingredients.txt
+index 6cacd50,6484462..0000000
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@@ -1,4 -1,4 +1,10 @@@
+++<<<<<<< HEAD
+ +* 2 tbsp cilantro
+++=======
++ * 1/2 tbsp cilantro
+++>>>>>>> dislike-cilantro
+  * 2 avocados
+  * 1 chili
+  * 1 lime
+
+
+

git diff now only shows the conflicting part, nothing else.

+
+
+

Conflict resolution

+
<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+
+
+

We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged.

+
+

Steps to resolve a conflict

+
    +

  • Check status with git status and git diff.

    • +

  • Decide what you keep (the one, the other, or both or something +else). Edit the file to do this.

    +
      +

    • Remove the resolution markers, if not already done.

      • +

    • The file(s) should now look exactly how you want them.

      • +
    +
    • +

  • Check status with git status and git diff.

    • +

  • Tell Git that you have resolved the conflict with git add ingredients.txt +(if you use the Emacs editor with a certain plugin the editor may stage the +change for you after you have removed the conflict markers).

    • +

  • Verify the result with git status.

    • +

  • Finally commit the merge with only git commit. Everything is pre-filled.

    • +
+
+
+
+

Exercise: Create and resolve a conflict

+
+

Conflict-1: Create another conflict and resolve

+

In this exercise, we repeat almost exactly what we did above with a +different ingredient.

+
    +

  1. Create two branches before making any modifications.

    2. +

  2. Again modify some ingredient on both branches.

    3. +

  3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

    4. +

  4. What happens if you apply the same modification on both branches?

    5. +

  5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into main you will not see a conflict. Can you +explain, why it is different this time?

    6. +
+ +
+
+
+

Optional exercises with conflict resolution

+
+

(optional) Conflict-2: Resolve a conflict when rebasing a branch

+
    +

  1. Create two branches where you anticipate a conflict.

    2. +

  2. Try to merge them and observe that indeed they conflict.

    3. +

  3. Abort the merge with git merge --abort.

    4. +

  4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

    5. +
+ +
+
+

(optional) Conflict-3: Resolve a conflict using mergetool

+
    +

  • Again create a conflict (for instance disagree on the number of avocados).

    • +

  • Stop at this stage:

    +
    Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +
    • +

  • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

    +
    $ git mergetool
+
    +
    +
    +Conflict resolution using mergetool +
    +
    • +

  • Your current branch is left, the branch you merge is right, result is in the middle.

    • +

  • After you are done, close and commit, git add is not needed when using git mergetool.

    • +
+

If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

+

To view what will be removed:

+
$ git clean -n
+
+
+

To remove:

+
$ git clean -f
+
+
+

To configure Git to avoid creating backups at all:

+
$ git config --global mergetool.keepBackup false
+
+
+
+
+
+
+

Using “ours” or “theirs” strategy

+
    +

  • Sometimes you know that you want to keep “ours” version (version on the branch you are on) +or “theirs” (version on the merged branch).

    • +

  • Then you do not have to resolve conflicts manually.

    • +

  • See merge strategies.

    • +
+

Example (merge and in doubt take the changes from current branch):

+
$ git merge -s recursive -Xours less-avocados
+
+
+

Or (merge and in doubt take the changes from less-avocados branch):

+
$ git merge -s recursive -Xtheirs less-avocados
+
+
+
+
+
+

Aborting a conflicting merge

+

Sometimes you get a merge conflict but realize that you can’t solve it without +talking to a colleague (who created the other change) first. What to do?

+

You can abort the merge and postponing conflict resolution by resetting the +repository to HEAD (last committed state):

+
$ git merge --abort
+
+
+

The repository looks then exactly as it was before the merge.

+
+
+
+

Avoiding conflicts

+
    +

  • Human measures

    +
      +

    • Think and plan to which branch you will commit to.

      • +

    • Do not put unrelated changes on the same branch.

      • +
    +
    • +

  • Collaboration measures

    +
      +

    • Open an issue and discuss with collaborators before starting a long-living +branch.

      • +
    +
    • +

  • Project layout measures

    +
      +

    • Modifying global data often causes conflicts.

      • +

    • Modular programming reduces this risk.

      • +
    +
    • +

  • Technical measures

    +
      +

    • Share your changes early and often - this is one of the happy, +rare circumstances when everyone doing the selfish thing (e.g. git push as +early as practical) results in best case for everyone!

      • +

    • Pull/rebase often to keep up to date with upstream.

      • +

    • Resolve conflicts early.

      • +
    +
    • +
+
+

Discussion

+

Discuss how Git handles conflicts compared to services like Google Drive.

+
+
+

Keypoints

+
    +

  • Conflicts often appear because of not enough communication or not optimal +branching strategy.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/customizing/index.html b/branch/2023-version/customizing/index.html new file mode 100644 index 00000000..ff6dfcc3 --- /dev/null +++ b/branch/2023-version/customizing/index.html @@ -0,0 +1,185 @@ + + + + + + + Customizing Git — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Customizing Git

+
+

Shell prompt

+
+

Instructor note

+

Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like.

+
+

You can make your shell display contextual information about +your Git state even at all times.

+

Here are few example projects that make this possible and easy:

+ +
+
+

More useful “diff” output

+

Delta is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +“diff” output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/exercises/index.html b/branch/2023-version/exercises/index.html new file mode 100644 index 00000000..7d1f4d2e --- /dev/null +++ b/branch/2023-version/exercises/index.html @@ -0,0 +1,923 @@ + + + + + + + List of exercises — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

List of exercises

+
+

Summary

+

Basics:

+ +

Branching and merging:

+ +

Conflict resolution:

+ +

Inspecting history:

+ +

Using the Git staging area:

+ +

Undoing and recovering:

+ +

Interrupted work:

+ +
+
+

Full list

+

This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests.

+
+

Motivation

+

In motivation.md:

+ +
+
+

Basics

+

In basics.md:

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+

In basics.md:

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+

In basics.md:

+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+

In basics.md:

+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+

In basics.md:

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+
+

Branching and merging

+

In branches.md:

+
+

Branch-1: Create and commit to branches

+

In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging. The goal of the exercise is to end up with 3 branches.

+
    +

  • Change to the branch main.

    • +

  • Create another branch called less-salt.

    +
      +

    • Note! makes sure you are on main branch when you create the less-salt branch.

      • +

    • A safer way would be to explicitly mention to create from the main branch +as shown below:

      +
      $ git branch less-salt main
+
      +
      +
      • +
    +
    • +

  • Switch to the less-salt branch.

    • +

  • On the less-salt branch reduce the amount of salt.

    • +

  • Commit your changes to the less-salt branch.

    • +
+

Use the same commands as we used above.

+

We now have three branches (in this case HEAD points to less-salt):

+
$ git branch
+
+  experiment
+* less-salt
+  main
+
+$ git graph
+
+* bf28166 (HEAD -> less-salt) reduce amount of salt
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Here is a graphical representation of what we have created:

+
+../_images/git-branch-2.svg
+
    +

  • Now switch to main.

    • +

  • In a new commit, improve the README.md file (we added the word “Guacamole”):

    +
    # Guacamole recipe
+
+This is an exercise repository.
+
    +
    +
    • +
+

Now you should have this situation:

+
$ git graph
+
+* b4af65b (HEAD -> main) improve the documentation
+| * bf28166 (less-salt) reduce amount of salt
+|/
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
+../_images/git-branch-3.svg
+

And for comparison this is how it looks on GitHub.

+
+

In branches.md:

+
+

Branch-2: Merge branches

+

Merge experiment and less-salt back into main following the lesson below +until the point where we start deleting branches.

+
+

In branches.md:

+
+

(optional) Branch-3: Perform a fast-forward merge

+
    +

  1. Create a new branch from main and switch to it.

    2. +

  2. Create a couple of commits on the new branch (for instance edit README.md):

    +
    +../_images/git-pre-ff.svg
    +
    3. +

  3. Now switch to main.

    4. +

  4. Merge the new branch to main.

    5. +

  5. Examine the result with git graph.

    6. +

  6. Have you expected the result? Discuss what you see.

    7. +
+ +
+

In branches.md:

+
+

(optional) Branch-4: Rebase a branch (instead of merge)

+

As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

+
    +

  1. Create a new branch, and make a couple of commits on it.

    2. +

  2. Switch back to main, and make a couple of commits on it.

    3. +

  3. Inspect the situation with git graph.

    4. +

  4. Now rebase the new branch on top of main by first switching to the new branch, and then git rebase main.

    5. +

  5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

    6. +
+ +
+

In branches.md:

+
+

Branch-5: Test your understanding

+

Which of the following combos (one or more) creates a new branch and makes a commit to it?

+
    +
  1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    2. +
  2. $ git add file.txt
+$ git branch new-branch
+$ git switch new-branch
+$ git commit
+
    +
    +
    3. +
  3. $ git switch --create new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    4. +
  4. $ git switch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    5. +
+ +
+
+
+

Conflict resolution

+

In conflicts.md:

+
+

Conflict-1: Create another conflict and resolve

+

In this exercise, we repeat almost exactly what we did above with a +different ingredient.

+
    +

  1. Create two branches before making any modifications.

    2. +

  2. Again modify some ingredient on both branches.

    3. +

  3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

    4. +

  4. What happens if you apply the same modification on both branches?

    5. +

  5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into main you will not see a conflict. Can you +explain, why it is different this time?

    6. +
+ +
+

In conflicts.md:

+
+

(optional) Conflict-2: Resolve a conflict when rebasing a branch

+
    +

  1. Create two branches where you anticipate a conflict.

    2. +

  2. Try to merge them and observe that indeed they conflict.

    3. +

  3. Abort the merge with git merge --abort.

    4. +

  4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

    5. +
+ +
+

In conflicts.md:

+
+

(optional) Conflict-3: Resolve a conflict using mergetool

+
    +

  • Again create a conflict (for instance disagree on the number of avocados).

    • +

  • Stop at this stage:

    +
    Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +
    • +

  • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

    +
    $ git mergetool
+
    +
    +
    +Conflict resolution using mergetool +
    +
    • +

  • Your current branch is left, the branch you merge is right, result is in the middle.

    • +

  • After you are done, close and commit, git add is not needed when using git mergetool.

    • +
+

If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

+

To view what will be removed:

+
$ git clean -n
+
+
+

To remove:

+
$ git clean -f
+
+
+

To configure Git to avoid creating backups at all:

+
$ git config --global mergetool.keepBackup false
+
+
+
+
+
+

Inspecting history

+

In archaeology.md:

+
+

History-1: Explore basic archaeology commands

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Clone this repository: +https://github.com/networkx/networkx.git. +Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release:

    +
    $ git clone https://github.com/networkx/networkx.git
+$ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+

In archaeology.md:

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+
+

Using the Git staging area

+

In staging-area.md:

+
+

Staging-1: Perform an interactive commit

+

One option to help us create nice logical commits is to stage interactively +with git commit --patch:

+
    +

  1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

    2. +

  2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

    3. +

  3. Do it again for the other change.

    4. +

  4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

    5. +

  5. When would this be useful?

    6. +
+ +
+

In staging-area.md:

+
+

Staging-2: Use the staging area to make a commit in two steps

+
    +

  1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

    2. +

  2. Use git add to stage one of the changes.

    3. +

  3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

    4. +

  4. Feel some regret and unstage the staged change.

    5. +
+
+
+
+

Undoing and recovering

+

In recovering.md:

+
+

Undoing-1: Revert a commit

+
    +

  • Create a commit (commit A).

    • +

  • Revert the commit with git revert (commit B).

    • +

  • Inspect the history with git log --oneline.

    • +

  • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

    • +
+
+

In recovering.md:

+
+

Undoing-2: Modify a previous commit

+
    +

  1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

    2. +

  2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

    3. +

  3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

    4. +
+ +
+

In recovering.md:

+
+

Undoing-3: Destroy our experimentation in this episode

+

After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

+
    +

  • First, we will look at our history (git log/git graph) and +find the last commit HASH before our tests.

    • +

  • Then, we will git reset --hard HASH to that.

    • +

  • Then, git graph again to see what happened.

    • +
+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+$ git reset --hard b4af65b
+
+HEAD is now at b4af65b improve the documentation
+
+$ git log --oneline
+
+b4af65b (HEAD -> main) improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+
+

In recovering.md:

+
+

Undoing-4: Test your understanding

+
    +

  1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

    2. +

  2. Is it OK to modify commits that nobody has seen yet?

    3. +

  3. What situations would justify to modify the Git history and possibly remove commits?

    4. +
+ +
+
+
+

Interrupted work

+

In interrupted.md:

+
+

Interrupted-1: Stash some uncommitted work

+
    +

  1. Make a change.

    2. +

  2. Check status/diff, stash the change with git stash, check status/diff again.

    3. +

  3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

    4. +

  4. Pop off the stash you saved with git stash pop, and check status/diff.

    5. +

  5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

    6. +

  6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

    7. +

  7. Advanced: what does git graph show when you have something +stashed?

    8. +
+ +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/genindex/index.html b/branch/2023-version/genindex/index.html new file mode 100644 index 00000000..fcf37d8f --- /dev/null +++ b/branch/2023-version/genindex/index.html @@ -0,0 +1,155 @@ + + + + + + Index — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + +

Index

+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/guide/index.html b/branch/2023-version/guide/index.html new file mode 100644 index 00000000..5e906b98 --- /dev/null +++ b/branch/2023-version/guide/index.html @@ -0,0 +1,430 @@ + + + + + + + Instructor guide — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Instructor guide

+
+

Schedule Day 1

+

Times here are in CE(S)T.

+
    +

  • 08:50 - 09:00 (10 min) Soft start and icebreaker question

    • +

  • 09:00 - 09:20 (20 min) Welcome and practical information

    • +

  • 09:20 - 09:35 (15 min) Motivation

    • +

  • 09:35 - 09:50 (15 min) Basics - configuration and first commits

    • +

  • 09:50 - 10:00 (10 min) Break

    • +

  • 10:00 - 10:20 (20 min) Exercise

    +
      +

    • Record changes

      • +

    • Optional exercises

      • +
    +
    • +

  • 10:20 - 10:40 (20 min) Basics - history, commit log, ignoring

    • +

  • 10:40 - 11:00 (20 min) Exercise

    +
      +

    • One or all optional exercises

      • +
    +
    • +

  • 11:00 - 12:00: Lunch break

    • +

  • 12:00 - 12:15 (15 min) Branching and merging

    • +

  • 12:15 - 12:35 (20 min) Exercise

    +
      +

    • Branch-1

      • +

    • Branch-2

      • +
    +
    • +

  • 12:35 - 12:50 (15 min) Summarize/discuss branching and merging

    • +

  • 12:50 - 13:00 (10 min) Break

    • +

  • 13:00 - 13:20 (20 min) Conflict resolution

    • +

  • 13:20 - 13:30 (10 min) Q&A, feedback, and what will we be doing tomorrow?

    • +
+
+
+

Schedule Day 2

+

Times here are in CE(S)T.

+
    +

  • 08:50 - 09:00 (10 min) Soft start and icebreaker question

    • +

  • 09:00 - 09:10 (10 min) Recap and Q&A from day 1

    • +

  • 09:10 - 09:25 (15 min) Sharing repositories online

    • +

  • 09:25 - 09:50 (25 min) Exercise

    +
      +

    • Set up SSH keys

      • +

    • Pushing our guacamole recipe repository to GitHub

      • +

    • Clone repository

      • +
    +
    • +

  • 09:50 - 10:00 (10 min) Break

    • +

  • 10:00 - 10:15 (15 min) Inspecting history

    • +

  • 10:15 - 10:45 (30 min) Exercise

    +
      +

    • History-1

      • +

    • History-2 is optional

      • +
    +
    • +

  • 10:45 - 11:00 (15 min) Summarize/discuss inspecting history

    • +

  • 11:00 - 12:00: Lunch break

    • +

  • 12:00 - 12:15 (15 min) Undoing and recovering

    • +

  • 12:15 - 12:40 (25 min) Exercises

    +
      +

    • Undoing-1

      • +

    • Undoing-2

      • +

    • Undoing-3

      • +
    +
    • +

  • 12:40 - 11:50 (10 min) Summarize undoing and recovering and discussion and mention that staging area exists

    • +

  • 12:50 - 13:00 (10 min) Break

    • +

  • 13:00 - 13:20 (20 min) How much Git is necessary?

    • +

  • 13:20 - 13:30 (10 min) Q&A, feedback, and what will we be doing tomorrow?

    • +
+
+
+

Installation reminders for each day

+
    +

  • Day 1: Git configuration

    • +

  • Day 2: SSH set up (if you don’t, sharing repositories online will be demo)

    • +
+
+
+

Why we teach this lesson

+

Everyone should be using a version control system for their work, even if they’re working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories.

+

Specific motivations:

+
    +

  • Code easily becomes a disaster without version control

    • +

  • Mistakes happen - Git offers roll-back functionality and easy backup mechanism

    • +

  • One often needs to work on multiple things in parallel - branches solve that problem

    • +

  • Git enables people to collaborate on code or text without stepping on each other’s toes

    • +

  • Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, +and if bugs are found one can find out exactly when it was introduced

    • +
+

Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices (e.g. how to use the staging area), which is useful for more experienced users.

+
+
+

Intended learning outcomes

+

By the end of this lesson, learners should:

+
    +

  • realize that version control is very important and Git is a valuable tool to learn and use

    • +

  • understand that Git is configurable and know how to set basic configurations

    • +

  • be able to set up Git repositories and make commits

    • +

  • understand that information on commits, branches etc. are stored under .git/, and have a +mental model of how that relates to the working directory

    • +

  • have a mental model of the different states a file can have in Git (untracked, modified, staged, unmodified)

    • +

  • know how to write good commit messages

    • +

  • have an idea of how the staging area can be used to craft good commits

    • +

  • know how to undo commits using git revert and discard changes using git restore

    • +

  • understand that git restore can be dangerous if changes have not been staged

    • +

  • know how to create branches and switch between branches

    • +

  • have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way

    • +

  • know how to merge branches and understand what that means in terms of combining different modifications

    • +

  • know how to resolve conflicts, or to abort conflicting merges

    • +

  • realize that conflicts are generally a good thing since they prevent incorrect merges

    • +

  • be able to set up a repository on GitHub and connect it with local repository

    • +

  • push changes to a remote repository

    • +

  • know a few ways to search through a repository and its history

    • +
+
+
+

How to teach this lesson

+
+

Take first editor steps slowly

+

Some participants will be new to using a terminal text editor so please open, +edit, and close the editor (Nano) slowly in first type-along sessions and +exercises to avoid that participants will fall behind the instructor. At one +point a student did not follow the file edits of the instructor, and to correct +the mistake they had to do a manual merge, which they were not ready for.

+
+
+

How to use the exercises

+

Most episodes have standard exercises followed by optional (often more advanced) exercises +for more experienced learners so they don’t get bored waiting for the newcomers. +The instructor should briefly introduce the exercises and mention that after finishing the +standard exercise (and indicating that using the green sticky) the learners can move on to the +optional ones if they wish. When at least half of the learners have raised the green sticky +the instructor should go through the standard exercise to describe its most important take-home messages. +It’s also fine to briefly go though important points from the optional exercises, but don’t spend +too much time on it since everyone will not have attempted them.

+
+
+

“Test your understanding” exercises

+

Some episodes have a “test your understanding” exercise at the end which is intended as formative assessment, +i.e. an activity that provides feedback to instructors and learners on whether learning objectives are being met. +The instructor should end each episode by posing the “test your understanding” multiple-choice question, +giving learners a minute to think about it, and then asking for the right answer or asking learners to raise their +hands to signal which answer they think is correct.

+
+
+

Inspecting history

+

Key lesson is how to find when something is broken or what commit has broken +the code.

+

It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that git annotate +and git show are available on GitHub and GitLab.

+

When discussing git annotate and git bisect the “when” is more important +than “who”. It is not to blame anybody but rather to find out whether published +results are affected.

+

Discuss how one would find out this information without version control.

+

Questions to involve participants:

+
    +

  • Have you ever found a bug in your code and wondered whether it has affected published results?

    • +

  • Have you ever wondered when, and by whom, a particular line of code was introduced?

    • +

  • Have you ever found out that a code behaves differently than it used to but you are not sure when +precisely this changed?

    • +
+

Confusion during git bisect exercise:

+

Learners may get stuck in the git bisect exercise if they incorrectly assign a commit +as bad or good. +To leave the bisect mode and return to the commit before git bisect start was issued, +one can do

+
$ git bisect reset
+
+
+

and start over if needed.

+
+
+

Live better than reading the website material

+

It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier.

+
+
+

Log your history in a separate window

+

The screencasting (shell window cheatsheet) hints have been moved to +the presenting +manual.

+
+
+

Create a cheatsheet on the board

+

For in-person workshops, create a “cheatsheet” on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven’t forgotten anything. Re-create and expand in future git lessons. +One strategy is:

+
    +

  • a common section for basic commands: init, config, clone, help, stash

    • +

  • info commands, can be run anytime: status, log, diff, graph

    • +

  • A section for all the commands that move code from different states: +add, commit, etc. See the visual cheat sheet below.

    • +
+

You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it’s probably too confusing to use after this course. But, the idea +of commands moving from the “working dir”, “staging area”, “commits”, +etc is good.

+
+Example cheat sheet +
+

Example cheat sheet.

+
+
+

We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to.

+
+
+

Draw a graph on the board

+

Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run git graph, then do the command, +then look at git graph again.

+
+
+

Repeat the following points

+
    +

  • Always check git status, git diff, and git graph (our alias) before and +after every command until you get used to things. These give you a clear view +into what is going on, the key to knowing what you are doing. Even +after you are used to things… anytime you do something you do +infrequently, it’s good to check.

    • +

  • git graph is a direct representation of what we are drawing on the +board and should constantly be compared to it.

    • +

  • Once you git add something, it’s almost impossible to lose it. +This is used all the time, for example once you commit or even add +it is hard to lose. Commit before you merge or rebase. And so on.

    • +
+
+
+

Start from identical environment

+

You probably have a highly optimized bash and git environment - one +that is different from students. Move .gitconfig and .bashrc out +of the way before you start so that your environment is identical to +what students have.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/index.html b/branch/2023-version/index.html new file mode 100644 index 00000000..e4cbe6ea --- /dev/null +++ b/branch/2023-version/index.html @@ -0,0 +1,244 @@ + + + + + + + Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version
    • +
  • + Edit on GitHub +
    • +
+
+
+
+
+ +
+

Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version

+

This is the introductory lesson to version control using +Git. It is assumed to be the very first thing +done in a course.

+

Our philosophy is that we start from own local repository, branching and +merging (locally), and a brief introduction to pushing to remotes. In +the separate collaborative Git +lesson, we teach more use of +remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with +Git to be able to work well. We try to avoid commands which might get +you into a confusing state.

+

The goals of the module as a whole are that the user will feel +comfortable about staging changes, committing them, merging, and +branching.

+
+

Prerequisites

+
    +

  • A reasonably recent version of Git (ideal is 2.28 or newer but we +recommend at least 2.23) is installed and configured (installation +instructions). But also on older +Git (2.0) the workshop will work and we will offer workarounds for Git below 2.28 +or 2.23.

    • +

  • For one of the episodes we need a GitHub user +account (but alternatives exist, see below).

    • +

  • Being comfortable with the command line. No expertise is required, but +the lesson will be mostly taken from the command line. For most commands, where reasonable, +we also offer the possibility to participate through the browser.

    • +

  • To edit files on the local computer, learners should be familiar with +using a text editor on their system. If you are new to text editors, +we recommend to start with Nano or VS Code.

    • +
+
+
+

Core episodes

+ +
+
+

Optional episodes

+ +
+
+

Reference

+ +
+
+

About

+ +
+
+

Why GitHub?

+

In this introduction we will mention and use +GitHub but also +GitLab and +Bitbucket allow similar workflows and +basically everything that we will discuss is transferable. With this +material and these exercises we do not implicitly endorse the company +GitHub. We have chosen to demonstrate a +number of concepts using examples with +GitHub because it is currently the most +popular web platform for hosting Git repositories and the chance is +high that you will interact with +GitHub-based repositories even if you choose +to host your Git repository on another platform.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/interrupted/index.html b/branch/2023-version/interrupted/index.html new file mode 100644 index 00000000..2229c9c5 --- /dev/null +++ b/branch/2023-version/interrupted/index.html @@ -0,0 +1,269 @@ + + + + + + + Interrupted work — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Interrupted work

+
+

Objectives

+
    +

  • Learn to switch context or abort work without panicking.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+

Keypoints

+
    +

  • There is almost never reason to clone a fresh copy to complete a task that +you have in mind.

    • +
+
+
+

Frequent situation: interrupted work

+

We all wish that we could write beautiful perfect code. But the real world is +much more chaotic:

+
    +

  • You are in the middle of a “Jackson-Pollock-style” debugging spree with 27 modified files +and debugging prints everywhere.

    • +

  • Your colleague comes in and wants you to fix/commit something right now.

    • +

  • What to do?

    • +
+

Git provides lots of ways to switch tasks without ruining everything.

+
+
+

Option 1: Stashing

+

The stash is the first and easiest place to temporarily “stash” +things.

+
    +

  • git stash will put working directory and staging area changes +away. Your code will be same as last commit.

    • +

  • git stash pop will return to the state you were before. Can give it a list.

    • +

  • git stash list will list the current stashes.

    • +

  • git stash save NAME is like the first, but will give it a name. +Useful if it might last a while.

    • +

  • git stash save [-p] [filename] will stash certain files files +and/or by patches.

    • +

  • git stash drop will drop the most recent stash (or whichever stash +you give).

    • +

  • The stashes form a stack, so you can stash several batches of modifications.

    • +
+
+

Exercise: Stashing

+
+

Interrupted-1: Stash some uncommitted work

+
    +

  1. Make a change.

    2. +

  2. Check status/diff, stash the change with git stash, check status/diff again.

    3. +

  3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

    4. +

  4. Pop off the stash you saved with git stash pop, and check status/diff.

    5. +

  5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

    6. +

  6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

    7. +

  7. Advanced: what does git graph show when you have something +stashed?

    8. +
+ +
+
+
+
+

Option 2: Create branches

+

You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch.

+

You basically know how to do this:

+
$ git switch --create temporary  # create a branch and switch to it
+$ git add PATHS                  # stage changes
+$ git commit                     # commit them
+$ git switch main                # back to main, continue your work there ...
+$ git switch temporary           # continue again on "temporary" where you left off
+
+
+

Later you can merge it to main or rebase it on top of main and resume work.

+
+
+

Storing various junk you don’t need but don’t want to get rid of

+

It happens often that you do something and don’t need it, but you don’t want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/lesson.pdf b/branch/2023-version/lesson.pdf new file mode 100644 index 00000000..083de564 Binary files /dev/null and b/branch/2023-version/lesson.pdf differ diff --git a/branch/2023-version/level/index.html b/branch/2023-version/level/index.html new file mode 100644 index 00000000..2b17d83a --- /dev/null +++ b/branch/2023-version/level/index.html @@ -0,0 +1,249 @@ + + + + + + + Practical advice: how much Git is necessary? — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Practical advice: how much Git is necessary?

+
+

Instructor note

+
    +

  • 20 min teaching/discussion

    • +
+
+
+

What level of branching complexity is necessary for each project?

+
+

Simple personal projects

+
    +

  • Typically start with just the main branch.

    • +

  • Use branches for unfinished/untested ideas.

    • +

  • Use branches when you are not sure about a change.

    • +

  • Use tags to mark important milestones.

    • +
+
+
+

Projects with few persons: you accept things breaking sometimes

+
    +

  • It might be reasonable to commit to the main branch and feature branches.

    • +
+
+
+

Projects with few persons: changes are reviewed by others

+
    +

  • You create new feature branches for changes.

    • +

  • Changes are reviewed before they are merged to the main branch +(more about that in the collaborative Git lesson).

    • +

  • The main branch is write-protected and can only be changed with pull requests or merge requests.

    • +
+
+
+

When you distribute releases

+
    +

  • If you want to patch releases, you probably need release branches.

    • +

  • The main branch and release branches are read-only.

    • +

  • Many branching models exist.

    • +
+
+
+
+
+

How about staging and committing?

+
    +

  • It is OK to start committing directly by doing git commit SOMEFILE.

    • +

  • Commit early and often: rather create too many commits than too few. +You can always combine commits later.

    • +

  • Once you commit, it is very, very hard to really lose your code.

    • +

  • Always fully commit (or stash) before you do dangerous things, so that you know you are safe. +Otherwise it can be hard to recover.

    • +

  • Later you can start using the staging area.

    • +

  • Later start using git add -p and/or git commit -p.

    • +
+
+
+
+

How large should a commit be?

+
    +

  • Better too small than too large (easier to combine than to split).

    • +

  • Often I make a commit at the end of the day (this is a unit I would not like to lose).

    • +

  • Smaller sized commits may be easier to review for others than huge commits.

    • +

  • Imperfect commits are better than no commits.

    • +

  • A commit should not contain unrelated changes to simplify review and possible +repair/adjustments/undo later (but again: imperfect commits are better than no commits).

    • +
+
+
+

Keypoints

+
    +

  • There is no one size fits all - start simple and grow your project.

    • +
+
+
+

Discussion

+

How do you [plan to] use Git?

+
    +

  • Advanced users or beginners, please provide your input in the online collaborative document.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/motivation/index.html b/branch/2023-version/motivation/index.html new file mode 100644 index 00000000..3b3e157a --- /dev/null +++ b/branch/2023-version/motivation/index.html @@ -0,0 +1,323 @@ + + + + + + + Motivation — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Motivation

+
+

Objectives

+
    +

  • Make sure nobody leaves the workshop without starting to use some form of version control.

    • +

  • Discuss the reasons why we advocate distributed version control.

    • +
+
+
+

Instructor note

+
    +

  • 15 min teaching/demonstration

    • +
+
+
+

Git is all about keeping track of changes

+

We will learn how to keep track of changes first in a terminal (example +repository):

+
+Screenshot of a git log in terminal +
+

Later also via web interface (example +repository):

+
+Screenshot of a git log on GitHub +
+
+
+

Why do we need to keep track of versions?

+

Version control is an answer to these questions (do you recognize some of them?):

+
    +

  • “It broke … hopefully I have a working version somewhere?”

    • +

  • “Can you please send me the latest version?”

    • +

  • “Where is the latest version?”

    • +

  • “Which version are you using?”

    • +

  • “Which version have the authors used in the paper I am trying to reproduce?”

    • +

  • “Found a bug! Since when was it there?”

    • +

  • “I am sure it used to work. When did it change?”

    • +

  • “My laptop is gone. Is my thesis now gone?”

    • +
+
+
+

Features: roll-back, branching, merging, collaboration

+
    +

  • Roll-back: you can always go back to a previous version and compare

    • +

  • Branching and merging:

    +
      +

    • Work on different ideas at the same time

      • +

    • Different people can work on the same code/project without interfering

      • +

    • You can experiment with an idea and discard it if it turns out to be a bad idea

      • +
    +
    • +
+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+ +
+
+

Reproducibility

+
    +

  • How do you indicate which version of your code you have used in your paper?

    • +

  • When you find a bug, how do you know when precisely this bug was introduced +(Are published results affected? Do you need to inform collaborators or users of your code?).

    • +
+

With version control we can “annotate” code (browse this example online):

+
+Example of a git-annotated code with code and history side-by-side +
+

Example of a git-annotated code with code and history side-by-side.

+
+
+
+
+

Talking about code

+

Which of these two is more practical?

+
    +

  • “Clone the code, go to the file ‘src/util.rs’, and search for ‘time_iso8601’”. +Oh! But make sure you use the version from August 2023.”

    • +

  • Or I can send you a permalink:

    • +
+
+Screen-shot of a code portion +
+

Permalink that points to a code portion.

+
+
+
+
+

What we typically like to snapshot

+
    +

  • Software (this is how it started but Git/GitHub can track a lot more)

    • +

  • Scripts

    • +

  • Documents (plain text files much better suitable than Word documents)

    • +

  • Manuscripts (Git is great for collaborating/sharing LaTeX or Quarto manuscripts)

    • +

  • Configuration files

    • +

  • Website sources

    • +

  • Data

    • +
+
+

Discussion

+

In this example somebody tried to keep track of versions without a version +control system tool like Git. Discuss the following directory listing. What +possible problems do you anticipate with this kind of “version control”:

+
myproject-2019.zip
+myproject-2020-February.zip
+myproject-2021-August.zip
+myproject-2023-09-19-working.zip
+myproject-2023-09-21.zip
+myproject-2023-09-21-test.zip
+myproject-2023-09-21-myversion.zip
+myproject-2023-09-21-newfeature.zip
+...
+
+
+ +
+
+
+

Difficulties of version control

+

Despite the benefits, let’s be honest, there are some difficulties:

+
    +

  • One more thing to learn (it’s probably worth it and will save you more time in the long run; basic career skill).

    • +

  • Difficult if your collaborators don’t want to use it (in the worst case, you can version control on your side and email them versions).

    • +

  • Advanced things can be difficult, but basics are often enough (ask others for help when needed).

    • +
+
+
+

Why Git and not another tool?

+
    +

  • Easy to set up: no server needed.

    • +

  • Very popular: chances are high you will need to contribute to somebody else’s code which is tracked with Git.

    • +

  • Distributed: good backup, no single point of failure, you can track and +clean-up changes offline, simplifies collaboration model for open-source +projects.

    • +

  • Important platforms such as GitHub, GitLab, and Bitbucket +build on top of Git.

    • +
+

However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +Subversion, +Mercurial, Pijul, or others.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/objects.inv b/branch/2023-version/objects.inv new file mode 100644 index 00000000..bc260a89 Binary files /dev/null and b/branch/2023-version/objects.inv differ diff --git a/branch/2023-version/recovering/index.html b/branch/2023-version/recovering/index.html new file mode 100644 index 00000000..e53d4034 --- /dev/null +++ b/branch/2023-version/recovering/index.html @@ -0,0 +1,428 @@ + + + + + + + Undoing and recovering — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Undoing and recovering

+
+

Objectives

+
    +

  • Learn to undo changes safely

    • +

  • See when undone changes are permanently deleted and when they can be retrieved

    • +
+
+
+

Instructor note

+
    +

  • 25 min teaching/type-along

    • +

  • 25 min exercise

    • +
+
+

One of the main points of version control is that you can go back in +time to recover. Unlike this xkcd comic implies: https://xkcd.com/1597/

+

In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn’t a “commit” permanent?

+
    +

  • You can modify old commit history.

    • +

  • But if you have shared that history already, modifying it can make +a huge mess.

    • +
+
+

It is almost always possible to recover

+

As long as you commit something once (or at least git add it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru… until that guru becomes you.

+
+
+

Nice resource to visually simulate Git operation

+

git-sim +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command.

+
+
+
+

Undoing your recent, uncommitted and unstaged changes (preserves history)

+
+

Note

+

In case git restore does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git restore.

+
+

You do some work, and want to undo your uncommitted and unstaged modifications. +You can always do that with:

+
    +

  • git restore . (the dot means “here and in all folders below”)

    • +
+

You can also undo things selectively:

+
    +

  • git restore -p (decide which portions of changes to undo) or git restore PATH (decide which path/file)

    • +
+

If you have staged changes, you have at least two options to undo the staging:

+
    +

  • git restore --staged . followed by git status and git restore .

    • +

  • git reset --hard HEAD throws away everything that is not in last +commit (HEAD - this literal word, this isn’t a placeholder)

    • +
+
+
+
+

Reverting commits (preserves history)

+

Imagine we made a few commits. +We realize that the latest commit e02efcd was a mistake and we wish to undo it:

+
$ git log --oneline
+
+e02efcd (HEAD -> main) not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

A safe way to undo the commit is to revert the commit with git revert:

+
$ git revert e02efcd
+
+
+

This creates a new commit that does the opposite of the reverted commit. +The old commit remains in the history:

+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

You can revert any commit, no matter how old it is. It doesn’t affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we’ll learn about later).

+
+

Exercise: Revert a commit

+
+

Undoing-1: Revert a commit

+
    +

  • Create a commit (commit A).

    • +

  • Revert the commit with git revert (commit B).

    • +

  • Inspect the history with git log --oneline.

    • +

  • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

    • +
+
+
+
+
+

Adding to the previous commit (modifies history)

+

Sometimes we commit but realize we forgot something. +We can amend to the last commit:

+
$ git commit --amend
+
+
+

This can also be used to modify the last commit message.

+

Note that this will change the commit hash. This command modifies the history. +This means that we avoid this command on commits that we have shared with others.

+
+

Exercise: Modify a previous commit

+
+

Undoing-2: Modify a previous commit

+
    +

  1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

    2. +

  2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

    3. +

  3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

    4. +
+ +
+
+
+
+

Rewinding branches (modifies history)

+

You can reset branch history to move your branch back to some +point in the past.

+
    +

  • git reset --hard HASH will force a branch label to any other point. All +other changes are lost (but it is possible to recover if you force reset by mistake).

    • +

  • Be careful if you do this - it can mess stuff up. Use git graph a +lot before and after.

    • +
+
+

Exercise: Git reset

+
+

Undoing-3: Destroy our experimentation in this episode

+

After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

+
    +

  • First, we will look at our history (git log/git graph) and +find the last commit HASH before our tests.

    • +

  • Then, we will git reset --hard HASH to that.

    • +

  • Then, git graph again to see what happened.

    • +
+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+$ git reset --hard b4af65b
+
+HEAD is now at b4af65b improve the documentation
+
+$ git log --oneline
+
+b4af65b (HEAD -> main) improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+
+
+
+
+
+

Recovering from committing to the wrong branch

+

It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes.

+

Here we assume that we made a couple of commits but we realize they went to the +wrong branch.

+

Solution 1 using git cherry-pick:

+
    +

  1. Make sure that the correct branch exists and if not, create it. Make sure to +create it from the commit hash where you wish you had created it from: git branch BRANCHNAME HASH

    2. +

  2. Switch to the correct branch.

    3. +

  3. git cherry-pick HASH can be used to take a specific commit to the +current branch. Cherry-pick all commits that should have gone to the correct +branch, from oldest to most recent.

    4. +

  4. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    5. +
+

Solution 2 using git reset --hard (makes sense if the correct branch should +contain all commits of the accidentally modified branch):

+
    +

  1. Create the correct branch, pointing at the latest commit: git branch BRANCHNAME.

    2. +

  2. Check with git log or git graph that both branches point to the same, latest, commit.

    3. +

  3. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    4. +
+
+
+

Recovering from merging/pulling into the wrong branch

+

git merge, git rebase, and git pull modify the current branch, never +the other branch. But sometimes we run this command on the wrong branch.

+
    +

  1. Check with git log the commit hash that you would like to rewind the +wrongly modified branch to.

    2. +

  2. Rewind the branch that accidentally got wrong commits with git reset --hard HASH (see also above).

    3. +
+
+
+

Recovering from conflict after pulling changes

+

Pulling changes with +git pull can create a conflict since git pull always also includes a git merge (more about this +in the collaborative Git lesson).

+

The recovery is same as described in Conflict resolution. Either +resolve conflicts or abort the merge with git merge --abort.

+
+
+

Undoing-4: Test your understanding

+
    +

  1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

    2. +

  2. Is it OK to modify commits that nobody has seen yet?

    3. +

  3. What situations would justify to modify the Git history and possibly remove commits?

    4. +
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/reference/index.html b/branch/2023-version/reference/index.html new file mode 100644 index 00000000..b91a6c28 --- /dev/null +++ b/branch/2023-version/reference/index.html @@ -0,0 +1,230 @@ + + + + + + + Quick reference — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Quick reference

+
+

Other cheatsheets

+ +
+
+

Glossary

+
    +

  • working directory/ workspace: the actual files you see and edit

    • +

  • staging area: Place files go after git add and before git commit

    • +

  • hash: unique reference of any commit or state

    • +

  • branch: One line of work. Different branches can exist at the +same time and split/merge.

    • +

  • HEAD: Pointer to the most recent commit on the current branch.

    • +

  • remote: Roughly, another server that holds .git.

    • +

  • origin: Default name for a remote repository.

    • +

  • master: Default name for main branch on Git. Depending on the configuration and service, +the default branch is sometimes main. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

    • +

  • main: Default name for main branch on GitLab and GitHub. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

    • +
+
+
+

Commands we use

+

Setup:

+
    +

  • git config: edit configuration options

    • +

  • git init -b main: create new repository with main as the default branch

    • +
+

See our status:

+
    +

  • git status: see status of files - use often!

    • +

  • git log: see history of commits and their messages, newest first

    • +

  • git graph: see a detailed graph of commits. Create this command +with git config --global alias.graph "log --all --graph --decorate --oneline"

    • +

  • git diff: show difference between working directory and last commit

    • +

  • git diff --staged: show difference between staging area and last commit

    • +

  • git show COMMIT: inspect individual commits

    • +
+

General work:

+
    +

  • git add FILE:

    +
      +

    • Add a new file

      • +

    • Add a file to staging

      • +
    +
    • +

  • git commit: record a version, add it to current branch

    • +

  • git commit --amend: amend our last commit

    • +

  • git branch: show which branch we’re on

    • +

  • git branch NAME: create a new branch called “name”

    • +

  • git restore FILE: restore last committed/staged version of FILE, losing unstaged changes

    • +

  • git switch --create BRANCH-NAME: create a new branch and switch to it

    • +

  • git revert HASH: create a new commit which reverts commit HASH

    • +

  • git reset --soft HASH: remove all commits after HASH, but keep their modifications as staged changes

    • +

  • git reset --hard HASH: remove all commits after HASH, permanently throwing away their changes

    • +

  • git merge BRANCH-NAME: merge branch BRANCH-NAME into current branch

    • +

  • git grep PATTERN: search for patterns in tracked files

    • +

  • git annotate FILE: find out when a specific line got introduced and by whom

    • +

  • git bisect: find a commit which broke some functionality

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/remotes/index.html b/branch/2023-version/remotes/index.html new file mode 100644 index 00000000..1e0e9828 --- /dev/null +++ b/branch/2023-version/remotes/index.html @@ -0,0 +1,439 @@ + + + + + + + Sharing repositories online — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Sharing repositories online

+
+

Objectives

+
    +

  • We get a feeling for remote repositories (more later).

    • +

  • We are able to publish a repository on the web.

    • +

  • We are able to fetch and track a repository from the web.

    • +
+
+
+

Instructor note

+
    +

  • 15 min demonstration/type-along

    • +

  • 25 min exercise

    • +
+
+
+

From our laptops to the web

+

We have seen that creating Git repositories and moving them around is +relatively simple and that is great.

+

So far, if you only worked in the command line, everything was local and all +snapshots, branches, and tags are saved under .git.

+

If we remove .git, we remove all Git history of a project.

+
+

Discussion

+
    +

  • What if the hard disk fails?

    • +

  • What if somebody steals my laptop?

    • +

  • How can we collaborate with others across the web?

    • +
+
+
+
+

Remotes

+

We will learn how to work with remote repositories in detail in the +collaborative distributed version control lesson.

+

In this section we only want to get a taste to prepare us for other lessons +where we will employ GitHub. Our goal is to publish our exercise guacamole recipe +which we prepared in the previous episodes on +the web. Don’t worry, you will be able to remove it afterwards.

+
+

If you don’t have the recipe repository from previous episodes

+

Maybe you joined the workshop later or got stuck somewhere? No problem!

+

If you don’t have the recipe repository from previous episodes, you can +clone our version of the repository using (please skip this if you have the recipe +repository on your computer already):

+
$ git clone https://github.com/coderefinery/recipe-before-merge.git recipe
+$ cd recipe
+$ git remote remove origin
+
+
+

Now you have a repository called recipe on your computer with a couple of +commits. Further down we will also clarify what git clone does.

+
+

To store your git data on another server, you use remotes. +A remote is a repository on its own, with its own branches +We can push changes to the remote and pull +from the remote.

+

You might use remotes to:

+
    +

  • Back up your own work.

    • +

  • To collaborate with other people.

    • +
+

There are different types of remotes:

+
    +

  • If you have a server you can ssh to, you can use that as a remote.

    • +

  • GitHub is a popular, closed-source commercial site.

    • +

  • GitLab is a popular, open-core +commercial site. Many universities have their own private GitLab servers +set up.

    • +

  • Bitbucket is yet another popular commercial site.

    • +

  • Another option is NotABug.

    • +

  • We also operate a Nordic +research software repository +platform. +This is GitLab, free for researchers and allows private, +cross-university sharing.

    • +
+
+
+
+

Authenticating to GitHub: SSH or HTTPS?

+

How does Github know who you are? This is hard and there are two +options.

+
    +

  • SSH is the classic method, using Secure Shell remote connection +keys.

    • +

  • HTTPS works with the Git Credential Manager, which is an +extra add-on that works easily in Windows and Mac.

    • +
+

Read how to install them from the installation +instructions.

+

Test which one you should use:

+
+

Try this command:

+
$ ssh -T git@github.com
+
+
+

If it returns Hi USERNAME! You've successfully authenticated, ..., +then SSH is configured and the following steps will work with the SSH +cloning.

+

See our installation +instructions to +set up SSH access.

+

From now on, if you know that SSH works, you should always select +SSH as the clone URL from GitHub, or translate the URL to start with +the right thing yourself: git@github.com: (with the trailing +:).

+
+

If you do not have these configured, please watch as we do this episode and you +can check the installation +instructions +before the next collaborative Git +lesson, where we will need +one of these set up.

+
+
+
+

Publishing an existing repository from laptop to GitHub

+
+

If you started in the browser and have nothing on your laptop yet

+

It is possible, that you already have a repository on GitHub if you followed +the examples and exercises in previous episodes in the browser. In this case, +please watch others publish their repository and try to clone your repository +to the laptop using instructions at the bottom of this page.

+
+

First log into GitHub, then follow the screenshots and descriptions below.

+
+Screenshot on GitHub before a new repository form is opened +
+

Click on the “plus” symbol on top right, then on “New repository”.

+
+
+

Another way to create a new repository is to visit +https://github.com/new directly.

+
+Screenshot on GitHub just before a new repository is created +
+

Choose a repository name, add a short description, but please do not check “Add a +README file”**. For “Add .gitignore” and “Choose a license” also leave as “None”. Finally “Create repository”.

+
+
+

Once you click the green “Create repository”, you will see a page similar to:

+
+Screenshot on GitHub after a bare repository was created +
+

What this means is that we have now an empty project with either an HTTPS or an +SSH address: click on the HTTPS and SSH buttons to see what happens.

+

We now want to follow the “… or push an existing repository from the command line:

+
    +

  1. Now go to your guacamole repository on your computer.

    2. +

  2. Check that you are in the right place with git status.

    3. +

  3. Copy paste the three lines to the terminal and execute those, in my case (you +need to replace the “USER” part and possibly also the repository name):

    4. +
+
+

See above for if SSH is the right option for you.

+
$ git remote add origin git@github.com:USER/recipe.git
+
+
+
+

Then:

+
$ git branch -M main
+$ git push -u origin main
+
+
+

The meaning of the above lines:

+
    +

  • Add a remote reference with the name “origin”

    • +

  • Rename current branch to “main”

    • +

  • Push branch “main” to “origin”

    • +
+

You should now see:

+
Enumerating objects: 3, done.
+Counting objects: 100% (3/3), done.
+Writing objects: 100% (3/3), 221 bytes | 221.00 KiB/s, done.
+Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
+To github.com:USER/recipe.git
+ * [new branch]      main -> main
+Branch 'main' set up to track remote branch 'main' from 'origin'.
+
+
+

Reload your GitHub project website and - taa-daa - your commits should now be +online! What just happened? Think of publishing a repository as uploading +the .git part online.

+
+

Troubleshooting

+

error: remote origin already exists.

+
    +

  • Explanation: You probably ran a git remote add origin ... command, then changed your +mind about HTTPS or SSH and then tried to run the other git remote add origin ... command but “origin” then already exists.

    • +

  • Recovery:

    +
      +

    • First remove “origin” with git remote remove origin

      • +

    • Then run the correct git remote add origin ... command

      • +
    +
    • +
+

remote contains work that you do not have

+
    +

  • Explanation: You probably clicked on “Add a README file” and now the +repository on GitHub is not empty but contains one commit and locally you +have a different history. Git now prevents you from accidentally overwriting +the history on GitHub.

    • +

  • Recovery:

    +
      +

    • Use git push --force instead of git push, which will force Git to overwrite the history on GitHub

      • +

    • Note that this is a powerful but also possibly dangerous option but here it +helps us. If it’s a brand new repo, it probably is fine to do this. For real +repositories, don’t do this unless you are very sure what is happening.

      • +
    +
    • +
+
+
+
+
+

Cloning a repository from GitHub to laptop

+

Now other people can clone this repository and contribute changes. In the +collaborative distributed version control lesson +we will learn how this works.

+

At this point only a brief demo - if you copy the SSH or HTTPS address, you can clone repositories like this +(again adapt the USER in the “USER/repository.git” part):

+
+
$ git clone git@github.com:USER/recipe.git
+
+
+

From now on, if you are using SSH, you should pay attention and make +sure your clone URLs start with git@github.com: now and in future +lessons.

+
+

This creates a directory called “recipe” unless it already exists. You can also specify the target directory +on your computer:

+
+
$ git clone git@github.com:USER/recipe.git myrecipe
+
+
+
+

What just happened? Think of cloning as downloading the .git part to your +computer. After downloading the .git part, the default branch (the branch pointed to by HEAD) is +automatically checked out.

+
+

Keypoints

+
    +

  • A repository can have one or multiple remotes (we will revisit these later).

    • +

  • Local branches often track remote branches.

    • +

  • A remote serves as a full backup of your work.

    • +

  • We’ll properly learn how to use these in the +collaborative distributed version control.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/resources/index.html b/branch/2023-version/resources/index.html new file mode 100644 index 00000000..0eee650e --- /dev/null +++ b/branch/2023-version/resources/index.html @@ -0,0 +1,169 @@ + + + + + + + Other resources — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/search/index.html b/branch/2023-version/search/index.html new file mode 100644 index 00000000..afb62b02 --- /dev/null +++ b/branch/2023-version/search/index.html @@ -0,0 +1,169 @@ + + + + + + Search — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/branch/2023-version/searchindex.js b/branch/2023-version/searchindex.js new file mode 100644 index 00000000..184e25b5 --- /dev/null +++ b/branch/2023-version/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["aliases", "archaeology", "basics", "branches", "conflicts", "customizing", "exercises", "guide", "index", "interrupted", "level", "motivation", "recovering", "reference", "remotes", "resources", "staging-area", "under-the-hood", "what-to-avoid"], "filenames": ["aliases.md", "archaeology.md", "basics.md", "branches.md", "conflicts.md", "customizing.md", "exercises.md", "guide.md", "index.md", "interrupted.md", "level.md", "motivation.md", "recovering.md", "reference.md", "remotes.md", "resources.md", "staging-area.md", "under-the-hood.md", "what-to-avoid.md"], "titles": ["Aliases and configuration", "Inspecting history", "Basics", "Branching and merging", "Conflict resolution", "Customizing Git", "List of exercises", "Instructor guide", "Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version", "Interrupted work", "Practical advice: how much Git is necessary?", "Motivation", "Undoing and recovering", "Quick reference", "Sharing repositories online", "Other resources", "Using the Git staging area", "Git under the hood", "What to avoid"], "terms": {"learn": [0, 2, 3, 9, 11, 12, 14, 15, 16, 17], "most": [0, 4, 7, 8, 9, 12, 13, 16, 18], "common": [0, 7, 12, 18], "ar": [0, 1, 2, 3, 5, 6, 7, 8, 9, 11, 12, 14, 16, 17, 18], "you": [0, 2, 5, 6, 7, 8, 11, 12, 13, 16, 17, 18], "get": [0, 2, 4, 6, 7, 8, 12, 14, 16, 18], "tire": 0, "type": [0, 1, 3, 4, 6, 7, 9, 12, 14, 16, 17], "so": [0, 1, 2, 3, 6, 7, 9, 10, 13, 14, 16, 17, 18], "much": [0, 5, 7, 8, 9, 11], "In": [0, 1, 2, 3, 4, 6, 8, 9, 11, 12, 13, 14, 16, 17, 18], "can": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 16, 17, 18], "defin": [0, 3, 16], "shortcut": [0, 3], "These": [0, 2, 7], "great": [0, 2, 11, 14, 16], "becaus": [0, 2, 4, 8, 9, 18], "thei": [0, 2, 3, 6, 7, 10, 12, 16, 17], "save": [0, 2, 6, 9, 11, 14, 16, 17], "time": [0, 2, 3, 4, 5, 6, 7, 9, 11, 12, 13, 15, 16, 17], "But": [0, 1, 2, 3, 4, 7, 8, 9, 11, 12, 16, 18], "": [0, 1, 2, 3, 4, 6, 7, 11, 14, 16], "easi": [0, 2, 5, 7, 11, 12], "forget": [0, 2, 3, 6, 12], "them": [0, 2, 3, 4, 6, 7, 8, 9, 11, 12, 14, 16], "confus": [0, 2, 3, 7, 8], "inconsist": 0, "your": [0, 1, 4, 5, 8, 9, 10, 11, 16, 17, 18], "colleagu": [0, 4, 9], "There": [0, 2, 3, 4, 6, 7, 9, 10, 14], "i": [0, 1, 4, 5, 6, 7, 8, 9, 13, 14, 18], "plenti": 0, "other": [0, 2, 3, 4, 6, 7, 8, 9, 11, 12, 14, 16, 17], "make": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 14, 18], "nicer": 0, "offer": [0, 7, 8], "wai": [0, 1, 2, 3, 4, 6, 7, 9, 12, 14, 16, 18], "improv": [0, 2, 3, 5, 6, 12, 18], "usabl": 0, "ci": 0, "instead": [0, 1, 2, 4, 12, 14, 18], "commit": [0, 4, 7, 8, 9, 13, 14, 15, 17, 18], "base": [0, 2, 8, 17], "simpl": [0, 7, 8, 14], "string": [0, 1, 17], "replac": [0, 2, 14, 16], "either": [0, 2, 6, 9, 12, 14], "specif": [0, 1, 2, 6, 7, 12, 13], "repositori": [0, 3, 4, 6, 7, 8, 9, 11, 12, 13, 16, 17, 18], "global": [0, 2, 3, 4, 6, 13], "help": [0, 2, 4, 6, 7, 11, 14, 16, 18], "do": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 12, 14, 16, 17, 18], "thing": [0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 14, 16, 18], "across": [0, 14], "project": [0, 1, 2, 3, 4, 5, 7, 11, 14, 15, 16, 18], "per": [0, 15], "also": [0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 14, 16, 17, 18], "creat": [0, 1, 10, 11, 12, 13, 14, 16, 17], "store": [0, 2, 6, 7, 14, 16, 17], "gitconfig": [0, 7], "A": [0, 2, 3, 4, 6, 7, 8, 10, 12, 14, 15, 16, 17], "veri": [0, 2, 3, 4, 7, 8, 10, 11, 14, 16, 17], "which": [0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 13, 14, 16, 17, 18], "we": [0, 1, 2, 3, 4, 6, 9, 12, 14, 16, 17, 18], "lot": [0, 2, 6, 9, 11, 12, 18], "our": [0, 2, 3, 7, 8, 13], "workshop": [0, 2, 7, 8, 11, 14], "config": [0, 2, 3, 4, 6, 7, 13, 14, 17], "log": [0, 1, 3, 6, 12, 13, 14, 16, 17], "all": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 16, 17, 18], "decor": [0, 3, 13], "onelin": [0, 1, 2, 3, 6, 12, 13], "cd": [0, 1, 2, 3, 4, 6, 14, 17], "your_git_repositori": 0, "It": [0, 1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14, 16, 18], "possibl": [0, 1, 2, 5, 6, 8, 10, 11, 14], "call": [0, 1, 2, 3, 4, 6, 13, 14], "exclam": 0, "mark": [0, 4, 10], "charact": [0, 2, 3, 17], "thi": [0, 2, 3, 4, 5, 8, 9, 10, 11, 13, 14, 16, 17, 18], "here": [0, 1, 2, 3, 5, 6, 7, 12, 14, 16], "local": [0, 2, 3, 6, 7, 8, 12, 14], "synchron": 0, "remot": [0, 3, 4, 7, 8, 13], "hi": [0, 14], "echo": 0, "hello": 0, "how": [0, 2, 3, 4, 5, 6, 9, 11, 12, 14, 16, 17], "mani": [0, 2, 7, 10, 14, 16, 18], "should": [0, 1, 2, 3, 4, 6, 7, 8, 12, 14, 16, 18], "wait": [0, 7, 18], "befor": [0, 1, 2, 3, 4, 6, 7, 9, 10, 12, 13, 14, 16, 18], "believ": 0, "gener": [0, 2, 6, 7, 13, 18], "two": [0, 2, 3, 4, 9, 11, 12, 14, 17], "letter": [0, 3], "acronym": 0, "welcom": [0, 7], "reus": [0, 8, 14], "suggest": [0, 2], "see": [0, 1, 2, 3, 4, 6, 7, 8, 12, 13, 14, 16, 17, 18], "current": [0, 1, 3, 4, 6, 8, 9, 12, 13, 14, 16], "ap": 0, "add": [0, 2, 3, 4, 6, 7, 9, 10, 12, 13, 14, 16, 18], "patch": [0, 6, 9, 10, 16], "br": 0, "branch": [0, 1, 2, 7, 8, 13, 14, 15, 18], "v": [0, 4, 8, 16], "cip": 0, "cl": 0, "clone": [0, 1, 3, 4, 6, 7, 9, 11], "recurs": [0, 4, 17], "di": 0, "diff": [0, 4, 7, 9, 13, 16], "dic": 0, "stage": [0, 2, 3, 4, 7, 8, 9, 12, 13], "color": 0, "word": [0, 3, 5, 6, 11, 12], "diw": 0, "pager": [0, 5], "stat": [0, 2, 6], "fe": 0, "fetch": [0, 14], "rem": 0, "st": 0, "statu": [0, 1, 2, 4, 6, 7, 9, 12, 13, 14, 16, 17], "su": 0, "submodul": 0, "updat": [0, 4, 7, 18], "init": [0, 2, 6, 7, 13], "what": [0, 3, 4, 6, 7, 8, 9, 12, 14, 16, 17], "select": [0, 12, 14, 16], "part": [0, 2, 3, 4, 14], "individu": [0, 2, 13, 16], "interact": [0, 8, 13], "obviou": [0, 18], "check": [0, 1, 2, 4, 6, 7, 9, 12, 14, 16, 17, 18], "option": [0, 7, 12, 13, 14, 16], "clariti": 0, "an": [0, 1, 2, 4, 7, 9, 11, 12, 15, 17, 18], "topic": 0, "area": [0, 2, 7, 8, 9, 10, 13, 17], "last": [0, 1, 4, 6, 9, 12, 13, 16], "about": [0, 2, 3, 4, 5, 6, 7, 12, 14, 16, 17], "small": [0, 2, 10, 16, 18], "chang": [0, 3, 7, 8, 9, 13, 14, 16, 17, 18], "diffstat": 0, "file": [0, 1, 3, 4, 6, 7, 8, 9, 11, 12, 13, 14, 16, 17, 18], "content": [0, 2, 4, 6], "show": [0, 1, 3, 4, 7, 9, 12, 13, 14], "whole": [0, 2, 7, 8], "some": [0, 1, 2, 3, 4, 7, 11, 12, 13, 16, 18], "u": [0, 1, 2, 3, 4, 6, 9, 12, 14, 16, 17], "l": [0, 17], "set": [0, 2, 3, 7, 11, 14], "p": [0, 9, 10, 12, 16, 17], "singlekei": 0, "true": [0, 18], "won": [0, 4], "t": [0, 2, 3, 4, 6, 7, 11, 12, 16, 17, 18], "explain": [0, 2, 4, 6, 7, 16, 18], "bore": [0, 7], "have": [0, 1, 2, 3, 4, 6, 7, 8, 9, 11, 12, 16, 17, 18], "want": [0, 1, 2, 3, 4, 5, 6, 10, 11, 12, 14, 16], "go": [0, 1, 2, 3, 4, 6, 7, 11, 12, 13, 14, 16, 17], "deeper": 0, "try": [0, 1, 2, 3, 4, 6, 8, 9, 11, 12, 14], "figur": [0, 2, 4], "out": [0, 2, 3, 4, 6, 7, 11, 13, 14, 16], "might": [0, 3, 4, 8, 9, 10, 12, 14], "manual": [0, 3, 4, 6, 7, 17], "page": [0, 1, 2, 6, 13, 14, 18], "cif": 0, "fixup": 0, "rb": 0, "rebas": [0, 7, 9, 12], "autosquash": 0, "rbi": 0, "autostash": 0, "rec": 0, "upstream": [0, 4], "head": [0, 2, 3, 4, 6, 12, 13, 14, 16, 17], "ignor": [0, 7, 18], "o": 0, "exclud": 0, "standard": [0, 7], "new": [0, 1, 2, 3, 4, 6, 7, 8, 10, 12, 13, 14, 16, 17, 18], "newd": 0, "newdi": 0, "reca": 0, "n10": 0, "recd": 0, "besid": 0, "ones": [0, 7, 16], "core": [0, 2, 14], "less": [0, 1, 3, 4, 6, 9], "r": [0, 11, 17], "excludesfil": 0, "gitignor": [0, 14, 18], "merg": [0, 5, 7, 8, 9, 10, 13, 14, 18], "conflictstyl": 0, "diff3": 0, "wordregex": 0, "za": 0, "z0": 0, "9_": 0, "space": [0, 1], "mnemonicprefix": 0, "copi": [0, 2, 9, 14], "past": [0, 6, 12, 14], "name": [0, 1, 2, 3, 9, 13, 14, 16], "like": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 14, 16, 17], "github": [0, 1, 2, 4, 5, 6, 7, 11, 12, 13], "com": [0, 1, 2, 3, 4, 5, 6, 7, 12, 14], "myusernam": 0, "url": [0, 14], "insteadof": 0, "gh": 0, "usernam": [0, 14], "ghu": 0, "Then": [0, 1, 3, 4, 6, 12, 14, 17], "recip": [0, 3, 4, 6, 7, 12, 16], "automat": [0, 1, 2, 4, 6, 14], "translat": [0, 14], "prefix": 0, "match": 0, "If": [0, 1, 2, 6, 8, 10, 12], "frustrat": 0, "rememb": [0, 2, 3, 4, 6, 12], "Be": [1, 3, 12], "abl": [1, 2, 3, 4, 6, 7, 8, 14], "why": [1, 2, 3, 6, 17, 18], "wa": [1, 2, 3, 4, 6, 7, 11, 12, 14, 18], "introduc": [1, 6, 7, 11, 13], "quickli": 1, "behavior": [1, 2], "30": [1, 3, 7], "min": [1, 2, 3, 4, 7, 9, 10, 11, 12, 14, 16, 17], "teach": [1, 2, 3, 4, 6, 8, 9, 10, 11, 12, 16, 17], "along": [1, 3, 4, 7, 9, 12, 14, 16, 17], "pleas": [1, 2, 3, 4, 7, 10, 11, 14, 18], "sure": [1, 2, 3, 6, 7, 10, 11, 12, 14, 16], "insid": [1, 2, 17], "alreadi": [1, 2, 3, 4, 6, 7, 9, 12, 14, 18], "track": [1, 3, 6, 12, 13, 14], "folder": [1, 2, 6, 12, 17], "exist": [1, 2, 4, 6, 7, 8, 10, 11, 12, 13], "step": [1, 2, 3, 14], "need": [1, 2, 3, 4, 6, 7, 8, 10, 12, 14, 16, 17], "differ": [1, 2, 3, 4, 6, 7, 11, 13, 14, 16, 17], "locat": [1, 16, 17], "sinc": [1, 2, 3, 4, 6, 7, 11, 12, 16, 18], "messag": [1, 3, 6, 7, 12, 13, 17, 18], "good": [1, 2, 3, 6, 7, 8, 9, 11, 12, 15, 17], "case": [1, 3, 4, 6, 7, 9, 11, 12, 14, 16], "fatal": 1, "ani": [1, 2, 3, 4, 6, 11, 12, 13], "parent": [1, 3, 6, 17], "directori": [1, 2, 3, 4, 6, 7, 9, 11, 13, 14, 16, 17], "first": [1, 2, 3, 4, 6, 8, 9, 11, 12, 13, 14, 17, 18], "demonstr": [1, 3, 5, 6, 7, 8, 11, 14], "few": [1, 3, 5, 6, 7, 9, 12, 17, 18], "real": [1, 9, 14], "life": 1, "exampl": [1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 14, 16], "http": [1, 2, 3, 4, 5, 6, 7, 11, 12, 16], "networkx": [1, 6], "mention": [1, 2, 3, 6, 7, 8], "amaz": 1, "site": [1, 14], "The": [1, 2, 3, 6, 7, 8, 9, 10, 12, 14, 15, 17, 18], "program": [1, 2, 4], "historian": 1, "later": [1, 2, 6, 9, 10, 11, 12, 14, 15, 16, 18], "practic": [1, 2, 3, 4, 6, 7, 8, 11, 15], "below": [1, 2, 3, 4, 6, 7, 8, 9, 12, 14], "As": [1, 2, 3, 6, 12], "readm": [1, 2, 3, 6, 12, 14], "rst": 1, "visit": [1, 2, 14], "brows": [1, 2, 6, 11], "githistori": 1, "xyz": 1, "blob": [1, 17], "main": [1, 2, 3, 4, 6, 9, 10, 12, 13, 14, 17], "left": [1, 2, 3, 4, 6, 9], "right": [1, 2, 3, 4, 6, 7, 9, 14, 16, 17], "kei": [1, 7, 14, 16], "too": [1, 2, 3, 7, 10, 18], "With": [1, 2, 3, 6, 8, 9, 11], "grep": [1, 5, 6, 13], "contain": [1, 2, 3, 6, 10, 12, 14, 17], "regular": [1, 3], "express": 1, "where": [1, 2, 3, 4, 6, 8, 9, 11, 12, 14, 16], "variabl": 1, "error": [1, 6, 14], "print": [1, 3, 6, 9, 16], "fixm": 1, "while": [1, 3, 6, 9], "state": [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 13, 16, 17], "through": [1, 2, 7, 8, 16], "sometext": 1, "got": [1, 2, 6, 12, 13, 14, 16], "remov": [1, 2, 3, 4, 6, 12, 13, 14, 16, 18], "same": [1, 2, 3, 4, 6, 7, 9, 11, 12, 13, 16], "q": [1, 2, 7, 16], "repo": [1, 12, 14], "3anetworkx": 1, "2fnetworkx": 1, "seen": [1, 2, 6, 12, 14], "one": [1, 2, 3, 4, 6, 7, 8, 9, 10, 14, 15, 16], "know": [1, 2, 3, 4, 6, 7, 9, 10, 11, 14, 16], "its": [1, 7, 14, 17], "hash": [1, 2, 3, 6, 9, 12, 13, 17], "For": [1, 2, 3, 6, 7, 8, 12, 14, 17], "instanc": [1, 3, 4, 6], "759d589bdfa61aff99e0535938f14f67b01c83f7": 1, "who": [1, 4, 7, 8, 14], "modifi": [1, 2, 4, 7, 9, 16, 17], "precis": [1, 7, 11], "each": [1, 2, 6, 16, 17], "incredibli": 1, "reproduc": [1, 7], "convert_matrix": 1, "py": [1, 6], "termin": [1, 3, 7, 11, 12, 14], "longer": [1, 18], "than": [1, 2, 3, 4, 6, 10, 11, 12, 18], "screen": 1, "default": [1, 2, 13, 14], "scroll": 1, "output": [1, 2, 6], "enter": [1, 6], "cycl": 1, "result": [1, 3, 4, 6, 7, 11], "n": [1, 4, 6, 16], "next": [1, 2, 3, 6, 14, 16], "down": [1, 6, 12, 14], "quit": [1, 2], "blame": [1, 7], "screenshot": [1, 2, 3, 6, 14], "rel": [1, 2, 14], "trivial": 1, "affect": [1, 2, 7, 11, 12], "wrap": 1, "long": [1, 2, 3, 4, 9, 11, 12, 15, 16], "shorter": 1, "auto": [1, 4, 6], "format": 1, "tool": [1, 4, 7, 16], "black": 1, "editor": [1, 2, 4, 6, 8, 16, 17], "trail": [1, 14], "whitespac": 1, "point": [1, 3, 6, 11, 12, 14, 18], "recommend": [1, 2, 7, 8], "mechan": [1, 7, 17], "old": [1, 6, 12], "switch": [1, 2, 3, 4, 6, 7, 9, 12, 13, 17], "branchnam": [1, 3, 6, 12], "start": [1, 2, 3, 4, 6, 8, 10, 11, 16, 17, 18], "onli": [1, 2, 3, 4, 6, 10, 12, 14, 16], "comment": [1, 3, 18], "older": [1, 3, 4, 8, 12], "from": [1, 2, 3, 4, 6, 8, 11, 16, 17, 18], "347e6292419b": 1, "347e6292419bd0e4bff077fe971f983932d7a0e9": 1, "now": [1, 2, 3, 4, 6, 7, 9, 11, 12, 14, 16, 17], "navig": [1, 6], "back": [1, 2, 3, 6, 7, 9, 12, 14, 16, 17, 18], "after": [1, 2, 3, 4, 6, 7, 9, 13, 14], "done": [1, 2, 3, 4, 6, 7, 8, 12, 14, 16, 18], "delet": [1, 4, 6, 12, 17], "d": [1, 3], "On": [1, 2, 3, 4, 6, 12, 17], "version": [1, 2, 3, 4, 6, 7, 12, 13, 14, 16], "23": [1, 6, 8], "checkout": [1, 3, 4, 6, 12, 16], "b": [1, 2, 4, 6, 12, 13, 16], "somehash": [1, 6], "347e629": 1, "onc": [1, 3, 4, 6, 7, 10, 12, 14, 15, 16, 17, 18], "let": [1, 2, 3, 4, 6, 11, 12, 16, 17, 18], "valu": [1, 6], "futur": [1, 2, 6, 7, 14], "depend": [1, 6, 12, 13], "ok": [1, 6, 10, 11, 12, 18], "complet": [1, 6, 9, 12, 18], "fulli": [1, 6, 10], "6": [1, 4, 6, 9], "3": [1, 7, 14, 16, 17], "tag": [1, 6, 10, 14, 17], "releas": [1, 2, 6], "abov": [1, 2, 4, 6, 9, 12, 14, 16], "logic": [1, 6, 16], "degree_correl": [1, 6], "ad": [1, 3, 4, 6, 18], "actual": [1, 4, 6, 13, 16], "bring": [1, 6], "provid": [1, 6, 7, 9, 10, 17], "encourag": [1, 2, 3, 6], "give": [1, 2, 3, 4, 6, 7, 9, 11, 16], "algorithm": [1, 3, 6], "threshold": [1, 2, 6], "rdi": [1, 6], "mayb": [1, 3, 6, 14, 18], "number": [1, 4, 6, 8], "follow": [1, 2, 3, 4, 6, 11, 12, 14], "90544b4fa": [1, 6], "unless": [1, 2, 3, 4, 6, 14], "compact": [1, 6], "access": [1, 2, 6, 14], "just": [1, 2, 3, 6, 8, 10, 14, 16], "am": [1, 11], "work": [1, 2, 4, 7, 11, 12, 13, 14, 16, 17, 18], "strang": 1, "sometim": [1, 3, 4, 12, 13, 18], "realiz": [1, 3, 4, 7, 12], "problem": [1, 3, 7, 11, 14, 16, 18], "500": [1, 6], "ago": 1, "doe": [1, 2, 3, 4, 6, 9, 12, 14, 17, 18], "could": [1, 2, 6, 9], "probabl": [1, 2, 6, 7, 9, 10, 11, 14, 18], "arriv": [1, 2, 6], "similar": [1, 2, 6, 8, 12, 14], "f0ea950": 1, "broken": [1, 7], "compil": [1, 2, 3, 16], "run": [1, 2, 3, 4, 6, 7, 11, 12, 14, 16], "test": [1, 11, 14, 18], "decid": [1, 4, 6, 12, 16], "whether": [1, 4, 7], "tell": [1, 2, 3, 4, 6], "And": [1, 2, 3, 4, 6, 7], "iter": 1, "until": [1, 3, 6, 7, 12, 14], "reset": [1, 4, 6, 7, 13, 16], "even": [1, 3, 4, 5, 7, 8, 18], "script": [1, 6, 11], "write": [1, 6, 7, 9, 10, 12, 14], "return": [1, 2, 7, 9, 14], "zero": 1, "non": 1, "success": [1, 2, 15], "failur": [1, 11], "begin": [1, 6, 16], "coderefineri": [1, 3, 4, 6, 7, 8, 14], "motiv": [1, 2, 7, 8], "sourc": [1, 6, 11, 14], "bug": [1, 3, 6, 7, 11], "difficult": [1, 2, 6, 11, 18], "visual": [1, 3, 4, 7], "offend": [1, 6], "often": [1, 2, 3, 4, 6, 7, 9, 10, 11, 13, 14, 15, 16, 18], "more": [1, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 18], "half": [1, 2, 3, 6, 7, 12], "debug": [1, 3, 6, 9, 16], "background": [1, 6], "get_pi": [1, 6], "approxim": [1, 6], "pi": [1, 6], "term": [1, 2, 6, 7, 15, 17], "nilakantha": [1, 6], "seri": [1, 6], "produc": [1, 6], "14": [1, 2, 6], "57": [1, 6], "python": [1, 2, 3, 6], "At": [1, 3, 6, 7, 14], "within": [1, 2, 6], "correctli": [1, 6], "task": [1, 6, 9], "comput": [1, 3, 6, 8, 14], "spoiler": [1, 6], "alert": [1, 6], "found": [1, 3, 6, 7, 11], "bonu": [1, 6], "correct": [1, 2, 6, 7, 12, 14], "hint": [1, 2, 6, 7], "tail": [1, 6], "tild": [1, 6], "power": [1, 14], "combin": [1, 4, 7, 10, 18], "grasp": 2, "structur": [2, 3, 7], "inspect": [2, 3, 4, 8, 12, 13, 16, 17], "35": [2, 7], "40": [2, 3, 7, 17], "control": [2, 3, 4, 7, 12, 14], "system": [2, 4, 7, 8, 11], "over": [2, 7, 16, 18], "everi": [2, 6, 7, 16], "entir": [2, 4, 15], "assign": [2, 7], "kept": 2, "sub": 2, "keep": [2, 3, 4, 7, 13, 16], "move": [2, 3, 4, 6, 7, 12, 14, 16], "somewher": [2, 11, 14], "els": [2, 3, 4, 9, 11, 18], "still": [2, 4, 6, 7, 9], "doesn": [2, 6, 9, 12, 17], "anyth": [2, 7], "ask": [2, 6, 7, 9, 11, 12], "multipl": [2, 7, 14, 16], "web": [2, 8, 11], "take": [2, 4, 12, 16], "request": [2, 10, 18], "don": [2, 3, 4, 6, 7, 11, 12, 18], "yet": [2, 6, 7, 12], "txt": [2, 3, 4, 6, 16], "anotherfil": 2, "focu": 2, "think": [2, 3, 4, 6, 7, 14], "outcom": 2, "edit": [2, 3, 4, 6, 7, 8, 13], "again": [2, 3, 4, 6, 7, 9, 10, 12, 14, 16], "sever": [2, 3, 4, 6, 9, 16, 17], "end": [2, 3, 6, 7, 10, 16, 18], "perform": 2, "focus": 2, "scene": 2, "press": 2, "shutter": 2, "instal": [2, 4, 6, 8, 14], "instruct": [2, 3, 4, 6, 8, 12, 14, 16], "email": [2, 11], "address": [2, 14, 16], "yournam": 2, "nano": [2, 7, 8], "defaultbranch": 2, "verifi": [2, 3, 4, 14, 17], "list": [2, 3, 8, 9, 11, 12, 17, 18], "learner": [2, 7, 8], "enough": [2, 4, 8, 11], "initi": 2, "delici": 2, "inspir": [2, 3, 7, 11], "smith": 2, "carpentri": 2, "mail": 2, "cook": 2, "everybodi": 2, "relat": [2, 4, 6, 7, 16], "mai": [2, 3, 4, 7, 10, 12, 18], "written": [2, 15], "e": [2, 3, 4, 6, 7, 12], "g": [2, 3, 4, 6, 7, 12], "anoth": [2, 3, 7, 8, 13, 14, 16, 17], "languag": 2, "lesson": [2, 3, 6, 8, 10, 12, 13, 14, 16], "realli": [2, 3, 7, 9, 10, 18], "stuck": [2, 6, 7, 14], "One": [2, 6, 7, 11, 12, 13, 16], "principl": 2, "mkdir": 2, "That": 2, "empti": [2, 14], "No": [2, 4, 6, 8, 14], "noth": [2, 3, 4, 6, 17], "sens": [2, 12], "inform": [2, 3, 5, 6, 7, 11, 12, 17], "dure": [2, 4, 6, 7, 18], "descript": [2, 14, 16, 17], "click": [2, 6, 14], "plu": [2, 14], "symbol": [2, 6, 14], "top": [2, 3, 4, 6, 9, 11, 14, 16], "directli": [2, 10, 14], "choos": [2, 8, 14], "short": [2, 14, 16], "final": [2, 4, 14], "overview": 2, "md": [2, 3, 6], "ingredi": [2, 3, 4, 6, 12, 16], "avocado": [2, 3, 4, 6], "chili": [2, 3, 4, 6], "lime": [2, 3, 4, 6], "tsp": [2, 3, 4, 6], "salt": [2, 3, 4, 6], "second": [2, 4], "chop": 2, "onion": [2, 3, 4, 6, 12], "squeez": [2, 6], "mix": [2, 6, 16], "well": [2, 3, 4, 6, 8, 16], "alwai": [2, 7, 10, 11, 14, 17], "safe": [2, 4, 6, 10, 12], "idea": [2, 3, 6, 7, 10, 11, 12, 16, 17, 18], "when": [2, 3, 7, 9, 11, 12, 13, 16, 17, 18], "untrack": [2, 7], "includ": [2, 12, 18], "present": [2, 7, 16, 17], "camera": 2, "consciou": 2, "decis": 2, "rm": [2, 6, 12, 18], "cach": 2, "unstag": [2, 4, 6, 13, 16], "readi": [2, 3, 7, 16, 17, 18], "m": [2, 3, 6, 14], "root": 2, "f146d25": [2, 3, 6, 12], "insert": [2, 4], "mode": [2, 6, 7], "100644": [2, 4, 6], "queri": 2, "muscl": 2, "memori": 2, "third": 2, "flag": [2, 3, 6], "mean": [2, 3, 4, 6, 7, 12, 14], "versatil": [2, 3], "worri": [2, 14, 17], "mind": [2, 3, 9, 14], "read": [2, 10, 14], "doubt": [2, 4], "search": [2, 6, 7, 11, 13], "onlin": [2, 7, 8, 10, 11], "find": [2, 3, 7, 11, 12, 13, 17], "relev": [2, 6], "thread": 2, "network": [2, 11], "connect": [2, 7, 14], "specifi": [2, 7, 14], "adjust": [2, 10], "howev": [2, 3, 11], "up": [2, 3, 4, 6, 7, 11, 12, 14, 17, 18], "three": [2, 3, 6, 14, 16], "enjoi": [2, 3, 6, 12], "identifi": [2, 6], "index": [2, 4, 6, 9, 17], "4422a31": [2, 6], "ba8854f": [2, 6], "7811273": [2, 6], "2b11074": [2, 6], "separ": [2, 3, 6, 8, 9, 16], "happen": [2, 3, 4, 6, 7, 9, 12, 14, 17], "leav": [2, 4, 6, 7, 11, 14], "open": [2, 4, 6, 7, 11, 14, 17], "associ": [2, 6], "made": [2, 3, 6, 12, 16, 17], "chanc": [2, 4, 6, 7, 8, 11], "ve": [2, 6, 14, 17], "convinc": [2, 6], "self": [2, 6], "were": [2, 3, 6, 7, 9, 17], "justifi": [2, 6, 12], "close": [2, 4, 6, 7, 14], "experi": [2, 3, 6, 11, 12], "modif": [2, 4, 6, 7, 9, 12, 13, 16], "pen": [2, 6], "By": [2, 6, 7], "preview": [2, 6], "goal": [2, 3, 6, 8, 14, 17], "haven": [2, 6, 7, 12], "e7cf023efe382340e5284c278c6ae2c087dd3ff7": [2, 3], "author": [2, 3, 11, 17], "radovan": 2, "bast": 2, "norepli": 2, "date": [2, 4], "sun": 2, "sep": 2, "17": 2, "19": [2, 11], "12": [2, 7], "47": 2, "2023": [2, 3, 11], "0200": 2, "79161b6e67c62ad4688a58c1e54183334611a390": 2, "32": 2, "a3394e39535343c4dae3bb4f703741a31aa8b78a": 2, "18": 2, "369624674e63de48055a65bf63055bd59c985d22": 2, "46": 2, "58": 2, "f146d25b94569a15e94d7f0da6f15d7554f76c49": 2, "52": [2, 17], "arbitrari": 2, "hash1": [2, 6], "hash2": [2, 6], "develop": [2, 3, 6, 7], "uniqu": [2, 13], "label": [2, 3, 6, 12, 16], "code": [2, 3, 4, 6, 7, 8, 9, 10, 12, 16, 18], "integ": 2, "count": [2, 14], "revers": 2, "chronolog": 2, "order": [2, 6, 9, 16, 17], "newest": [2, 13, 16], "7": [2, 6, 9], "necessari": [2, 7, 8], "nice": [2, 3, 6, 16], "been": [2, 3, 6, 7, 9, 18], "look": [2, 3, 4, 5, 6, 7, 12, 16, 17], "between": [2, 3, 4, 6, 7, 9, 13, 16], "under": [2, 6, 7, 8, 14], "side": [2, 5, 6, 11], "further": [2, 6, 14], "difftool": [2, 6], "requir": [2, 3, 4, 6, 8], "window": [2, 6, 14], "linux": [2, 6], "meld": [2, 6], "maco": [2, 6], "opendiff": [2, 6], "notic": [2, 3, 4, 6, 18], "deepen": [2, 6], "both": [2, 3, 4, 6, 12, 16], "manag": [2, 3, 4, 6, 14], "troubl": [2, 6], "shoot": [2, 6], "better": [2, 9, 10, 11, 16, 18], "import": [2, 7, 10, 11, 16, 18], "increas": [2, 4, 18], "alpha": 2, "0": [2, 3, 8, 14, 17], "enabl": [2, 7], "123": 2, "convent": [2, 3], "summar": [2, 7], "paragraph": 2, "detail": [2, 3, 13, 14], "free": [2, 14], "form": [2, 3, 7, 9, 11, 17], "someth": [2, 3, 4, 6, 7, 9, 12, 14, 18], "ha": [2, 3, 6, 7, 12, 18], "cross": [2, 14], "refer": [2, 6, 7, 14, 16, 17, 18], "issu": [2, 4, 7, 16], "bad": [2, 3, 4, 7, 9, 11, 16], "fix": [2, 3, 4, 6, 9, 12, 16], "oop": 2, "whatthecommit": 2, "english": 2, "understood": 2, "15": [2, 7, 9, 11, 14, 17], "year": [2, 7], "someon": [2, 4, 18], "Or": [2, 3, 4, 11, 18], "me": [2, 3, 11], "50": [2, 7], "peopl": [2, 4, 6, 7, 11, 12, 14, 18], "decad": 2, "my": [2, 5, 6, 11, 14], "favourit": 2, "style": [2, 9], "choic": [2, 7, 16], "scipi": 2, "numpi": 2, "panda": 2, "julia": 2, "ggplot2": 2, "flask": 2, "design": 2, "consid": 2, "easili": [2, 4, 7, 9, 14, 16], "changelog": 2, "review": [2, 11, 18], "especi": [2, 18], "perfect": [2, 9, 15, 18], "enemi": 2, "binari": 2, "reason": [2, 8, 9, 10, 11], "platform": [2, 8, 11, 14], "thu": 2, "contribut": [2, 3, 11, 14, 18], "meaning": 2, "although": 2, "touch": [2, 6, 9, 12], "pyc": 2, "__pycache__": 2, "taken": [2, 8], "offici": 2, "document": [2, 3, 6, 10, 11, 12], "archiv": 2, "anywher": 2, "tree": [2, 7, 17], "oa": 2, "html": [2, 7], "except": 2, "foo": 2, "maintain": 2, "hand": [2, 7], "everyth": [2, 4, 8, 9, 12, 14, 16, 17], "build": [2, 11], "shell": [2, 7, 14], "glob": 2, "syntax": [2, 5], "determin": 2, "pattern": [2, 13], "lower": 2, "level": [2, 5, 17], "via": [2, 11], "websit": [2, 11, 14], "gui": 2, "desktop": 2, "sourcetre": 2, "parti": 2, "checkpoint": [2, 16], "undo": [2, 7, 8, 10, 18], "uncommit": 2, "mv": 2, "renam": [2, 14], "ideal": [2, 7, 8], "larg": [2, 18], "annex": 2, "would": [2, 3, 4, 6, 7, 10, 12, 16], "myfil": [2, 6], "recent": [2, 6, 8, 9, 13], "stori": [2, 3], "afraid": [2, 4, 7], "20": [3, 4, 7, 10], "previou": [3, 11, 17], "section": [3, 4, 6, 7, 14], "guacamol": [3, 6, 7, 14], "git": [3, 7, 9, 13, 14, 15, 18], "had": [3, 7, 12], "come": [3, 9, 18], "linear": [3, 6], "depict": 3, "littl": [3, 4, 6], "box": [3, 4, 16], "abbrevi": 3, "posit": 3, "record": [3, 7, 13, 16, 17], "tape": 3, "sai": 3, "those": [3, 4, 6, 14], "liter": [3, 12, 16], "isn": [3, 12, 16], "placehold": [3, 12], "talk": [3, 4], "imag": [3, 11, 17], "us": [3, 8, 9, 10, 11, 12, 14, 17, 18], "gopher": [3, 11], "softwar": [3, 11, 14], "least": [3, 6, 7, 8, 9, 12, 16], "expect": [3, 4, 6], "featur": [3, 4, 9, 10, 15, 16, 18], "concurr": 3, "unfinish": [3, 10, 18], "line": [3, 4, 7, 8, 9, 13, 14, 16], "strength": 3, "permit": 3, "research": [3, 8, 14], "isol": 3, "composit": 3, "master": [3, 13], "special": 3, "direct": [3, 7, 17], "acycl": [3, 17], "graph": [3, 4, 6, 9, 11, 12, 13, 17], "arrow": 3, "avoid": [3, 6, 7, 8, 12], "group": [3, 16, 18], "singl": [3, 6, 11, 12], "narr": 3, "strategi": [3, 7, 9], "sequenc": [3, 16], "extract": 3, "interfac": [3, 11], "matrix": 3, "invers": 3, "without": [3, 4, 7, 9, 11], "command": [3, 4, 7, 8, 12, 14], "alias": [3, 8], "given": 3, "extens": 3, "rest": 3, "ensur": 3, "collabor": [3, 4, 6, 7, 8, 10, 12, 14, 18], "histori": [3, 4, 8, 11, 13, 14, 18], "e7cf023": [3, 6, 12], "79161b6": [3, 6, 12], "a3394e3": [3, 6, 12], "3696246": [3, 6, 12], "coupl": [3, 6, 12, 14, 17], "character": 3, "checksum": [3, 17], "pointer": [3, 13, 17], "afterward": [3, 14], "togeth": [3, 4, 6, 16, 18], "particip": [3, 7, 8, 17], "episod": [3, 7], "prefer": [3, 11], "browser": [3, 8], "cilantro": [3, 4, 6], "text": [3, 4, 7, 8, 11, 17], "2019": [3, 4, 11, 12], "clear": [3, 4, 7, 16], "tbsp": [3, 4], "reduc": [3, 4, 6], "amount": [3, 4, 6], "bit": [3, 4, 6, 9, 17], "bcb8b78": [3, 6], "f6ec7b7": [3, 6], "ahead": 3, "safer": [3, 6], "explicitli": [3, 6], "shown": [3, 6], "bf28166": [3, 6], "graphic": [3, 6, 7], "represent": [3, 6, 7], "situat": [3, 6, 12, 16], "b4af65b": [3, 6, 12], "comparison": [3, 6], "turn": [3, 11], "appli": [3, 4, 6], "skip": [3, 4, 14, 16], "origin": [3, 4, 13, 14], "helper": [3, 4, 6, 14], "un": [3, 4], "wish": [3, 7, 9, 12], "81fcc0c": 3, "intern": [3, 15], "attempt": [3, 7], "incorpor": 3, "To": [3, 4, 6, 7, 8, 14], "view": [3, 4, 5, 6, 7], "happi": [3, 4], "4e03d4b": [3, 4], "observ": [3, 4, 6], "cat": [3, 4, 17], "overlap": 3, "user": [3, 7, 8, 10, 11, 14, 17, 18], "settl": 3, "conflict": [3, 5, 7, 8, 9, 18], "sticki": [3, 7], "disappear": 3, "reintegr": 3, "insist": 3, "lost": [3, 12], "hard": [3, 6, 7, 10, 12, 13, 14, 17], "advanc": [3, 6, 7, 9, 10, 11], "absolut": 3, "postpon": [3, 4, 18], "month": [3, 4, 16, 18], "resolv": [3, 7, 9, 12], "examin": [3, 6], "discuss": [3, 6, 7, 8, 12], "ancestor": [3, 4, 6], "did": [3, 4, 6, 7, 11, 16], "diverg": [3, 6], "altern": [3, 6, 8, 16], "replai": [3, 6], "explicit": [3, 6], "public": [3, 6, 7], "alter": [3, 6], "contrast": 3, "ever": [3, 7, 16], "commemor": 3, "plaqu": 3, "particular": [3, 7], "mileston": [3, 10], "semant": [3, 4], "v1": 3, "easier": [3, 10, 18], "64441c1934def7d91ff0b66af0795749d5f1954a": 3, "basic": [3, 7, 8, 9, 11, 18], "annot": [3, 6, 7, 11, 13], "lightweight": [3, 17], "cryptograph": 3, "sign": 3, "gpg": 3, "timestamp": 3, "attach": 3, "nobel": 3, "banquet": 3, "pro": [3, 15, 17], "book": [3, 15, 17], "chapter": 3, "subject": 3, "paus": 3, "moment": [3, 17], "recapitul": 3, "unmerg": [3, 4], "combo": [3, 6], "frequent": 3, "wild": 3, "throw": [3, 12, 13], "awai": [3, 9, 12, 13, 17], "gone": [3, 6, 11, 12], "off": [3, 6, 9], "job": [3, 6], "divis": 3, "unit": [3, 10], "understand": [4, 17], "suffici": 4, "imagin": [4, 12], "somebodi": [4, 11, 14], "smooth": 4, "appear": 4, "fast": 4, "forward": 4, "portion": [4, 11, 12], "silent": 4, "overwrit": [4, 14], "scari": 4, "luckili": 4, "rare": [4, 16], "meet": 4, "simpli": 4, "kind": [4, 11], "measur": 4, "person": [4, 7], "declar": 4, "minor": 4, "revis": 4, "spell": 4, "rewrit": 4, "function": [4, 7, 13], "solv": [4, 6, 7, 16], "demo": [4, 7, 14], "decreas": 4, "dislik": [4, 6], "e83294b": 4, "6cacd50": 4, "4": [4, 16, 17], "6484462": 4, "3caa632": 4, "fail": [4, 6, 14], "path": [4, 9, 12, 18], "marker": [4, 6], "cc": [4, 17], "0000000": 4, "10": [4, 7, 9, 16, 17], "care": [4, 12], "exactli": [4, 6, 7], "emac": 4, "certain": [4, 9], "plugin": 4, "pre": 4, "fill": 4, "repeat": [4, 6, 16], "almost": [4, 6, 7, 9], "banch": [4, 6], "5": [4, 9, 16, 17], "link": [4, 6, 17], "assum": [4, 6, 8, 12], "meant": [4, 6], "anticip": [4, 6, 11, 16], "inde": [4, 6], "ye": [4, 6, 9], "slightli": [4, 6], "continu": [4, 6, 9], "disagre": [4, 6], "stop": [4, 6, 18], "middl": [4, 6, 9, 16], "backup": [4, 6, 7, 11, 14], "addit": [4, 6, 9, 18], "temporari": [4, 6, 9], "clean": [4, 6, 11, 17], "f": [4, 6], "configur": [4, 6, 7, 8, 11, 13, 14], "keepbackup": [4, 6], "fals": [4, 6], "xour": 4, "xtheir": 4, "plan": [4, 10], "put": [4, 9, 16], "unrel": [4, 6, 9, 10, 16, 18], "live": [4, 16], "layout": [4, 18], "data": [4, 9, 11, 14, 17], "caus": 4, "modular": 4, "risk": [4, 18], "technic": 4, "share": [4, 6, 7, 8, 11, 12], "earli": [4, 7, 10, 18], "circumst": 4, "everyon": [4, 7], "selfish": 4, "push": [4, 6, 7, 8, 12, 14], "best": [4, 15], "pull": [4, 10, 14, 18], "handl": 4, "compar": [4, 7, 11, 16], "servic": [4, 13], "googl": 4, "drive": 4, "commun": 4, "optim": [4, 7], "context": [5, 9], "awar": 5, "displai": 5, "contextu": 5, "jimeh": 5, "bash": [5, 7], "ohmyz": 5, "sh": 5, "zsh": 5, "oh": [5, 11], "fish": 5, "magicmonti": 5, "delta": [5, 14], "highlight": 5, "allow": [5, 8, 14], "mainli": 6, "instructor": [6, 8], "event": 6, "cover": 6, "subset": 6, "interest": 6, "own": [6, 8, 11, 12, 14], "sound": [6, 9, 11], "discov": [6, 11], "note": [6, 18], "abort": [6, 7, 9, 12, 16], "toolbox": 6, "broke": [6, 11, 13], "bottom": [6, 14, 16], "unmodifi": [6, 7, 16], "keystrok": [6, 16], "re": [6, 7, 13, 16], "benefici": [6, 16], "feel": [6, 7, 8, 14, 16], "regret": [6, 16], "newli": [6, 12], "incomplet": [6, 12], "typo": [6, 12], "unsatisfactori": [6, 12], "amend": [6, 12, 13], "d3fc63a": [6, 12], "e02efcd": [6, 12], "accident": [6, 12, 14, 18], "forev": [6, 12], "nobodi": [6, 11, 12], "possibli": [6, 12, 14], "anyon": [6, 12], "alright": [6, 12], "extraordinari": [6, 12], "condit": [6, 12], "sensit": [6, 12], "secret": [6, 12], "pop": [6, 9], "twice": [6, 9], "opposit": [6, 9, 12, 16], "extra": [6, 9, 14], "deci": [6, 9], "ref": [6, 9, 17], "ce": 7, "08": 7, "09": [7, 11], "00": [7, 14], "soft": [7, 13, 16], "icebreak": 7, "question": [7, 11, 18], "break": 7, "11": 7, "lunch": 7, "13": 7, "resolut": [7, 8, 12], "feedback": 7, "tomorrow": 7, "recap": 7, "25": [7, 12, 14, 17], "ssh": 7, "45": 7, "recov": [7, 8, 10], "alon": [7, 16], "industri": 7, "high": [7, 8, 11, 18], "encount": 7, "becom": [7, 12], "disast": 7, "mistak": [7, 12], "roll": 7, "parallel": 7, "toe": 7, "exact": 7, "major": 7, "extent": 7, "comfort": [7, 8], "lack": 7, "mental": 7, "model": [7, 10, 11, 15, 17], "oper": [7, 14], "never": [7, 9, 12, 17, 18], "newcom": 7, "experienc": 7, "valuabl": 7, "etc": [7, 17], "craft": [7, 16], "revert": [7, 13], "discard": [7, 11, 16], "restor": [7, 12, 13, 16], "danger": [7, 10, 14], "prevent": [7, 14, 18], "incorrect": 7, "session": 7, "fall": 7, "behind": 7, "student": 7, "briefli": 7, "finish": 7, "indic": [7, 11], "green": [7, 14], "rais": 7, "describ": [7, 12, 18], "home": [7, 16], "fine": [7, 14], "though": 7, "spend": 7, "assess": 7, "activ": [7, 18], "object": 7, "being": 7, "met": 7, "pose": 7, "minut": 7, "answer": [7, 11], "signal": 7, "emphas": 7, "effici": [7, 15], "avail": [7, 16], "gitlab": [7, 8, 11, 13, 14], "bisect": [7, 13], "anybodi": 7, "rather": [7, 10, 16], "publish": [7, 11, 15], "involv": 7, "wonder": 7, "whom": [7, 13], "behav": 7, "incorrectli": 7, "earlier": 7, "screencast": 7, "modul": [7, 8], "forgotten": 7, "expand": 7, "stash": [7, 10], "info": [7, 17], "anytim": 7, "cheat": 7, "sheet": 7, "www": 7, "ndpsoftwar": 7, "far": [7, 14], "cours": [7, 8, 17], "dir": 7, "diagram": 7, "sampl": 7, "alia": [7, 13], "infrequ": 7, "constantli": 7, "imposs": 7, "lose": [7, 9, 10, 13, 17], "highli": 7, "bashrc": 7, "introductori": 8, "philosophi": 8, "brief": [8, 14], "workflow": [8, 15], "stick": [8, 16], "obsess": 8, "2": [8, 13, 17], "28": 8, "newer": 8, "workaround": 8, "account": 8, "Being": 8, "expertis": 8, "mostli": 8, "familiar": [8, 17], "advic": 8, "interrupt": 8, "hood": 8, "quick": [8, 18], "custom": 8, "resourc": 8, "exercis": [8, 14, 17], "guid": [8, 15], "bitbucket": [8, 11, 14], "transfer": 8, "materi": 8, "implicitli": 8, "endors": 8, "compani": 8, "chosen": 8, "concept": 8, "popular": [8, 11, 14], "host": 8, "panick": 9, "fresh": 9, "beauti": 9, "world": 9, "chaotic": [9, 18], "jackson": 9, "pollock": 9, "spree": 9, "27": 9, "everywher": [9, 18], "ruin": 9, "easiest": 9, "place": [9, 13, 14, 16], "temporarili": 9, "filenam": 9, "drop": 9, "whichev": 9, "stack": [9, 12], "batch": 9, "resum": 9, "overlook": 9, "week": [9, 18], "typic": 10, "untest": 10, "protect": 10, "somefil": 10, "otherwis": 10, "split": [10, 13, 16, 18], "dai": 10, "smaller": 10, "size": [10, 18], "huge": [10, 12, 18], "imperfect": 10, "simplifi": [10, 11], "repair": 10, "fit": 10, "grow": [10, 18], "beginn": 10, "input": 10, "advoc": 11, "distribut": [11, 14], "recogn": 11, "hopefulli": [11, 17], "send": 11, "latest": [11, 12], "paper": 11, "laptop": 11, "thesi": 11, "interf": 11, "src": 11, "util": 11, "time_iso8601": 11, "august": 11, "permalink": 11, "plain": 11, "suitabl": 11, "manuscript": 11, "latex": 11, "quarto": 11, "tri": [11, 14], "myproject": 11, "zip": 11, "2020": [11, 16], "februari": 11, "2021": 11, "21": [11, 17], "myvers": 11, "newfeatur": 11, "despit": 11, "benefit": 11, "honest": 11, "worth": 11, "career": 11, "skill": 11, "worst": 11, "server": [11, 13, 14], "offlin": 11, "subvers": 11, "mercuri": 11, "pijul": 11, "undon": 12, "perman": [12, 13], "retriev": [12, 17], "unlik": 12, "xkcd": [12, 15], "comic": 12, "impli": [12, 16], "1597": 12, "mess": 12, "matter": 12, "overflow": 12, "guru": 12, "sim": 12, "resouc": 12, "dot": 12, "remain": 12, "ll": [12, 14], "forgot": [12, 16], "forc": [12, 14], "stuff": [12, 16], "went": 12, "cherri": 12, "pick": [12, 16], "oldest": 12, "wrongli": 12, "recoveri": [12, 14], "workspac": 13, "roughli": 13, "hold": 13, "consist": 13, "setup": 13, "around": 14, "snapshot": 14, "disk": 14, "steal": 14, "tast": 14, "prepar": [14, 16], "emploi": 14, "join": 14, "clarifi": 14, "commerci": 14, "univers": 14, "privat": 14, "notabug": 14, "nordic": 14, "classic": 14, "method": 14, "secur": 14, "credenti": 14, "mac": 14, "successfulli": 14, "yourself": [14, 18], "watch": 14, "licens": [14, 17], "none": 14, "button": 14, "execut": 14, "enumer": 14, "100": 14, "221": 14, "byte": 14, "kib": 14, "total": 14, "pack": [14, 16], "reload": 14, "taa": 14, "daa": 14, "upload": 14, "explan": 14, "ran": 14, "brand": 14, "adapt": 14, "pai": [14, 16], "attent": 14, "target": 14, "myrecip": 14, "download": 14, "revisit": 14, "serv": 14, "full": 14, "properli": 14, "scott": 15, "chacon": 15, "ben": 15, "straub": 15, "peepcod": 15, "mid": 15, "demystifi": 16, "came": [16, 18], "stand": 16, "hardli": 16, "organ": 16, "five": 16, "advantag": 16, "disadvantag": 16, "b135ec8": 16, "c": 16, "6f0d49f": 16, "implement": [16, 17], "fee1807": 16, "6fe2f23": 16, "ab990f4": 16, "miscellan": 16, "bf39f9d": 16, "45831a5": 16, "bddb280": 16, "72d78e7": 16, "72e0211": 16, "61dd3a3": 16, "bugfix": 16, "49dc419": 16, "wip": 16, "progress": 16, "1949dc4": 16, "04": 16, "07": 16, "a361dd3": 16, "06": 16, "1172e02": 16, "03": 16, "e772d78": 16, "02": 16, "spread": 16, "simplest": 16, "y": 16, "blank": 16, "sort": 16, "shot": 16, "somehow": 16, "analogi": 16, "shop": 16, "receipt": 16, "wouldn": 16, "item": 16, "bathroom": 16, "kitchen": 16, "room": 16, "correspond": 16, "seal": 16, "dev": 16, "sublimegeek": 16, "im": 16, "1anh": 16, "bui": 16, "ineffici": 16, "annoi": 16, "basket": 16, "conveyor": 16, "belt": 16, "ground": 16, "importantli": 16, "complex": 16, "flexibl": 16, "extrem": 17, "drwxr": 17, "xr": 17, "x": 17, "aug": 17, "51": 17, "rw": 17, "499": 17, "commit_editmsg": 17, "92": 17, "73": 17, "hook": 17, "137": 17, "fact": 17, "previous": 17, "wrote": 17, "referenc": 17, "sha": 17, "1": 17, "hexadecim": 17, "BY": 17, "ca": 17, "digest": 17, "poke": 17, "raw": 17, "explor": 17, "lift": 17, "aha": 17, "underli": 17, "41": 17, "54": 17, "045e3db14740c60684d745e5fb891ae71e335611": 17, "replic": 17, "cp": 17, "gotcha": 18, "ugli": 18, "ish": 18, "harder": 18, "Not": 18, "wors": 18, "meantim": 18, "largest": 18, "counterpoint": 18, "big": 18, "phase": 18, "ambiti": 18, "engin": 18, "safeguard": 18, "restrict": 18, "loop": 18, "significantli": 18, "subsequ": 18, "detect": 18, "autom": 18, "season": 18, "miss": 18}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"alias": 0, "configur": [0, 2], "object": [0, 1, 2, 3, 4, 9, 11, 12, 14, 16, 17], "exampl": 0, "alia": [0, 3], "git": [0, 1, 2, 4, 5, 6, 8, 10, 11, 12, 16, 17], "graph": [0, 7], "us": [0, 1, 2, 4, 5, 6, 7, 13, 16], "extern": 0, "command": [0, 1, 2, 6, 13, 16], "food": 0, "thought": 0, "when": [0, 1, 4, 6, 10], "list": [0, 6], "instructor": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 14, 16, 17], "advanc": [0, 2], "keypoint": [0, 1, 2, 3, 4, 9, 10, 14, 16], "inspect": [1, 6, 7], "histori": [1, 2, 6, 7, 12, 16], "note": [1, 2, 3, 4, 5, 9, 10, 11, 12, 14, 16, 17], "prepar": [1, 4], "our": [1, 4, 6, 12, 14], "toolbox": 1, "warm": 1, "up": 1, "browser": [1, 2, 6, 14], "search": 1, "text": 1, "pattern": 1, "repositori": [1, 2, 14], "individu": 1, "commit": [1, 2, 3, 6, 10, 12, 16], "line": [1, 2, 6], "code": [1, 11], "annot": 1, "metadata": 1, "discuss": [1, 2, 4, 10, 11, 14, 16, 17, 18], "past": 1, "exercis": [1, 2, 3, 4, 6, 7, 9, 12, 16], "basic": [1, 2, 6, 17], "archaeologi": [1, 6], "1": [1, 2, 3, 4, 6, 7, 9, 12, 16], "explor": [1, 6], "solut": [1, 2, 3, 4, 6, 9, 11, 12, 16], "find": [1, 6], "out": 1, "someth": 1, "broke": 1, "chang": [1, 2, 4, 6, 10, 11, 12], "bisect": [1, 6], "how": [1, 7, 8, 10], "would": 1, "you": [1, 3, 4, 9, 10, 14], "solv": 1, "thi": [1, 6, 7, 12], "option": [1, 2, 3, 4, 6, 8, 9], "2": [1, 2, 3, 4, 6, 7, 9, 12, 16], "bad": [1, 6], "what": [2, 10, 11, 18], "i": [2, 3, 10, 11, 12, 16, 17], "record": [2, 6], "snapshot": [2, 11], "question": 2, "more": [2, 5], "particip": 2, "type": 2, "along": 2, "track": [2, 8, 11], "guacamol": 2, "recip": [2, 14], "creat": [2, 3, 4, 6, 7, 9], "ad": [2, 12], "file": 2, "log": [2, 7], "compar": [2, 6], "show": [2, 6], "3": [2, 3, 4, 6, 12], "visual": [2, 6, 12], "diff": [2, 5, 6], "tool": [2, 6, 11], "4": [2, 3, 6, 12], "write": 2, "messag": 2, "ignor": 2, "path": 2, "gitignor": 2, "graphic": 2, "user": 2, "interfac": 2, "summari": [2, 3, 6], "5": [2, 3, 6], "test": [2, 3, 6, 7, 12], "your": [2, 3, 6, 7, 12, 14], "understand": [2, 3, 6, 7, 12], "branch": [3, 4, 6, 9, 10, 11, 12, 17], "merg": [3, 4, 6, 11, 12], "motiv": [3, 6, 11], "an": [3, 6, 14, 16], "import": 3, "work": [3, 6, 8, 9], "It": [3, 12], "possibl": [3, 12], "directli": 3, "github": [3, 8, 14], "If": [3, 4, 14], "got": [3, 4], "stuck": [3, 4], "abov": 3, "join": [3, 4], "later": [3, 4], "delet": 3, "safe": 3, "perform": [3, 6, 16], "fast": [3, 6], "forward": [3, 6], "rebas": [3, 4, 6], "instead": [3, 6], "tag": 3, "typic": [3, 11], "workflow": 3, "conflict": [4, 6, 12], "resolut": [4, 6], "why": [4, 7, 8, 11], "thei": 4, "ar": [4, 10], "good": 4, "The": [4, 16], "human": 4, "side": 4, "previous": 4, "step": [4, 6, 7, 16], "resolv": [4, 6], "anoth": [4, 6, 11], "mergetool": [4, 6], "theirs": 4, "strategi": 4, "abort": 4, "avoid": [4, 18], "custom": 5, "shell": 5, "prompt": 5, "output": 5, "full": 6, "stage": [6, 10, 16], "area": [6, 16], "interact": [6, 16], "make": [6, 16], "two": [6, 16], "undo": [6, 12], "recov": [6, 12], "revert": [6, 12], "modifi": [6, 12], "previou": [6, 12, 14], "destroi": [6, 12], "experiment": [6, 12], "episod": [6, 8, 12, 14], "interrupt": [6, 9], "stash": [6, 9], "some": [6, 9], "uncommit": [6, 9, 12], "guid": 7, "schedul": 7, "dai": 7, "instal": 7, "remind": 7, "each": [7, 10], "we": [7, 8, 11, 13], "teach": 7, "lesson": 7, "intend": 7, "learn": 7, "outcom": 7, "take": 7, "first": 7, "editor": 7, "slowli": 7, "live": 7, "better": 7, "than": 7, "read": 7, "websit": 7, "materi": 7, "separ": 7, "window": 7, "cheatsheet": [7, 13], "board": 7, "draw": 7, "repeat": 7, "follow": 7, "point": 7, "start": [7, 14], "from": [7, 12, 14], "ident": 7, "environ": 7, "introduct": 8, "version": [8, 11], "control": [8, 11], "want": [8, 9], "go": 8, "back": [8, 11], "time": 8, "prerequisit": 8, "core": 8, "refer": [8, 13], "about": [8, 10, 11], "frequent": 9, "situat": 9, "store": 9, "variou": 9, "junk": 9, "don": [9, 14], "t": [9, 14], "need": [9, 11], "get": 9, "rid": 9, "practic": 10, "advic": 10, "much": 10, "necessari": 10, "level": 10, "complex": 10, "project": 10, "simpl": 10, "person": 10, "few": 10, "accept": 10, "thing": 10, "break": 10, "sometim": 10, "review": 10, "other": [10, 13, 15], "distribut": 10, "releas": 10, "larg": 10, "should": 10, "all": 11, "keep": 11, "do": 11, "featur": 11, "roll": 11, "collabor": 11, "reproduc": 11, "talk": 11, "like": 11, "difficulti": 11, "almost": 12, "alwai": 12, "nice": 12, "resourc": [12, 15], "simul": 12, "oper": 12, "recent": 12, "unstag": 12, "preserv": 12, "rewind": 12, "reset": 12, "wrong": 12, "pull": 12, "after": 12, "quick": 13, "glossari": 13, "share": 14, "onlin": 14, "laptop": 14, "web": 14, "remot": 14, "have": 14, "authent": 14, "ssh": 14, "http": 14, "publish": 14, "exist": 14, "noth": 14, "yet": 14, "troubleshoot": 14, "clone": 14, "tell": 16, "stori": 16, "under": 17, "hood": 17, "down": 17, "rabbit": 17, "hole": 17, "content": 17, "address": 17, "storag": 17, "system": 17, "demonstr": 17, "experi": 17}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Aliases and configuration": [[0, "aliases-and-configuration"]], "Objectives": [[0, "objectives-0"], [1, "objectives-0"], [2, "objectives-0"], [3, "objectives-0"], [4, "objectives-0"], [9, "objectives-0"], [11, "objectives-0"], [12, "objectives-0"], [14, "objectives-0"], [16, "objectives-0"], [17, "objectives-0"]], "Aliases": [[0, "aliases"]], "Example alias: git graph": [[0, "example-alias-git-graph"]], "Using external commands": [[0, "using-external-commands"]], "Food for thought: When to alias?": [[0, "discussion-0"]], "List of aliases the instructors use": [[0, "list-of-aliases-the-instructors-use"]], "Advanced aliases": [[0, "advanced-aliases"]], "Advanced Git configuration": [[0, "advanced-git-configuration"]], "Keypoints": [[0, "keypoints-0"], [1, "keypoints-0"], [2, "keypoints-0"], [3, "keypoints-0"], [4, "keypoints-0"], [9, "keypoints-0"], [10, "keypoints-0"], [14, "keypoints-0"], [16, "keypoints-0"]], "Inspecting history": [[1, "inspecting-history"], [6, "inspecting-history"], [7, "inspecting-history"]], "Instructor note": [[1, "instructor-note-0"], [1, "instructor-note-1"], [2, "instructor-note-0"], [2, "instructor-note-1"], [2, "instructor-note-2"], [3, "instructor-note-0"], [3, "instructor-note-1"], [3, "instructor-note-2"], [4, "instructor-note-0"], [4, "instructor-note-1"], [5, "instructor-note-0"], [9, "instructor-note-0"], [10, "instructor-note-0"], [11, "instructor-note-0"], [12, "instructor-note-0"], [14, "instructor-note-0"], [16, "instructor-note-0"], [16, "instructor-note-1"], [17, "instructor-note-0"]], "Preparation": [[1, "prerequisites-0"]], "Our toolbox for history inspection": [[1, "our-toolbox-for-history-inspection"]], "Warm-up: \u201cGit History\u201d browser": [[1, "warm-up-git-history-browser"]], "Searching text patterns in the repository": [[1, "searching-text-patterns-in-the-repository"]], "Inspecting individual commits": [[1, "inspecting-individual-commits"]], "Line-by-line code annotation with metadata": [[1, "line-by-line-code-annotation-with-metadata"]], "Discussion": [[1, "discussion-0"], [2, "discussion-1"], [4, "discussion-1"], [10, "discussion-0"], [11, "discussion-0"], [14, "discussion-0"], [16, "discussion-0"], [16, "discussion-1"], [16, "discussion-2"], [17, "discussion-0"], [18, "discussion-0"]], "Inspecting code in the past": [[1, "inspecting-code-in-the-past"]], "Exercise: Basic archaeology commands": [[1, "exercise-basic-archaeology-commands"]], "History-1: Explore basic archaeology commands": [[1, "exercise-0"], [6, "exercise-0"]], "Solution": [[1, "solution-0"], [2, "solution-0"], [3, "solution-0"], [3, "solution-1"], [3, "solution-2"], [4, "solution-0"], [4, "solution-1"], [6, "solution-0"], [6, "solution-0"], [6, "solution-0"], [6, "solution-1"], [6, "solution-2"], [6, "solution-0"], [6, "solution-1"], [6, "solution-0"], [6, "solution-0"], [6, "solution-0"], [6, "solution-1"], [6, "solution-0"], [9, "solution-0"], [11, "solution-0"], [12, "solution-0"], [12, "solution-1"], [16, "solution-0"]], "Finding out when something broke/changed with git bisect": [[1, "finding-out-when-something-broke-changed-with-git-bisect"]], "How would you solve this?": [[1, "discussion-1"]], "Optional exercise: Git bisect": [[1, "optional-exercise-git-bisect"]], "(optional) History-2: Use git bisect to find the bad commit": [[1, "exercise-1"], [6, "exercise-1"]], "Basics": [[2, "basics"], [6, "basics"]], "What is Git, and what is a Git repository?": [[2, "what-is-git-and-what-is-a-git-repository"]], "Recording a snapshot with Git": [[2, "recording-a-snapshot-with-git"]], "Question for the more advanced participants": [[2, "discussion-0"]], "Configuring Git command line": [[2, "configuring-git-command-line"]], "Type-along: Tracking a guacamole recipe with Git": [[2, "type-along-tracking-a-guacamole-recipe-with-git"]], "Creating a repository": [[2, "creating-a-repository"]], "Adding files and committing changes": [[2, "adding-files-and-committing-changes"]], "Exercise: Record changes": [[2, "exercise-record-changes"]], "Basic-1: Record changes": [[2, "exercise-0"], [6, "exercise-0"]], "Git history and log": [[2, "git-history-and-log"]], "Optional exercises: Comparing changes": [[2, "optional-exercises-comparing-changes"]], "(optional) Basic-2: Comparing and showing commits": [[2, "exercise-1"], [6, "exercise-1"]], "(optional) Basic-3: Visual diff tools": [[2, "exercise-2"], [6, "exercise-2"]], "(optional) Basic-4: Browser and command line": [[2, "exercise-3"], [6, "exercise-3"]], "Writing useful commit messages": [[2, "writing-useful-commit-messages"]], "Ignoring files and paths with .gitignore": [[2, "ignoring-files-and-paths-with-gitignore"]], "Graphical user interfaces": [[2, "graphical-user-interfaces"]], "Summary": [[2, "summary"], [3, "summary"], [6, "summary"]], "Basic-5: Test your understanding": [[2, "exercise-4"], [6, "exercise-4"]], "Branching and merging": [[3, "branching-and-merging"], [6, "branching-and-merging"]], "Motivation for branches": [[3, "motivation-for-branches"]], "An important alias": [[3, null]], "Creating and working with branches": [[3, "creating-and-working-with-branches"]], "It is possible to create and merge branches directly on GitHub": [[3, null]], "Exercise: Create and commit to branches": [[3, "exercise-create-and-commit-to-branches"]], "Branch-1: Create and commit to branches": [[3, "exercise-0"], [6, "exercise-0"]], "Exercise: Merging branches": [[3, "exercise-merging-branches"]], "Branch-2: Merge branches": [[3, "exercise-1"], [6, "exercise-1"]], "If you got stuck in the above exercises or joined later": [[3, null]], "Deleting branches safely": [[3, "deleting-branches-safely"]], "Optional exercises with branches": [[3, "optional-exercises-with-branches"]], "(optional) Branch-3: Perform a fast-forward merge": [[3, "exercise-2"], [6, "exercise-2"]], "(optional) Branch-4: Rebase a branch (instead of merge)": [[3, "exercise-3"], [6, "exercise-3"]], "Tags": [[3, "tags"]], "Typical workflows": [[3, "typical-workflows"]], "Branch-5: Test your understanding": [[3, "exercise-4"], [6, "exercise-4"]], "Conflict resolution": [[4, "conflict-resolution"], [4, "id2"], [6, "conflict-resolution"]], "Conflicts in Git and why they are good": [[4, "conflicts-in-git-and-why-they-are-good"]], "The human side of conflicts": [[4, "discussion-0"]], "Preparing a conflict": [[4, "preparing-a-conflict"]], "If you got stuck previously or joined later": [[4, null]], "Merging conflicting changes": [[4, "merging-conflicting-changes"]], "Steps to resolve a conflict": [[4, null]], "Exercise: Create and resolve a conflict": [[4, "exercise-create-and-resolve-a-conflict"]], "Conflict-1: Create another conflict and resolve": [[4, "exercise-0"], [6, "exercise-0"]], "Optional exercises with conflict resolution": [[4, "optional-exercises-with-conflict-resolution"]], "(optional) Conflict-2: Resolve a conflict when rebasing a branch": [[4, "exercise-1"], [6, "exercise-1"]], "(optional) Conflict-3: Resolve a conflict using mergetool": [[4, "exercise-2"], [6, "exercise-2"]], "Using \u201cours\u201d or \u201ctheirs\u201d strategy": [[4, "using-ours-or-theirs-strategy"]], "Aborting a conflicting merge": [[4, "aborting-a-conflicting-merge"]], "Avoiding conflicts": [[4, "avoiding-conflicts"]], "Customizing Git": [[5, "customizing-git"]], "Shell prompt": [[5, "shell-prompt"]], "More useful \u201cdiff\u201d output": [[5, "more-useful-diff-output"]], "List of exercises": [[6, "list-of-exercises"]], "Full list": [[6, "full-list"]], "Motivation": [[6, "motivation"], [11, "motivation"]], "Using the Git staging area": [[6, "using-the-git-staging-area"], [16, "using-the-git-staging-area"]], "Staging-1: Perform an interactive commit": [[6, "exercise-0"], [16, "exercise-0"]], "Staging-2: Use the staging area to make a commit in two steps": [[6, "exercise-1"], [16, "exercise-1"]], "Undoing and recovering": [[6, "undoing-and-recovering"], [12, "undoing-and-recovering"]], "Undoing-1: Revert a commit": [[6, "exercise-0"], [12, "exercise-0"]], "Undoing-2: Modify a previous commit": [[6, "exercise-1"], [12, "exercise-1"]], "Undoing-3: Destroy our experimentation in this episode": [[6, "exercise-2"], [12, "exercise-2"]], "Undoing-4: Test your understanding": [[6, "exercise-3"], [12, "exercise-3"]], "Interrupted work": [[6, "interrupted-work"], [9, "interrupted-work"]], "Interrupted-1: Stash some uncommitted work": [[6, "exercise-0"], [9, "exercise-0"]], "Instructor guide": [[7, "instructor-guide"]], "Schedule Day 1": [[7, "schedule-day-1"]], "Schedule Day 2": [[7, "schedule-day-2"]], "Installation reminders for each day": [[7, "installation-reminders-for-each-day"]], "Why we teach this lesson": [[7, "why-we-teach-this-lesson"]], "Intended learning outcomes": [[7, "intended-learning-outcomes"]], "How to teach this lesson": [[7, "how-to-teach-this-lesson"]], "Take first editor steps slowly": [[7, "take-first-editor-steps-slowly"]], "How to use the exercises": [[7, "how-to-use-the-exercises"]], "\u201cTest your understanding\u201d exercises": [[7, "test-your-understanding-exercises"]], "Live better than reading the website material": [[7, "live-better-than-reading-the-website-material"]], "Log your history in a separate window": [[7, "log-your-history-in-a-separate-window"]], "Create a cheatsheet on the board": [[7, "create-a-cheatsheet-on-the-board"]], "Draw a graph on the board": [[7, "draw-a-graph-on-the-board"]], "Repeat the following points": [[7, "repeat-the-following-points"]], "Start from identical environment": [[7, "start-from-identical-environment"]], "Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version": [[8, "introduction-to-version-control-with-git-why-we-want-to-track-versions-and-how-to-go-back-in-time-to-a-working-version"]], "Prerequisites": [[8, "prerequisites-0"]], "Core episodes": [[8, null]], "Optional episodes": [[8, null]], "Reference": [[8, null]], "About": [[8, null]], "Why GitHub?": [[8, null]], "Frequent situation: interrupted work": [[9, "frequent-situation-interrupted-work"]], "Option 1: Stashing": [[9, "option-1-stashing"]], "Exercise: Stashing": [[9, "exercise-stashing"]], "Option 2: Create branches": [[9, "option-2-create-branches"]], "Storing various junk you don\u2019t need but don\u2019t want to get rid of": [[9, "storing-various-junk-you-don-t-need-but-don-t-want-to-get-rid-of"]], "Practical advice: how much Git is necessary?": [[10, "practical-advice-how-much-git-is-necessary"]], "What level of branching complexity is necessary for each project?": [[10, "what-level-of-branching-complexity-is-necessary-for-each-project"]], "Simple personal projects": [[10, "simple-personal-projects"]], "Projects with few persons: you accept things breaking sometimes": [[10, "projects-with-few-persons-you-accept-things-breaking-sometimes"]], "Projects with few persons: changes are reviewed by others": [[10, "projects-with-few-persons-changes-are-reviewed-by-others"]], "When you distribute releases": [[10, "when-you-distribute-releases"]], "How about staging and committing?": [[10, "how-about-staging-and-committing"]], "How large should a commit be?": [[10, "how-large-should-a-commit-be"]], "Git is all about keeping track of changes": [[11, "git-is-all-about-keeping-track-of-changes"]], "Why do we need to keep track of versions?": [[11, "why-do-we-need-to-keep-track-of-versions"]], "Features: roll-back, branching, merging, collaboration": [[11, "features-roll-back-branching-merging-collaboration"]], "Reproducibility": [[11, "reproducibility"]], "Talking about code": [[11, "talking-about-code"]], "What we typically like to snapshot": [[11, "what-we-typically-like-to-snapshot"]], "Difficulties of version control": [[11, "difficulties-of-version-control"]], "Why Git and not another tool?": [[11, "discussion-1"]], "It is almost always possible to recover": [[12, null]], "Nice resource to visually simulate Git operation": [[12, null]], "Undoing your recent, uncommitted and unstaged changes (preserves history)": [[12, "undoing-your-recent-uncommitted-and-unstaged-changes-preserves-history"]], "Reverting commits (preserves history)": [[12, "reverting-commits-preserves-history"]], "Exercise: Revert a commit": [[12, "exercise-revert-a-commit"]], "Adding to the previous commit (modifies history)": [[12, "adding-to-the-previous-commit-modifies-history"]], "Exercise: Modify a previous commit": [[12, "exercise-modify-a-previous-commit"]], "Rewinding branches (modifies history)": [[12, "rewinding-branches-modifies-history"]], "Exercise: Git reset": [[12, "exercise-git-reset"]], "Recovering from committing to the wrong branch": [[12, "recovering-from-committing-to-the-wrong-branch"]], "Recovering from merging/pulling into the wrong branch": [[12, "recovering-from-merging-pulling-into-the-wrong-branch"]], "Recovering from conflict after pulling changes": [[12, "recovering-from-conflict-after-pulling-changes"]], "Quick reference": [[13, "quick-reference"]], "Other cheatsheets": [[13, "other-cheatsheets"]], "Glossary": [[13, "glossary"]], "Commands we use": [[13, "commands-we-use"]], "Sharing repositories online": [[14, "sharing-repositories-online"]], "From our laptops to the web": [[14, "from-our-laptops-to-the-web"]], "Remotes": [[14, "remotes"]], "If you don\u2019t have the recipe repository from previous episodes": [[14, null]], "Authenticating to GitHub: SSH or HTTPS?": [[14, "authenticating-to-github-ssh-or-https"]], "Publishing an existing repository from laptop to GitHub": [[14, "publishing-an-existing-repository-from-laptop-to-github"]], "If you started in the browser and have nothing on your laptop yet": [[14, null]], "Troubleshooting": [[14, null]], "Cloning a repository from GitHub to laptop": [[14, "cloning-a-repository-from-github-to-laptop"]], "Other resources": [[15, "other-resources"]], "Commit history is telling a story": [[16, "commit-history-is-telling-a-story"]], "Interactive commits": [[16, "interactive-commits"]], "Exercise: Interactive commits": [[16, "exercise-interactive-commits"]], "The staging area": [[16, "the-staging-area"]], "Staging area commands": [[16, "staging-area-commands"]], "Exercise: Using the staging area": [[16, "exercise-using-the-staging-area"]], "Git under the hood": [[17, "git-under-the-hood"]], "Down the rabbit hole": [[17, "down-the-rabbit-hole"]], "Git is basically a content-addressed storage system": [[17, "git-is-basically-a-content-addressed-storage-system"]], "Demonstration: experimenting with branches": [[17, "demonstration-experimenting-with-branches"]], "What to avoid": [[18, "what-to-avoid"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/branch/2023-version/singlehtml/.buildinfo b/branch/2023-version/singlehtml/.buildinfo new file mode 100644 index 00000000..0e3b2f24 --- /dev/null +++ b/branch/2023-version/singlehtml/.buildinfo @@ -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: 4202fab30366226cc703d00775a306ce +tags: 33eac41acc08762151beb8f3b7b86c8f diff --git a/branch/2023-version/singlehtml/.nojekyll b/branch/2023-version/singlehtml/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/branch/2023-version/singlehtml/_images/add-file.png b/branch/2023-version/singlehtml/_images/add-file.png new file mode 100644 index 00000000..9683b2db Binary files /dev/null and b/branch/2023-version/singlehtml/_images/add-file.png differ diff --git a/branch/2023-version/singlehtml/_images/annotate.png b/branch/2023-version/singlehtml/_images/annotate.png new file mode 100644 index 00000000..8021920a Binary files /dev/null and b/branch/2023-version/singlehtml/_images/annotate.png differ diff --git a/branch/2023-version/singlehtml/_images/bare-repo.png b/branch/2023-version/singlehtml/_images/bare-repo.png new file mode 100644 index 00000000..1aa5699d Binary files /dev/null and b/branch/2023-version/singlehtml/_images/bare-repo.png differ diff --git a/branch/2023-version/singlehtml/_images/browse-files.png b/branch/2023-version/singlehtml/_images/browse-files.png new file mode 100644 index 00000000..5fcc3528 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/browse-files.png differ diff --git a/branch/2023-version/singlehtml/_images/cheat-sheet.jpg b/branch/2023-version/singlehtml/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/branch/2023-version/singlehtml/_images/cheat-sheet.jpg differ diff --git a/branch/2023-version/singlehtml/_images/code-portion.png b/branch/2023-version/singlehtml/_images/code-portion.png new file mode 100644 index 00000000..39356bd5 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/code-portion.png differ diff --git a/branch/2023-version/singlehtml/_images/commit-and-tree.png b/branch/2023-version/singlehtml/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/branch/2023-version/singlehtml/_images/commit-and-tree.png differ diff --git a/branch/2023-version/singlehtml/_images/commit-changes.png b/branch/2023-version/singlehtml/_images/commit-changes.png new file mode 100644 index 00000000..4c0546c6 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/commit-changes.png differ diff --git a/branch/2023-version/singlehtml/_images/commits-and-parents.png b/branch/2023-version/singlehtml/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/commits-and-parents.png differ diff --git a/branch/2023-version/singlehtml/_images/commits.png b/branch/2023-version/singlehtml/_images/commits.png new file mode 100644 index 00000000..b154c666 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/commits.png differ diff --git a/branch/2023-version/singlehtml/_images/edit-file.png b/branch/2023-version/singlehtml/_images/edit-file.png new file mode 100644 index 00000000..f7527bd0 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/edit-file.png differ diff --git a/branch/2023-version/singlehtml/_images/git-annotate.png b/branch/2023-version/singlehtml/_images/git-annotate.png new file mode 100644 index 00000000..60c6f7c2 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/git-annotate.png differ diff --git a/branch/2023-version/singlehtml/_images/git-branch-1.svg b/branch/2023-version/singlehtml/_images/git-branch-1.svg new file mode 100644 index 00000000..1174a2e9 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-branch-1.svg @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + m2 + + + m3 + + + m1 + + + + + main + + + + + HEAD + + + diff --git a/branch/2023-version/singlehtml/_images/git-branch-2.svg b/branch/2023-version/singlehtml/_images/git-branch-2.svg new file mode 100644 index 00000000..e3f7abfc --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-branch-2.svg @@ -0,0 +1,443 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + l1 + + + e2 + + + e1 + + + m5 + + + m4 + + + m2 + + + m3 + + + m1 + + + + + less-salt + + + + + HEAD + + + + + experiment + + + + + main + + + diff --git a/branch/2023-version/singlehtml/_images/git-branch-3.svg b/branch/2023-version/singlehtml/_images/git-branch-3.svg new file mode 100644 index 00000000..8916d588 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-branch-3.svg @@ -0,0 +1,475 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + e2 + + + m3 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + + + less-salt + + + + + experiment + + + diff --git a/branch/2023-version/singlehtml/_images/git-collaborative.svg b/branch/2023-version/singlehtml/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/branch/2023-version/singlehtml/_images/git-deleted-branches.svg b/branch/2023-version/singlehtml/_images/git-deleted-branches.svg new file mode 100644 index 00000000..2b4b3fd5 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-deleted-branches.svg @@ -0,0 +1,483 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + m5 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + diff --git a/branch/2023-version/singlehtml/_images/git-log-github.png b/branch/2023-version/singlehtml/_images/git-log-github.png new file mode 100644 index 00000000..db44d29b Binary files /dev/null and b/branch/2023-version/singlehtml/_images/git-log-github.png differ diff --git a/branch/2023-version/singlehtml/_images/git-log-terminal.png b/branch/2023-version/singlehtml/_images/git-log-terminal.png new file mode 100644 index 00000000..56493e6e Binary files /dev/null and b/branch/2023-version/singlehtml/_images/git-log-terminal.png differ diff --git a/branch/2023-version/singlehtml/_images/git-merge-1.svg b/branch/2023-version/singlehtml/_images/git-merge-1.svg new file mode 100644 index 00000000..34fd0f87 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-merge-1.svg @@ -0,0 +1,515 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + m3 + + + l1 + + + m7 + + + m4 + + + + + experiment + + + + + less-salt + + + + + main + + + + + HEAD + + + diff --git a/branch/2023-version/singlehtml/_images/git-merge-2.svg b/branch/2023-version/singlehtml/_images/git-merge-2.svg new file mode 100644 index 00000000..5f5fd6a7 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-merge-2.svg @@ -0,0 +1,555 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + l1 + + + m5 + + + m4 + + + + + experiment + + + + + main + + + + + HEAD + + + + + less-salt + + + diff --git a/branch/2023-version/singlehtml/_images/git-pre-ff.svg b/branch/2023-version/singlehtml/_images/git-pre-ff.svg new file mode 100644 index 00000000..df06fc7e --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git-pre-ff.svg @@ -0,0 +1,615 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e1 + + + e2 + + + m7 + + + m8 + + + n3 + + + n1 + + + m5 + + + l1 + + + m6 + + + m4 + + + n2 + + + m2 + + + m3 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + main + + + diff --git a/branch/2023-version/singlehtml/_images/git_stage_commit.svg b/branch/2023-version/singlehtml/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/2023-version/singlehtml/_images/gophers.png b/branch/2023-version/singlehtml/_images/gophers.png new file mode 100644 index 00000000..741406ba Binary files /dev/null and b/branch/2023-version/singlehtml/_images/gophers.png differ diff --git a/branch/2023-version/singlehtml/_images/history.png b/branch/2023-version/singlehtml/_images/history.png new file mode 100644 index 00000000..6384e302 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/history.png differ diff --git a/branch/2023-version/singlehtml/_images/meld.png b/branch/2023-version/singlehtml/_images/meld.png new file mode 100644 index 00000000..774f9cd1 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/meld.png differ diff --git a/branch/2023-version/singlehtml/_images/mergetool.png b/branch/2023-version/singlehtml/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/mergetool.png differ diff --git a/branch/2023-version/singlehtml/_images/new-bare-repo-form.png b/branch/2023-version/singlehtml/_images/new-bare-repo-form.png new file mode 100644 index 00000000..939e4f84 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/new-bare-repo-form.png differ diff --git a/branch/2023-version/singlehtml/_images/new-repo-form.png b/branch/2023-version/singlehtml/_images/new-repo-form.png new file mode 100644 index 00000000..b808ee0b Binary files /dev/null and b/branch/2023-version/singlehtml/_images/new-repo-form.png differ diff --git a/branch/2023-version/singlehtml/_images/new-repo-plus.png b/branch/2023-version/singlehtml/_images/new-repo-plus.png new file mode 100644 index 00000000..e58ba5d8 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/new-repo-plus.png differ diff --git a/branch/2023-version/singlehtml/_images/pen-symbol.png b/branch/2023-version/singlehtml/_images/pen-symbol.png new file mode 100644 index 00000000..044902a3 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/pen-symbol.png differ diff --git a/branch/2023-version/singlehtml/_images/preview.png b/branch/2023-version/singlehtml/_images/preview.png new file mode 100644 index 00000000..8a602b66 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/preview.png differ diff --git a/branch/2023-version/singlehtml/_images/search.png b/branch/2023-version/singlehtml/_images/search.png new file mode 100644 index 00000000..4462f71e Binary files /dev/null and b/branch/2023-version/singlehtml/_images/search.png differ diff --git a/branch/2023-version/singlehtml/_images/show.png b/branch/2023-version/singlehtml/_images/show.png new file mode 100644 index 00000000..12d7915c Binary files /dev/null and b/branch/2023-version/singlehtml/_images/show.png differ diff --git a/branch/2023-version/singlehtml/_images/staging-basics.svg b/branch/2023-version/singlehtml/_images/staging-basics.svg new file mode 100644 index 00000000..13df8bf5 --- /dev/null +++ b/branch/2023-version/singlehtml/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + restore + add + commit + restore + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/branch/2023-version/singlehtml/_images/stranger.jpg b/branch/2023-version/singlehtml/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/branch/2023-version/singlehtml/_images/stranger.jpg differ diff --git a/branch/2023-version/singlehtml/_static/_sphinx_javascript_frameworks_compat.js b/branch/2023-version/singlehtml/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/_sphinx_javascript_frameworks_compat.js @@ -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; +} diff --git a/branch/2023-version/singlehtml/_static/basic.css b/branch/2023-version/singlehtml/_static/basic.css new file mode 100644 index 00000000..30fee9d0 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/check-solid.svg b/branch/2023-version/singlehtml/_static/check-solid.svg new file mode 100644 index 00000000..92fad4b5 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/2023-version/singlehtml/_static/clipboard.min.js b/branch/2023-version/singlehtml/_static/clipboard.min.js new file mode 100644 index 00000000..54b3c463 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/branch/2023-version/singlehtml/_static/copybutton.css b/branch/2023-version/singlehtml/_static/copybutton.css new file mode 100644 index 00000000..40eafe5f --- /dev/null +++ b/branch/2023-version/singlehtml/_static/copybutton.css @@ -0,0 +1,93 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +.highlight:hover button.copybtn { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/branch/2023-version/singlehtml/_static/copybutton.js b/branch/2023-version/singlehtml/_static/copybutton.js new file mode 100644 index 00000000..f3ecd034 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/copybutton.js @@ -0,0 +1,241 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copié dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for two seconds, then changes it back +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000) + setTimeout(() => el.classList.remove('success'), 2000) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, 2000) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos, .gp'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/copybutton_funcs.js b/branch/2023-version/singlehtml/_static/copybutton_funcs.js new file mode 100644 index 00000000..dbe1aaad --- /dev/null +++ b/branch/2023-version/singlehtml/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/branch/2023-version/singlehtml/_static/css/badge_only.css b/branch/2023-version/singlehtml/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.eot b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.svg b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.ttf b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.woff b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-bold-italic.woff b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold-italic.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-bold-italic.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-bold.woff b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-bold.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-bold.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-normal-italic.woff b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal-italic.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-normal-italic.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-normal.woff b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal.woff differ diff --git a/branch/2023-version/singlehtml/_static/css/fonts/lato-normal.woff2 b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/css/fonts/lato-normal.woff2 differ diff --git a/branch/2023-version/singlehtml/_static/css/theme.css b/branch/2023-version/singlehtml/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/doctools.js b/branch/2023-version/singlehtml/_static/doctools.js new file mode 100644 index 00000000..d06a71d7 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/branch/2023-version/singlehtml/_static/documentation_options.js b/branch/2023-version/singlehtml/_static/documentation_options.js new file mode 100644 index 00000000..89003c67 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'singlehtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/file.png b/branch/2023-version/singlehtml/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/file.png differ diff --git a/branch/2023-version/singlehtml/_static/jquery.js b/branch/2023-version/singlehtml/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/branch/2023-version/singlehtml/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/js/html5shiv.min.js b/branch/2023-version/singlehtml/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/branch/2023-version/singlehtml/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/js/theme.js b/branch/2023-version/singlehtml/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/branch/2023-version/singlehtml/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/branch/2023-version/singlehtml/_static/minipres.js b/branch/2023-version/singlehtml/_static/minipres.js new file mode 100644 index 00000000..ad11c871 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/minipres.js @@ -0,0 +1,223 @@ +// Add goTo method to elements +// http://stackoverflow.com/questions/4801655/how-to-go-to-a-specific-element-on-page +(function($) { + $.fn.goTo = function() { + $('html, body').animate({ + scrollTop: $(this).offset().top //+ 'px' + }, 'fast'); + return this; // for chaining... + } +})(jQuery); + +// NO good way to do this!. Copy a hack from here +// https://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript +// https://stackoverflow.com/a/2880929 +var urlParams; +(window.onpopstate = function () { + var match, + pl = /\+/g, // Regex for replacing addition symbol with a space + search = /([^&=]+)=?([^&]*)/g, + decode = function (s) { return decodeURIComponent(s.replace(pl, " ")); }, + query = window.location.search.substring(1); + urlParams = {}; + while (match = search.exec(query)) + urlParams[decode(match[1])] = decode(match[2]); +})(); + +// Select heading levels +var maxHeading = urlParams['h'] +if (maxHeading === undefined) maxHeading = 2 +var headingLevels = []; +for (h=2 ; h (sections.length-1) ) { + // if we would scroll past bottom, or above top, do nothing + return; + } + + console.log('xxxxxx'); + var targetSection = sections[targetPos]; + console.log(targetSection, typeof(targetSection)); + + // Return targetSection top and height + var secProperties = section_top_and_height(targetSection); + var top = secProperties['top']; + var height = secProperties['height'] + var win_height = window.innerHeight; + //console.info(top, height, win_height) + + var scroll_to = 0; + if (height >= win_height || height == 0) { + scroll_to = top; + } else { + scroll_to = top - (win_height-height)/3.; + } + //console.info(top, height, win_height, scroll_to) + + $('html, body').animate({ + scrollTop: scroll_to //+ 'px' + }, 'fast'); + +} + + +function minipres() { + /* Enable the minipres mode: + - call the hide() function + - set up the scrolling listener + */ + document.addEventListener('keydown', function (event) { + switch(event.which) { + case 37: // left + switch_slide(-1); + event.preventDefault(); + return false; + break; + //case 38: // up + case 39: // right + switch_slide(+1); + event.preventDefault(); + return false; + break; + //case 40: // down + default: + return; // exit this handler for other keys + } + }, true) + + hide() + + // Increase space between sections + //$("div .section").css('margin-bottom', '50%'); + $(sectionSelector).css('margin-top', '50%'); + + // Reduce size/color of other sections + if (hiddenSectionSelector.length > 0) { + var hideNodes = $(hiddenSectionSelector); + console.log(typeof hideNodes, hideNodes); + for (node in hideNodes) { + console.log("a", typeof node, node); + node = hideNodes[node]; // what's right way to iterate values? + console.log("b", typeof node, node); + if (node.parentNode && node.parentNode.className == "section") { + node = node.parentNode; + console.log("c", typeof node, node); + //node.css['transform'] = 'scale(.5)'; + //node.css['transform-origin'] = 'top center'; + $(node).css('color', 'lightgrey'); + //$(node).css('font-size', '20%'); + //$(node).css('visibility', 'collapse'); + //ntahousnatouhasno; + } + } + } +} + +function hide() { + /* Hide all non-essential elements on the page + */ + + // This is for sphinx_rst_theme and readthedocs + $(".wy-nav-side").remove(); + $(".wy-nav-content-wrap").css('margin-left', 0); + $('.rst-versions').remove(); // readthedocs version selector + + // Add other formats here. +} + + +var slideshow = minipres; + +if (window.location.search.match(/[?&](minipres|slideshow|pres)([=&]|$)/) ) { + //minipres() + window.addEventListener("load", minipres); +} else if (window.location.search.match(/[?&](plain)([=&]|$)/) ) { + window.addEventListener("load", hide); +} diff --git a/branch/2023-version/singlehtml/_static/minus.png b/branch/2023-version/singlehtml/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/branch/2023-version/singlehtml/_static/minus.png differ diff --git a/branch/2023-version/singlehtml/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css b/branch/2023-version/singlehtml/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css new file mode 100644 index 00000000..33566310 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css @@ -0,0 +1,2342 @@ +/* Variables */ +:root { + --mystnb-source-bg-color: #f7f7f7; + --mystnb-stdout-bg-color: #fcfcfc; + --mystnb-stderr-bg-color: #fdd; + --mystnb-traceback-bg-color: #fcfcfc; + --mystnb-source-border-color: #ccc; + --mystnb-source-margin-color: green; + --mystnb-stdout-border-color: #f7f7f7; + --mystnb-stderr-border-color: #f7f7f7; + --mystnb-traceback-border-color: #ffd6d6; + --mystnb-hide-prompt-opacity: 70%; + --mystnb-source-border-radius: .4em; + --mystnb-source-border-width: 1px; +} + +/* Whole cell */ +div.container.cell { + padding-left: 0; + margin-bottom: 1em; +} + +/* Removing all background formatting so we can control at the div level */ +.cell_input div.highlight, +.cell_output pre, +.cell_input pre, +.cell_output .output { + border: none; + box-shadow: none; +} + +.cell_output .output pre, +.cell_input pre { + margin: 0px; +} + +/* Input cells */ +div.cell div.cell_input, +div.cell details.above-input>summary { + padding-left: 0em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + background-color: var(--mystnb-source-bg-color); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; + border-radius: var(--mystnb-source-border-radius); +} + +div.cell_input>div, +div.cell_output div.output>div.highlight { + margin: 0em !important; + border: none !important; +} + +/* All cell outputs */ +.cell_output { + padding-left: 1em; + padding-right: 0em; + margin-top: 1em; +} + +/* Text outputs from cells */ +.cell_output .output.text_plain, +.cell_output .output.traceback, +.cell_output .output.stream, +.cell_output .output.stderr { + margin-top: 1em; + margin-bottom: 0em; + box-shadow: none; +} + +.cell_output .output.text_plain, +.cell_output .output.stream { + background: var(--mystnb-stdout-bg-color); + border: 1px solid var(--mystnb-stdout-border-color); +} + +.cell_output .output.stderr { + background: var(--mystnb-stderr-bg-color); + border: 1px solid var(--mystnb-stderr-border-color); +} + +.cell_output .output.traceback { + background: var(--mystnb-traceback-bg-color); + border: 1px solid var(--mystnb-traceback-border-color); +} + +/* Collapsible cell content */ +div.cell details.above-input div.cell_input { + border-top-left-radius: 0; + border-top-right-radius: 0; + border-top: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; +} + +div.cell div.cell_input.above-output-prompt { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} + +div.cell details.above-input>summary { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + border-bottom: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; + padding-left: 1em; + margin-bottom: 0; +} + +div.cell details.above-output>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.below-input>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-top: none; + border-bottom-left-radius: var(--mystnb-source-border-radius); + border-bottom-right-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.hide>summary>span { + opacity: var(--mystnb-hide-prompt-opacity); +} + +div.cell details.hide[open]>summary>span.collapsed { + display: none; +} + +div.cell details.hide:not([open])>summary>span.expanded { + display: none; +} + +@keyframes collapsed-fade-in { + 0% { + opacity: 0; + } + + 100% { + opacity: 1; + } +} +div.cell details.hide[open]>summary~* { + -moz-animation: collapsed-fade-in 0.3s ease-in-out; + -webkit-animation: collapsed-fade-in 0.3s ease-in-out; + animation: collapsed-fade-in 0.3s ease-in-out; +} + +/* Math align to the left */ +.cell_output .MathJax_Display { + text-align: left !important; +} + +/* Pandas tables. Pulled from the Jupyter / nbsphinx CSS */ +div.cell_output table { + border: none; + border-collapse: collapse; + border-spacing: 0; + color: black; + font-size: 1em; + table-layout: fixed; +} + +div.cell_output thead { + border-bottom: 1px solid black; + vertical-align: bottom; +} + +div.cell_output tr, +div.cell_output th, +div.cell_output td { + text-align: right; + vertical-align: middle; + padding: 0.5em 0.5em; + line-height: normal; + white-space: normal; + max-width: none; + border: none; +} + +div.cell_output th { + font-weight: bold; +} + +div.cell_output tbody tr:nth-child(odd) { + background: #f5f5f5; +} + +div.cell_output tbody tr:hover { + background: rgba(66, 165, 245, 0.2); +} + +/** source code line numbers **/ +span.linenos { + opacity: 0.5; +} + +/* Inline text from `paste` operation */ + +span.pasted-text { + font-weight: bold; +} + +span.pasted-inline img { + max-height: 2em; +} + +tbody span.pasted-inline img { + max-height: none; +} + +/* Font colors for translated ANSI escape sequences +Color values are copied from Jupyter Notebook +https://github.com/jupyter/notebook/blob/52581f8eda9b319eb0390ac77fe5903c38f81e3e/notebook/static/notebook/less/ansicolors.less#L14-L21 +Background colors from +https://nbsphinx.readthedocs.io/en/latest/code-cells.html#ANSI-Colors +*/ +div.highlight .-Color-Bold { + font-weight: bold; +} + +div.highlight .-Color[class*=-Black] { + color: #3E424D +} + +div.highlight .-Color[class*=-Red] { + color: #E75C58 +} + +div.highlight .-Color[class*=-Green] { + color: #00A250 +} + +div.highlight .-Color[class*=-Yellow] { + color: #DDB62B +} + +div.highlight .-Color[class*=-Blue] { + color: #208FFB +} + +div.highlight .-Color[class*=-Magenta] { + color: #D160C4 +} + +div.highlight .-Color[class*=-Cyan] { + color: #60C6C8 +} + +div.highlight .-Color[class*=-White] { + color: #C5C1B4 +} + +div.highlight .-Color[class*=-BGBlack] { + background-color: #3E424D +} + +div.highlight .-Color[class*=-BGRed] { + background-color: #E75C58 +} + +div.highlight .-Color[class*=-BGGreen] { + background-color: #00A250 +} + +div.highlight .-Color[class*=-BGYellow] { + background-color: #DDB62B +} + +div.highlight .-Color[class*=-BGBlue] { + background-color: #208FFB +} + +div.highlight .-Color[class*=-BGMagenta] { + background-color: #D160C4 +} + +div.highlight .-Color[class*=-BGCyan] { + background-color: #60C6C8 +} + +div.highlight .-Color[class*=-BGWhite] { + background-color: #C5C1B4 +} + +/* Font colors for 8-bit ANSI */ + +div.highlight .-Color[class*=-C0] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC0] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C1] { + color: #800000 +} + +div.highlight .-Color[class*=-BGC1] { + background-color: #800000 +} + +div.highlight .-Color[class*=-C2] { + color: #008000 +} + +div.highlight .-Color[class*=-BGC2] { + background-color: #008000 +} + +div.highlight .-Color[class*=-C3] { + color: #808000 +} + +div.highlight .-Color[class*=-BGC3] { + background-color: #808000 +} + +div.highlight .-Color[class*=-C4] { + color: #000080 +} + +div.highlight .-Color[class*=-BGC4] { + background-color: #000080 +} + +div.highlight .-Color[class*=-C5] { + color: #800080 +} + +div.highlight .-Color[class*=-BGC5] { + background-color: #800080 +} + +div.highlight .-Color[class*=-C6] { + color: #008080 +} + +div.highlight .-Color[class*=-BGC6] { + background-color: #008080 +} + +div.highlight .-Color[class*=-C7] { + color: #C0C0C0 +} + +div.highlight .-Color[class*=-BGC7] { + background-color: #C0C0C0 +} + +div.highlight .-Color[class*=-C8] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC8] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C9] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC9] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C10] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC10] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C11] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC11] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C12] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC12] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C13] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC13] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C14] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC14] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C15] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC15] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C16] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC16] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C17] { + color: #00005F +} + +div.highlight .-Color[class*=-BGC17] { + background-color: #00005F +} + +div.highlight .-Color[class*=-C18] { + color: #000087 +} + +div.highlight .-Color[class*=-BGC18] { + background-color: #000087 +} + +div.highlight .-Color[class*=-C19] { + color: #0000AF +} + +div.highlight .-Color[class*=-BGC19] { + background-color: #0000AF +} + +div.highlight .-Color[class*=-C20] { + color: #0000D7 +} + +div.highlight .-Color[class*=-BGC20] { + background-color: #0000D7 +} + +div.highlight .-Color[class*=-C21] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC21] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C22] { + color: #005F00 +} + +div.highlight .-Color[class*=-BGC22] { + background-color: #005F00 +} + +div.highlight .-Color[class*=-C23] { + color: #005F5F +} + +div.highlight .-Color[class*=-BGC23] { + background-color: #005F5F +} + +div.highlight .-Color[class*=-C24] { + color: #005F87 +} + +div.highlight .-Color[class*=-BGC24] { + background-color: #005F87 +} + +div.highlight .-Color[class*=-C25] { + color: #005FAF +} + +div.highlight .-Color[class*=-BGC25] { + background-color: #005FAF +} + +div.highlight .-Color[class*=-C26] { + color: #005FD7 +} + +div.highlight .-Color[class*=-BGC26] { + background-color: #005FD7 +} + +div.highlight .-Color[class*=-C27] { + color: #005FFF +} + +div.highlight .-Color[class*=-BGC27] { + background-color: #005FFF +} + +div.highlight .-Color[class*=-C28] { + color: #008700 +} + +div.highlight .-Color[class*=-BGC28] { + background-color: #008700 +} + +div.highlight .-Color[class*=-C29] { + color: #00875F +} + +div.highlight .-Color[class*=-BGC29] { + background-color: #00875F +} + +div.highlight .-Color[class*=-C30] { + color: #008787 +} + +div.highlight .-Color[class*=-BGC30] { + background-color: #008787 +} + +div.highlight .-Color[class*=-C31] { + color: #0087AF +} + +div.highlight .-Color[class*=-BGC31] { + background-color: #0087AF +} + +div.highlight .-Color[class*=-C32] { + color: #0087D7 +} + +div.highlight .-Color[class*=-BGC32] { + background-color: #0087D7 +} + +div.highlight .-Color[class*=-C33] { + color: #0087FF +} + +div.highlight .-Color[class*=-BGC33] { + background-color: #0087FF +} + +div.highlight .-Color[class*=-C34] { + color: #00AF00 +} + +div.highlight .-Color[class*=-BGC34] { + background-color: #00AF00 +} + +div.highlight .-Color[class*=-C35] { + color: #00AF5F +} + +div.highlight .-Color[class*=-BGC35] { + background-color: #00AF5F +} + +div.highlight .-Color[class*=-C36] { + color: #00AF87 +} + +div.highlight .-Color[class*=-BGC36] { + background-color: #00AF87 +} + +div.highlight .-Color[class*=-C37] { + color: #00AFAF +} + +div.highlight .-Color[class*=-BGC37] { + background-color: #00AFAF +} + +div.highlight .-Color[class*=-C38] { + color: #00AFD7 +} + +div.highlight .-Color[class*=-BGC38] { + background-color: #00AFD7 +} + +div.highlight .-Color[class*=-C39] { + color: #00AFFF +} + +div.highlight .-Color[class*=-BGC39] { + background-color: #00AFFF +} + +div.highlight .-Color[class*=-C40] { + color: #00D700 +} + +div.highlight .-Color[class*=-BGC40] { + background-color: #00D700 +} + +div.highlight .-Color[class*=-C41] { + color: #00D75F +} + +div.highlight .-Color[class*=-BGC41] { + background-color: #00D75F +} + +div.highlight .-Color[class*=-C42] { + color: #00D787 +} + +div.highlight .-Color[class*=-BGC42] { + background-color: #00D787 +} + +div.highlight .-Color[class*=-C43] { + color: #00D7AF +} + +div.highlight .-Color[class*=-BGC43] { + background-color: #00D7AF +} + +div.highlight .-Color[class*=-C44] { + color: #00D7D7 +} + +div.highlight .-Color[class*=-BGC44] { + background-color: #00D7D7 +} + +div.highlight .-Color[class*=-C45] { + color: #00D7FF +} + +div.highlight .-Color[class*=-BGC45] { + background-color: #00D7FF +} + +div.highlight .-Color[class*=-C46] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC46] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C47] { + color: #00FF5F +} + +div.highlight .-Color[class*=-BGC47] { + background-color: #00FF5F +} + +div.highlight .-Color[class*=-C48] { + color: #00FF87 +} + +div.highlight .-Color[class*=-BGC48] { + background-color: #00FF87 +} + +div.highlight .-Color[class*=-C49] { + color: #00FFAF +} + +div.highlight .-Color[class*=-BGC49] { + background-color: #00FFAF +} + +div.highlight .-Color[class*=-C50] { + color: #00FFD7 +} + +div.highlight .-Color[class*=-BGC50] { + background-color: #00FFD7 +} + +div.highlight .-Color[class*=-C51] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC51] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C52] { + color: #5F0000 +} + +div.highlight .-Color[class*=-BGC52] { + background-color: #5F0000 +} + +div.highlight .-Color[class*=-C53] { + color: #5F005F +} + +div.highlight .-Color[class*=-BGC53] { + background-color: #5F005F +} + +div.highlight .-Color[class*=-C54] { + color: #5F0087 +} + +div.highlight .-Color[class*=-BGC54] { + background-color: #5F0087 +} + +div.highlight .-Color[class*=-C55] { + color: #5F00AF +} + +div.highlight .-Color[class*=-BGC55] { + background-color: #5F00AF +} + +div.highlight .-Color[class*=-C56] { + color: #5F00D7 +} + +div.highlight .-Color[class*=-BGC56] { + background-color: #5F00D7 +} + +div.highlight .-Color[class*=-C57] { + color: #5F00FF +} + +div.highlight .-Color[class*=-BGC57] { + background-color: #5F00FF +} + +div.highlight .-Color[class*=-C58] { + color: #5F5F00 +} + +div.highlight .-Color[class*=-BGC58] { + background-color: #5F5F00 +} + +div.highlight .-Color[class*=-C59] { + color: #5F5F5F +} + +div.highlight .-Color[class*=-BGC59] { + background-color: #5F5F5F +} + +div.highlight .-Color[class*=-C60] { + color: #5F5F87 +} + +div.highlight .-Color[class*=-BGC60] { + background-color: #5F5F87 +} + +div.highlight .-Color[class*=-C61] { + color: #5F5FAF +} + +div.highlight .-Color[class*=-BGC61] { + background-color: #5F5FAF +} + +div.highlight .-Color[class*=-C62] { + color: #5F5FD7 +} + +div.highlight .-Color[class*=-BGC62] { + background-color: #5F5FD7 +} + +div.highlight .-Color[class*=-C63] { + color: #5F5FFF +} + +div.highlight .-Color[class*=-BGC63] { + background-color: #5F5FFF +} + +div.highlight .-Color[class*=-C64] { + color: #5F8700 +} + +div.highlight .-Color[class*=-BGC64] { + background-color: #5F8700 +} + +div.highlight .-Color[class*=-C65] { + color: #5F875F +} + +div.highlight .-Color[class*=-BGC65] { + background-color: #5F875F +} + +div.highlight .-Color[class*=-C66] { + color: #5F8787 +} + +div.highlight .-Color[class*=-BGC66] { + background-color: #5F8787 +} + +div.highlight .-Color[class*=-C67] { + color: #5F87AF +} + +div.highlight .-Color[class*=-BGC67] { + background-color: #5F87AF +} + +div.highlight .-Color[class*=-C68] { + color: #5F87D7 +} + +div.highlight .-Color[class*=-BGC68] { + background-color: #5F87D7 +} + +div.highlight .-Color[class*=-C69] { + color: #5F87FF +} + +div.highlight .-Color[class*=-BGC69] { + background-color: #5F87FF +} + +div.highlight .-Color[class*=-C70] { + color: #5FAF00 +} + +div.highlight .-Color[class*=-BGC70] { + background-color: #5FAF00 +} + +div.highlight .-Color[class*=-C71] { + color: #5FAF5F +} + +div.highlight .-Color[class*=-BGC71] { + background-color: #5FAF5F +} + +div.highlight .-Color[class*=-C72] { + color: #5FAF87 +} + +div.highlight .-Color[class*=-BGC72] { + background-color: #5FAF87 +} + +div.highlight .-Color[class*=-C73] { + color: #5FAFAF +} + +div.highlight .-Color[class*=-BGC73] { + background-color: #5FAFAF +} + +div.highlight .-Color[class*=-C74] { + color: #5FAFD7 +} + +div.highlight .-Color[class*=-BGC74] { + background-color: #5FAFD7 +} + +div.highlight .-Color[class*=-C75] { + color: #5FAFFF +} + +div.highlight .-Color[class*=-BGC75] { + background-color: #5FAFFF +} + +div.highlight .-Color[class*=-C76] { + color: #5FD700 +} + +div.highlight .-Color[class*=-BGC76] { + background-color: #5FD700 +} + +div.highlight .-Color[class*=-C77] { + color: #5FD75F +} + +div.highlight .-Color[class*=-BGC77] { + background-color: #5FD75F +} + +div.highlight .-Color[class*=-C78] { + color: #5FD787 +} + +div.highlight .-Color[class*=-BGC78] { + background-color: #5FD787 +} + +div.highlight .-Color[class*=-C79] { + color: #5FD7AF +} + +div.highlight .-Color[class*=-BGC79] { + background-color: #5FD7AF +} + +div.highlight .-Color[class*=-C80] { + color: #5FD7D7 +} + +div.highlight .-Color[class*=-BGC80] { + background-color: #5FD7D7 +} + +div.highlight .-Color[class*=-C81] { + color: #5FD7FF +} + +div.highlight .-Color[class*=-BGC81] { + background-color: #5FD7FF +} + +div.highlight .-Color[class*=-C82] { + color: #5FFF00 +} + +div.highlight .-Color[class*=-BGC82] { + background-color: #5FFF00 +} + +div.highlight .-Color[class*=-C83] { + color: #5FFF5F +} + +div.highlight .-Color[class*=-BGC83] { + background-color: #5FFF5F +} + +div.highlight .-Color[class*=-C84] { + color: #5FFF87 +} + +div.highlight .-Color[class*=-BGC84] { + background-color: #5FFF87 +} + +div.highlight .-Color[class*=-C85] { + color: #5FFFAF +} + +div.highlight .-Color[class*=-BGC85] { + background-color: #5FFFAF +} + +div.highlight .-Color[class*=-C86] { + color: #5FFFD7 +} + +div.highlight .-Color[class*=-BGC86] { + background-color: #5FFFD7 +} + +div.highlight .-Color[class*=-C87] { + color: #5FFFFF +} + +div.highlight .-Color[class*=-BGC87] { + background-color: #5FFFFF +} + +div.highlight .-Color[class*=-C88] { + color: #870000 +} + +div.highlight .-Color[class*=-BGC88] { + background-color: #870000 +} + +div.highlight .-Color[class*=-C89] { + color: #87005F +} + +div.highlight .-Color[class*=-BGC89] { + background-color: #87005F +} + +div.highlight .-Color[class*=-C90] { + color: #870087 +} + +div.highlight .-Color[class*=-BGC90] { + background-color: #870087 +} + +div.highlight .-Color[class*=-C91] { + color: #8700AF +} + +div.highlight .-Color[class*=-BGC91] { + background-color: #8700AF +} + +div.highlight .-Color[class*=-C92] { + color: #8700D7 +} + +div.highlight .-Color[class*=-BGC92] { + background-color: #8700D7 +} + +div.highlight .-Color[class*=-C93] { + color: #8700FF +} + +div.highlight .-Color[class*=-BGC93] { + background-color: #8700FF +} + +div.highlight .-Color[class*=-C94] { + color: #875F00 +} + +div.highlight .-Color[class*=-BGC94] { + background-color: #875F00 +} + +div.highlight .-Color[class*=-C95] { + color: #875F5F +} + +div.highlight .-Color[class*=-BGC95] { + background-color: #875F5F +} + +div.highlight .-Color[class*=-C96] { + color: #875F87 +} + +div.highlight .-Color[class*=-BGC96] { + background-color: #875F87 +} + +div.highlight .-Color[class*=-C97] { + color: #875FAF +} + +div.highlight .-Color[class*=-BGC97] { + background-color: #875FAF +} + +div.highlight .-Color[class*=-C98] { + color: #875FD7 +} + +div.highlight .-Color[class*=-BGC98] { + background-color: #875FD7 +} + +div.highlight .-Color[class*=-C99] { + color: #875FFF +} + +div.highlight .-Color[class*=-BGC99] { + background-color: #875FFF +} + +div.highlight .-Color[class*=-C100] { + color: #878700 +} + +div.highlight .-Color[class*=-BGC100] { + background-color: #878700 +} + +div.highlight .-Color[class*=-C101] { + color: #87875F +} + +div.highlight .-Color[class*=-BGC101] { + background-color: #87875F +} + +div.highlight .-Color[class*=-C102] { + color: #878787 +} + +div.highlight .-Color[class*=-BGC102] { + background-color: #878787 +} + +div.highlight .-Color[class*=-C103] { + color: #8787AF +} + +div.highlight .-Color[class*=-BGC103] { + background-color: #8787AF +} + +div.highlight .-Color[class*=-C104] { + color: #8787D7 +} + +div.highlight .-Color[class*=-BGC104] { + background-color: #8787D7 +} + +div.highlight .-Color[class*=-C105] { + color: #8787FF +} + +div.highlight .-Color[class*=-BGC105] { + background-color: #8787FF +} + +div.highlight .-Color[class*=-C106] { + color: #87AF00 +} + +div.highlight .-Color[class*=-BGC106] { + background-color: #87AF00 +} + +div.highlight .-Color[class*=-C107] { + color: #87AF5F +} + +div.highlight .-Color[class*=-BGC107] { + background-color: #87AF5F +} + +div.highlight .-Color[class*=-C108] { + color: #87AF87 +} + +div.highlight .-Color[class*=-BGC108] { + background-color: #87AF87 +} + +div.highlight .-Color[class*=-C109] { + color: #87AFAF +} + +div.highlight .-Color[class*=-BGC109] { + background-color: #87AFAF +} + +div.highlight .-Color[class*=-C110] { + color: #87AFD7 +} + +div.highlight .-Color[class*=-BGC110] { + background-color: #87AFD7 +} + +div.highlight .-Color[class*=-C111] { + color: #87AFFF +} + +div.highlight .-Color[class*=-BGC111] { + background-color: #87AFFF +} + +div.highlight .-Color[class*=-C112] { + color: #87D700 +} + +div.highlight .-Color[class*=-BGC112] { + background-color: #87D700 +} + +div.highlight .-Color[class*=-C113] { + color: #87D75F +} + +div.highlight .-Color[class*=-BGC113] { + background-color: #87D75F +} + +div.highlight .-Color[class*=-C114] { + color: #87D787 +} + +div.highlight .-Color[class*=-BGC114] { + background-color: #87D787 +} + +div.highlight .-Color[class*=-C115] { + color: #87D7AF +} + +div.highlight .-Color[class*=-BGC115] { + background-color: #87D7AF +} + +div.highlight .-Color[class*=-C116] { + color: #87D7D7 +} + +div.highlight .-Color[class*=-BGC116] { + background-color: #87D7D7 +} + +div.highlight .-Color[class*=-C117] { + color: #87D7FF +} + +div.highlight .-Color[class*=-BGC117] { + background-color: #87D7FF +} + +div.highlight .-Color[class*=-C118] { + color: #87FF00 +} + +div.highlight .-Color[class*=-BGC118] { + background-color: #87FF00 +} + +div.highlight .-Color[class*=-C119] { + color: #87FF5F +} + +div.highlight .-Color[class*=-BGC119] { + background-color: #87FF5F +} + +div.highlight .-Color[class*=-C120] { + color: #87FF87 +} + +div.highlight .-Color[class*=-BGC120] { + background-color: #87FF87 +} + +div.highlight .-Color[class*=-C121] { + color: #87FFAF +} + +div.highlight .-Color[class*=-BGC121] { + background-color: #87FFAF +} + +div.highlight .-Color[class*=-C122] { + color: #87FFD7 +} + +div.highlight .-Color[class*=-BGC122] { + background-color: #87FFD7 +} + +div.highlight .-Color[class*=-C123] { + color: #87FFFF +} + +div.highlight .-Color[class*=-BGC123] { + background-color: #87FFFF +} + +div.highlight .-Color[class*=-C124] { + color: #AF0000 +} + +div.highlight .-Color[class*=-BGC124] { + background-color: #AF0000 +} + +div.highlight .-Color[class*=-C125] { + color: #AF005F +} + +div.highlight .-Color[class*=-BGC125] { + background-color: #AF005F +} + +div.highlight .-Color[class*=-C126] { + color: #AF0087 +} + +div.highlight .-Color[class*=-BGC126] { + background-color: #AF0087 +} + +div.highlight .-Color[class*=-C127] { + color: #AF00AF +} + +div.highlight .-Color[class*=-BGC127] { + background-color: #AF00AF +} + +div.highlight .-Color[class*=-C128] { + color: #AF00D7 +} + +div.highlight .-Color[class*=-BGC128] { + background-color: #AF00D7 +} + +div.highlight .-Color[class*=-C129] { + color: #AF00FF +} + +div.highlight .-Color[class*=-BGC129] { + background-color: #AF00FF +} + +div.highlight .-Color[class*=-C130] { + color: #AF5F00 +} + +div.highlight .-Color[class*=-BGC130] { + background-color: #AF5F00 +} + +div.highlight .-Color[class*=-C131] { + color: #AF5F5F +} + +div.highlight .-Color[class*=-BGC131] { + background-color: #AF5F5F +} + +div.highlight .-Color[class*=-C132] { + color: #AF5F87 +} + +div.highlight .-Color[class*=-BGC132] { + background-color: #AF5F87 +} + +div.highlight .-Color[class*=-C133] { + color: #AF5FAF +} + +div.highlight .-Color[class*=-BGC133] { + background-color: #AF5FAF +} + +div.highlight .-Color[class*=-C134] { + color: #AF5FD7 +} + +div.highlight .-Color[class*=-BGC134] { + background-color: #AF5FD7 +} + +div.highlight .-Color[class*=-C135] { + color: #AF5FFF +} + +div.highlight .-Color[class*=-BGC135] { + background-color: #AF5FFF +} + +div.highlight .-Color[class*=-C136] { + color: #AF8700 +} + +div.highlight .-Color[class*=-BGC136] { + background-color: #AF8700 +} + +div.highlight .-Color[class*=-C137] { + color: #AF875F +} + +div.highlight .-Color[class*=-BGC137] { + background-color: #AF875F +} + +div.highlight .-Color[class*=-C138] { + color: #AF8787 +} + +div.highlight .-Color[class*=-BGC138] { + background-color: #AF8787 +} + +div.highlight .-Color[class*=-C139] { + color: #AF87AF +} + +div.highlight .-Color[class*=-BGC139] { + background-color: #AF87AF +} + +div.highlight .-Color[class*=-C140] { + color: #AF87D7 +} + +div.highlight .-Color[class*=-BGC140] { + background-color: #AF87D7 +} + +div.highlight .-Color[class*=-C141] { + color: #AF87FF +} + +div.highlight .-Color[class*=-BGC141] { + background-color: #AF87FF +} + +div.highlight .-Color[class*=-C142] { + color: #AFAF00 +} + +div.highlight .-Color[class*=-BGC142] { + background-color: #AFAF00 +} + +div.highlight .-Color[class*=-C143] { + color: #AFAF5F +} + +div.highlight .-Color[class*=-BGC143] { + background-color: #AFAF5F +} + +div.highlight .-Color[class*=-C144] { + color: #AFAF87 +} + +div.highlight .-Color[class*=-BGC144] { + background-color: #AFAF87 +} + +div.highlight .-Color[class*=-C145] { + color: #AFAFAF +} + +div.highlight .-Color[class*=-BGC145] { + background-color: #AFAFAF +} + +div.highlight .-Color[class*=-C146] { + color: #AFAFD7 +} + +div.highlight .-Color[class*=-BGC146] { + background-color: #AFAFD7 +} + +div.highlight .-Color[class*=-C147] { + color: #AFAFFF +} + +div.highlight .-Color[class*=-BGC147] { + background-color: #AFAFFF +} + +div.highlight .-Color[class*=-C148] { + color: #AFD700 +} + +div.highlight .-Color[class*=-BGC148] { + background-color: #AFD700 +} + +div.highlight .-Color[class*=-C149] { + color: #AFD75F +} + +div.highlight .-Color[class*=-BGC149] { + background-color: #AFD75F +} + +div.highlight .-Color[class*=-C150] { + color: #AFD787 +} + +div.highlight .-Color[class*=-BGC150] { + background-color: #AFD787 +} + +div.highlight .-Color[class*=-C151] { + color: #AFD7AF +} + +div.highlight .-Color[class*=-BGC151] { + background-color: #AFD7AF +} + +div.highlight .-Color[class*=-C152] { + color: #AFD7D7 +} + +div.highlight .-Color[class*=-BGC152] { + background-color: #AFD7D7 +} + +div.highlight .-Color[class*=-C153] { + color: #AFD7FF +} + +div.highlight .-Color[class*=-BGC153] { + background-color: #AFD7FF +} + +div.highlight .-Color[class*=-C154] { + color: #AFFF00 +} + +div.highlight .-Color[class*=-BGC154] { + background-color: #AFFF00 +} + +div.highlight .-Color[class*=-C155] { + color: #AFFF5F +} + +div.highlight .-Color[class*=-BGC155] { + background-color: #AFFF5F +} + +div.highlight .-Color[class*=-C156] { + color: #AFFF87 +} + +div.highlight .-Color[class*=-BGC156] { + background-color: #AFFF87 +} + +div.highlight .-Color[class*=-C157] { + color: #AFFFAF +} + +div.highlight .-Color[class*=-BGC157] { + background-color: #AFFFAF +} + +div.highlight .-Color[class*=-C158] { + color: #AFFFD7 +} + +div.highlight .-Color[class*=-BGC158] { + background-color: #AFFFD7 +} + +div.highlight .-Color[class*=-C159] { + color: #AFFFFF +} + +div.highlight .-Color[class*=-BGC159] { + background-color: #AFFFFF +} + +div.highlight .-Color[class*=-C160] { + color: #D70000 +} + +div.highlight .-Color[class*=-BGC160] { + background-color: #D70000 +} + +div.highlight .-Color[class*=-C161] { + color: #D7005F +} + +div.highlight .-Color[class*=-BGC161] { + background-color: #D7005F +} + +div.highlight .-Color[class*=-C162] { + color: #D70087 +} + +div.highlight .-Color[class*=-BGC162] { + background-color: #D70087 +} + +div.highlight .-Color[class*=-C163] { + color: #D700AF +} + +div.highlight .-Color[class*=-BGC163] { + background-color: #D700AF +} + +div.highlight .-Color[class*=-C164] { + color: #D700D7 +} + +div.highlight .-Color[class*=-BGC164] { + background-color: #D700D7 +} + +div.highlight .-Color[class*=-C165] { + color: #D700FF +} + +div.highlight .-Color[class*=-BGC165] { + background-color: #D700FF +} + +div.highlight .-Color[class*=-C166] { + color: #D75F00 +} + +div.highlight .-Color[class*=-BGC166] { + background-color: #D75F00 +} + +div.highlight .-Color[class*=-C167] { + color: #D75F5F +} + +div.highlight .-Color[class*=-BGC167] { + background-color: #D75F5F +} + +div.highlight .-Color[class*=-C168] { + color: #D75F87 +} + +div.highlight .-Color[class*=-BGC168] { + background-color: #D75F87 +} + +div.highlight .-Color[class*=-C169] { + color: #D75FAF +} + +div.highlight .-Color[class*=-BGC169] { + background-color: #D75FAF +} + +div.highlight .-Color[class*=-C170] { + color: #D75FD7 +} + +div.highlight .-Color[class*=-BGC170] { + background-color: #D75FD7 +} + +div.highlight .-Color[class*=-C171] { + color: #D75FFF +} + +div.highlight .-Color[class*=-BGC171] { + background-color: #D75FFF +} + +div.highlight .-Color[class*=-C172] { + color: #D78700 +} + +div.highlight .-Color[class*=-BGC172] { + background-color: #D78700 +} + +div.highlight .-Color[class*=-C173] { + color: #D7875F +} + +div.highlight .-Color[class*=-BGC173] { + background-color: #D7875F +} + +div.highlight .-Color[class*=-C174] { + color: #D78787 +} + +div.highlight .-Color[class*=-BGC174] { + background-color: #D78787 +} + +div.highlight .-Color[class*=-C175] { + color: #D787AF +} + +div.highlight .-Color[class*=-BGC175] { + background-color: #D787AF +} + +div.highlight .-Color[class*=-C176] { + color: #D787D7 +} + +div.highlight .-Color[class*=-BGC176] { + background-color: #D787D7 +} + +div.highlight .-Color[class*=-C177] { + color: #D787FF +} + +div.highlight .-Color[class*=-BGC177] { + background-color: #D787FF +} + +div.highlight .-Color[class*=-C178] { + color: #D7AF00 +} + +div.highlight .-Color[class*=-BGC178] { + background-color: #D7AF00 +} + +div.highlight .-Color[class*=-C179] { + color: #D7AF5F +} + +div.highlight .-Color[class*=-BGC179] { + background-color: #D7AF5F +} + +div.highlight .-Color[class*=-C180] { + color: #D7AF87 +} + +div.highlight .-Color[class*=-BGC180] { + background-color: #D7AF87 +} + +div.highlight .-Color[class*=-C181] { + color: #D7AFAF +} + +div.highlight .-Color[class*=-BGC181] { + background-color: #D7AFAF +} + +div.highlight .-Color[class*=-C182] { + color: #D7AFD7 +} + +div.highlight .-Color[class*=-BGC182] { + background-color: #D7AFD7 +} + +div.highlight .-Color[class*=-C183] { + color: #D7AFFF +} + +div.highlight .-Color[class*=-BGC183] { + background-color: #D7AFFF +} + +div.highlight .-Color[class*=-C184] { + color: #D7D700 +} + +div.highlight .-Color[class*=-BGC184] { + background-color: #D7D700 +} + +div.highlight .-Color[class*=-C185] { + color: #D7D75F +} + +div.highlight .-Color[class*=-BGC185] { + background-color: #D7D75F +} + +div.highlight .-Color[class*=-C186] { + color: #D7D787 +} + +div.highlight .-Color[class*=-BGC186] { + background-color: #D7D787 +} + +div.highlight .-Color[class*=-C187] { + color: #D7D7AF +} + +div.highlight .-Color[class*=-BGC187] { + background-color: #D7D7AF +} + +div.highlight .-Color[class*=-C188] { + color: #D7D7D7 +} + +div.highlight .-Color[class*=-BGC188] { + background-color: #D7D7D7 +} + +div.highlight .-Color[class*=-C189] { + color: #D7D7FF +} + +div.highlight .-Color[class*=-BGC189] { + background-color: #D7D7FF +} + +div.highlight .-Color[class*=-C190] { + color: #D7FF00 +} + +div.highlight .-Color[class*=-BGC190] { + background-color: #D7FF00 +} + +div.highlight .-Color[class*=-C191] { + color: #D7FF5F +} + +div.highlight .-Color[class*=-BGC191] { + background-color: #D7FF5F +} + +div.highlight .-Color[class*=-C192] { + color: #D7FF87 +} + +div.highlight .-Color[class*=-BGC192] { + background-color: #D7FF87 +} + +div.highlight .-Color[class*=-C193] { + color: #D7FFAF +} + +div.highlight .-Color[class*=-BGC193] { + background-color: #D7FFAF +} + +div.highlight .-Color[class*=-C194] { + color: #D7FFD7 +} + +div.highlight .-Color[class*=-BGC194] { + background-color: #D7FFD7 +} + +div.highlight .-Color[class*=-C195] { + color: #D7FFFF +} + +div.highlight .-Color[class*=-BGC195] { + background-color: #D7FFFF +} + +div.highlight .-Color[class*=-C196] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC196] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C197] { + color: #FF005F +} + +div.highlight .-Color[class*=-BGC197] { + background-color: #FF005F +} + +div.highlight .-Color[class*=-C198] { + color: #FF0087 +} + +div.highlight .-Color[class*=-BGC198] { + background-color: #FF0087 +} + +div.highlight .-Color[class*=-C199] { + color: #FF00AF +} + +div.highlight .-Color[class*=-BGC199] { + background-color: #FF00AF +} + +div.highlight .-Color[class*=-C200] { + color: #FF00D7 +} + +div.highlight .-Color[class*=-BGC200] { + background-color: #FF00D7 +} + +div.highlight .-Color[class*=-C201] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC201] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C202] { + color: #FF5F00 +} + +div.highlight .-Color[class*=-BGC202] { + background-color: #FF5F00 +} + +div.highlight .-Color[class*=-C203] { + color: #FF5F5F +} + +div.highlight .-Color[class*=-BGC203] { + background-color: #FF5F5F +} + +div.highlight .-Color[class*=-C204] { + color: #FF5F87 +} + +div.highlight .-Color[class*=-BGC204] { + background-color: #FF5F87 +} + +div.highlight .-Color[class*=-C205] { + color: #FF5FAF +} + +div.highlight .-Color[class*=-BGC205] { + background-color: #FF5FAF +} + +div.highlight .-Color[class*=-C206] { + color: #FF5FD7 +} + +div.highlight .-Color[class*=-BGC206] { + background-color: #FF5FD7 +} + +div.highlight .-Color[class*=-C207] { + color: #FF5FFF +} + +div.highlight .-Color[class*=-BGC207] { + background-color: #FF5FFF +} + +div.highlight .-Color[class*=-C208] { + color: #FF8700 +} + +div.highlight .-Color[class*=-BGC208] { + background-color: #FF8700 +} + +div.highlight .-Color[class*=-C209] { + color: #FF875F +} + +div.highlight .-Color[class*=-BGC209] { + background-color: #FF875F +} + +div.highlight .-Color[class*=-C210] { + color: #FF8787 +} + +div.highlight .-Color[class*=-BGC210] { + background-color: #FF8787 +} + +div.highlight .-Color[class*=-C211] { + color: #FF87AF +} + +div.highlight .-Color[class*=-BGC211] { + background-color: #FF87AF +} + +div.highlight .-Color[class*=-C212] { + color: #FF87D7 +} + +div.highlight .-Color[class*=-BGC212] { + background-color: #FF87D7 +} + +div.highlight .-Color[class*=-C213] { + color: #FF87FF +} + +div.highlight .-Color[class*=-BGC213] { + background-color: #FF87FF +} + +div.highlight .-Color[class*=-C214] { + color: #FFAF00 +} + +div.highlight .-Color[class*=-BGC214] { + background-color: #FFAF00 +} + +div.highlight .-Color[class*=-C215] { + color: #FFAF5F +} + +div.highlight .-Color[class*=-BGC215] { + background-color: #FFAF5F +} + +div.highlight .-Color[class*=-C216] { + color: #FFAF87 +} + +div.highlight .-Color[class*=-BGC216] { + background-color: #FFAF87 +} + +div.highlight .-Color[class*=-C217] { + color: #FFAFAF +} + +div.highlight .-Color[class*=-BGC217] { + background-color: #FFAFAF +} + +div.highlight .-Color[class*=-C218] { + color: #FFAFD7 +} + +div.highlight .-Color[class*=-BGC218] { + background-color: #FFAFD7 +} + +div.highlight .-Color[class*=-C219] { + color: #FFAFFF +} + +div.highlight .-Color[class*=-BGC219] { + background-color: #FFAFFF +} + +div.highlight .-Color[class*=-C220] { + color: #FFD700 +} + +div.highlight .-Color[class*=-BGC220] { + background-color: #FFD700 +} + +div.highlight .-Color[class*=-C221] { + color: #FFD75F +} + +div.highlight .-Color[class*=-BGC221] { + background-color: #FFD75F +} + +div.highlight .-Color[class*=-C222] { + color: #FFD787 +} + +div.highlight .-Color[class*=-BGC222] { + background-color: #FFD787 +} + +div.highlight .-Color[class*=-C223] { + color: #FFD7AF +} + +div.highlight .-Color[class*=-BGC223] { + background-color: #FFD7AF +} + +div.highlight .-Color[class*=-C224] { + color: #FFD7D7 +} + +div.highlight .-Color[class*=-BGC224] { + background-color: #FFD7D7 +} + +div.highlight .-Color[class*=-C225] { + color: #FFD7FF +} + +div.highlight .-Color[class*=-BGC225] { + background-color: #FFD7FF +} + +div.highlight .-Color[class*=-C226] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC226] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C227] { + color: #FFFF5F +} + +div.highlight .-Color[class*=-BGC227] { + background-color: #FFFF5F +} + +div.highlight .-Color[class*=-C228] { + color: #FFFF87 +} + +div.highlight .-Color[class*=-BGC228] { + background-color: #FFFF87 +} + +div.highlight .-Color[class*=-C229] { + color: #FFFFAF +} + +div.highlight .-Color[class*=-BGC229] { + background-color: #FFFFAF +} + +div.highlight .-Color[class*=-C230] { + color: #FFFFD7 +} + +div.highlight .-Color[class*=-BGC230] { + background-color: #FFFFD7 +} + +div.highlight .-Color[class*=-C231] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC231] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C232] { + color: #080808 +} + +div.highlight .-Color[class*=-BGC232] { + background-color: #080808 +} + +div.highlight .-Color[class*=-C233] { + color: #121212 +} + +div.highlight .-Color[class*=-BGC233] { + background-color: #121212 +} + +div.highlight .-Color[class*=-C234] { + color: #1C1C1C +} + +div.highlight .-Color[class*=-BGC234] { + background-color: #1C1C1C +} + +div.highlight .-Color[class*=-C235] { + color: #262626 +} + +div.highlight .-Color[class*=-BGC235] { + background-color: #262626 +} + +div.highlight .-Color[class*=-C236] { + color: #303030 +} + +div.highlight .-Color[class*=-BGC236] { + background-color: #303030 +} + +div.highlight .-Color[class*=-C237] { + color: #3A3A3A +} + +div.highlight .-Color[class*=-BGC237] { + background-color: #3A3A3A +} + +div.highlight .-Color[class*=-C238] { + color: #444444 +} + +div.highlight .-Color[class*=-BGC238] { + background-color: #444444 +} + +div.highlight .-Color[class*=-C239] { + color: #4E4E4E +} + +div.highlight .-Color[class*=-BGC239] { + background-color: #4E4E4E +} + +div.highlight .-Color[class*=-C240] { + color: #585858 +} + +div.highlight .-Color[class*=-BGC240] { + background-color: #585858 +} + +div.highlight .-Color[class*=-C241] { + color: #626262 +} + +div.highlight .-Color[class*=-BGC241] { + background-color: #626262 +} + +div.highlight .-Color[class*=-C242] { + color: #6C6C6C +} + +div.highlight .-Color[class*=-BGC242] { + background-color: #6C6C6C +} + +div.highlight .-Color[class*=-C243] { + color: #767676 +} + +div.highlight .-Color[class*=-BGC243] { + background-color: #767676 +} + +div.highlight .-Color[class*=-C244] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC244] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C245] { + color: #8A8A8A +} + +div.highlight .-Color[class*=-BGC245] { + background-color: #8A8A8A +} + +div.highlight .-Color[class*=-C246] { + color: #949494 +} + +div.highlight .-Color[class*=-BGC246] { + background-color: #949494 +} + +div.highlight .-Color[class*=-C247] { + color: #9E9E9E +} + +div.highlight .-Color[class*=-BGC247] { + background-color: #9E9E9E +} + +div.highlight .-Color[class*=-C248] { + color: #A8A8A8 +} + +div.highlight .-Color[class*=-BGC248] { + background-color: #A8A8A8 +} + +div.highlight .-Color[class*=-C249] { + color: #B2B2B2 +} + +div.highlight .-Color[class*=-BGC249] { + background-color: #B2B2B2 +} + +div.highlight .-Color[class*=-C250] { + color: #BCBCBC +} + +div.highlight .-Color[class*=-BGC250] { + background-color: #BCBCBC +} + +div.highlight .-Color[class*=-C251] { + color: #C6C6C6 +} + +div.highlight .-Color[class*=-BGC251] { + background-color: #C6C6C6 +} + +div.highlight .-Color[class*=-C252] { + color: #D0D0D0 +} + +div.highlight .-Color[class*=-BGC252] { + background-color: #D0D0D0 +} + +div.highlight .-Color[class*=-C253] { + color: #DADADA +} + +div.highlight .-Color[class*=-BGC253] { + background-color: #DADADA +} + +div.highlight .-Color[class*=-C254] { + color: #E4E4E4 +} + +div.highlight .-Color[class*=-BGC254] { + background-color: #E4E4E4 +} + +div.highlight .-Color[class*=-C255] { + color: #EEEEEE +} + +div.highlight .-Color[class*=-BGC255] { + background-color: #EEEEEE +} diff --git a/branch/2023-version/singlehtml/_static/plus.png b/branch/2023-version/singlehtml/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/branch/2023-version/singlehtml/_static/plus.png differ diff --git a/branch/2023-version/singlehtml/_static/pygments.css b/branch/2023-version/singlehtml/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/searchtools.js b/branch/2023-version/singlehtml/_static/searchtools.js new file mode 100644 index 00000000..7918c3fa --- /dev/null +++ b/branch/2023-version/singlehtml/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/branch/2023-version/singlehtml/_static/sphinx_highlight.js b/branch/2023-version/singlehtml/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/branch/2023-version/singlehtml/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.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: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/branch/2023-version/singlehtml/_static/sphinx_lesson.css b/branch/2023-version/singlehtml/_static/sphinx_lesson.css new file mode 100644 index 00000000..14b20c64 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/sphinx_lesson.css @@ -0,0 +1,51 @@ +/* sphinx_lesson.css */ + +body.wy-body-for-nav img.with-border { + border: 2px solid; +} + +.rst-content .admonition-no-content { + padding-bottom: 0px; +} + +.rst-content .demo > .admonition-title::before { + content: "\01F440"; /* Eyes */ } +.rst-content .type-along > .admonition-title::before { + content: "\02328\0FE0F"; /* Keyboard */ } +.rst-content .exercise > .admonition-title::before { + content: "\0270D\0FE0F"; /* Hand */ } +.rst-content .solution > .admonition-title::before { + content: "\02714\0FE0E"; /* Check mark */ } +.rst-content .homework > .admonition-title::before { + content: "\01F4DD"; /* Memo */ } +.rst-content .discussion > .admonition-title::before { + content: "\01F4AC"; /* Speech balloon */ } +.rst-content .questions > .admonition-title::before { + content: "\02753\0FE0E"; /* Question mark */ } +.rst-content .prerequisites > .admonition-title::before { + content: "\02699"; /* Gear */ } +.rst-content .seealso > .admonition-title::before { + content: "\027A1\0FE0E"; /* Question mark */ } + + +/* instructor-note */ +.rst-content .instructor-note { + background: #e7e7e7; +} +.rst-content .instructor-note > .admonition-title { + background: #6a6a6a; +} +.rst-content .instructor-note > .admonition-title::before { + content: ""; +} + + +/* sphinx_toggle_button, make the font white */ +.rst-content .toggle.admonition button.toggle-button { + color: white; +} + +/* sphinx-togglebutton, remove underflow when toggled to hidden mode */ +.rst-content .admonition.toggle-hidden { + padding-bottom: 0px; +} diff --git a/branch/2023-version/singlehtml/_static/sphinx_rtd_theme_ext_color_contrast.css b/branch/2023-version/singlehtml/_static/sphinx_rtd_theme_ext_color_contrast.css new file mode 100644 index 00000000..e68feb82 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/sphinx_rtd_theme_ext_color_contrast.css @@ -0,0 +1,47 @@ +/* The following are for web accessibility of sphinx_rtd_theme: they + * solve some of the most frequent contrast issues. Remove when this + * solved: + * https://github.com/readthedocs/sphinx_rtd_theme/issues/971 + */ +/* background: #fcfcfc, note boxes #E7F2FA */ +a { color: #2573A7; } /* original #2980B9, #1F5C84; */ +body { color: #242424; } /* original #404040, #383838 */ +.wy-side-nav-search>a, .wy-side-nav-search .wy-dropdown>a { + color: #ffffff; +} /* original #fcfcfc */ +footer { color: #737373; } /* original gray=#808080*/ +footer span.commit code, footer span.commit .rst-content tt, .rst-content footer span.commit tt { + color: #737373; +} /* original gray=#808080*/ +.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { + color: #AB2314; +} +/* Sidebar background */ +.wy-side-nav-search { background-color: #277CB4;} + +/* Same, but for pygments */ +.highlight .ch { color: #3E7A89; } /* #! line */ +.highlight .c1 { color: #3E7A89; } /* also comments */ +.highlight .nv { color: #AD3ECC; } /* variable */ +.highlight .gp { color: #B45608; } /* prompt character, $*/ +.highlight .si { color: #3975B1; } /* ${} variable text */ +.highlight .nc { color: #0C78A7; } + +/* Sphinx admonitions */ +/* warning */ +.wy-alert.wy-alert-warning .wy-alert-title, .rst-content .wy-alert-warning.note .wy-alert-title, .rst-content .attention .wy-alert-title, .rst-content .caution .wy-alert-title, .rst-content .wy-alert-warning.danger .wy-alert-title, .rst-content .wy-alert-warning.error .wy-alert-title, .rst-content .wy-alert-warning.hint .wy-alert-title, .rst-content .wy-alert-warning.important .wy-alert-title, .rst-content .wy-alert-warning.tip .wy-alert-title, .rst-content .warning .wy-alert-title, .rst-content .wy-alert-warning.seealso .wy-alert-title, .rst-content .admonition-todo .wy-alert-title, .rst-content .wy-alert-warning.admonition .wy-alert-title, .wy-alert.wy-alert-warning .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-warning .admonition-title, .rst-content .wy-alert-warning.note .admonition-title, .rst-content .attention .admonition-title, .rst-content .caution .admonition-title, .rst-content .wy-alert-warning.danger .admonition-title, .rst-content .wy-alert-warning.error .admonition-title, .rst-content .wy-alert-warning.hint .admonition-title, .rst-content .wy-alert-warning.important .admonition-title, .rst-content .wy-alert-warning.tip .admonition-title, .rst-content .warning .admonition-title, .rst-content .wy-alert-warning.seealso .admonition-title, .rst-content .admonition-todo .admonition-title, .rst-content .wy-alert-warning.admonition .admonition-title { + background: #B15E16; } +/* important */ +.wy-alert.wy-alert-success .wy-alert-title, .rst-content .wy-alert-success.note .wy-alert-title, .rst-content .wy-alert-success.attention .wy-alert-title, .rst-content .wy-alert-success.caution .wy-alert-title, .rst-content .wy-alert-success.danger .wy-alert-title, .rst-content .wy-alert-success.error .wy-alert-title, .rst-content .hint .wy-alert-title, .rst-content .important .wy-alert-title, .rst-content .tip .wy-alert-title, .rst-content .wy-alert-success.warning .wy-alert-title, .rst-content .wy-alert-success.seealso .wy-alert-title, .rst-content .wy-alert-success.admonition-todo .wy-alert-title, .rst-content .wy-alert-success.admonition .wy-alert-title, .wy-alert.wy-alert-success .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-success .admonition-title, .rst-content .wy-alert-success.note .admonition-title, .rst-content .wy-alert-success.attention .admonition-title, .rst-content .wy-alert-success.caution .admonition-title, .rst-content .wy-alert-success.danger .admonition-title, .rst-content .wy-alert-success.error .admonition-title, .rst-content .hint .admonition-title, .rst-content .important .admonition-title, .rst-content .tip .admonition-title, .rst-content .wy-alert-success.warning .admonition-title, .rst-content .wy-alert-success.seealso .admonition-title, .rst-content .wy-alert-success.admonition-todo .admonition-title, .rst-content .wy-alert-success.admonition .admonition-title { + background: #12826C; } +/* seealso, note, etc */ +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition .admonition-title { + background: #277CB4; } +/* error, danger */ +.rst-content .danger .admonition-title, .rst-content .danger .wy-alert-title, .rst-content .error .admonition-title, .rst-content .error .wy-alert-title, .rst-content .wy-alert-danger.admonition-todo .admonition-title, .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, .rst-content .wy-alert-danger.admonition .admonition-title, .rst-content .wy-alert-danger.admonition .wy-alert-title, .rst-content .wy-alert-danger.attention .admonition-title, .rst-content .wy-alert-danger.attention .wy-alert-title, .rst-content .wy-alert-danger.caution .admonition-title, .rst-content .wy-alert-danger.caution .wy-alert-title, .rst-content .wy-alert-danger.hint .admonition-title, .rst-content .wy-alert-danger.hint .wy-alert-title, .rst-content .wy-alert-danger.important .admonition-title, .rst-content .wy-alert-danger.important .wy-alert-title, .rst-content .wy-alert-danger.note .admonition-title, .rst-content .wy-alert-danger.note .wy-alert-title, .rst-content .wy-alert-danger.seealso .admonition-title, .rst-content .wy-alert-danger.seealso .wy-alert-title, .rst-content .wy-alert-danger.tip .admonition-title, .rst-content .wy-alert-danger.tip .wy-alert-title, .rst-content .wy-alert-danger.warning .admonition-title, .rst-content .wy-alert-danger.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-danger .admonition-title, .wy-alert.wy-alert-danger .rst-content .admonition-title, .wy-alert.wy-alert-danger .wy-alert-title { + background: #e31704; +} + +/* Generic admonition titles */ +.wy-alert-title, .rst-content .admonition-title { + background: #277CB4; } diff --git a/branch/2023-version/singlehtml/_static/tabs.css b/branch/2023-version/singlehtml/_static/tabs.css new file mode 100644 index 00000000..957ba60d --- /dev/null +++ b/branch/2023-version/singlehtml/_static/tabs.css @@ -0,0 +1,89 @@ +.sphinx-tabs { + margin-bottom: 1rem; +} + +[role="tablist"] { + border-bottom: 1px solid #a0b3bf; +} + +.sphinx-tabs-tab { + position: relative; + font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif; + color: #1D5C87; + line-height: 24px; + margin: 0; + font-size: 16px; + font-weight: 400; + background-color: rgba(255, 255, 255, 0); + border-radius: 5px 5px 0 0; + border: 0; + padding: 1rem 1.5rem; + margin-bottom: 0; +} + +.sphinx-tabs-tab[aria-selected="true"] { + font-weight: 700; + border: 1px solid #a0b3bf; + border-bottom: 1px solid white; + margin: -1px; + background-color: white; +} + +.sphinx-tabs-tab:focus { + z-index: 1; + outline-offset: 1px; +} + +.sphinx-tabs-panel { + position: relative; + padding: 1rem; + border: 1px solid #a0b3bf; + margin: 0px -1px -1px -1px; + border-radius: 0 0 5px 5px; + border-top: 0; + background: white; +} + +.sphinx-tabs-panel.code-tab { + padding: 0.4rem; +} + +.sphinx-tab img { + margin-bottom: 24 px; +} + +/* Dark theme preference styling */ + +@media (prefers-color-scheme: dark) { + body[data-theme="auto"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); + } + + body[data-theme="auto"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); + } + + body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 1px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); + } +} + +/* Explicit dark theme styling */ + +body[data-theme="dark"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); +} + +body[data-theme="dark"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); +} + +body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 2px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); +} diff --git a/branch/2023-version/singlehtml/_static/tabs.js b/branch/2023-version/singlehtml/_static/tabs.js new file mode 100644 index 00000000..48dc303c --- /dev/null +++ b/branch/2023-version/singlehtml/_static/tabs.js @@ -0,0 +1,145 @@ +try { + var session = window.sessionStorage || {}; +} catch (e) { + var session = {}; +} + +window.addEventListener("DOMContentLoaded", () => { + const allTabs = document.querySelectorAll('.sphinx-tabs-tab'); + const tabLists = document.querySelectorAll('[role="tablist"]'); + + allTabs.forEach(tab => { + tab.addEventListener("click", changeTabs); + }); + + tabLists.forEach(tabList => { + tabList.addEventListener("keydown", keyTabs); + }); + + // Restore group tab selection from session + const lastSelected = session.getItem('sphinx-tabs-last-selected'); + if (lastSelected != null) selectNamedTabs(lastSelected); +}); + +/** + * Key focus left and right between sibling elements using arrows + * @param {Node} e the element in focus when key was pressed + */ +function keyTabs(e) { + const tab = e.target; + let nextTab = null; + if (e.keyCode === 39 || e.keyCode === 37) { + tab.setAttribute("tabindex", -1); + // Move right + if (e.keyCode === 39) { + nextTab = tab.nextElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.firstElementChild; + } + // Move left + } else if (e.keyCode === 37) { + nextTab = tab.previousElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.lastElementChild; + } + } + } + + if (nextTab !== null) { + nextTab.setAttribute("tabindex", 0); + nextTab.focus(); + } +} + +/** + * Select or deselect clicked tab. If a group tab + * is selected, also select tab in other tabLists. + * @param {Node} e the element that was clicked + */ +function changeTabs(e) { + // Use this instead of the element that was clicked, in case it's a child + const notSelected = this.getAttribute("aria-selected") === "false"; + const positionBefore = this.parentNode.getBoundingClientRect().top; + const notClosable = !this.parentNode.classList.contains("closeable"); + + deselectTabList(this); + + if (notSelected || notClosable) { + selectTab(this); + const name = this.getAttribute("name"); + selectNamedTabs(name, this.id); + + if (this.classList.contains("group-tab")) { + // Persist during session + session.setItem('sphinx-tabs-last-selected', name); + } + } + + const positionAfter = this.parentNode.getBoundingClientRect().top; + const positionDelta = positionAfter - positionBefore; + // Scroll to offset content resizing + window.scrollTo(0, window.scrollY + positionDelta); +} + +/** + * Select tab and show associated panel. + * @param {Node} tab tab to select + */ +function selectTab(tab) { + tab.setAttribute("aria-selected", true); + + // Show the associated panel + document + .getElementById(tab.getAttribute("aria-controls")) + .removeAttribute("hidden"); +} + +/** + * Hide the panels associated with all tabs within the + * tablist containing this tab. + * @param {Node} tab a tab within the tablist to deselect + */ +function deselectTabList(tab) { + const parent = tab.parentNode; + const grandparent = parent.parentNode; + + Array.from(parent.children) + .forEach(t => t.setAttribute("aria-selected", false)); + + Array.from(grandparent.children) + .slice(1) // Skip tablist + .forEach(panel => panel.setAttribute("hidden", true)); +} + +/** + * Select grouped tabs with the same name, but no the tab + * with the given id. + * @param {Node} name name of grouped tab to be selected + * @param {Node} clickedId id of clicked tab + */ +function selectNamedTabs(name, clickedId=null) { + const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`); + const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode); + + tabLists + .forEach(tabList => { + // Don't want to change the tabList containing the clicked tab + const clickedTab = tabList.querySelector(`[id="${clickedId}"]`); + if (clickedTab === null ) { + // Select first tab with matching name + const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`); + deselectTabList(tab); + selectTab(tab); + } + }) +} + +if (typeof exports === 'undefined') { + exports = {}; +} + +exports.keyTabs = keyTabs; +exports.changeTabs = changeTabs; +exports.selectTab = selectTab; +exports.deselectTabList = deselectTabList; +exports.selectNamedTabs = selectNamedTabs; diff --git a/branch/2023-version/singlehtml/_static/term_role_formatting.css b/branch/2023-version/singlehtml/_static/term_role_formatting.css new file mode 100644 index 00000000..0b66095c --- /dev/null +++ b/branch/2023-version/singlehtml/_static/term_role_formatting.css @@ -0,0 +1,4 @@ +/* Make terms bold */ +a.reference span.std-term { + font-weight: bold; +} diff --git a/branch/2023-version/singlehtml/_static/togglebutton.css b/branch/2023-version/singlehtml/_static/togglebutton.css new file mode 100644 index 00000000..54a67879 --- /dev/null +++ b/branch/2023-version/singlehtml/_static/togglebutton.css @@ -0,0 +1,160 @@ +/** + * Admonition-based toggles + */ + +/* Visibility of the target */ +.admonition.toggle .admonition-title ~ * { + transition: opacity .3s, height .3s; +} + +/* Toggle buttons inside admonitions so we see the title */ +.admonition.toggle { + position: relative; +} + +/* Titles should cut off earlier to avoid overlapping w/ button */ +.admonition.toggle .admonition-title { + padding-right: 25%; + cursor: pointer; +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:hover { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 1%); +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:active { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 3%); +} + +/* Remove extra whitespace below the admonition title when hidden */ +.admonition.toggle-hidden { + padding-bottom: 0; +} + +.admonition.toggle-hidden .admonition-title { + margin-bottom: 0; +} + +/* hides all the content of a page until de-toggled */ +.admonition.toggle-hidden .admonition-title ~ * { + height: 0; + margin: 0; + opacity: 0; + visibility: hidden; +} + +/* General button style and position*/ +button.toggle-button { + /** + * Background and shape. By default there's no background + * but users can style as they wish + */ + background: none; + border: none; + outline: none; + + /* Positioning just inside the admonition title */ + position: absolute; + right: 0.5em; + padding: 0px; + border: none; + outline: none; +} + +/* Display the toggle hint on wide screens */ +@media (min-width: 768px) { + button.toggle-button.toggle-button-hidden:before { + content: attr(data-toggle-hint); /* This will be filled in by JS */ + font-size: .8em; + align-self: center; + } +} + +/* Icon behavior */ +.tb-icon { + transition: transform .2s ease-out; + height: 1.5em; + width: 1.5em; + stroke: currentColor; /* So that we inherit the color of other text */ +} + +/* The icon should point right when closed, down when open. */ +/* Open */ +.admonition.toggle button .tb-icon { + transform: rotate(90deg); +} + +/* Closed */ +.admonition.toggle button.toggle-button-hidden .tb-icon { + transform: rotate(0deg); +} + +/* With details toggles, we don't rotate the icon so it points right */ +details.toggle-details .tb-icon { + height: 1.4em; + width: 1.4em; + margin-top: 0.1em; /* To center the button vertically */ +} + + +/** + * Details-based toggles. + * In this case, we wrap elements with `.toggle` in a details block. + */ + +/* Details blocks */ +details.toggle-details { + margin: 1em 0; +} + + +details.toggle-details summary { + display: flex; + align-items: center; + cursor: pointer; + list-style: none; + border-radius: .2em; + border-left: 3px solid #1976d2; + background-color: rgb(204 204 204 / 10%); + padding: 0.2em 0.7em 0.3em 0.5em; /* Less padding on left because the SVG has left margin */ + font-size: 0.9em; +} + +details.toggle-details summary:hover { + background-color: rgb(204 204 204 / 20%); +} + +details.toggle-details summary:active { + background: rgb(204 204 204 / 28%); +} + +.toggle-details__summary-text { + margin-left: 0.2em; +} + +details.toggle-details[open] summary { + margin-bottom: .5em; +} + +details.toggle-details[open] summary .tb-icon { + transform: rotate(90deg); +} + +details.toggle-details[open] summary ~ * { + animation: toggle-fade-in .3s ease-out; +} + +@keyframes toggle-fade-in { + from {opacity: 0%;} + to {opacity: 100%;} +} + +/* Print rules - we hide all toggle button elements at print */ +@media print { + /* Always hide the summary so the button doesn't show up */ + details.toggle-details summary { + display: none; + } +} \ No newline at end of file diff --git a/branch/2023-version/singlehtml/_static/togglebutton.js b/branch/2023-version/singlehtml/_static/togglebutton.js new file mode 100644 index 00000000..215a7eef --- /dev/null +++ b/branch/2023-version/singlehtml/_static/togglebutton.js @@ -0,0 +1,187 @@ +/** + * Add Toggle Buttons to elements + */ + +let toggleChevron = ` + + + +`; + +var initToggleItems = () => { + var itemsToToggle = document.querySelectorAll(togglebuttonSelector); + console.log(`[togglebutton]: Adding toggle buttons to ${itemsToToggle.length} items`) + // Add the button to each admonition and hook up a callback to toggle visibility + itemsToToggle.forEach((item, index) => { + if (item.classList.contains("admonition")) { + // If it's an admonition block, then we'll add a button inside + // Generate unique IDs for this item + var toggleID = `toggle-${index}`; + var buttonID = `button-${toggleID}`; + + item.setAttribute('id', toggleID); + if (!item.classList.contains("toggle")){ + item.classList.add("toggle"); + } + // This is the button that will be added to each item to trigger the toggle + var collapseButton = ` + `; + + title = item.querySelector(".admonition-title") + title.insertAdjacentHTML("beforeend", collapseButton); + thisButton = document.getElementById(buttonID); + + // Add click handlers for the button + admonition title (if admonition) + admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`) + if (admonitionTitle) { + // If an admonition, then make the whole title block clickable + admonitionTitle.addEventListener('click', toggleClickHandler); + admonitionTitle.dataset.target = toggleID + admonitionTitle.dataset.button = buttonID + } else { + // If not an admonition then we'll listen for the button click + thisButton.addEventListener('click', toggleClickHandler); + } + + // Now hide the item for this toggle button unless explicitly noted to show + if (!item.classList.contains("toggle-shown")) { + toggleHidden(thisButton); + } + } else { + // If not an admonition, wrap the block in a
block + // Define the structure of the details block and insert it as a sibling + var detailsBlock = ` +
+ + ${toggleChevron} + ${toggleHintShow} + +
`; + item.insertAdjacentHTML("beforebegin", detailsBlock); + + // Now move the toggle-able content inside of the details block + details = item.previousElementSibling + details.appendChild(item) + item.classList.add("toggle-details__container") + + // Set up a click trigger to change the text as needed + details.addEventListener('click', (click) => { + let parent = click.target.parentElement; + if (parent.tagName.toLowerCase() == "details") { + summary = parent.querySelector("summary"); + details = parent; + } else { + summary = parent; + details = parent.parentElement; + } + // Update the inner text for the proper hint + if (details.open) { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintShow; + } else { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintHide; + } + + }); + + // If we have a toggle-shown class, open details block should be open + if (item.classList.contains("toggle-shown")) { + details.click(); + } + } + }) +}; + +// This should simply add / remove the collapsed class and change the button text +var toggleHidden = (button) => { + target = button.dataset['target'] + var itemToToggle = document.getElementById(target); + if (itemToToggle.classList.contains("toggle-hidden")) { + itemToToggle.classList.remove("toggle-hidden"); + button.classList.remove("toggle-button-hidden"); + } else { + itemToToggle.classList.add("toggle-hidden"); + button.classList.add("toggle-button-hidden"); + } +} + +var toggleClickHandler = (click) => { + // Be cause the admonition title is clickable and extends to the whole admonition + // We only look for a click event on this title to trigger the toggle. + + if (click.target.classList.contains("admonition-title")) { + button = click.target.querySelector(".toggle-button"); + } else if (click.target.classList.contains("tb-icon")) { + // We've clicked the icon and need to search up one parent for the button + button = click.target.parentElement; + } else if (click.target.tagName == "polyline") { + // We've clicked the SVG elements inside the button, need to up 2 layers + button = click.target.parentElement.parentElement; + } else if (click.target.classList.contains("toggle-button")) { + // We've clicked the button itself and so don't need to do anything + button = click.target; + } else { + console.log(`[togglebutton]: Couldn't find button for ${click.target}`) + } + target = document.getElementById(button.dataset['button']); + toggleHidden(target); +} + +// If we want to blanket-add toggle classes to certain cells +var addToggleToSelector = () => { + const selector = ""; + if (selector.length > 0) { + document.querySelectorAll(selector).forEach((item) => { + item.classList.add("toggle"); + }) + } +} + +// Helper function to run when the DOM is finished +const sphinxToggleRunWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} +sphinxToggleRunWhenDOMLoaded(addToggleToSelector) +sphinxToggleRunWhenDOMLoaded(initToggleItems) + +/** Toggle details blocks to be open when printing */ +if (toggleOpenOnPrint == "true") { + window.addEventListener("beforeprint", () => { + // Open the details + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.dataset["togglestatus"] = el.open; + el.open = true; + }); + + // Open the admonitions + document.querySelectorAll(".admonition.toggle.toggle-hidden").forEach((el) => { + console.log(el); + el.querySelector("button.toggle-button").click(); + el.dataset["toggle_after_print"] = "true"; + }); + }); + window.addEventListener("afterprint", () => { + // Re-close the details that were closed + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.open = el.dataset["togglestatus"] == "true"; + delete el.dataset["togglestatus"]; + }); + + // Re-close the admonition toggle buttons + document.querySelectorAll(".admonition.toggle").forEach((el) => { + if (el.dataset["toggle_after_print"] == "true") { + el.querySelector("button.toggle-button").click(); + delete el.dataset["toggle_after_print"]; + } + }); + }); +} diff --git a/branch/2023-version/singlehtml/index.html b/branch/2023-version/singlehtml/index.html new file mode 100644 index 00000000..68c9ea51 --- /dev/null +++ b/branch/2023-version/singlehtml/index.html @@ -0,0 +1,4193 @@ + + + + + + + Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Introduction to version control with Git documentation
    • +
  • + Edit on GitHub +
    • +
+
+
+
+
+ +
+

Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version

+

This is the introductory lesson to version control using +Git. It is assumed to be the very first thing +done in a course.

+

Our philosophy is that we start from own local repository, branching and +merging (locally), and a brief introduction to pushing to remotes. In +the separate collaborative Git +lesson, we teach more use of +remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with +Git to be able to work well. We try to avoid commands which might get +you into a confusing state.

+

The goals of the module as a whole are that the user will feel +comfortable about staging changes, committing them, merging, and +branching.

+
+

Prerequisites

+
    +

  • A reasonably recent version of Git (ideal is 2.28 or newer but we +recommend at least 2.23) is installed and configured (installation +instructions). But also on older +Git (2.0) the workshop will work and we will offer workarounds for Git below 2.28 +or 2.23.

    • +

  • For one of the episodes we need a GitHub user +account (but alternatives exist, see below).

    • +

  • Being comfortable with the command line. No expertise is required, but +the lesson will be mostly taken from the command line. For most commands, where reasonable, +we also offer the possibility to participate through the browser.

    • +

  • To edit files on the local computer, learners should be familiar with +using a text editor on their system. If you are new to text editors, +we recommend to start with Nano or VS Code.

    • +
+
+
+
+

Motivation

+
+

Objectives

+
    +

  • Make sure nobody leaves the workshop without starting to use some form of version control.

    • +

  • Discuss the reasons why we advocate distributed version control.

    • +
+
+
+

Instructor note

+
    +

  • 15 min teaching/demonstration

    • +
+
+
+

Git is all about keeping track of changes

+

We will learn how to keep track of changes first in a terminal (example +repository):

+
+Screenshot of a git log in terminal +
+

Later also via web interface (example +repository):

+
+Screenshot of a git log on GitHub +
+
+
+

Why do we need to keep track of versions?

+

Version control is an answer to these questions (do you recognize some of them?):

+
    +

  • “It broke … hopefully I have a working version somewhere?”

    • +

  • “Can you please send me the latest version?”

    • +

  • “Where is the latest version?”

    • +

  • “Which version are you using?”

    • +

  • “Which version have the authors used in the paper I am trying to reproduce?”

    • +

  • “Found a bug! Since when was it there?”

    • +

  • “I am sure it used to work. When did it change?”

    • +

  • “My laptop is gone. Is my thesis now gone?”

    • +
+
+
+

Features: roll-back, branching, merging, collaboration

+
    +

  • Roll-back: you can always go back to a previous version and compare

    • +

  • Branching and merging:

    +
      +

    • Work on different ideas at the same time

      • +

    • Different people can work on the same code/project without interfering

      • +

    • You can experiment with an idea and discard it if it turns out to be a bad idea

      • +
    +
    • +
+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+ +
+
+

Reproducibility

+
    +

  • How do you indicate which version of your code you have used in your paper?

    • +

  • When you find a bug, how do you know when precisely this bug was introduced +(Are published results affected? Do you need to inform collaborators or users of your code?).

    • +
+

With version control we can “annotate” code (browse this example online):

+
+Example of a git-annotated code with code and history side-by-side +
+

Example of a git-annotated code with code and history side-by-side.

+
+
+
+
+

Talking about code

+

Which of these two is more practical?

+
    +

  • “Clone the code, go to the file ‘src/util.rs’, and search for ‘time_iso8601’”. +Oh! But make sure you use the version from August 2023.”

    • +

  • Or I can send you a permalink:

    • +
+
+Screen-shot of a code portion +
+

Permalink that points to a code portion.

+
+
+
+
+

What we typically like to snapshot

+
    +

  • Software (this is how it started but Git/GitHub can track a lot more)

    • +

  • Scripts

    • +

  • Documents (plain text files much better suitable than Word documents)

    • +

  • Manuscripts (Git is great for collaborating/sharing LaTeX or Quarto manuscripts)

    • +

  • Configuration files

    • +

  • Website sources

    • +

  • Data

    • +
+
+

Discussion

+

In this example somebody tried to keep track of versions without a version +control system tool like Git. Discuss the following directory listing. What +possible problems do you anticipate with this kind of “version control”:

+
myproject-2019.zip
+myproject-2020-February.zip
+myproject-2021-August.zip
+myproject-2023-09-19-working.zip
+myproject-2023-09-21.zip
+myproject-2023-09-21-test.zip
+myproject-2023-09-21-myversion.zip
+myproject-2023-09-21-newfeature.zip
+...
+
+
+ +
+
+
+

Difficulties of version control

+

Despite the benefits, let’s be honest, there are some difficulties:

+
    +

  • One more thing to learn (it’s probably worth it and will save you more time in the long run; basic career skill).

    • +

  • Difficult if your collaborators don’t want to use it (in the worst case, you can version control on your side and email them versions).

    • +

  • Advanced things can be difficult, but basics are often enough (ask others for help when needed).

    • +
+
+
+

Why Git and not another tool?

+
    +

  • Easy to set up: no server needed.

    • +

  • Very popular: chances are high you will need to contribute to somebody else’s code which is tracked with Git.

    • +

  • Distributed: good backup, no single point of failure, you can track and +clean-up changes offline, simplifies collaboration model for open-source +projects.

    • +

  • Important platforms such as GitHub, GitLab, and Bitbucket +build on top of Git.

    • +
+

However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +Subversion, +Mercurial, Pijul, or others.

+
+
+
+
+

Basics

+
+

Objectives

+
    +

  • Learn to create Git repositories and make commits.

    • +

  • Get a grasp of the structure of a repository.

    • +

  • Learn how to inspect the project history.

    • +

  • Learn how to write useful commit log messages.

    • +
+
+
+

Instructor note

+
    +

  • 35 min teaching/type-along

    • +

  • 40 min exercise

    • +
+
+
+

What is Git, and what is a Git repository?

+
    +

  • Git is a version control system: can record/save snapshots and track the content of a folder as it changes over time.

    • +

  • Every time we commit a snapshot, Git records a snapshot of the entire project, saves it, and assigns it a version.

    • +

  • These snapshots are kept inside a sub-folder called .git.

    • +

  • If we remove .git, we remove the repository and history (but keep the working directory!).

    • +

  • The directory .git uses relative paths - you can move the whole repository somewhere else and it will still work.

    • +

  • Git doesn’t do anything unless you ask it to (it does not record anything automatically).

    • +

  • Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces).

    • +
+
+
+

Recording a snapshot with Git

+
    +

  • Git takes snapshots only if we request it.

    • +

  • We will record changes in two steps (we will later explain why this is a recommended practice).

    • +

  • Example (we don’t need to type yet):

    +
    $ git add FILE.txt
+$ git commit
+
+$ git add FILE.txt ANOTHERFILE.txt
+$ git commit
+
    +
    +
    • +

  • We first focus (git add, we “stage” the change), then record (git commit):

    • +
+
+Git staging +
+

Git staging and committing.

+
+
+
+

Question for the more advanced participants

+

What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end.

+
+
+
+

Configuring Git command line

+

Before we start using Git on the command line, we need to configure Git. +This is also part of the +installation instructions +but we need to make sure we all have +set name, email address, editor, and +default branch:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+$ git config --global core.editor nano
+$ git config --global init.defaultBranch main
+
+
+

Verify with:

+
$ git config --list
+
+
+
+

Instructor note

+

Instructors, give learners enough time to do the above configuration steps.

+
+
+
+

Type-along: Tracking a guacamole recipe with Git

+

We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list)

+

The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language.

+
+

Instructor note

+

Instructors, please encourage now that participants type along.

+
+
+

Note

+

It is possible to go through this lesson in the command line or in the browser +(on GitHub).

+
    +

  • We recommend to start with the command line but later to also try in the browser.

    • +

  • If you get really stuck in the command line, try following in the browser and +later you can try to return to the command line.

    • +
+
+
+
+

Creating a repository

+

One of the basic principles of Git is that it is easy to create repositories:

+
+
$ mkdir recipe
+$ cd recipe
+$ git init -b main
+
+
+

That’s it! With git init -b main have now created an empty Git repository +where main is the default branch (more about branches later).

+

We will use git status a lot to check out what is going on:

+
$ git status
+
+On branch main
+
+No commits yet
+
+nothing to commit (create/copy files and use "git add" to track)
+
+
+

We will make sense of this information during this workshop.

+
+
+
+

Adding files and committing changes

+

Let us now create two files.

+

One file is called ingredients.txt and contains:

+
* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+
+
+

The second file is called instructions.txt and contains:

+
* chop avocados
+* chop onion
+* chop chili
+* squeeze lime
+* add salt
+* and mix well
+
+
+
+

As mentioned above, in Git you can always check the status of files in your repository using +git status. It is always a safe command to run and in general a good idea to +do when you are trying to figure out what to do next:

+
$ git status
+
+On branch main
+
+No commits yet
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    ingredients.txt
+    instructions.txt
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+

The two files are untracked in the repository (directory). You want to add the files (focus the camera) +to the list of files tracked by Git. Git does not track +any files automatically and you need make a conscious decision to add a file. Let’s do what +Git hints at, and add the files, one by one:

+
$ git add ingredients.txt
+$ git status
+
+On branch main
+
+No commits yet
+
+Changes to be committed:
+  (use "git rm --cached <file>..." to unstage)
+    new file:   ingredients.txt
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    instructions.txt
+
+
+

Now this change is staged and ready to be committed. +Let us now commit the change to the repository:

+
$ git commit -m "adding ingredients"
+
+[main (root-commit) f146d25] adding ingredients
+ 1 file changed, 4 insertions(+)
+ create mode 100644 ingredients.txt
+
+
+

Right after we query the status to get this useful command into our muscle memory:

+
$ git status
+
+
+

Now stage and commit also the other file:

+
$ git add instructions.txt
+$ git commit -m "adding instructions"
+
+
+

We will add a third file to the repository, README.md, containing:

+
# recipe
+
+This is an exercise repository.
+
+
+

Now stage and commit also the README.md file:

+
$ git add README.md
+$ git commit -m "adding README"
+
+
+

What does the -m flag mean? Let us check the help page for that command:

+
$ git help commit
+
+
+

You should see a very long help page as the tool is very versatile (press q to quit). +Do not worry about this now but keep in mind that you can always read the help files +when in doubt. Searching online can also be useful, but choosing search terms +to find relevant information takes some practice and discussions in some +online threads may be confusing. +Note that help pages also work when you don’t have a network connection!

+
+
+
+

Exercise: Record changes

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+
+
+

Git history and log

+
+

If you haven’t yet, please try now git log:

+
$ git log
+
+commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main)
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:47 2023 +0200
+
+    don't forget to enjoy
+
+commit 79161b6e67c62ad4688a58c1e54183334611a390
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:32 2023 +0200
+
+    add half an onion
+
+commit a3394e39535343c4dae3bb4f703741a31aa8b78a
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:47:14 2023 +0200
+
+    adding README
+
+commit 369624674e63de48055a65bf63055bd59c985d22
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:46:58 2023 +0200
+
+    adding instructions
+
+commit f146d25b94569a15e94d7f0da6f15d7554f76c49
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:35:52 2023 +0200
+
+    adding ingredients
+
+
+
+
    +

  • We can browse the development and access each state that we have committed.

    • +

  • The long hashes uniquely label a state of the code.

    • +

  • They are not just integers counting 1, 2, 3, 4, … (why?).

    • +

  • Output is in reverse chronological order, i.e. newest commits on top.

    • +

  • We will use them when comparing versions and when going back in time.

    • +

  • git log --oneline only shows the first 7 characters of the commit hash and is good to get an overview.

    • +

  • If the first characters of the hash are unique it is not necessary to type the entire hash.

    • +

  • git log --stat is nice to show which files have been modified.

    • +
+
+
+

Optional exercises: Comparing changes

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+
+
+

Writing useful commit messages

+

Using git log --oneline or browsing a repository on the web, we better +understand that the first line of the commit message is very important.

+

Good example:

+
increase threshold alpha to 2.0
+
+the motivation for this change is
+to enable ...
+...
+this is based on a discussion in #123
+
+
+

Convention: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

Ignoring files and paths with .gitignore

+
+

Discussion

+
    +

  • Should we add and track all files in a project?

    • +

  • How about generated files?

    • +

  • Why is it considered a bad idea to commit compiled binaries to version control?

    • +

  • What types of generated files do you know?

    • +
+
+

Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files. Example:

+
# ignore compiled python 2 files
+*.pyc
+# ignore compiled python 3 files
+__pycache__
+
+
+

An example taken from the official Git documentation:

+
# ignore objects and archives, anywhere in the tree.
+*.[oa]
+# ignore generated html files,
+*.html
+# except foo.html which is maintained by hand
+!foo.html
+# ignore everything under build directory
+build/
+
+
+
    +

  • .gitignore should be part of the repository because we want to make sure that all developers see the same behavior.

    • +

  • All files should be either tracked or ignored.

    • +

  • .gitignore uses something called a +shell glob syntax for +determining file patterns to ignore. You can read more about the syntax in the +documentation.

    • +

  • You can have .gitignore files in lower level directories and they affect the paths below.

    • +
+
+
+

Graphical user interfaces

+

We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI):

+ +
+
+

Summary

+

Now we know how to save snapshots:

+
$ git add FILE(S)
+$ git commit
+
+
+

And this is what we do as we program.

+

Every state is then saved and later we will learn how to go back to these “checkpoints” +and how to undo things.

+
$ git init -b main  # initialize new repository (main is default branch)
+$ git add           # add files or stage file(s)
+$ git commit        # commit staged file(s)
+$ git status        # see what is going on
+$ git log           # see history
+$ git diff          # show unstaged/uncommitted modifications
+$ git show          # show the change for a specific commit
+$ git mv            # move/rename tracked files
+$ git rm            # remove tracked files
+
+
+

Git is not ideal for large binary files +(for this consider git-annex).

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • It takes only one command to initialize a Git repository: git init -b main.

    • +

  • Commits should be used to tell a story.

    • +

  • Git uses the .git folder to store the snapshots.

    • +

  • Don’t be afraid to stage and commit often. Better too often than not often enough.

    • +
+
+
+
+
+

Branching and merging

+
+

Objectives

+
    +

  • Be able to create and merge branches.

    • +

  • Know the difference between a branch and a tag.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Motivation for branches

+

In the previous section we tracked a guacamole recipe with Git.

+

Up until now our repository had only one branch with one commit coming +after the other:

+
+Linear Git repository +
+

Linear Git repository.

+
+
+
    +

  • Commits are depicted here as little boxes with abbreviated hashes.

    • +

  • Here the branch main points to a commit.

    • +

  • “HEAD” is the current position (remember the recording head of tape +recorders?). When we say HEAD, we mean those literal letters - +this isn’t a placeholder for something else.

    • +

  • When we talk about branches, we often mean all parent commits, not only the commit pointed to.

    • +
+

Now we want to do this:

+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+

Software development is often not linear:

+
    +

  • We typically need at least one version of the code to “work” (to compile, to give expected results, …).

    • +

  • At the same time we work on new features, often several features concurrently. +Often they are unfinished.

    • +

  • We need to be able to separate different lines of work really well.

    • +
+

The strength of version control is that it permits the researcher to isolate +different tracks of work, which can later be merged to create a composite +version that contains all changes:

+
+Isolated tracks of work +
+

Isolated tracks of work.

+
+
+
    +

  • We see branching points and merging points.

    • +

  • Main line development is often called main or master.

    • +

  • Other than this convention there is nothing special about main or master, it is a branch like any other.

    • +

  • Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow).

    • +
+

A group of commits that create a single narrative are called a branch. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. “fast sequence extraction” or “Python interface” or “fixing bug in +matrix inversion algorithm”.

+
+

An important alias

+

We will now define an alias in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). This is extensively used in the rest of this +and other lessons:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+
+
+

Instructor note

+

Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative.

+
+

Let us inspect the project history using the git graph alias:

+
$ git graph
+
+* e7cf023 (HEAD -> main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • We have a couple commits and only +one development line (branch) and this branch is called main.

    • +

  • Commits are states characterized by a 40-character hash (checksum).

    • +

  • git graph print abbreviations of these checksums.

    • +

  • Branches are pointers that point to a commit.

    • +

  • Branch main points to a commit (in this example it is e7cf023efe382340e5284c278c6ae2c087dd3ff7 but on your computer +the hash will be different).

    • +

  • HEAD is another pointer, it points to where we are right now (currently main)

    • +
+

In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards.

+
+
+

Creating and working with branches

+
+

Instructor note

+

We do the following part together. Encourage participants to type along.

+
+
+

It is possible to create and merge branches directly on GitHub

+
    +

  • However, we do not have screenshots for that in this episode

    • +

  • But if you prefer to work in the browser, please try it

    • +

  • Please contribute screenshots to this lesson

    • +
+
+

Let’s create a branch called experiment where we add cilantro to ingredients.txt +(text after “#” are comments and not part of the command).

+
$ git branch experiment main  # creates branch "experiment" from "main"
+$ git switch experiment       # switch to branch "experiment"
+$ git branch                  # list all local branches and show on which branch we are
+
+
+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+
    +

  • Verify that you are on the experiment branch (note that git graph also +makes it clear what branch you are on: HEAD -> branchname):

    +
    $ git branch
+
+* experiment
+  main
+
    +
    +

    This command shows where we are, it does not create a branch.

    +
    • +

  • Then add 2 tbsp cilantro on top of the ingredients.txt:

    +
    * 2 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+* 1/2 onion
+
    +
    +
    • +

  • Stage this and commit it with the message “let us try with some cilantro”.

    • +

  • Then reduce the amount of cilantro to 1 tbsp, stage and commit again with “maybe little bit less cilantro”.

    • +
+

We have created two new commits:

+
$ git graph
+
+* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro
+* f6ec7b7 let us try with some cilantro
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • The branch experiment is two commits ahead of main.

    • +

  • We commit our changes to this branch.

    • +
+
+
+

Exercise: Create and commit to branches

+
+

Branch-1: Create and commit to branches

+

In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging. The goal of the exercise is to end up with 3 branches.

+
    +

  • Change to the branch main.

    • +

  • Create another branch called less-salt.

    +
      +

    • Note! makes sure you are on main branch when you create the less-salt branch.

      • +

    • A safer way would be to explicitly mention to create from the main branch +as shown below:

      +
      $ git branch less-salt main
+
      +
      +
      • +
    +
    • +

  • Switch to the less-salt branch.

    • +

  • On the less-salt branch reduce the amount of salt.

    • +

  • Commit your changes to the less-salt branch.

    • +
+

Use the same commands as we used above.

+

We now have three branches (in this case HEAD points to less-salt):

+
$ git branch
+
+  experiment
+* less-salt
+  main
+
+$ git graph
+
+* bf28166 (HEAD -> less-salt) reduce amount of salt
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Here is a graphical representation of what we have created:

+
+_images/git-branch-2.svg
+
    +

  • Now switch to main.

    • +

  • In a new commit, improve the README.md file (we added the word “Guacamole”):

    +
    # Guacamole recipe
+
+This is an exercise repository.
+
    +
    +
    • +
+

Now you should have this situation:

+
$ git graph
+
+* b4af65b (HEAD -> main) improve the documentation
+| * bf28166 (less-salt) reduce amount of salt
+|/
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
+_images/git-branch-3.svg
+

And for comparison this is how it looks on GitHub.

+
+
+
+

Exercise: Merging branches

+

It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge experiment into main.

+
+

Branch-2: Merge branches

+

Merge experiment and less-salt back into main following the lesson below +until the point where we start deleting branches.

+
+
+

If you got stuck in the above exercises or joined later

+

If you got stuck in the above exercises or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git switch experiment
+$ git switch less-salt
+$ git switch main
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

First we make sure we are on the branch we wish to merge into:

+
$ git branch
+
+  experiment
+  less-salt
+* main
+
+
+

Then we merge experiment into main:

+
$ git merge experiment
+
+
+
+_images/git-merge-1.svg
+

We can verify the result:

+
$ git graph
+
+*   81fcc0c (HEAD -> main) Merge branch 'experiment'
+|\
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+* | b4af65b improve the documentation
+|/
+| * bf28166 (less-salt) reduce amount of salt
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents.

+

To view the branches that are merged into the current branch we can use the command:

+
$ git branch --merged
+
+  experiment
+* main
+
+
+

We are also happy with the work on the less-salt branch. Let us merge that +one, too, into main:

+
$ git branch  # make sure you are on main
+$ git merge less-salt
+
+
+
+Commit graph after merge
+

Commit graph after merge.

+
+
+

We can verify the result in the terminal:

+
$ git graph
+
+*   4e03d4b (HEAD -> main) Merge branch 'less-salt'
+|\
+| * bf28166 (less-salt) reduce amount of salt
+* |   81fcc0c Merge branch 'experiment'
+|\ \
+| * | bcb8b78 (experiment) maybe little bit less cilantro
+| * | f6ec7b7 let us try with some cilantro
+| |/
+* / b4af65b improve the documentation
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Observe how Git nicely merged the changed amount of salt and the new ingredient in the same file +without us merging it manually:

+
$ cat ingredients.txt
+
+* 1 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually settle merge conflicts (we will do that later).

+
+
+

Deleting branches safely

+

Both feature branches are merged:

+
$ git branch --merged
+
+  experiment
+  less-salt
+* main
+
+
+

This means we can delete the branches:

+
$ git branch -d experiment
+$ git branch -d less-salt
+
+
+

This is the result:

+
+Commit graph after merged branches were deleted
+

Commit graph after merged branches were deleted.

+
+
+

We observe that when deleting branches, +only the pointers (“sticky notes”) disappeared, not the commits.

+

Git will not let you delete a branch which has not been reintegrated unless you +insist using git branch -D. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them.

+
+
+

Optional exercises with branches

+

The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section.

+
+

(optional) Branch-3: Perform a fast-forward merge

+
    +

  1. Create a new branch from main and switch to it.

    2. +

  2. Create a couple of commits on the new branch (for instance edit README.md):

    +
    +_images/git-pre-ff.svg
    +
    3. +

  3. Now switch to main.

    4. +

  4. Merge the new branch to main.

    5. +

  5. Examine the result with git graph.

    6. +

  6. Have you expected the result? Discuss what you see.

    7. +
+ +
+
+

(optional) Branch-4: Rebase a branch (instead of merge)

+

As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

+
    +

  1. Create a new branch, and make a couple of commits on it.

    2. +

  2. Switch back to main, and make a couple of commits on it.

    3. +

  3. Inspect the situation with git graph.

    4. +

  4. Now rebase the new branch on top of main by first switching to the new branch, and then git rebase main.

    5. +

  5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

    6. +
+ +
+
+
+

Tags

+
    +

  • A tag is a pointer to a commit but in contrast to a branch it does not ever +move when creating new commits later.

    • +

  • It can be useful to think of branches as sticky notes and of tags as +commemorative plaques.

    • +

  • We use tags to record particular states or milestones of a project at a given +point in time, like for instance versions (have a look at semantic versioning, +v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a).

    • +

  • There are two basic types of tags: annotated and lightweight.

    • +

  • Use annotated tags since they contain the author and can be cryptographically signed using +GPG, timestamped, and a message attached.

    • +
+

Let’s add an annotated tag to our current state of the guacamole recipe:

+
$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet"
+
+
+

As you may have found out already, git show is a very versatile command. Try this:

+
$ git show nobel-2023
+
+
+

For more information about tags see for example +the Pro Git book chapter on the +subject.

+
+
+
+

Summary

+

Let us pause for a moment and recapitulate what we have just learned:

+
$ git branch               # see where we are
+$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+$ git merge NAME           # merge branch NAME (to current branch)
+$ git branch -d NAME       # delete branch NAME
+$ git branch -D NAME       # delete unmerged branch NAME
+
+
+

Since the following command combo is so frequent:

+
$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+
+
+

There is a shortcut for it:

+
$ git switch --create NAME  # create branch NAME and switch to it
+
+
+
+

Typical workflows

+

With this there are two typical workflows:

+
$ git switch --create new-feature  # create branch, switch to it
+$ git commit                       # work, work, work, ..., and test
+$ git switch main                  # once feature is ready, switch to main
+$ git merge new-feature            # merge work to main
+$ git branch -d new-feature        # remove branch
+
+
+

Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging:

+
$ git switch --create wild-idea    # create branch, switch to it, work, work, work ...
+$ git switch main                  # realize it was a bad idea, back to main
+$ git branch -D wild-idea          # it is gone, off to a new idea
+
+
+
+
+

Branch-5: Test your understanding

+

Which of the following combos (one or more) creates a new branch and makes a commit to it?

+
    +
  1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    2. +
  2. $ git add file.txt
+$ git branch new-branch
+$ git switch new-branch
+$ git commit
+
    +
    +
    3. +
  3. $ git switch --create new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    4. +
  4. $ git switch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • A branch is a division unit of work, to be merged with other units of work.

    • +

  • A tag is a pointer to a moment in the history of a project.

    • +
+
+
+
+
+
+

Conflict resolution

+
+

Objectives

+
    +

  • Understand merge conflicts sufficiently well to be able to fix them.

    • +
+
+
+

Instructor note

+
    +

  • 20 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Conflicts in Git and why they are good

+

Imagine we start with the following text file:

+
1 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch A somebody modifies:

+
2 tbsp cilantro
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch B somebody else modifies:

+
1/2 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1 onion
+
+
+

When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro:

+
?????????????????
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1 onion
+
+
+

Git is very good at resolving modifications when merging branches and +in most cases a git merge runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see Optional exercises with branches) without you even noticing.

+

But sometimes the same portion of the code/text is modified on two branches +in two different ways and Git issues a conflict. +Then you need to tell Git which version to keep (resolve it).

+

There are several ways to do that as we will see.

+

Please remember:

+
    +

  • It is good that Git conflicts exist: Git will not silently overwrite one of +two differing modifications.

    • +

  • Conflicts may look scary, but are not that bad after a little bit of +practice. Also they are luckily rare.

    • +

  • Don’t be afraid of Git because of conflicts. You may not meet some conflicts +using other systems because you simply can’t do the kinds of things you do +in Git.

    • +

  • You can take human measures to reduce them.

    • +
+
+
+

The human side of conflicts

+
    +

  • What does it mean if two people do the same thing in two different ways?

    • +

  • What if you work on the same file but do two different things in the different sections?

    • +

  • What if you do something, don’t tell someone from 6 months, and then try to combine it with other people’s work?

    • +

  • How are conflicts avoided in other work? (Only one person working at once? +Declaring what you are doing before you start, if there is any chance someone +else might do the same thing, helps.)

    • +

  • Minor conflicts (two people revise spelling) vs semantic (two people rewrite +a function to add two different new features). How did Git solve these in +branching/merging easily?

    • +
+
+

Now we can go to show how Git controls when there is actually a conflict.

+
+
+

Preparing a conflict

+
+

Instructor note

+

We do the following together as type-along/demo.

+
+
+

If you got stuck previously or joined later

+

If you got stuck previously or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together.

+
    +

  • Create two branches from main: one called like-cilantro, one called dislike-cilantro:

    +
    $ git branch like-cilantro main
+$ git branch dislike-cilantro main
+
    +
    +
    • +

  • On the two branches make different modifications to the amount of the same ingredient:

    • +

  • On the branch like-cilantro we have the following change:

    +
    $ git diff main like-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6cacd50 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +

  • And on the branch dislike-cilantro we have the following change:

    +
    $ git diff main dislike-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6484462 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 1/2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +
+
+
+

Merging conflicting changes

+

What do you expect will happen when we try to merge these two branches into +main?

+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+

The first merge will work:

+
$ git switch main
+$ git status
+$ git merge like-cilantro
+
+Updating 4e03d4b..3caa632
+Fast-forward
+ ingredients.txt | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+

But the second will fail:

+
$ git merge dislike-cilantro
+
+Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+

Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit:

+
$ git status
+
+You have unmerged paths.
+  (fix conflicts and run "git commit")
+  (use "git merge --abort" to abort the merge)
+
+Unmerged paths:
+  (use "git add <file>..." to mark resolution)
+	both modified:   ingredients.txt
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+

Git won’t decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward.

+

Let us inspect the conflicting file:

+
$ cat ingredients.txt
+
+<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

Git inserted resolution markers (the <<<<<<<, >>>>>>>, and =======).

+

Try also git diff:

+
$ git diff
+
+
+
diff --cc ingredients.txt
+index 6cacd50,6484462..0000000
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@@ -1,4 -1,4 +1,10 @@@
+++<<<<<<< HEAD
+ +* 2 tbsp cilantro
+++=======
++ * 1/2 tbsp cilantro
+++>>>>>>> dislike-cilantro
+  * 2 avocados
+  * 1 chili
+  * 1 lime
+
+
+

git diff now only shows the conflicting part, nothing else.

+
+
+

Conflict resolution

+
<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+
+
+

We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged.

+
+

Steps to resolve a conflict

+
    +

  • Check status with git status and git diff.

    • +

  • Decide what you keep (the one, the other, or both or something +else). Edit the file to do this.

    +
      +

    • Remove the resolution markers, if not already done.

      • +

    • The file(s) should now look exactly how you want them.

      • +
    +
    • +

  • Check status with git status and git diff.

    • +

  • Tell Git that you have resolved the conflict with git add ingredients.txt +(if you use the Emacs editor with a certain plugin the editor may stage the +change for you after you have removed the conflict markers).

    • +

  • Verify the result with git status.

    • +

  • Finally commit the merge with only git commit. Everything is pre-filled.

    • +
+
+
+
+

Exercise: Create and resolve a conflict

+
+

Conflict-1: Create another conflict and resolve

+

In this exercise, we repeat almost exactly what we did above with a +different ingredient.

+
    +

  1. Create two branches before making any modifications.

    2. +

  2. Again modify some ingredient on both branches.

    3. +

  3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

    4. +

  4. What happens if you apply the same modification on both branches?

    5. +

  5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into main you will not see a conflict. Can you +explain, why it is different this time?

    6. +
+ +
+
+
+

Optional exercises with conflict resolution

+
+

(optional) Conflict-2: Resolve a conflict when rebasing a branch

+
    +

  1. Create two branches where you anticipate a conflict.

    2. +

  2. Try to merge them and observe that indeed they conflict.

    3. +

  3. Abort the merge with git merge --abort.

    4. +

  4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

    5. +
+ +
+
+

(optional) Conflict-3: Resolve a conflict using mergetool

+
    +

  • Again create a conflict (for instance disagree on the number of avocados).

    • +

  • Stop at this stage:

    +
    Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +
    • +

  • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

    +
    $ git mergetool
+
    +
    +
    +Conflict resolution using mergetool +
    +
    • +

  • Your current branch is left, the branch you merge is right, result is in the middle.

    • +

  • After you are done, close and commit, git add is not needed when using git mergetool.

    • +
+

If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

+

To view what will be removed:

+
$ git clean -n
+
+
+

To remove:

+
$ git clean -f
+
+
+

To configure Git to avoid creating backups at all:

+
$ git config --global mergetool.keepBackup false
+
+
+
+
+
+
+

Using “ours” or “theirs” strategy

+
    +

  • Sometimes you know that you want to keep “ours” version (version on the branch you are on) +or “theirs” (version on the merged branch).

    • +

  • Then you do not have to resolve conflicts manually.

    • +

  • See merge strategies.

    • +
+

Example (merge and in doubt take the changes from current branch):

+
$ git merge -s recursive -Xours less-avocados
+
+
+

Or (merge and in doubt take the changes from less-avocados branch):

+
$ git merge -s recursive -Xtheirs less-avocados
+
+
+
+
+
+

Aborting a conflicting merge

+

Sometimes you get a merge conflict but realize that you can’t solve it without +talking to a colleague (who created the other change) first. What to do?

+

You can abort the merge and postponing conflict resolution by resetting the +repository to HEAD (last committed state):

+
$ git merge --abort
+
+
+

The repository looks then exactly as it was before the merge.

+
+
+
+

Avoiding conflicts

+
    +

  • Human measures

    +
      +

    • Think and plan to which branch you will commit to.

      • +

    • Do not put unrelated changes on the same branch.

      • +
    +
    • +

  • Collaboration measures

    +
      +

    • Open an issue and discuss with collaborators before starting a long-living +branch.

      • +
    +
    • +

  • Project layout measures

    +
      +

    • Modifying global data often causes conflicts.

      • +

    • Modular programming reduces this risk.

      • +
    +
    • +

  • Technical measures

    +
      +

    • Share your changes early and often - this is one of the happy, +rare circumstances when everyone doing the selfish thing (e.g. git push as +early as practical) results in best case for everyone!

      • +

    • Pull/rebase often to keep up to date with upstream.

      • +

    • Resolve conflicts early.

      • +
    +
    • +
+
+

Discussion

+

Discuss how Git handles conflicts compared to services like Google Drive.

+
+
+

Keypoints

+
    +

  • Conflicts often appear because of not enough communication or not optimal +branching strategy.

    • +
+
+
+
+
+

Sharing repositories online

+
+

Objectives

+
    +

  • We get a feeling for remote repositories (more later).

    • +

  • We are able to publish a repository on the web.

    • +

  • We are able to fetch and track a repository from the web.

    • +
+
+
+

Instructor note

+
    +

  • 15 min demonstration/type-along

    • +

  • 25 min exercise

    • +
+
+
+

From our laptops to the web

+

We have seen that creating Git repositories and moving them around is +relatively simple and that is great.

+

So far, if you only worked in the command line, everything was local and all +snapshots, branches, and tags are saved under .git.

+

If we remove .git, we remove all Git history of a project.

+
+

Discussion

+
    +

  • What if the hard disk fails?

    • +

  • What if somebody steals my laptop?

    • +

  • How can we collaborate with others across the web?

    • +
+
+
+
+

Remotes

+

We will learn how to work with remote repositories in detail in the +collaborative distributed version control lesson.

+

In this section we only want to get a taste to prepare us for other lessons +where we will employ GitHub. Our goal is to publish our exercise guacamole recipe +which we prepared in the previous episodes on +the web. Don’t worry, you will be able to remove it afterwards.

+
+

If you don’t have the recipe repository from previous episodes

+

Maybe you joined the workshop later or got stuck somewhere? No problem!

+

If you don’t have the recipe repository from previous episodes, you can +clone our version of the repository using (please skip this if you have the recipe +repository on your computer already):

+
$ git clone https://github.com/coderefinery/recipe-before-merge.git recipe
+$ cd recipe
+$ git remote remove origin
+
+
+

Now you have a repository called recipe on your computer with a couple of +commits. Further down we will also clarify what git clone does.

+
+

To store your git data on another server, you use remotes. +A remote is a repository on its own, with its own branches +We can push changes to the remote and pull +from the remote.

+

You might use remotes to:

+
    +

  • Back up your own work.

    • +

  • To collaborate with other people.

    • +
+

There are different types of remotes:

+
    +

  • If you have a server you can ssh to, you can use that as a remote.

    • +

  • GitHub is a popular, closed-source commercial site.

    • +

  • GitLab is a popular, open-core +commercial site. Many universities have their own private GitLab servers +set up.

    • +

  • Bitbucket is yet another popular commercial site.

    • +

  • Another option is NotABug.

    • +

  • We also operate a Nordic +research software repository +platform. +This is GitLab, free for researchers and allows private, +cross-university sharing.

    • +
+
+
+
+

Authenticating to GitHub: SSH or HTTPS?

+

How does Github know who you are? This is hard and there are two +options.

+
    +

  • SSH is the classic method, using Secure Shell remote connection +keys.

    • +

  • HTTPS works with the Git Credential Manager, which is an +extra add-on that works easily in Windows and Mac.

    • +
+

Read how to install them from the installation +instructions.

+

Test which one you should use:

+
+

Try this command:

+
$ ssh -T git@github.com
+
+
+

If it returns Hi USERNAME! You've successfully authenticated, ..., +then SSH is configured and the following steps will work with the SSH +cloning.

+

See our installation +instructions to +set up SSH access.

+

From now on, if you know that SSH works, you should always select +SSH as the clone URL from GitHub, or translate the URL to start with +the right thing yourself: git@github.com: (with the trailing +:).

+
+

If you do not have these configured, please watch as we do this episode and you +can check the installation +instructions +before the next collaborative Git +lesson, where we will need +one of these set up.

+
+
+
+

Publishing an existing repository from laptop to GitHub

+
+

If you started in the browser and have nothing on your laptop yet

+

It is possible, that you already have a repository on GitHub if you followed +the examples and exercises in previous episodes in the browser. In this case, +please watch others publish their repository and try to clone your repository +to the laptop using instructions at the bottom of this page.

+
+

First log into GitHub, then follow the screenshots and descriptions below.

+
+Screenshot on GitHub before a new repository form is opened +
+

Click on the “plus” symbol on top right, then on “New repository”.

+
+
+

Another way to create a new repository is to visit +https://github.com/new directly.

+
+Screenshot on GitHub just before a new repository is created +
+

Choose a repository name, add a short description, but please do not check “Add a +README file”**. For “Add .gitignore” and “Choose a license” also leave as “None”. Finally “Create repository”.

+
+
+

Once you click the green “Create repository”, you will see a page similar to:

+
+Screenshot on GitHub after a bare repository was created +
+

What this means is that we have now an empty project with either an HTTPS or an +SSH address: click on the HTTPS and SSH buttons to see what happens.

+

We now want to follow the “… or push an existing repository from the command line:

+
    +

  1. Now go to your guacamole repository on your computer.

    2. +

  2. Check that you are in the right place with git status.

    3. +

  3. Copy paste the three lines to the terminal and execute those, in my case (you +need to replace the “USER” part and possibly also the repository name):

    4. +
+
+

See above for if SSH is the right option for you.

+
$ git remote add origin git@github.com:USER/recipe.git
+
+
+
+

Then:

+
$ git branch -M main
+$ git push -u origin main
+
+
+

The meaning of the above lines:

+
    +

  • Add a remote reference with the name “origin”

    • +

  • Rename current branch to “main”

    • +

  • Push branch “main” to “origin”

    • +
+

You should now see:

+
Enumerating objects: 3, done.
+Counting objects: 100% (3/3), done.
+Writing objects: 100% (3/3), 221 bytes | 221.00 KiB/s, done.
+Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
+To github.com:USER/recipe.git
+ * [new branch]      main -> main
+Branch 'main' set up to track remote branch 'main' from 'origin'.
+
+
+

Reload your GitHub project website and - taa-daa - your commits should now be +online! What just happened? Think of publishing a repository as uploading +the .git part online.

+
+

Troubleshooting

+

error: remote origin already exists.

+
    +

  • Explanation: You probably ran a git remote add origin ... command, then changed your +mind about HTTPS or SSH and then tried to run the other git remote add origin ... command but “origin” then already exists.

    • +

  • Recovery:

    +
      +

    • First remove “origin” with git remote remove origin

      • +

    • Then run the correct git remote add origin ... command

      • +
    +
    • +
+

remote contains work that you do not have

+
    +

  • Explanation: You probably clicked on “Add a README file” and now the +repository on GitHub is not empty but contains one commit and locally you +have a different history. Git now prevents you from accidentally overwriting +the history on GitHub.

    • +

  • Recovery:

    +
      +

    • Use git push --force instead of git push, which will force Git to overwrite the history on GitHub

      • +

    • Note that this is a powerful but also possibly dangerous option but here it +helps us. If it’s a brand new repo, it probably is fine to do this. For real +repositories, don’t do this unless you are very sure what is happening.

      • +
    +
    • +
+
+
+
+
+

Cloning a repository from GitHub to laptop

+

Now other people can clone this repository and contribute changes. In the +collaborative distributed version control lesson +we will learn how this works.

+

At this point only a brief demo - if you copy the SSH or HTTPS address, you can clone repositories like this +(again adapt the USER in the “USER/repository.git” part):

+
+
$ git clone git@github.com:USER/recipe.git
+
+
+

From now on, if you are using SSH, you should pay attention and make +sure your clone URLs start with git@github.com: now and in future +lessons.

+
+

This creates a directory called “recipe” unless it already exists. You can also specify the target directory +on your computer:

+
+
$ git clone git@github.com:USER/recipe.git myrecipe
+
+
+
+

What just happened? Think of cloning as downloading the .git part to your +computer. After downloading the .git part, the default branch (the branch pointed to by HEAD) is +automatically checked out.

+
+

Keypoints

+
    +

  • A repository can have one or multiple remotes (we will revisit these later).

    • +

  • Local branches often track remote branches.

    • +

  • A remote serves as a full backup of your work.

    • +

  • We’ll properly learn how to use these in the +collaborative distributed version control.

    • +
+
+
+
+
+

Inspecting history

+
+

Objectives

+
    +

  • Be able find a line of code, find out why it was introduced and when.

    • +

  • Be able to quickly find the commit that changed a behavior.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 30 min exercise

    • +
+
+
+

Preparation

+

Please make sure that you do not clone repositories inside an already tracked folder:

+
$ git status
+
+
+

If you are inside an existing Git repository, step out of it. +You need to find a different location since we will clone a new repository.

+

If you see this message, this is good in this case:

+
fatal: not a git repository (or any of the parent directories): .git
+
+
+
+
+

Our toolbox for history inspection

+
+

Instructor note

+

First the instructor demonstrates few commands on a real life example +repository https://github.com/networkx/networkx (mentioned in the amazing site The +Programming Historian). +Later we will practice these in an archaeology exercise (below).

+
+
+

Warm-up: “Git History” browser

+

As a warm-up we can try the “Git History” browser +on the README.rst file of the networkx repository:

+ +
+
+

Searching text patterns in the repository

+
+

With git grep you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or some error message printed:

+
$ git grep TEXT
+$ git grep "some text with spaces"
+
+
+

In the networkx repository you can try:

+
$ git clone https://github.com/networkx/networkx
+$ cd networkx
+$ git grep -i fixme
+
+
+

While git grep searches the current state of the repository, +it is also possible to search through all changes with git log -S sometext +which can be useful to find where something got removed.

+
+
+
+

Inspecting individual commits

+
+

We have seen this one before already. Using git show we can inspect an individual commit if +we know its hash:

+
$ git show HASH
+
+
+

For instance:

+
$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7
+
+
+
+
+
+

Line-by-line code annotation with metadata

+

With git annotate you can see line by line who and when the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility.

+
+
$ git annotate FILE
+
+
+

Example:

+
$ git annotate networkx/convert_matrix.py
+
+
+

If you annotate in a terminal and the file is longer than the screen, Git by default uses the program less to +scroll the output. +Use /sometext <ENTER> to find “sometext” and you can cycle through the results with n (next) and N (last). +You can also use page up/down to scroll. You can quit with q.

+
+
+

Discussion

+

Discuss how these relatively trivial changes affect the annotation:

+
    +

  • Wrapping long lines of text/code into shorter lines

    • +

  • Auto-formatting tools such as black

    • +

  • Editors that automatically remove trailing whitespace

    • +
+
+
+
+

Inspecting code in the past

+
+

We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code:

+
$ git switch --create BRANCHNAME HASH
+
+
+

Example (lines starting with “#” are only comments):

+
$ # create branch called "older-code" from hash 347e6292419b
+$ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9
+
+$ # now you can navigate and inspect the code as it was back then
+$ # ...
+
+$ # after we are done we can switch back to "main"
+$ git switch main
+
+$ # if we like we can delete the "older-code" branch
+$ git branch -d older-code
+
+
+

On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

+
$ git checkout -b BRANCHNAME SOMEHASH
+
+
+
+
+
+
+

Exercise: Basic archaeology commands

+
+

History-1: Explore basic archaeology commands

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Clone this repository: +https://github.com/networkx/networkx.git. +Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release:

    +
    $ git clone https://github.com/networkx/networkx.git
+$ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+
+
+
+

Finding out when something broke/changed with git bisect

+
+

“But I am sure it used to work! Strange.”

+
+

Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke.

+
+

How would you solve this?

+

Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now.

+
    +

  • How would you find the commit which changed it?

    • +

  • Why could it be useful to know the commit that changed it?

    • +
+
+

We will probably arrive at a solution which is similar to git bisect:

+
    +

  • First find out a commit in past when it worked.

    +
    $ git bisect start
+$ git bisect good f0ea950  # this is a commit that worked
+$ git bisect bad main      # last commit is broken
+
    +
    +
    • +

  • Now compile and/or run and/or test and decide whether “good” or “bad”.

    • +

  • This is how you can tell Git that this was a working commit:

    +
    $ git bisect good
+
    +
    +
    • +

  • And this is how you can tell Git that this was not a working commit:

    +
    $ git bisect bad
+
    +
    +
    • +

  • Then bisect/iterate your way until you find the commit that broke it.

    • +

  • If you want to go back to start, type git bisect reset.

    • +

  • This can even be automatized with git bisect run SCRIPT. +For this you write a script that returns zero/non-zero (success/failure).

    • +
+
+
+

Optional exercise: Git bisect

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+

Keypoints

+
    +

  • git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project.

    • +

  • git switch --create NAME HASH is the recommended mechanism to inspect old code.

    • +
+
+
+
+
+

Practical advice: how much Git is necessary?

+
+

Instructor note

+
    +

  • 20 min teaching/discussion

    • +
+
+
+

What level of branching complexity is necessary for each project?

+
+

Simple personal projects

+
    +

  • Typically start with just the main branch.

    • +

  • Use branches for unfinished/untested ideas.

    • +

  • Use branches when you are not sure about a change.

    • +

  • Use tags to mark important milestones.

    • +
+
+
+

Projects with few persons: you accept things breaking sometimes

+
    +

  • It might be reasonable to commit to the main branch and feature branches.

    • +
+
+
+

Projects with few persons: changes are reviewed by others

+
    +

  • You create new feature branches for changes.

    • +

  • Changes are reviewed before they are merged to the main branch +(more about that in the collaborative Git lesson).

    • +

  • The main branch is write-protected and can only be changed with pull requests or merge requests.

    • +
+
+
+

When you distribute releases

+
    +

  • If you want to patch releases, you probably need release branches.

    • +

  • The main branch and release branches are read-only.

    • +

  • Many branching models exist.

    • +
+
+
+
+
+

How about staging and committing?

+
    +

  • It is OK to start committing directly by doing git commit SOMEFILE.

    • +

  • Commit early and often: rather create too many commits than too few. +You can always combine commits later.

    • +

  • Once you commit, it is very, very hard to really lose your code.

    • +

  • Always fully commit (or stash) before you do dangerous things, so that you know you are safe. +Otherwise it can be hard to recover.

    • +

  • Later you can start using the staging area.

    • +

  • Later start using git add -p and/or git commit -p.

    • +
+
+
+
+

How large should a commit be?

+
    +

  • Better too small than too large (easier to combine than to split).

    • +

  • Often I make a commit at the end of the day (this is a unit I would not like to lose).

    • +

  • Smaller sized commits may be easier to review for others than huge commits.

    • +

  • Imperfect commits are better than no commits.

    • +

  • A commit should not contain unrelated changes to simplify review and possible +repair/adjustments/undo later (but again: imperfect commits are better than no commits).

    • +
+
+
+

Keypoints

+
    +

  • There is no one size fits all - start simple and grow your project.

    • +
+
+
+

Discussion

+

How do you [plan to] use Git?

+
    +

  • Advanced users or beginners, please provide your input in the online collaborative document.

    • +
+
+
+
+
+

What to avoid

+

The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas.

+

Postponing commits because the changes are “unfinished”/”ugly”: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all.

+

Not updating your branch before starting new work: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later.

+

Commit unrelated changes together: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects.

+

Too ambitious branch which risks to never get completed: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere.

+

Committing generated files: See Ignoring files and paths with .gitignore.

+

Over-engineering the branch layout and safeguards in small projects: This +may prevent people from contributing (maybe even including yourself?). Add more restrictions and safeguards as +the project and the group of collaborators grows.

+

Commit messages that explain what has been changed but do not explain why it has been +changed: This is as useful as code comments which describe the “obvious” such +as “this is a loop” instead of explaining why something is done this way. +But don’t let perfect commit messages stop you from the most important point, committing often (first point).

+

Commit huge files: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent git rm does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request.

+
+

Discussion

+

Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements.

+
+
+
+
+
+

Using the Git staging area

+
+

Objectives

+
    +

  • Learn how to tell a story with your commit history.

    • +

  • Demystify the Git staging area.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 10 min exercise

    • +
+
+
+

Commit history is telling a story

+

Your current code is very important, but the history can be just +as important - it tells a story about how your code came to be.

+
    +

  • Each individual line of code rarely stands alone.

    • +

  • You often want to see all the related changes together.

    • +

  • But you also hardly ever do one thing at once.

    • +
+

Along with your code, Git creates a history for you, and if your +history is clear then you are a long way to organized code.

+
+

Discussion

+

Here are five types of history. What are the advantages and +disadvantages of each, when you look at it later?

+

Example 1:

+
b135ec8 add features A, B, and C
+
+
+

Example 2 (newest commit is on top):

+
6f0d49f implement feature C
+fee1807 implement feature B
+6fe2f23 implement feature A
+
+
+

Example 3:

+
ab990f4 saving three months of miscellaneous work I forgot to commit
+
+
+

Example 4 (newest commit is on top):

+
bf39f9d more work on feature B
+45831a5 removing debug prints for feature A and add new file
+bddb280 more work on feature B and make feature A compile again
+72d78e7 feature A did not work and started work on feature B
+b135ec8 now feature A should work
+72e0211 another fix to make it compile
+61dd3a3 forgot file and bugfix
+49dc419 wip (work in progress)
+
+
+

Example 5 (newest commit is on top):

+
1949dc4 Work of 2020-04-07
+a361dd3 Work of 2020-04-06
+1172e02 Work of 2020-04-03
+e772d78 Work of 2020-04-02
+
+
+

Discuss these examples. Can you anticipate problems?

+
+

We want to have nice commits. But we also want to “save often” +(checkpointing) - how can we have both?

+
    +

  • We will now learn to create nice commits using git commit --patch and/or the staging area.

    • +

  • Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits.

    • +

  • The staging area isn’t the only way to organize your history nicely, some alternatives are discussed at the end of the lesson.

    • +
+
+
+

Interactive commits

+
    +

  • The simplest ways to solve this is to do interactive commits: +the git commit --patch option (or git commit -p for short).

    • +

  • It will present you with every change you have made individually, +and you can decide which ones to commit right now.

    • +

  • Reference and key commands

    +
      +

    • git commit --patch to start the interactive commit

      • +

    • y to use the change

      • +

    • n to skip the change

      • +

    • s (split) if there are several changes grouped together, but +separated by a blank line, split them into separate choices.

      • +

    • q aborts everything.

      • +

    • ? for more options.

      • +
    +
    • +

  • The -p option is also available on commit, restore, checkout, reset, and add.

    • +
+
+
+

Exercise: Interactive commits

+
+

Staging-1: Perform an interactive commit

+

One option to help us create nice logical commits is to stage interactively +with git commit --patch:

+
    +

  1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

    2. +

  2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

    3. +

  3. Do it again for the other change.

    4. +

  4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

    5. +

  5. When would this be useful?

    6. +
+ +
+
+
+

The staging area

+
    +

  • The interactive commits above are great, but what if there are so +many changes that you can’t sort them out in one shot?

    • +

  • What if you make progress and want to record it somehow, but it’s +not ready to be committed?

    • +

  • The staging area is a place to record things before committing.

    • +
+
+

Instructor note

+

We give two examples and the instructor can pick one or both:

+
    +

  • Analogy using moving boxes

    • +

  • Analogy using shopping receipts

    • +
+
+
+

Discussion

+

Analogy using moving boxes

+
    +

  • You’re moving and you have a box to pack your things in.

    • +

  • You can put stuff into the box, but you can also take stuff out of the box.

    • +

  • You wouldn’t want to mix items from the bathroom, kitchen, and living room +into the same box.

    • +

  • The box corresponds to the staging area of Git, where you can craft your commits.

    • +

  • Committing is like sealing the box and sticking a label on it.

    • +

  • You wouldn’t want to label your box with “stuff”, but rather give a more +descriptive label.

    • +

  • See also https://dev.to/sublimegeek/git-staging-area-explained-like-im-five-1anh

    • +
+

Analogy using shopping receipts

+
    +

  • You need to go shopping and buy some stuff for work and for home. +You need two separate receipts.

    • +

  • Bad idea: go through the store get home stuff, pay, start at the +beginning and go through the store again. This is inefficient and +annoying.

    • +

  • What you actually do:

    +
      +

    • Go through the store and put everything you need in your shopping +basket.

      • +

    • Get to the check-out. Put your home stuff on the conveyor belt +(git add). Check both the belt (git diff --staged) and your +basket (git diff) to make sure you got all your home stuff.

      • +

    • Pay (git commit)

      • +

    • Repeat for work stuff.

      • +
    +
    • +
+

In order to keep organized, you have to use multiple locations to +stage things in sequence.

+
+
+
+

Staging area commands

+

The staging area is a middle ground between what you have done to your files +(the working directory) and what you have last committed (the HEAD commit). +Just like the name implies, it lets you prepare (stage) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since you can modify and stage several times before committing.

+

git add stages/prepares for the next commit:

+
                git add
+ [project*]  <------------  project*
+                               ^
+                               | modify with editor
+                               |
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git commit creates a new commit:

+
  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+  HEAD~2          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git reset --soft HEAD~1 (move HEAD back by one but keep changes and stage +them) would do the opposite of git commit. (in this case, HEAD +is literally this - not a replacement)

+

Going back to the last staged version:

+
              git restore
+ [project*]  ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Unstaging changes with git restore --staged:

+
          git restore --staged
+             ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Discarding unstaged changes:

+
                            project*
+                               |
+                               | git restore
+                               v
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Comparing:

+
                git diff
+ [project*]  <----------->  project*
+    ^                          ^
+    | git diff --staged        | git diff HEAD
+    v                          v
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+
+Staging basics +
+

The different states of the repository and the commands to move from one to +another.

+
+
+
+
+

Exercise: Using the staging area

+
+

Staging-2: Use the staging area to make a commit in two steps

+
    +

  1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

    2. +

  2. Use git add to stage one of the changes.

    3. +

  3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

    4. +

  4. Feel some regret and unstage the staged change.

    5. +
+
+
+

Discussion

+
    +

  • When is it better to “save” a change as commit, when is it better to “save” +it with git add?

    • +

  • Is it a problem to commit many small changes?

    • +
+
+
+

Keypoints

+
    +

  • The staging area helps us to create well-defined commits.

    • +
+
+
+
+
+

Undoing and recovering

+
+

Objectives

+
    +

  • Learn to undo changes safely

    • +

  • See when undone changes are permanently deleted and when they can be retrieved

    • +
+
+
+

Instructor note

+
    +

  • 25 min teaching/type-along

    • +

  • 25 min exercise

    • +
+
+

One of the main points of version control is that you can go back in +time to recover. Unlike this xkcd comic implies: https://xkcd.com/1597/

+

In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn’t a “commit” permanent?

+
    +

  • You can modify old commit history.

    • +

  • But if you have shared that history already, modifying it can make +a huge mess.

    • +
+
+

It is almost always possible to recover

+

As long as you commit something once (or at least git add it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru… until that guru becomes you.

+
+
+

Nice resource to visually simulate Git operation

+

git-sim +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command.

+
+
+
+

Undoing your recent, uncommitted and unstaged changes (preserves history)

+
+

Note

+

In case git restore does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git restore.

+
+

You do some work, and want to undo your uncommitted and unstaged modifications. +You can always do that with:

+
    +

  • git restore . (the dot means “here and in all folders below”)

    • +
+

You can also undo things selectively:

+
    +

  • git restore -p (decide which portions of changes to undo) or git restore PATH (decide which path/file)

    • +
+

If you have staged changes, you have at least two options to undo the staging:

+
    +

  • git restore --staged . followed by git status and git restore .

    • +

  • git reset --hard HEAD throws away everything that is not in last +commit (HEAD - this literal word, this isn’t a placeholder)

    • +
+
+
+
+

Reverting commits (preserves history)

+

Imagine we made a few commits. +We realize that the latest commit e02efcd was a mistake and we wish to undo it:

+
$ git log --oneline
+
+e02efcd (HEAD -> main) not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

A safe way to undo the commit is to revert the commit with git revert:

+
$ git revert e02efcd
+
+
+

This creates a new commit that does the opposite of the reverted commit. +The old commit remains in the history:

+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

You can revert any commit, no matter how old it is. It doesn’t affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we’ll learn about later).

+
+

Exercise: Revert a commit

+
+

Undoing-1: Revert a commit

+
    +

  • Create a commit (commit A).

    • +

  • Revert the commit with git revert (commit B).

    • +

  • Inspect the history with git log --oneline.

    • +

  • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

    • +
+
+
+
+
+

Adding to the previous commit (modifies history)

+

Sometimes we commit but realize we forgot something. +We can amend to the last commit:

+
$ git commit --amend
+
+
+

This can also be used to modify the last commit message.

+

Note that this will change the commit hash. This command modifies the history. +This means that we avoid this command on commits that we have shared with others.

+
+

Exercise: Modify a previous commit

+
+

Undoing-2: Modify a previous commit

+
    +

  1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

    2. +

  2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

    3. +

  3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

    4. +
+ +
+
+
+
+

Rewinding branches (modifies history)

+

You can reset branch history to move your branch back to some +point in the past.

+
    +

  • git reset --hard HASH will force a branch label to any other point. All +other changes are lost (but it is possible to recover if you force reset by mistake).

    • +

  • Be careful if you do this - it can mess stuff up. Use git graph a +lot before and after.

    • +
+
+

Exercise: Git reset

+
+

Undoing-3: Destroy our experimentation in this episode

+

After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

+
    +

  • First, we will look at our history (git log/git graph) and +find the last commit HASH before our tests.

    • +

  • Then, we will git reset --hard HASH to that.

    • +

  • Then, git graph again to see what happened.

    • +
+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+$ git reset --hard b4af65b
+
+HEAD is now at b4af65b improve the documentation
+
+$ git log --oneline
+
+b4af65b (HEAD -> main) improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+
+
+
+
+
+

Recovering from committing to the wrong branch

+

It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes.

+

Here we assume that we made a couple of commits but we realize they went to the +wrong branch.

+

Solution 1 using git cherry-pick:

+
    +

  1. Make sure that the correct branch exists and if not, create it. Make sure to +create it from the commit hash where you wish you had created it from: git branch BRANCHNAME HASH

    2. +

  2. Switch to the correct branch.

    3. +

  3. git cherry-pick HASH can be used to take a specific commit to the +current branch. Cherry-pick all commits that should have gone to the correct +branch, from oldest to most recent.

    4. +

  4. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    5. +
+

Solution 2 using git reset --hard (makes sense if the correct branch should +contain all commits of the accidentally modified branch):

+
    +

  1. Create the correct branch, pointing at the latest commit: git branch BRANCHNAME.

    2. +

  2. Check with git log or git graph that both branches point to the same, latest, commit.

    3. +

  3. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    4. +
+
+
+

Recovering from merging/pulling into the wrong branch

+

git merge, git rebase, and git pull modify the current branch, never +the other branch. But sometimes we run this command on the wrong branch.

+
    +

  1. Check with git log the commit hash that you would like to rewind the +wrongly modified branch to.

    2. +

  2. Rewind the branch that accidentally got wrong commits with git reset --hard HASH (see also above).

    3. +
+
+
+

Recovering from conflict after pulling changes

+

Pulling changes with +git pull can create a conflict since git pull always also includes a git merge (more about this +in the collaborative Git lesson).

+

The recovery is same as described in Conflict resolution. Either +resolve conflicts or abort the merge with git merge --abort.

+
+
+

Undoing-4: Test your understanding

+
    +

  1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

    2. +

  2. Is it OK to modify commits that nobody has seen yet?

    3. +

  3. What situations would justify to modify the Git history and possibly remove commits?

    4. +
+ +
+
+
+
+

Interrupted work

+
+

Objectives

+
    +

  • Learn to switch context or abort work without panicking.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+

Keypoints

+
    +

  • There is almost never reason to clone a fresh copy to complete a task that +you have in mind.

    • +
+
+
+

Frequent situation: interrupted work

+

We all wish that we could write beautiful perfect code. But the real world is +much more chaotic:

+
    +

  • You are in the middle of a “Jackson-Pollock-style” debugging spree with 27 modified files +and debugging prints everywhere.

    • +

  • Your colleague comes in and wants you to fix/commit something right now.

    • +

  • What to do?

    • +
+

Git provides lots of ways to switch tasks without ruining everything.

+
+
+

Option 1: Stashing

+

The stash is the first and easiest place to temporarily “stash” +things.

+
    +

  • git stash will put working directory and staging area changes +away. Your code will be same as last commit.

    • +

  • git stash pop will return to the state you were before. Can give it a list.

    • +

  • git stash list will list the current stashes.

    • +

  • git stash save NAME is like the first, but will give it a name. +Useful if it might last a while.

    • +

  • git stash save [-p] [filename] will stash certain files files +and/or by patches.

    • +

  • git stash drop will drop the most recent stash (or whichever stash +you give).

    • +

  • The stashes form a stack, so you can stash several batches of modifications.

    • +
+
+

Exercise: Stashing

+
+

Interrupted-1: Stash some uncommitted work

+
    +

  1. Make a change.

    2. +

  2. Check status/diff, stash the change with git stash, check status/diff again.

    3. +

  3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

    4. +

  4. Pop off the stash you saved with git stash pop, and check status/diff.

    5. +

  5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

    6. +

  6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

    7. +

  7. Advanced: what does git graph show when you have something +stashed?

    8. +
+ +
+
+
+
+

Option 2: Create branches

+

You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch.

+

You basically know how to do this:

+
$ git switch --create temporary  # create a branch and switch to it
+$ git add PATHS                  # stage changes
+$ git commit                     # commit them
+$ git switch main                # back to main, continue your work there ...
+$ git switch temporary           # continue again on "temporary" where you left off
+
+
+

Later you can merge it to main or rebase it on top of main and resume work.

+
+
+

Storing various junk you don’t need but don’t want to get rid of

+

It happens often that you do something and don’t need it, but you don’t want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still.

+
+
+
+

Aliases and configuration

+
+

Objectives

+
    +

  • Learn to use aliases for most common commands.

    • +
+
+

Are you getting tired of typing so much? In Git you can define aliases (shortcuts):

+
    +

  • These are great because they can save you time typing.

    • +

  • But it’s easy to forget them, get confused, or be inconsistent with your colleagues.

    • +
+

There is plenty of other configuration for Git, that can make it nicer.

+
+

Aliases

+
    +

  • Aliases offer a way to improve the usability of Git: for +example git ci instead of git commit.

    • +

  • Aliases are based on simple string replacement in the command.

    • +

  • Aliases can either be specific to a repository or global.

    +
      +

    • Global aliases help you do the things you are used to across Git projects.

      • +

    • Per-project aliases can also be created.

      • +
    +
    • +

  • Global aliases are stored in ~/.gitconfig.

    • +
+
+
+

Example alias: git graph

+

A very useful shortcut which we use a lot in our workshops:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ cd your_git_repository
+$ git graph
+
+
+
+
+

Using external commands

+

It is possible to call external commands using the exclamation mark character “!”. +In this example here we create a local alias which is +stored in .git/config and not synchronized with remotes:

+
$ cd your_git_repository
+$ git config alias.hi '!echo hello'
+$ git hi
+
+
+
+

Food for thought: When to alias?

+
    +

  • How many times should you wait before aliasing a command?

    • +

  • Do you believe a list of generic two-letter acronyms for common commands will +save your time?

    • +
+
+
+
+

List of aliases the instructors use

+

You are welcome to reuse, suggest, improve. +You can see your current aliases in ~/.gitconfig.

+
$ git config --global alias.ap "add --patch"
+$ git config --global alias.br branch
+$ git config --global alias.ci "commit -v"
+$ git config --global alias.cip "commit --patch -v"
+$ git config --global alias.cl "clone --recursive"
+$ git config --global alias.di diff
+$ git config --global alias.dic "diff --staged --color-words"
+$ git config --global alias.diw "diff --color-words"
+$ git config --global alias.dis "!git --no-pager diff --stat"
+$ git config --global alias.fe fetch
+$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ git config --global alias.rem remote
+$ git config --global alias.st status
+$ git config --global alias.su "submodule update --init --recursive"
+
+
+

Here is what they do:

+
    +

  • ap: add, selecting parts individually, interactively.

    • +

  • br: branch (obvious)

    • +

  • ci: commit (check in), with -v option for clarity

    • +

  • cip: commit, selecting parts individually, interactively.

    • +

  • cl: clone, init submodules (submodules are an advanced topic)

    • +

  • di: diff (obvious)

    • +

  • dic: diff of staging area vs last commit (what is about to be committed)

    • +

  • diw: a word diff, color. Useful for small changes.

    • +

  • dis: a “diffstat”: what files are changed, not contents

    • +

  • fe: fetch (obvious)

    • +

  • graph: show whole git graph (so useful, some of us call it l)

    • +

  • rem: remote (obvious)

    • +

  • st: status (obvious)

    • +

  • su: submodule update (advanced)

    • +
+

A useful setting for the p aliases:

+
$ git config --global interactive.singlekey true
+
+
+
+
+

Advanced aliases

+

These are advanced aliases and configuration options. We won’t explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages!

+
$ git config --global alias.cif "commit -v -p --fixup"
+$ git config --global alias.rb "rebase --autosquash"
+$ git config --global alias.rbi "rebase --interactive --autosquash"
+$ git config --global alias.rbis "rebase --interactive --autosquash --autostash"
+$ git config --global alias.rbs "rebase --autosquash --autostash"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard"
+$ git config --global alias.new "log HEAD..HEAD@{upstream}"
+$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}"
+$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}"
+$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all"
+$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD"
+$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat"
+
+
+
+
+

Advanced Git configuration

+

Besides aliases, you can do plenty of other configuration of git. +Here are some of the most common ones:

+
$ git config --global interactive.singlekey true
+$ git config --global core.pager "less -RS"
+$ git config --global core.excludesfile ~/.gitignore
+$ git config --global merge.conflictstyle diff3
+$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]"
+$ git config --global diff.mnemonicPrefix true
+
+
+

Do you get tired of typing and copying and pasting your remote names +all the time, like git@github.com:myusername? You can create remote +aliases like this:

+
$ git config --global url.git@github.com:.insteadOf gh:
+$ git config --global url.git@github.com:/username/.insteadOf ghu:
+
+
+

Then, when you add a remote ghu:recipe, it will automatically be +translated to git@github.com:/username/recipe using a simple prefix +matching.

+
+

Keypoints

+
    +

  • If you are frustrated about remembering a command, you should create an alias.

    • +
+
+
+
+
+

Git under the hood

+
+

Objectives

+
    +

  • Verify that branches are pointers to commits and extremely lightweight.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+Git under the hood +
+
+

Down the rabbit hole

+

When working with Git, you will never need to go inside .git, but in this +exercise we will, in order to learn about how branches are implemented in Git.

+

For this exercise create a new repository and commit a couple of changes.

+

Now that we’ve made a couple of commits let us look at what is happening under +the hood.

+
$ cd .git
+$ ls -l
+
+drwxr-xr-x   - user 25 Aug 15:51 branches
+.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG
+.rw-r--r--  92 user 25 Aug 15:51 config
+.rw-r--r--  73 user 25 Aug 15:51 description
+.rw-r--r--  21 user 25 Aug 15:51 HEAD
+drwxr-xr-x   - user 25 Aug 15:51 hooks
+.rw-r--r-- 137 user 25 Aug 15:52 index
+drwxr-xr-x   - user 25 Aug 15:51 info
+drwxr-xr-x   - user 25 Aug 15:52 logs
+drwxr-xr-x   - user 25 Aug 15:52 objects
+drwxr-xr-x   - user 25 Aug 15:51 refs
+
+
+

Git stores everything under the .git folder in your repository. In fact, the +.git directory is the Git repository.

+

Previously when you wrote the commit messages using your text editor, they +were in fact saved to COMMIT_EDITMSG.

+

Each commit in Git is stored as a “blob”. This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file.

+

Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string).

+
+A commit inside Git +
+

States of a Git file. Image from the Pro Git book. License CC BY 3.0.

+
+
+

Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a directed acyclic +graph (do not worry +if the term is not familiar).

+
+A commit and its parents +
+

A commit and its parents. Image from the Pro Git book. License CC BY 3.0.

+
+
+

All branches and tags in Git are pointers to commits.

+
+
+

Git is basically a content-addressed storage system

+ +

Let us poke a bit into raw objects! Start with:

+
$ git cat-file -p HEAD
+
+
+

Then explore the tree object, then the file object, etc. recursively using the hashes you see.

+
+
+

Demonstration: experimenting with branches

+

Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an “Aha!” moment and provide us a +good understanding of the underlying model.

+

We are starting from the main branch and create an idea branch:

+
$ git status
+
+On branch main
+nothing to commit, working tree clean
+
+
+
$ git switch --create idea
+
+Switched to a new branch 'idea'
+
+
+
$ git branch
+
+* idea
+  main
+
+
+

Now let us go in:

+
$ cd .git
+$ cd refs/heads
+$ ls -l
+
+.rw-r--r-- 41 user 25 Aug 15:54 idea
+.rw-r--r-- 41 user 25 Aug 15:52 main
+
+
+

Let us check what the idea file looks like +(do not worry if the hash is different):

+
$ cat idea
+
+045e3db14740c60684d745e5fb891ae71e335611
+
+
+

Now let us replicate this file:

+
$ cp idea idea-2
+$ cp idea idea-3
+$ cp idea idea-4
+$ cp idea idea-5
+
+
+

Let us go up two levels and inspect the file HEAD:

+
$ cd ../..
+$ cat HEAD
+
+ref: refs/heads/idea
+
+
+

Let us open this file and change it to:

+
ref: refs/heads/idea-3
+
+
+

Now we are ready for the aha moment! +First let us go back to the working area:

+
$ cd ..
+
+
+

Now - on which branch are we?

+
$ git branch
+
+  idea
+  idea-2
+* idea-3
+  idea-4
+  idea-5
+  main
+
+
+
+

Discussion

+

Discuss the findings with other course participants.

+
+
+
+
+
+
+

Quick reference

+
+

Other cheatsheets

+ +
+
+

Glossary

+
    +

  • working directory/ workspace: the actual files you see and edit

    • +

  • staging area: Place files go after git add and before git commit

    • +

  • hash: unique reference of any commit or state

    • +

  • branch: One line of work. Different branches can exist at the +same time and split/merge.

    • +

  • HEAD: Pointer to the most recent commit on the current branch.

    • +

  • remote: Roughly, another server that holds .git.

    • +

  • origin: Default name for a remote repository.

    • +

  • master: Default name for main branch on Git. Depending on the configuration and service, +the default branch is sometimes main. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

    • +

  • main: Default name for main branch on GitLab and GitHub. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

    • +
+
+
+

Commands we use

+

Setup:

+
    +

  • git config: edit configuration options

    • +

  • git init -b main: create new repository with main as the default branch

    • +
+

See our status:

+
    +

  • git status: see status of files - use often!

    • +

  • git log: see history of commits and their messages, newest first

    • +

  • git graph: see a detailed graph of commits. Create this command +with git config --global alias.graph "log --all --graph --decorate --oneline"

    • +

  • git diff: show difference between working directory and last commit

    • +

  • git diff --staged: show difference between staging area and last commit

    • +

  • git show COMMIT: inspect individual commits

    • +
+

General work:

+
    +

  • git add FILE:

    +
      +

    • Add a new file

      • +

    • Add a file to staging

      • +
    +
    • +

  • git commit: record a version, add it to current branch

    • +

  • git commit --amend: amend our last commit

    • +

  • git branch: show which branch we’re on

    • +

  • git branch NAME: create a new branch called “name”

    • +

  • git restore FILE: restore last committed/staged version of FILE, losing unstaged changes

    • +

  • git switch --create BRANCH-NAME: create a new branch and switch to it

    • +

  • git revert HASH: create a new commit which reverts commit HASH

    • +

  • git reset --soft HASH: remove all commits after HASH, but keep their modifications as staged changes

    • +

  • git reset --hard HASH: remove all commits after HASH, permanently throwing away their changes

    • +

  • git merge BRANCH-NAME: merge branch BRANCH-NAME into current branch

    • +

  • git grep PATTERN: search for patterns in tracked files

    • +

  • git annotate FILE: find out when a specific line got introduced and by whom

    • +

  • git bisect: find a commit which broke some functionality

    • +
+
+
+
+

Customizing Git

+
+

Shell prompt

+
+

Instructor note

+

Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like.

+
+

You can make your shell display contextual information about +your Git state even at all times.

+

Here are few example projects that make this possible and easy:

+ +
+
+

More useful “diff” output

+

Delta is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +“diff” output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more.

+
+
+
+

Other resources

+ +
+
+

List of exercises

+
+

Summary

+

Basics:

+ +

Branching and merging:

+ +

Conflict resolution:

+ +

Inspecting history:

+ +

Using the Git staging area:

+ +

Undoing and recovering:

+ +

Interrupted work:

+ +
+
+

Full list

+

This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests.

+
+
+
+

Instructor guide

+
+

Schedule Day 1

+

Times here are in CE(S)T.

+
    +

  • 08:50 - 09:00 (10 min) Soft start and icebreaker question

    • +

  • 09:00 - 09:20 (20 min) Welcome and practical information

    • +

  • 09:20 - 09:35 (15 min) Motivation

    • +

  • 09:35 - 09:50 (15 min) Basics - configuration and first commits

    • +

  • 09:50 - 10:00 (10 min) Break

    • +

  • 10:00 - 10:20 (20 min) Exercise

    +
      +

    • Record changes

      • +

    • Optional exercises

      • +
    +
    • +

  • 10:20 - 10:40 (20 min) Basics - history, commit log, ignoring

    • +

  • 10:40 - 11:00 (20 min) Exercise

    +
      +

    • One or all optional exercises

      • +
    +
    • +

  • 11:00 - 12:00: Lunch break

    • +

  • 12:00 - 12:15 (15 min) Branching and merging

    • +

  • 12:15 - 12:35 (20 min) Exercise

    +
      +

    • Branch-1

      • +

    • Branch-2

      • +
    +
    • +

  • 12:35 - 12:50 (15 min) Summarize/discuss branching and merging

    • +

  • 12:50 - 13:00 (10 min) Break

    • +

  • 13:00 - 13:20 (20 min) Conflict resolution

    • +

  • 13:20 - 13:30 (10 min) Q&A, feedback, and what will we be doing tomorrow?

    • +
+
+
+

Schedule Day 2

+

Times here are in CE(S)T.

+
    +

  • 08:50 - 09:00 (10 min) Soft start and icebreaker question

    • +

  • 09:00 - 09:10 (10 min) Recap and Q&A from day 1

    • +

  • 09:10 - 09:25 (15 min) Sharing repositories online

    • +

  • 09:25 - 09:50 (25 min) Exercise

    +
      +

    • Set up SSH keys

      • +

    • Pushing our guacamole recipe repository to GitHub

      • +

    • Clone repository

      • +
    +
    • +

  • 09:50 - 10:00 (10 min) Break

    • +

  • 10:00 - 10:15 (15 min) Inspecting history

    • +

  • 10:15 - 10:45 (30 min) Exercise

    +
      +

    • History-1

      • +

    • History-2 is optional

      • +
    +
    • +

  • 10:45 - 11:00 (15 min) Summarize/discuss inspecting history

    • +

  • 11:00 - 12:00: Lunch break

    • +

  • 12:00 - 12:15 (15 min) Undoing and recovering

    • +

  • 12:15 - 12:40 (25 min) Exercises

    +
      +

    • Undoing-1

      • +

    • Undoing-2

      • +

    • Undoing-3

      • +
    +
    • +

  • 12:40 - 11:50 (10 min) Summarize undoing and recovering and discussion and mention that staging area exists

    • +

  • 12:50 - 13:00 (10 min) Break

    • +

  • 13:00 - 13:20 (20 min) How much Git is necessary?

    • +

  • 13:20 - 13:30 (10 min) Q&A, feedback, and what will we be doing tomorrow?

    • +
+
+
+

Installation reminders for each day

+
    +

  • Day 1: Git configuration

    • +

  • Day 2: SSH set up (if you don’t, sharing repositories online will be demo)

    • +
+
+
+

Why we teach this lesson

+

Everyone should be using a version control system for their work, even if they’re working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories.

+

Specific motivations:

+
    +

  • Code easily becomes a disaster without version control

    • +

  • Mistakes happen - Git offers roll-back functionality and easy backup mechanism

    • +

  • One often needs to work on multiple things in parallel - branches solve that problem

    • +

  • Git enables people to collaborate on code or text without stepping on each other’s toes

    • +

  • Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, +and if bugs are found one can find out exactly when it was introduced

    • +
+

Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices (e.g. how to use the staging area), which is useful for more experienced users.

+
+
+

Intended learning outcomes

+

By the end of this lesson, learners should:

+
    +

  • realize that version control is very important and Git is a valuable tool to learn and use

    • +

  • understand that Git is configurable and know how to set basic configurations

    • +

  • be able to set up Git repositories and make commits

    • +

  • understand that information on commits, branches etc. are stored under .git/, and have a +mental model of how that relates to the working directory

    • +

  • have a mental model of the different states a file can have in Git (untracked, modified, staged, unmodified)

    • +

  • know how to write good commit messages

    • +

  • have an idea of how the staging area can be used to craft good commits

    • +

  • know how to undo commits using git revert and discard changes using git restore

    • +

  • understand that git restore can be dangerous if changes have not been staged

    • +

  • know how to create branches and switch between branches

    • +

  • have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way

    • +

  • know how to merge branches and understand what that means in terms of combining different modifications

    • +

  • know how to resolve conflicts, or to abort conflicting merges

    • +

  • realize that conflicts are generally a good thing since they prevent incorrect merges

    • +

  • be able to set up a repository on GitHub and connect it with local repository

    • +

  • push changes to a remote repository

    • +

  • know a few ways to search through a repository and its history

    • +
+
+
+

How to teach this lesson

+
+

Take first editor steps slowly

+

Some participants will be new to using a terminal text editor so please open, +edit, and close the editor (Nano) slowly in first type-along sessions and +exercises to avoid that participants will fall behind the instructor. At one +point a student did not follow the file edits of the instructor, and to correct +the mistake they had to do a manual merge, which they were not ready for.

+
+
+

How to use the exercises

+

Most episodes have standard exercises followed by optional (often more advanced) exercises +for more experienced learners so they don’t get bored waiting for the newcomers. +The instructor should briefly introduce the exercises and mention that after finishing the +standard exercise (and indicating that using the green sticky) the learners can move on to the +optional ones if they wish. When at least half of the learners have raised the green sticky +the instructor should go through the standard exercise to describe its most important take-home messages. +It’s also fine to briefly go though important points from the optional exercises, but don’t spend +too much time on it since everyone will not have attempted them.

+
+
+

“Test your understanding” exercises

+

Some episodes have a “test your understanding” exercise at the end which is intended as formative assessment, +i.e. an activity that provides feedback to instructors and learners on whether learning objectives are being met. +The instructor should end each episode by posing the “test your understanding” multiple-choice question, +giving learners a minute to think about it, and then asking for the right answer or asking learners to raise their +hands to signal which answer they think is correct.

+
+
+

Inspecting history

+

Key lesson is how to find when something is broken or what commit has broken +the code.

+

It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that git annotate +and git show are available on GitHub and GitLab.

+

When discussing git annotate and git bisect the “when” is more important +than “who”. It is not to blame anybody but rather to find out whether published +results are affected.

+

Discuss how one would find out this information without version control.

+

Questions to involve participants:

+
    +

  • Have you ever found a bug in your code and wondered whether it has affected published results?

    • +

  • Have you ever wondered when, and by whom, a particular line of code was introduced?

    • +

  • Have you ever found out that a code behaves differently than it used to but you are not sure when +precisely this changed?

    • +
+

Confusion during git bisect exercise:

+

Learners may get stuck in the git bisect exercise if they incorrectly assign a commit +as bad or good. +To leave the bisect mode and return to the commit before git bisect start was issued, +one can do

+
$ git bisect reset
+
+
+

and start over if needed.

+
+
+

Live better than reading the website material

+

It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier.

+
+
+

Log your history in a separate window

+

The screencasting (shell window cheatsheet) hints have been moved to +the presenting +manual.

+
+
+

Create a cheatsheet on the board

+

For in-person workshops, create a “cheatsheet” on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven’t forgotten anything. Re-create and expand in future git lessons. +One strategy is:

+
    +

  • a common section for basic commands: init, config, clone, help, stash

    • +

  • info commands, can be run anytime: status, log, diff, graph

    • +

  • A section for all the commands that move code from different states: +add, commit, etc. See the visual cheat sheet below.

    • +
+

You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it’s probably too confusing to use after this course. But, the idea +of commands moving from the “working dir”, “staging area”, “commits”, +etc is good.

+
+Example cheat sheet +
+

Example cheat sheet.

+
+
+

We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to.

+
+
+

Draw a graph on the board

+

Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run git graph, then do the command, +then look at git graph again.

+
+
+

Repeat the following points

+
    +

  • Always check git status, git diff, and git graph (our alias) before and +after every command until you get used to things. These give you a clear view +into what is going on, the key to knowing what you are doing. Even +after you are used to things… anytime you do something you do +infrequently, it’s good to check.

    • +

  • git graph is a direct representation of what we are drawing on the +board and should constantly be compared to it.

    • +

  • Once you git add something, it’s almost impossible to lose it. +This is used all the time, for example once you commit or even add +it is hard to lose. Commit before you merge or rebase. And so on.

    • +
+
+
+

Start from identical environment

+

You probably have a highly optimized bash and git environment - one +that is different from students. Move .gitconfig and .bashrc out +of the way before you start so that your environment is identical to +what students have.

+
+
+
+
+
+
+
+

Why GitHub?

+

In this introduction we will mention and use +GitHub but also +GitLab and +Bitbucket allow similar workflows and +basically everything that we will discuss is transferable. With this +material and these exercises we do not implicitly endorse the company +GitHub. We have chosen to demonstrate a +number of concepts using examples with +GitHub because it is currently the most +popular web platform for hosting Git repositories and the chance is +high that you will interact with +GitHub-based repositories even if you choose +to host your Git repository on another platform.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/singlehtml/objects.inv b/branch/2023-version/singlehtml/objects.inv new file mode 100644 index 00000000..64062e47 Binary files /dev/null and b/branch/2023-version/singlehtml/objects.inv differ diff --git a/branch/2023-version/staging-area/index.html b/branch/2023-version/staging-area/index.html new file mode 100644 index 00000000..3baf7a6d --- /dev/null +++ b/branch/2023-version/staging-area/index.html @@ -0,0 +1,493 @@ + + + + + + + Using the Git staging area — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Using the Git staging area

+
+

Objectives

+
    +

  • Learn how to tell a story with your commit history.

    • +

  • Demystify the Git staging area.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 10 min exercise

    • +
+
+
+

Commit history is telling a story

+

Your current code is very important, but the history can be just +as important - it tells a story about how your code came to be.

+
    +

  • Each individual line of code rarely stands alone.

    • +

  • You often want to see all the related changes together.

    • +

  • But you also hardly ever do one thing at once.

    • +
+

Along with your code, Git creates a history for you, and if your +history is clear then you are a long way to organized code.

+
+

Discussion

+

Here are five types of history. What are the advantages and +disadvantages of each, when you look at it later?

+

Example 1:

+
b135ec8 add features A, B, and C
+
+
+

Example 2 (newest commit is on top):

+
6f0d49f implement feature C
+fee1807 implement feature B
+6fe2f23 implement feature A
+
+
+

Example 3:

+
ab990f4 saving three months of miscellaneous work I forgot to commit
+
+
+

Example 4 (newest commit is on top):

+
bf39f9d more work on feature B
+45831a5 removing debug prints for feature A and add new file
+bddb280 more work on feature B and make feature A compile again
+72d78e7 feature A did not work and started work on feature B
+b135ec8 now feature A should work
+72e0211 another fix to make it compile
+61dd3a3 forgot file and bugfix
+49dc419 wip (work in progress)
+
+
+

Example 5 (newest commit is on top):

+
1949dc4 Work of 2020-04-07
+a361dd3 Work of 2020-04-06
+1172e02 Work of 2020-04-03
+e772d78 Work of 2020-04-02
+
+
+

Discuss these examples. Can you anticipate problems?

+
+

We want to have nice commits. But we also want to “save often” +(checkpointing) - how can we have both?

+
    +

  • We will now learn to create nice commits using git commit --patch and/or the staging area.

    • +

  • Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits.

    • +

  • The staging area isn’t the only way to organize your history nicely, some alternatives are discussed at the end of the lesson.

    • +
+
+
+

Interactive commits

+
    +

  • The simplest ways to solve this is to do interactive commits: +the git commit --patch option (or git commit -p for short).

    • +

  • It will present you with every change you have made individually, +and you can decide which ones to commit right now.

    • +

  • Reference and key commands

    +
      +

    • git commit --patch to start the interactive commit

      • +

    • y to use the change

      • +

    • n to skip the change

      • +

    • s (split) if there are several changes grouped together, but +separated by a blank line, split them into separate choices.

      • +

    • q aborts everything.

      • +

    • ? for more options.

      • +
    +
    • +

  • The -p option is also available on commit, restore, checkout, reset, and add.

    • +
+
+
+

Exercise: Interactive commits

+
+

Staging-1: Perform an interactive commit

+

One option to help us create nice logical commits is to stage interactively +with git commit --patch:

+
    +

  1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

    2. +

  2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

    3. +

  3. Do it again for the other change.

    4. +

  4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

    5. +

  5. When would this be useful?

    6. +
+ +
+
+
+

The staging area

+
    +

  • The interactive commits above are great, but what if there are so +many changes that you can’t sort them out in one shot?

    • +

  • What if you make progress and want to record it somehow, but it’s +not ready to be committed?

    • +

  • The staging area is a place to record things before committing.

    • +
+
+

Instructor note

+

We give two examples and the instructor can pick one or both:

+
    +

  • Analogy using moving boxes

    • +

  • Analogy using shopping receipts

    • +
+
+
+

Discussion

+

Analogy using moving boxes

+
    +

  • You’re moving and you have a box to pack your things in.

    • +

  • You can put stuff into the box, but you can also take stuff out of the box.

    • +

  • You wouldn’t want to mix items from the bathroom, kitchen, and living room +into the same box.

    • +

  • The box corresponds to the staging area of Git, where you can craft your commits.

    • +

  • Committing is like sealing the box and sticking a label on it.

    • +

  • You wouldn’t want to label your box with “stuff”, but rather give a more +descriptive label.

    • +

  • See also https://dev.to/sublimegeek/git-staging-area-explained-like-im-five-1anh

    • +
+

Analogy using shopping receipts

+
    +

  • You need to go shopping and buy some stuff for work and for home. +You need two separate receipts.

    • +

  • Bad idea: go through the store get home stuff, pay, start at the +beginning and go through the store again. This is inefficient and +annoying.

    • +

  • What you actually do:

    +
      +

    • Go through the store and put everything you need in your shopping +basket.

      • +

    • Get to the check-out. Put your home stuff on the conveyor belt +(git add). Check both the belt (git diff --staged) and your +basket (git diff) to make sure you got all your home stuff.

      • +

    • Pay (git commit)

      • +

    • Repeat for work stuff.

      • +
    +
    • +
+

In order to keep organized, you have to use multiple locations to +stage things in sequence.

+
+
+
+

Staging area commands

+

The staging area is a middle ground between what you have done to your files +(the working directory) and what you have last committed (the HEAD commit). +Just like the name implies, it lets you prepare (stage) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since you can modify and stage several times before committing.

+

git add stages/prepares for the next commit:

+
                git add
+ [project*]  <------------  project*
+                               ^
+                               | modify with editor
+                               |
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git commit creates a new commit:

+
  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+  HEAD~2          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git reset --soft HEAD~1 (move HEAD back by one but keep changes and stage +them) would do the opposite of git commit. (in this case, HEAD +is literally this - not a replacement)

+

Going back to the last staged version:

+
              git restore
+ [project*]  ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Unstaging changes with git restore --staged:

+
          git restore --staged
+             ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Discarding unstaged changes:

+
                            project*
+                               |
+                               | git restore
+                               v
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Comparing:

+
                git diff
+ [project*]  <----------->  project*
+    ^                          ^
+    | git diff --staged        | git diff HEAD
+    v                          v
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+
+Staging basics +
+

The different states of the repository and the commands to move from one to +another.

+
+
+
+
+

Exercise: Using the staging area

+
+

Staging-2: Use the staging area to make a commit in two steps

+
    +

  1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

    2. +

  2. Use git add to stage one of the changes.

    3. +

  3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

    4. +

  4. Feel some regret and unstage the staged change.

    5. +
+
+
+

Discussion

+
    +

  • When is it better to “save” a change as commit, when is it better to “save” +it with git add?

    • +

  • Is it a problem to commit many small changes?

    • +
+
+
+

Keypoints

+
    +

  • The staging area helps us to create well-defined commits.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/under-the-hood/index.html b/branch/2023-version/under-the-hood/index.html new file mode 100644 index 00000000..a7f7b75f --- /dev/null +++ b/branch/2023-version/under-the-hood/index.html @@ -0,0 +1,321 @@ + + + + + + + Git under the hood — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Git under the hood

+
+

Objectives

+
    +

  • Verify that branches are pointers to commits and extremely lightweight.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+Git under the hood +
+
+

Down the rabbit hole

+

When working with Git, you will never need to go inside .git, but in this +exercise we will, in order to learn about how branches are implemented in Git.

+

For this exercise create a new repository and commit a couple of changes.

+

Now that we’ve made a couple of commits let us look at what is happening under +the hood.

+
$ cd .git
+$ ls -l
+
+drwxr-xr-x   - user 25 Aug 15:51 branches
+.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG
+.rw-r--r--  92 user 25 Aug 15:51 config
+.rw-r--r--  73 user 25 Aug 15:51 description
+.rw-r--r--  21 user 25 Aug 15:51 HEAD
+drwxr-xr-x   - user 25 Aug 15:51 hooks
+.rw-r--r-- 137 user 25 Aug 15:52 index
+drwxr-xr-x   - user 25 Aug 15:51 info
+drwxr-xr-x   - user 25 Aug 15:52 logs
+drwxr-xr-x   - user 25 Aug 15:52 objects
+drwxr-xr-x   - user 25 Aug 15:51 refs
+
+
+

Git stores everything under the .git folder in your repository. In fact, the +.git directory is the Git repository.

+

Previously when you wrote the commit messages using your text editor, they +were in fact saved to COMMIT_EDITMSG.

+

Each commit in Git is stored as a “blob”. This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file.

+

Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string).

+
+A commit inside Git +
+

States of a Git file. Image from the Pro Git book. License CC BY 3.0.

+
+
+

Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a directed acyclic +graph (do not worry +if the term is not familiar).

+
+A commit and its parents +
+

A commit and its parents. Image from the Pro Git book. License CC BY 3.0.

+
+
+

All branches and tags in Git are pointers to commits.

+
+
+

Git is basically a content-addressed storage system

+ +

Let us poke a bit into raw objects! Start with:

+
$ git cat-file -p HEAD
+
+
+

Then explore the tree object, then the file object, etc. recursively using the hashes you see.

+
+
+

Demonstration: experimenting with branches

+

Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an “Aha!” moment and provide us a +good understanding of the underlying model.

+

We are starting from the main branch and create an idea branch:

+
$ git status
+
+On branch main
+nothing to commit, working tree clean
+
+
+
$ git switch --create idea
+
+Switched to a new branch 'idea'
+
+
+
$ git branch
+
+* idea
+  main
+
+
+

Now let us go in:

+
$ cd .git
+$ cd refs/heads
+$ ls -l
+
+.rw-r--r-- 41 user 25 Aug 15:54 idea
+.rw-r--r-- 41 user 25 Aug 15:52 main
+
+
+

Let us check what the idea file looks like +(do not worry if the hash is different):

+
$ cat idea
+
+045e3db14740c60684d745e5fb891ae71e335611
+
+
+

Now let us replicate this file:

+
$ cp idea idea-2
+$ cp idea idea-3
+$ cp idea idea-4
+$ cp idea idea-5
+
+
+

Let us go up two levels and inspect the file HEAD:

+
$ cd ../..
+$ cat HEAD
+
+ref: refs/heads/idea
+
+
+

Let us open this file and change it to:

+
ref: refs/heads/idea-3
+
+
+

Now we are ready for the aha moment! +First let us go back to the working area:

+
$ cd ..
+
+
+

Now - on which branch are we?

+
$ git branch
+
+  idea
+  idea-2
+* idea-3
+  idea-4
+  idea-5
+  main
+
+
+
+

Discussion

+

Discuss the findings with other course participants.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/2023-version/what-to-avoid/index.html b/branch/2023-version/what-to-avoid/index.html new file mode 100644 index 00000000..85a8b76e --- /dev/null +++ b/branch/2023-version/what-to-avoid/index.html @@ -0,0 +1,197 @@ + + + + + + + What to avoid — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

What to avoid

+

The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas.

+

Postponing commits because the changes are “unfinished”/”ugly”: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all.

+

Not updating your branch before starting new work: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later.

+

Commit unrelated changes together: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects.

+

Too ambitious branch which risks to never get completed: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere.

+

Committing generated files: See Ignoring files and paths with .gitignore.

+

Over-engineering the branch layout and safeguards in small projects: This +may prevent people from contributing (maybe even including yourself?). Add more restrictions and safeguards as +the project and the group of collaborators grows.

+

Commit messages that explain what has been changed but do not explain why it has been +changed: This is as useful as code comments which describe the “obvious” such +as “this is a loop” instead of explaining why something is done this way. +But don’t let perfect commit messages stop you from the most important point, committing often (first point).

+

Commit huge files: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent git rm does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request.

+
+

Discussion

+

Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/.buildinfo b/branch/main/.buildinfo new file mode 100644 index 00000000..5a3dbcf9 --- /dev/null +++ b/branch/main/.buildinfo @@ -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: e21ba9a26a1fa041e43d0d2e9e34e5b6 +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/branch/main/.nojekyll b/branch/main/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/branch/main/_images/add-file.png b/branch/main/_images/add-file.png new file mode 100644 index 00000000..9683b2db Binary files /dev/null and b/branch/main/_images/add-file.png differ diff --git a/branch/main/_images/annotate.png b/branch/main/_images/annotate.png new file mode 100644 index 00000000..8021920a Binary files /dev/null and b/branch/main/_images/annotate.png differ diff --git a/branch/main/_images/annotate1.png b/branch/main/_images/annotate1.png new file mode 100644 index 00000000..93416b2a Binary files /dev/null and b/branch/main/_images/annotate1.png differ diff --git a/branch/main/_images/bare-repository.png b/branch/main/_images/bare-repository.png new file mode 100644 index 00000000..45286f93 Binary files /dev/null and b/branch/main/_images/bare-repository.png differ diff --git a/branch/main/_images/browse-files.png b/branch/main/_images/browse-files.png new file mode 100644 index 00000000..5fcc3528 Binary files /dev/null and b/branch/main/_images/browse-files.png differ diff --git a/branch/main/_images/cheat-sheet.jpg b/branch/main/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/branch/main/_images/cheat-sheet.jpg differ diff --git a/branch/main/_images/code-portion.png b/branch/main/_images/code-portion.png new file mode 100644 index 00000000..39356bd5 Binary files /dev/null and b/branch/main/_images/code-portion.png differ diff --git a/branch/main/_images/commit-and-tree.png b/branch/main/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/branch/main/_images/commit-and-tree.png differ diff --git a/branch/main/_images/commit-changes.png b/branch/main/_images/commit-changes.png new file mode 100644 index 00000000..4c0546c6 Binary files /dev/null and b/branch/main/_images/commit-changes.png differ diff --git a/branch/main/_images/commits-and-parents.png b/branch/main/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/branch/main/_images/commits-and-parents.png differ diff --git a/branch/main/_images/commits.png b/branch/main/_images/commits.png new file mode 100644 index 00000000..b154c666 Binary files /dev/null and b/branch/main/_images/commits.png differ diff --git a/branch/main/_images/create-repository-with-readme.png b/branch/main/_images/create-repository-with-readme.png new file mode 100644 index 00000000..24118344 Binary files /dev/null and b/branch/main/_images/create-repository-with-readme.png differ diff --git a/branch/main/_images/create-repository.png b/branch/main/_images/create-repository.png new file mode 100644 index 00000000..80fb99c2 Binary files /dev/null and b/branch/main/_images/create-repository.png differ diff --git a/branch/main/_images/edit-file.png b/branch/main/_images/edit-file.png new file mode 100644 index 00000000..f7527bd0 Binary files /dev/null and b/branch/main/_images/edit-file.png differ diff --git a/branch/main/_images/file-history.png b/branch/main/_images/file-history.png new file mode 100644 index 00000000..5e42fbe9 Binary files /dev/null and b/branch/main/_images/file-history.png differ diff --git a/branch/main/_images/fork.png b/branch/main/_images/fork.png new file mode 100644 index 00000000..0c992d3d Binary files /dev/null and b/branch/main/_images/fork.png differ diff --git a/branch/main/_images/forking.png b/branch/main/_images/forking.png new file mode 100644 index 00000000..73c4d71a Binary files /dev/null and b/branch/main/_images/forking.png differ diff --git a/branch/main/_images/git-annotate.png b/branch/main/_images/git-annotate.png new file mode 100644 index 00000000..60c6f7c2 Binary files /dev/null and b/branch/main/_images/git-annotate.png differ diff --git a/branch/main/_images/git-branch-1.svg b/branch/main/_images/git-branch-1.svg new file mode 100644 index 00000000..4b735e40 --- /dev/null +++ b/branch/main/_images/git-branch-1.svg @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + m2 + + + m3 + + + m1 + + + + + main + + + + + HEAD + + + diff --git a/branch/main/_images/git-branch-2.svg b/branch/main/_images/git-branch-2.svg new file mode 100644 index 00000000..dde628b6 --- /dev/null +++ b/branch/main/_images/git-branch-2.svg @@ -0,0 +1,443 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + l1 + + + e2 + + + e1 + + + m5 + + + m4 + + + m2 + + + m3 + + + m1 + + + + + less-salt + + + + + HEAD + + + + + experiment + + + + + main + + + diff --git a/branch/main/_images/git-branch-3.svg b/branch/main/_images/git-branch-3.svg new file mode 100644 index 00000000..19231579 --- /dev/null +++ b/branch/main/_images/git-branch-3.svg @@ -0,0 +1,475 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + e2 + + + m3 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + + + less-salt + + + + + experiment + + + diff --git a/branch/main/_images/git-collaborative.svg b/branch/main/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/branch/main/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/branch/main/_images/git-deleted-branches.svg b/branch/main/_images/git-deleted-branches.svg new file mode 100644 index 00000000..d54c0032 --- /dev/null +++ b/branch/main/_images/git-deleted-branches.svg @@ -0,0 +1,483 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + m5 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + diff --git a/branch/main/_images/git-log-github.png b/branch/main/_images/git-log-github.png new file mode 100644 index 00000000..db44d29b Binary files /dev/null and b/branch/main/_images/git-log-github.png differ diff --git a/branch/main/_images/git-log-terminal.png b/branch/main/_images/git-log-terminal.png new file mode 100644 index 00000000..56493e6e Binary files /dev/null and b/branch/main/_images/git-log-terminal.png differ diff --git a/branch/main/_images/git-merge-1.svg b/branch/main/_images/git-merge-1.svg new file mode 100644 index 00000000..005301ab --- /dev/null +++ b/branch/main/_images/git-merge-1.svg @@ -0,0 +1,515 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + m3 + + + l1 + + + m7 + + + m4 + + + + + experiment + + + + + less-salt + + + + + main + + + + + HEAD + + + diff --git a/branch/main/_images/git-merge-2.svg b/branch/main/_images/git-merge-2.svg new file mode 100644 index 00000000..cb268ee7 --- /dev/null +++ b/branch/main/_images/git-merge-2.svg @@ -0,0 +1,555 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + l1 + + + m5 + + + m4 + + + + + experiment + + + + + main + + + + + HEAD + + + + + less-salt + + + diff --git a/branch/main/_images/git-pre-ff.svg b/branch/main/_images/git-pre-ff.svg new file mode 100644 index 00000000..e4d8bc5b --- /dev/null +++ b/branch/main/_images/git-pre-ff.svg @@ -0,0 +1,615 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e1 + + + e2 + + + m7 + + + m8 + + + n3 + + + n1 + + + m5 + + + l1 + + + m6 + + + m4 + + + n2 + + + m2 + + + m3 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + main + + + diff --git a/branch/main/_images/git_stage_commit.svg b/branch/main/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/branch/main/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/main/_images/github-branches-overview.png b/branch/main/_images/github-branches-overview.png new file mode 100644 index 00000000..89e0058d Binary files /dev/null and b/branch/main/_images/github-branches-overview.png differ diff --git a/branch/main/_images/github-branches.png b/branch/main/_images/github-branches.png new file mode 100644 index 00000000..3a6a8ff9 Binary files /dev/null and b/branch/main/_images/github-branches.png differ diff --git a/branch/main/_images/github-comparing-changes.png b/branch/main/_images/github-comparing-changes.png new file mode 100644 index 00000000..735b990b Binary files /dev/null and b/branch/main/_images/github-comparing-changes.png differ diff --git a/branch/main/_images/github-contribute.png b/branch/main/_images/github-contribute.png new file mode 100644 index 00000000..a149e9f3 Binary files /dev/null and b/branch/main/_images/github-contribute.png differ diff --git a/branch/main/_images/github-create-branch.png b/branch/main/_images/github-create-branch.png new file mode 100644 index 00000000..e7958ff2 Binary files /dev/null and b/branch/main/_images/github-create-branch.png differ diff --git a/branch/main/_images/github-create-tag.png b/branch/main/_images/github-create-tag.png new file mode 100644 index 00000000..f08f5878 Binary files /dev/null and b/branch/main/_images/github-create-tag.png differ diff --git a/branch/main/_images/github-merged.png b/branch/main/_images/github-merged.png new file mode 100644 index 00000000..eea47d93 Binary files /dev/null and b/branch/main/_images/github-merged.png differ diff --git a/branch/main/_images/github-navigate-to-branch.png b/branch/main/_images/github-navigate-to-branch.png new file mode 100644 index 00000000..42b0f753 Binary files /dev/null and b/branch/main/_images/github-navigate-to-branch.png differ diff --git a/branch/main/_images/gophers.png b/branch/main/_images/gophers.png new file mode 100644 index 00000000..741406ba Binary files /dev/null and b/branch/main/_images/gophers.png differ diff --git a/branch/main/_images/history.png b/branch/main/_images/history.png new file mode 100644 index 00000000..6384e302 Binary files /dev/null and b/branch/main/_images/history.png differ diff --git a/branch/main/_images/history1.png b/branch/main/_images/history1.png new file mode 100644 index 00000000..06662c31 Binary files /dev/null and b/branch/main/_images/history1.png differ diff --git a/branch/main/_images/license.png b/branch/main/_images/license.png new file mode 100644 index 00000000..f4cadf0d Binary files /dev/null and b/branch/main/_images/license.png differ diff --git a/branch/main/_images/meld.png b/branch/main/_images/meld.png new file mode 100644 index 00000000..774f9cd1 Binary files /dev/null and b/branch/main/_images/meld.png differ diff --git a/branch/main/_images/mergetool.png b/branch/main/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/branch/main/_images/mergetool.png differ diff --git a/branch/main/_images/network.png b/branch/main/_images/network.png new file mode 100644 index 00000000..e0fcb2fb Binary files /dev/null and b/branch/main/_images/network.png differ diff --git a/branch/main/_images/new-repo-form.png b/branch/main/_images/new-repo-form.png new file mode 100644 index 00000000..b808ee0b Binary files /dev/null and b/branch/main/_images/new-repo-form.png differ diff --git a/branch/main/_images/new-repo-plus.png b/branch/main/_images/new-repo-plus.png new file mode 100644 index 00000000..e58ba5d8 Binary files /dev/null and b/branch/main/_images/new-repo-plus.png differ diff --git a/branch/main/_images/new-repository.png b/branch/main/_images/new-repository.png new file mode 100644 index 00000000..aff76772 Binary files /dev/null and b/branch/main/_images/new-repository.png differ diff --git a/branch/main/_images/pen-symbol.png b/branch/main/_images/pen-symbol.png new file mode 100644 index 00000000..044902a3 Binary files /dev/null and b/branch/main/_images/pen-symbol.png differ diff --git a/branch/main/_images/preview.png b/branch/main/_images/preview.png new file mode 100644 index 00000000..8a602b66 Binary files /dev/null and b/branch/main/_images/preview.png differ diff --git a/branch/main/_images/search.png b/branch/main/_images/search.png new file mode 100644 index 00000000..4462f71e Binary files /dev/null and b/branch/main/_images/search.png differ diff --git a/branch/main/_images/search1.png b/branch/main/_images/search1.png new file mode 100644 index 00000000..89c0e25a Binary files /dev/null and b/branch/main/_images/search1.png differ diff --git a/branch/main/_images/show.png b/branch/main/_images/show.png new file mode 100644 index 00000000..12d7915c Binary files /dev/null and b/branch/main/_images/show.png differ diff --git a/branch/main/_images/staging-basics.svg b/branch/main/_images/staging-basics.svg new file mode 100644 index 00000000..13df8bf5 --- /dev/null +++ b/branch/main/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + restore + add + commit + restore + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/branch/main/_images/stranger.jpg b/branch/main/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/branch/main/_images/stranger.jpg differ diff --git a/branch/main/_images/upload-files.png b/branch/main/_images/upload-files.png new file mode 100644 index 00000000..fd3ef8cc Binary files /dev/null and b/branch/main/_images/upload-files.png differ diff --git a/branch/main/_images/vscode-add-and-commit.png b/branch/main/_images/vscode-add-and-commit.png new file mode 100644 index 00000000..d9a09c46 Binary files /dev/null and b/branch/main/_images/vscode-add-and-commit.png differ diff --git a/branch/main/_images/vscode-authorize.png b/branch/main/_images/vscode-authorize.png new file mode 100644 index 00000000..4d45dc2d Binary files /dev/null and b/branch/main/_images/vscode-authorize.png differ diff --git a/branch/main/_images/vscode-change-branch.png b/branch/main/_images/vscode-change-branch.png new file mode 100644 index 00000000..c1a5f00a Binary files /dev/null and b/branch/main/_images/vscode-change-branch.png differ diff --git a/branch/main/_images/vscode-create-branch.png b/branch/main/_images/vscode-create-branch.png new file mode 100644 index 00000000..71b275a9 Binary files /dev/null and b/branch/main/_images/vscode-create-branch.png differ diff --git a/branch/main/_images/vscode-merging.png b/branch/main/_images/vscode-merging.png new file mode 100644 index 00000000..7e5880e7 Binary files /dev/null and b/branch/main/_images/vscode-merging.png differ diff --git a/branch/main/_images/vscode-open-terminal.png b/branch/main/_images/vscode-open-terminal.png new file mode 100644 index 00000000..1be92267 Binary files /dev/null and b/branch/main/_images/vscode-open-terminal.png differ diff --git a/branch/main/_images/vscode-publish-to-github1.png b/branch/main/_images/vscode-publish-to-github1.png new file mode 100644 index 00000000..883e756c Binary files /dev/null and b/branch/main/_images/vscode-publish-to-github1.png differ diff --git a/branch/main/_images/vscode-publish-to-github2.png b/branch/main/_images/vscode-publish-to-github2.png new file mode 100644 index 00000000..d0055db4 Binary files /dev/null and b/branch/main/_images/vscode-publish-to-github2.png differ diff --git a/branch/main/_images/vscode-publish-to-github3.png b/branch/main/_images/vscode-publish-to-github3.png new file mode 100644 index 00000000..0f68d0ee Binary files /dev/null and b/branch/main/_images/vscode-publish-to-github3.png differ diff --git a/branch/main/_images/vscode-start.png b/branch/main/_images/vscode-start.png new file mode 100644 index 00000000..e7830807 Binary files /dev/null and b/branch/main/_images/vscode-start.png differ diff --git a/branch/main/_sources/aliases.md.txt b/branch/main/_sources/aliases.md.txt new file mode 100644 index 00000000..a257a1b7 --- /dev/null +++ b/branch/main/_sources/aliases.md.txt @@ -0,0 +1,156 @@ +(aliases)= + +# Aliases and configuration + +```{objectives} +- Learn to use aliases for most common commands. +``` + +Are you getting tired of typing so much? In Git you can define aliases (shortcuts): +- These are great because they can save you time typing. +- But it's easy to forget them, get confused, or be inconsistent with your colleagues. + +There is plenty of other configuration for Git, that can make it nicer. + + +## Aliases + +- Aliases offer a way to improve the usability of Git: for + example `git ci` instead of `git commit`. +- Aliases are based on simple string replacement in the command. +- Aliases can either be specific to a repository or global. + - Global aliases help you do the things you are used to across Git projects. + - Per-project aliases can also be created. +- Global aliases are stored in `~/.gitconfig`. + + +## Example alias: git graph + +A very useful shortcut which we use a lot in our workshops: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ cd your_git_repository +$ git graph +``` + + +## Using external commands + +It is possible to call external commands using the exclamation mark character "!". +In this example here we create a local alias which is +stored in `.git/config` and not synchronized with remotes: + +```console +$ cd your_git_repository +$ git config alias.hi '!echo hello' +$ git hi +``` + +```{discussion} Food for thought: When to alias? +- How many times should you wait before aliasing a command? +- Do you believe a list of generic two-letter acronyms for common commands will + save your time? +``` + + +## List of aliases the instructors use + +You are welcome to reuse, suggest, improve. +You can see your current aliases in `~/.gitconfig`. + +```console +$ git config --global alias.ap "add --patch" +$ git config --global alias.br branch +$ git config --global alias.ci "commit -v" +$ git config --global alias.cip "commit --patch -v" +$ git config --global alias.cl "clone --recursive" +$ git config --global alias.di diff +$ git config --global alias.dic "diff --staged --color-words" +$ git config --global alias.diw "diff --color-words" +$ git config --global alias.dis "!git --no-pager diff --stat" +$ git config --global alias.fe fetch +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ git config --global alias.rem remote +$ git config --global alias.st status +$ git config --global alias.su "submodule update --init --recursive" +``` + +Here is what they do: +- `ap`: add, selecting parts individually, interactively. +- `br`: branch (obvious) +- `ci`: commit (check in), with `-v` option for clarity +- `cip`: commit, selecting parts individually, interactively. +- `cl`: clone, init submodules (submodules are an advanced topic) +- `di`: diff (obvious) +- `dic`: diff of staging area vs last commit (what is about to be committed) +- `diw`: a word diff, color. Useful for small changes. +- `dis`: a "diffstat": what files are changed, not contents +- `fe`: fetch (obvious) +- `graph`: show whole git graph (so useful, some of us call it `l`) +- `rem`: remote (obvious) +- `st`: status (obvious) +- `su`: submodule update (advanced) + +A useful setting for the `p` aliases: +```console +$ git config --global interactive.singlekey true +``` + + +## Advanced aliases + +These are advanced aliases and configuration options. We won't explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages! + +```console +$ git config --global alias.cif "commit -v -p --fixup" +$ git config --global alias.rb "rebase --autosquash" +$ git config --global alias.rbi "rebase --interactive --autosquash" +$ git config --global alias.rbis "rebase --interactive --autosquash --autostash" +$ git config --global alias.rbs "rebase --autosquash --autostash" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard" +$ git config --global alias.new "log HEAD..HEAD@{upstream}" +$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}" +$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}" +$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all" +$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD" +$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat" +``` + +## Advanced Git configuration + +Besides aliases, you can do plenty of other configuration of `git`. +Here are some of the most common ones: + +```console +$ git config --global interactive.singlekey true +$ git config --global core.pager "less -RS" +$ git config --global core.excludesfile ~/.gitignore +$ git config --global merge.conflictstyle diff3 +$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]" +$ git config --global diff.mnemonicPrefix true +``` + +Do you get tired of typing and copying and pasting your remote names +all the time, like `git@github.com:myusername`? You can create remote +aliases like this: + +```console +$ git config --global url.git@github.com:.insteadOf gh: +$ git config --global url.git@github.com:/username/.insteadOf ghu: +``` + +Then, when you add a remote `ghu:recipe`, it will automatically be +translated to `git@github.com:/username/recipe` using a simple prefix +matching. + + +```{keypoints} +- If you are frustrated about remembering a command, you should create an alias. +``` diff --git a/branch/main/_sources/archaeology.md.txt b/branch/main/_sources/archaeology.md.txt new file mode 100644 index 00000000..c8fade0f --- /dev/null +++ b/branch/main/_sources/archaeology.md.txt @@ -0,0 +1,488 @@ +# Inspecting history + +:::{objectives} +- Be able find a line of code, find out why it was introduced and when. +- Be able to quickly find the commit that changed a behavior. +::: + +:::{instructor-note} +- 30 min teaching/type-along +- 20 min exercise +::: + + +## Command line, GitHub, and VS Code + +As usual, we offer ways to do this with the command line, VS Code, and +GitHub. + +* **Command line** is most powerful and relatively easy with this. + You may also use it along with other things. If you haven't tried + it yet, we'd recommend you to give it a try. +* The **GitHub** web interface allows many things to be done, but not + everything. +* **VS Code** allows some of these, but for some it's easier to open + the VS Code terminal and run git there. + + +## Our toolbox for history inspection + +:::{instructor-note} +First the instructor demonstrates few commands on a real life example +repository (mentioned in the amazing site [The +Programming Historian](https://programminghistorian.org/)). +Later we will practice these in an archaeology exercise (below). +::: + + +### Warm-up: ["Git History" browser](https://githistory.xyz/) + +As a warm-up we can try the ["Git History" browser](https://githistory.xyz/) +on the README.rst file of the [networkx](https://github.com/networkx/networkx) repository: + +- Visit and browse (use left/right keys). +- You can try this on some of your GitHub repositories, too! + + +### Searching text patterns in the repository + +With `git grep` you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or +some error message printed. + +:::::{tabs} + ::::{group-tab} Command line + The Git command is as described above: + ```console + $ git grep TEXT + $ git grep "some text with spaces" + ``` + + In the [networkx](https://github.com/networkx/networkx) repository you can try: + + ```console + $ git clone https://github.com/networkx/networkx + $ cd networkx + $ git grep -i fixme + ``` + + While `git grep` searches the **current state** of the repository, + it is also possible to search through all changes with `git log -S sometext` + which can be useful to find where something got removed. + :::: + + ::::{group-tab} GitHub + We can try the same example in the browser: + + + ```{figure} img/archaeology/search.png + :alt: Searching for "fixme" in a GitHub repository + :width: 100% + :class: with-border + + Searching for "fixme" in a GitHub repository. + ``` + :::: + + ::::{group-tab} VS Code + Our example repository is . + From a new VS Code window, select "Clone Git repository" and enter + that URL. + + Searching with the magnifying glass from the left sidebar is + equivalent to `git grep`. + :::: +::::: + + +### Inspecting individual commits + +:::::{tabs} + ::::{group-tab} Command line + We have seen this one before already. Using `git show` we can inspect an individual commit if + we know its hash: + + ```console + $ git show HASH + ``` + + For instance: + ```console + $ git show 759d589bdfa61aff99e0535938f14f67b01c83f7 + ``` + :::: + + ::::{group-tab} GitHub + We can try the same example in the browser: + + + ```{figure} img/archaeology/show.png + :alt: Inspecting an individual commit on GitHub + :width: 100% + :class: with-border + + Inspecting an individual commit on GitHub. + ``` + :::: + + ::::{group-tab} VS Code + We don't know of a built-in way to see every single Git commit in + order (extensions allow this). You can open the terminal and run + the command line option. + + But, if you open single files, a "Timeline" view under the + explorer shows changes to *that file*. You can click on a change + to see the details. + :::: +::::: + + +### Line-by-line code annotation with metadata + +With `git annotate` you can see line by line who and **when** the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility. + +:::::{tabs} + ::::{group-tab} Command line + ```console + $ git annotate FILE + ``` + + Example: + ```console + $ git annotate networkx/convert_matrix.py + ``` + + If you annotate in a terminal and the file is longer than the screen, Git by default uses the program `less` to + scroll the output. + Use `/sometext` `` to find "sometext" and you can cycle through the results with `n` (next) and `N` (last). + You can also use page up/down to scroll. You can quit with `q`. + :::: + + ::::{group-tab} GitHub + We can try the same example in the browser: + + + ```{figure} img/archaeology/annotate.png + :alt: Screenshot of file annotation on GitHub + :width: 100% + :class: with-border + + Screenshot of file annotation on GitHub. + ``` + :::: + + ::::{group-tab} VS Code + It seems this needs an extension. We'd recommend trying the + command line method for now. + :::: +::::: + +:::{discussion} +Discuss how these relatively trivial changes affect the annotation: +- Wrapping long lines of text/code into shorter lines +- Auto-formatting tools such as `black` +- Editors that automatically remove trailing whitespace +::: + + +### Inspecting code in the past + +:::::{tabs} + ::::{group-tab} Command line + We can create branches pointing to a commit in the past. + This is the recommended mechanism to inspect old code: + + ```console + $ git switch --create BRANCHNAME HASH + ``` + + Example (lines starting with "#" are only comments): + + ```console + $ # create branch called "older-code" from hash 347e6292419b + $ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9 + + $ # now you can navigate and inspect the code as it was back then + $ # ... + + $ # after we are done we can switch back to "main" + $ git switch main + + $ # if we like we can delete the "older-code" branch + $ git branch -d older-code + ``` + + On old Git versions which do not know the `switch` command (before 2.23), you + need to use this instead: + + ```console + $ git checkout -b BRANCHNAME SOMEHASH + ``` + :::: + + ::::{group-tab} GitHub + We now know how to visit a specific commit: + + + Once we are there we can "Browse files" at that point in history. + + ```{figure} img/archaeology/browse-files.png + :alt: Browsing code in the past on GitHub + :width: 100% + :class: with-border + + Browsing code in the past on GitHub. + ``` + :::: + + ::::{group-tab} VS Code + Switch to "Source Control", then the "..." menu, then "Branch", then "Create new branch from..." and now you can type a commit identifier (hash). + + Make sure you change back to the main branch when you are done. + :::: +::::: + + +## Exercise + +This is described with the command line method, but by looking above +you can translate to the other options. + +:::::{exercise} Exercise: Explore basic archaeology commands (20 min) + Let us explore the value of these commands in an exercise. Future + exercises do not depend on this, so it is OK if you do not complete + it fully. + + Exercise steps: + - **Make sure you are not inside another Git repository** when running this + exercise. If you are, first step "outside" of it. + We want to avoid creating a Git repository inside another Git repository. + :::::{tabs} + ::::{group-tab} Command line + You can check if you are inside a Git repository with: + ```console + $ git status + + fatal: not a git repository (or any of the parent directories): .git + ``` + You want to see the above message which tells us that this is not a Git repository. + :::: + + ::::{group-tab} GitHub + This is not a problem in the GitHub web interface since we are not + creating a new local repository. + :::: + + ::::{group-tab} VS Code + "File" -> "New Window". + :::: + ::::: + + - Clone this repository: + . + :::::{tabs} + ::::{group-tab} Command line + ```console + $ git clone https://github.com/networkx/networkx.git + ``` + :::: + + ::::{group-tab} GitHub + Nothing to clone. We will try to inspect the repository directly on GitHub. + :::: + + ::::{group-tab} VS Code + From a new VS Code window, select "Clone Git repository" and enter + that URL. + :::: + ::::: + + - Then let us all **make sure we are working on a well-defined version** of the repository. + :::::{tabs} + ::::{group-tab} Command line + Step into the new directory and create an exercise branch from the + networkx-2.6.3 tag/release: + ```console + $ cd networkx + $ git switch --create exercise networkx-2.6.3 + ``` + On old Git versions which do not know the `switch` command (before 2.23), you + need to use this instead: + ```console + $ git checkout -b exercise networkx-2.6.3 + ``` + :::: + + ::::{group-tab} GitHub + We can visit the version directly: + :::: + + ::::{group-tab} VS Code + Switch to "Source Control", then the "..." menu, then "Branch", then "Create new branch from..." and select "networkx-2.6.3". + :::: + ::::: + + Then using the above toolbox try to: + 1. Find the code line which contains `"Logic error in degree_correlation"`. + 1. Find out when this line was last modified or added. Find the actual commit which modified that line. + 1. Inspect that commit with `git show`. + 1. Create a branch pointing to the past when that commit was created to be + able to browse and use the code as it was back then. + 1. How would you bring the code to the version of the code right before that line was last modified? + + ::::{solution} + We provide here a solution for the command line but we also encourage you to + try to solve this in the browser. + + 1. We use `git grep`: + ```console + $ git grep "Logic error in degree_correlation" + ``` + This gives the output: + ``` + networkx/algorithms/threshold.py: print("Logic error in degree_correlation", i, rdi) + ``` + Maybe you also want to know the line number: + ```console + $ git grep -n "Logic error in degree_correlation" + ``` + 2. We use `git annotate`: + ```console + $ git annotate networkx/algorithms/threshold.py + ``` + Then search for "Logic error" by typing "/Logic error" followed by Enter. + The last commit that modified it was `90544b4fa` (unless that line changed since). + 3. We use `git show`: + ```console + $ git show 90544b4fa + ``` + 4. Create a branch pointing to that commit (here we called the branch "past-code"): + ```console + $ git branch past-code 90544b4fa + ``` + 5. This is a compact way to access the first parent of `90544b4fa` (here we + called the branch "just-before"): + ```console + $ git switch --create just-before 90544b4fa~1 + ``` + :::: +::::: + +--- + +## Finding out when something broke/changed with `git bisect` + +This only works with the command line. + +> *"But I am sure it used to work! Strange."* + +Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke. + +:::{discussion} How would you solve this? +Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now. + +- How would you find the commit which changed it? +- Why could it be useful to know the commit that changed it? +::: + +We will probably arrive at a solution which is similar to `git bisect`: + +- First find out a commit in past when it worked. + ```console + $ git bisect start + $ git bisect good f0ea950 # this is a commit that worked + $ git bisect bad main # last commit is broken + ``` +- Now compile and/or run and/or test and decide whether "good" or "bad". +- This is how you can tell Git that this was a working commit: + ```console + $ git bisect good + ``` +- And this is how you can tell Git that this was not a working commit: + ```console + $ git bisect bad + ``` +- Then bisect/iterate your way until you find the commit that broke it. +- If you want to go back to start, type `git bisect reset`. +- This can even be automatized with `git bisect run SCRIPT`. + For this you write a script that returns zero/non-zero (success/failure). + + +(exercise-bisect)= + +## Optional exercise: Git bisect + +This only works with the command line. + +::::{exercise} (optional) History-2: Use git bisect to find the bad commit + In this exercise, we use `git bisect` on an example repository. It + is OK if you do not complete this exercise fully. + + Begin by cloning [https://github.com/coderefinery/git-bisect-exercise](https://github.com/coderefinery/git-bisect-exercise). + + + **Motivation** + + The motivation for this exercise is to be able to do archaeology with Git on a + source code where the bug is difficult to see visually. **Finding the offending + commit is often more than half the debugging**. + + + **Background** + + The script `get_pi.py` approximates pi using terms of the Nilakantha series. It + should produce 3.14 but it does not. The script broke at some point and + produces 3.57 using the last commit: + + ```console + $ python get_pi.py + + 3.57 + ``` + + At some point within the 500 first commits, an error was introduced. The only + thing we know is that the first commit worked correctly. + + + **Your task** + + - Clone this repository and use `git bisect` to find the commit which + broke the computation + ([solution - spoiler alert!](https://github.com/coderefinery/git-bisect-exercise#solutions-spoiler-alert)). + - Once you have found the offending commit, also practice navigating to the last good commit. + - Bonus exercise: + Write a script that checks for a correct result and use `git bisect run` to + find the offending commit automatically + ([solution - spoiler alert!](https://github.com/coderefinery/git-bisect-exercise#solutions-spoiler-alert)). + + + **Hints** + + Finding the first commit: + + ```console + $ git log --oneline | tail -n 1 + ``` + + How to navigate to the parent of a commit with hash SOMEHASH: + ```console + $ git switch --create BRANCHNAME SOMEHASH~1 + ``` + + Instead of a tilde you can also use this: + ```console + $ git switch --create BRANCHNAME SOMEHASH^ + ``` +:::: + + +## Summary + +- git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project on the command line. +- `git switch --create NAME HASH` is the recommended mechanism to inspect old code on the command line. +- Most of these commands can be used in the GitHub web interface (except `git bisect`). diff --git a/branch/main/_sources/basics.md.txt b/branch/main/_sources/basics.md.txt new file mode 100644 index 00000000..fb56e9ca --- /dev/null +++ b/branch/main/_sources/basics.md.txt @@ -0,0 +1,715 @@ +# Basics + +```{objectives} +- Learn to create Git repositories and make commits. +- Get a grasp of the structure of a repository. +- Learn how to inspect the project history. +- Learn how to write useful commit log messages. +``` + +```{instructor-note} +- 35 min teaching/type-along +- 40 min exercise +``` + + +## What is Git, and what is a Git repository? + +- Git is a version control system: can **record/save snapshots** and track the content of a folder as it changes over time. +- Every time we **commit** a snapshot, Git records a snapshot of the **entire project**, saves it, and assigns it a version. +- These snapshots are kept inside a sub-folder called `.git`. +- If we remove `.git`, we remove the repository and history (but keep the working directory!). +- The directory `.git` uses relative paths - you can move the whole repository somewhere else and it will still work. +- Git doesn't do anything unless you ask it to (it **does not record anything automatically**). +- Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces). + + +## Recording a snapshot with Git + +- Git takes snapshots only if we request it. +- We will record changes in two steps (we will later explain why this is a recommended practice). +- Example (we don't need to type yet): + + ```console + $ git add FILE.txt + $ git commit + + $ git add FILE.txt ANOTHERFILE.txt + $ git commit + ``` + +- We first focus (`git add`, we "stage" the change), then record (`git commit`): + +```{figure} img/git_stage_commit.svg +:alt: Git staging +:width: 100% + +Git staging and committing. +``` + +```{discussion} Question for the more advanced participants +What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end. +``` + + +## Configuring Git command line + +Before we start using Git on the command line, we need to configure Git. +This is also part of the +[installation instructions](https://coderefinery.github.io/installation/shell-and-git/#configuration) +but we need to make sure we all have +set name, email address, editor, and +default branch: +```console +$ git config --global user.name "Your Name" +$ git config --global user.email yourname@example.com +$ git config --global core.editor nano +$ git config --global init.defaultBranch main +``` + +Verify with: +```console +$ git config --list +``` + +```{instructor-note} +Instructors, give learners enough time to do the above configuration steps. +``` + + +## Type-along: Tracking a guacamole recipe with Git + +We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list) + +The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language. + +```{instructor-note} +Instructors, please encourage now that participants type along. +``` + +```{note} +It is possible to go through this lesson in the command line or in the browser +(on GitHub). + +- We recommend to start with the command line but later to also try in the browser. +- If you get really stuck in the command line, try following in the browser and + later you can try to return to the command line. +``` + + +## Creating a repository + +One of the basic principles of Git is that it is **easy to create repositories**: + +`````{tabs} + ````{group-tab} Command line + ```console + $ mkdir recipe + $ cd recipe + $ git init -b main + ``` + + That's it! With `git init -b main` have now created an empty Git repository + where `main` is the default branch (more about branches later). + + We will use `git status` a lot to check out what is going on: + + ```console + $ git status + + On branch main + + No commits yet + + nothing to commit (create/copy files and use "git add" to track) + ``` + + We will make sense of this information during this workshop. + ```` + + ````{group-tab} Browser (GitHub) + First log into GitHub, then follow the screenshots and descriptions below. + + ```{figure} img/basics/new-repo-plus.png + :alt: Screenshot on GitHub before a new repository form is opened + :width: 100% + :class: with-border + + Click on the "plus" symbol on top right, then on "New repository". + ``` + + Another way to create a new repository is to visit + directly. + + ```{figure} img/basics/new-repo-form.png + :alt: Screenshot on GitHub just before creating a new repository + :width: 100% + :class: with-border + + Choose a repository name, add a short description, **check "Add a + README file"**, finally "Create repository". + ``` + + After you have clicked "Create repository" you should see a repository overview + with one file (README.md) and one commit. + ```` +````` + + +## Adding files and committing changes + +Let us now **create two files**. + +One file is called `ingredients.txt` and contains: +```shell +* 2 avocados +* 1 chili +* 1 lime +* 2 tsp salt +``` + +The second file is called `instructions.txt` and contains: +```shell +* chop avocados +* chop onion +* chop chili +* squeeze lime +* add salt +* and mix well +``` + +`````{tabs} + ````{group-tab} Command line + As mentioned above, in Git you can always check the status of files in your repository using + `git status`. It is always a safe command to run and in general a good idea to + do when you are trying to figure out what to do next: + + ```console + $ git status + + On branch main + + No commits yet + + Untracked files: + (use "git add ..." to include in what will be committed) + ingredients.txt + instructions.txt + + nothing added to commit but untracked files present (use "git add" to track) + ``` + + The two files are untracked in the repository (directory). You want to **add the files** (focus the camera) + to the list of files tracked by Git. Git does not track + any files automatically and you need make a conscious decision to add a file. Let's do what + Git hints at, and add the files, one by one: + + ```console + $ git add ingredients.txt + $ git status + + On branch main + + No commits yet + + Changes to be committed: + (use "git rm --cached ..." to unstage) + new file: ingredients.txt + + Untracked files: + (use "git add ..." to include in what will be committed) + instructions.txt + ``` + + Now this change is *staged* and ready to be committed. + Let us now commit the change to the repository: + ```console + $ git commit -m "adding ingredients" + + [main (root-commit) f146d25] adding ingredients + 1 file changed, 4 insertions(+) + create mode 100644 ingredients.txt + ``` + + Right after we query the status to get this useful command into our muscle memory: + ```console + $ git status + ``` + + Now stage and commit also the other file: + ```console + $ git add instructions.txt + $ git commit -m "adding instructions" + ``` + + We will add a third file to the repository, `README.md`, containing: + ```markdown + # recipe + + This is an exercise repository. + ``` + + Now stage and commit also the `README.md` file: + ```console + $ git add README.md + $ git commit -m "adding README" + ``` + + What does the `-m` flag mean? Let us check the help page for that command: + ```console + $ git help commit + ``` + + You should see a very long help page as the tool is very versatile (press q to quit). + Do not worry about this now but keep in mind that you can always read the help files + when in doubt. Searching online can also be useful, but choosing search terms + to find relevant information takes some practice and discussions in some + online threads may be confusing. + Note that help pages also work when you don't have a network connection! + ```` + + ````{group-tab} Browser (GitHub) + ```{figure} img/basics/add-file.png + :alt: Screenshot on GitHub before a new file is created + :width: 100% + :class: with-border + + Click on "Add file", then "Create new file". + ``` + + ```{figure} img/basics/edit-file.png + :alt: Screenshot on GitHub when editing a file + :width: 100% + :class: with-border + + Edit the file and specify the file name. + ``` + + ```{figure} img/basics/commit-changes.png + :alt: Screenshot on GitHub when editing the commit message + :width: 100% + :class: with-border + + Before you commit the change, adjust the commit message. + ``` + + After you have added `ingredients.txt`, add also `instructions.txt` in a similar + way. + + We have added two files, each in one commit. However, we ended up with + three files and three commits since `README.md` was automatically committed + when we created the repository on GitHub. + ```` +````` + + +(exercise-record-changes)= + +## Exercise: Record changes + +``````{exercise} Basic-1: Record changes + Add 1/2 onion to `ingredients.txt` and also the instruction + to "enjoy!" to `instructions.txt`. + + `````{tabs} + ````{group-tab} Command line + After modifying the files, do not stage the changes yet (do not `git add` + yet). + + When you are done editing the files, try `git diff`: + ```console + $ git diff + ``` + + You will see (can you identify in there the two added lines?): + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index 4422a31..ba8854f 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -2,3 +2,4 @@ + * 1 chili + * 1 lime + * 2 tsp salt + +* 1/2 onion + diff --git a/instructions.txt b/instructions.txt + index 7811273..2b11074 100644 + --- a/instructions.txt + +++ b/instructions.txt + @@ -4,3 +4,4 @@ + * squeeze lime + * add salt + * and mix well + +* enjoy! + ``` + + Now first stage and commit each change separately (what happens when we leave out the `-m` flag?): + ```console + $ git add ingredients.txt + $ git commit -m "add half an onion" + $ git add instructions.txt + $ git commit # <-- we have left out -m "..." + ``` + + When you leave out the `-m` flag, Git should open an editor where you can edit + your commit message. This message will be associated and stored with the + changes you made. This message is your chance to explain what you've done and + convince others (and your future self) that the changes you made were + justified. Write a message and save and close the file. + + When you are done committing the changes, experiment with these commands: + ```console + $ git log + $ git log --stat + $ git log --oneline + ``` + ```` + + ````{group-tab} Browser (GitHub) + We can make modifications to a file by clicking on the file and then the + pen symbol: + ```{figure} img/basics/pen-symbol.png + :alt: Screenshot on GitHub before clicking on the pen symbol + :width: 100% + :class: with-border + + By clicking on the pen symbol we can switch to edit mode. + ``` + + ```{figure} img/basics/preview.png + :alt: Screenshot on GitHub when previewing file changes + :width: 100% + :class: with-border + + Before committing the change, click on "Preview". + ``` + + Our goal is to arrive at two new commits: + - "add half an onion" (modifying `ingredients.txt`) + - "don't forget to enjoy" (modifying `instructions.txt`) + + When you are done committing the changes, try to browse commit history + on GitHub. + ```` + ````` +`````` + + +## Git history and log + +`````{tabs} + ````{group-tab} Command line + If you haven't yet, please try now `git log`: + + ```console + $ git log + + commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main) + Author: Radovan Bast + Date: Sun Sep 17 19:12:47 2023 +0200 + + don't forget to enjoy + + commit 79161b6e67c62ad4688a58c1e54183334611a390 + Author: Radovan Bast + Date: Sun Sep 17 19:12:32 2023 +0200 + + add half an onion + + commit a3394e39535343c4dae3bb4f703741a31aa8b78a + Author: Radovan Bast + Date: Sun Sep 17 18:47:14 2023 +0200 + + adding README + + commit 369624674e63de48055a65bf63055bd59c985d22 + Author: Radovan Bast + Date: Sun Sep 17 18:46:58 2023 +0200 + + adding instructions + + commit f146d25b94569a15e94d7f0da6f15d7554f76c49 + Author: Radovan Bast + Date: Sun Sep 17 18:35:52 2023 +0200 + + adding ingredients + ``` + ```` + + ````{group-tab} Browser (GitHub) + ```{figure} img/basics/commits.png + :alt: Screenshot on GitHub before clicking on commit history + :width: 100% + :class: with-border + + Click on the history symbol with (here) 5 commits. + ``` + + ```{figure} img/basics/history.png + :alt: Screenshot of GitHub repository commit history + :width: 100% + :class: with-border + + In this overview you can browse each commit individually. + ``` + + On GitHub you can also compare arbitrary two commits (replace "USER", + "HASH1", and "HASH2"): + `https://github.com/USER/recipe/compare/HASH1..HASH2` + + Try it with two of your commits. + ```` +````` + +- We can browse the development and access each state that we have committed. +- The long hashes uniquely label a state of the code. +- They are not just integers counting 1, 2, 3, 4, ... (why?). +- Output is in reverse chronological order, i.e. **newest commits on top**. +- We will use them when comparing versions and when going back in time. +- `git log --oneline` only shows the first 7 characters of the commit hash and is good to get an overview. +- If the first characters of the hash are unique it is not necessary to type the entire hash. +- `git log --stat` is nice to show which files have been modified. + + +(exercise-diff-and-rename)= + +## Optional exercises: Comparing changes + +``````{exercise} (optional) Basic-2: Comparing and showing commits + `````{tabs} + ````{group-tab} Command line + 1. Have a look at specific commits with `git show HASH`. + 2. Inspect differences between commit hashes with `git diff HASH1 HASH2`. + ```` + + ````{group-tab} Browser (GitHub) + 1. Have a look at specific commits. + 2. Inspect differences between commits. + + Use the screenshots under "Git history and log". + ```` + ````` +`````` + +````{exercise} (optional) Basic-3: Visual diff tools + This exercise is only relevant for the command line. In the browser, + the preview is already side-by-side and "visual". + + - Make further modifications and experiment with `git difftool` (requires installing one of the [visual diff tools](https://coderefinery.github.io/installation/difftools/)): + + On Windows or Linux: + ```console + $ git difftool --tool=meld HASH + ``` + + On macOS: + ```console + $ git difftool --tool=opendiff HASH + ``` + + ```{figure} img/meld.png + :alt: Git difftool using meld + :width: 100% + + Git difftool using meld. + ``` + + You probably want to use the same visual diff tool every time and + you can configure Git for that: + ```console + $ git config --global diff.tool meld + ``` +```` + +```{exercise} (optional) Basic-4: Browser and command line +You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both. + +- If you have managed to do the above in the command line, try now in the browser. +- If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git. +``` + + +## Writing useful commit messages + +Using `git log --oneline` or browsing a repository on the web, we better +understand that the first line of the commit message is very important. + +Good example: +```text +increase threshold alpha to 2.0 + +the motivation for this change is +to enable ... +... +this is based on a discussion in #123 +``` + +Convention: **one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary**. + +- **Why something was changed is more important than what has changed.** +- Cross-reference to issues and discussions if possible/relevant. +- Bad commit messages: "fix", "oops", "save work" +- Bad examples: [http://whatthecommit.com](http://whatthecommit.com) +- Write commit messages in English that will be understood + 15 years from now by someone else than you. Or by your future you. +- Many projects start out as projects "just for me" and end up to be successful projects + that are developed by 50 people over decades. +- [Commits with multiple authors](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) are possible. + +Good references: + +- ["My favourite Git commit"](https://fatbusinessman.com/2019/my-favourite-git-commit) +- ["On commit messages"](https://who-t.blogspot.com/2009/12/on-commit-messages.html) +- ["How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/) + +```{note} +A great way to learn how to write commit messages and to get inspired by their +style choices: **browse repositories of codes that you use/like**: + +Some examples (but there are so many good examples): +- [SciPy](https://github.com/scipy/scipy/commits/main) +- [NumPy](https://github.com/numpy/numpy/commits/main) +- [Pandas](https://github.com/pandas-dev/pandas/commits/main) +- [Julia](https://github.com/JuliaLang/julia/commits/master) +- [ggplot2](https://github.com/tidyverse/ggplot2/commits/main), + compare with their [release + notes](https://github.com/tidyverse/ggplot2/releases) +- [Flask](https://github.com/pallets/flask/commits/main), + compare with their [release + notes](https://github.com/pallets/flask/blob/main/CHANGES.rst) + +When designing commit message styles consider also these: +- How will you easily generate a changelog or release notes? +- During code review, you can help each other improving commit messages. +``` + +But remember: it is better to make any commit, than no commit. Especially in small projects. +**Let not the perfect be the enemy of the good enough**. + + +## Ignoring files and paths with .gitignore + +```{discussion} +- Should we add and track all files in a project? +- How about generated files? +- Why is it considered a bad idea to commit compiled binaries to version control? +- What types of generated files do you know? +``` + +Compiled and generated files are not +committed to version control. There are many reasons for this: + +- These files can make it more difficult to run on different platforms. +- These files are automatically generated and thus do not contribute in any meaningful way. +- When tracking generated files you could see differences in the code although you haven't touched the code. + +For this we use `.gitignore` files. Example: +```shell +# ignore compiled python 2 files +*.pyc +# ignore compiled python 3 files +__pycache__ +``` + +An example taken from the [official Git documentation](https://git-scm.com/docs/gitignore): +```shell +# ignore objects and archives, anywhere in the tree. +*.[oa] +# ignore generated html files, +*.html +# except foo.html which is maintained by hand +!foo.html +# ignore everything under build directory +build/ +``` + +- `.gitignore` should be part of the repository because we want to make sure that all developers see the same behavior. +- **All files should be either tracked or ignored**. +- `.gitignore` uses something called a + [shell glob syntax](https://en.wikipedia.org/wiki/Glob_(programming)) for + determining file patterns to ignore. You can read more about the syntax in the + [documentation](https://git-scm.com/docs/gitignore). +- You can have `.gitignore` files in lower level directories and they affect the paths below. + + +## Graphical user interfaces + +We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI): + +- [GitHub Desktop](https://desktop.github.com) +- [SourceTree](https://www.sourcetreeapp.com) +- [List of third-party GUIs](https://git-scm.com/downloads/guis) + + +## Summary + +Now we know how to save snapshots: + +```console +$ git add FILE(S) +$ git commit +``` + +And this is what we do as we program. + +Every state is then saved and later we will learn how to go back to these "checkpoints" +and how to undo things. + +```console +$ git init -b main # initialize new repository (main is default branch) +$ git add # add files or stage file(s) +$ git commit # commit staged file(s) +$ git status # see what is going on +$ git log # see history +$ git diff # show unstaged/uncommitted modifications +$ git show # show the change for a specific commit +$ git mv # move/rename tracked files +$ git rm # remove tracked files +``` + +Git is not ideal for large binary files +(for this consider [git-annex](http://git-annex.branchable.com)). + +````{challenge} Basic-5: Test your understanding + Which command(s) below would save the changes of `myfile.txt` + to an existing local Git repository? + + 1. ```console + $ git commit -m "my recent changes" + ``` + 2. ```console + $ git init myfile.txt + $ git commit -m "my recent changes" + ``` + 3. ```console + $ git add myfile.txt + $ git commit -m "my recent changes" + ``` + 4. ```console + $ git commit -m myfile.txt "my recent changes" + ``` + ```{solution} + + 1. Would only create a commit if files have already been staged. + 2. Would try to create a new repository in a folder "myfile.txt". + 3. **Is correct: first add the file to the staging area, then commit.** + 4. Would try to commit a file "my recent changes" with the message myfile.txt. + ``` +```` + +```{keypoints} +- It takes only one command to initialize a Git repository: `git init -b main`. +- Commits should be used to tell a story. +- Git uses the .git folder to store the snapshots. +- Don't be afraid to stage and commit often. Better too often than not often enough. +``` diff --git a/branch/main/_sources/branches.md.txt b/branch/main/_sources/branches.md.txt new file mode 100644 index 00000000..418e4d67 --- /dev/null +++ b/branch/main/_sources/branches.md.txt @@ -0,0 +1,624 @@ +# Branching and merging + +```{objectives} +- Be able to create and merge branches. +- Know the difference between a branch and a tag. +``` + +```{instructor-note} +- 30 min teaching/type-along +- 20 min exercise +``` + + +## Motivation for branches + +In the previous section we tracked a guacamole recipe with Git. + +Up until now our repository had only one branch with one commit coming +after the other: + +```{figure} img/gitink/git-branch-1.svg +:alt: Linear Git repository +:width: 40% + +Linear Git repository. +``` + +- Commits are depicted here as little boxes with abbreviated hashes. +- Here the branch `main` points to a commit. +- "HEAD" is the current position (remember the recording head of tape + recorders?). When we say `HEAD`, we mean those literal letters - + this isn't a placeholder for something else. +- When we talk about branches, we often mean all parent commits, not only the commit pointed to. + +**Now we want to do this:** + +```{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +``` + +Software development is often not linear: + +- We typically need at least one version of the code to "work" (to compile, to give expected results, ...). +- At the same time we work on new features, often several features concurrently. + Often they are unfinished. +- We need to be able to separate different lines of work really well. + +The strength of version control is that it permits the researcher to **isolate +different tracks of work**, which can later be merged to create a composite +version that contains all changes: + +```{figure} img/gitink/git-collaborative.svg +:alt: Isolated tracks of work +:width: 100% + +Isolated tracks of work. +``` + +- We see branching points and merging points. +- Main line development is often called `main` or `master`. +- Other than this convention there is nothing special about `main` or `master`, it is a branch like any other. +- Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow). + +A group of commits that create a single narrative are called a **branch**. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. "fast sequence extraction" or "Python interface" or "fixing bug in +matrix inversion algorithm". + +````{admonition} **An important alias** +--- +class: important +--- + +We will now define an *alias* in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). **This is extensively used in the rest of this +and other lessons**: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` +```` + +```{instructor-note} +Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative. +``` + +Let us inspect the project history using the `git graph` alias: + +```console +$ git graph + +* e7cf023 (HEAD -> main) don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +- We have a couple commits and only + one development line (branch) and this branch is called `main`. +- Commits are states characterized by a 40-character hash (checksum). +- `git graph` print abbreviations of these checksums. +- **Branches are pointers that point to a commit.** +- Branch `main` points to a commit (in this example it is `e7cf023efe382340e5284c278c6ae2c087dd3ff7` but on your computer + the hash will be different). +- `HEAD` is another pointer, it points to where we are right now (currently `main`) + +In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards. + + +## Creating and working with branches + +```{instructor-note} +We do the following part together. Encourage participants to type along. +``` + +```{admonition} It is possible to create and merge branches directly on GitHub +- However, we do not have screenshots for that in this episode +- But if you prefer to work in the browser, please try it +- Please contribute screenshots to this lesson +``` + +Let's create a branch called `experiment` where we add cilantro to `ingredients.txt` +(text after "#" are comments and not part of the command). + +```console +$ git branch experiment main # creates branch "experiment" from "main" +$ git switch experiment # switch to branch "experiment" +$ git branch # list all local branches and show on which branch we are +``` + +```{note} +In case `git switch` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git switch`. +``` + +- Verify that you are on the `experiment` branch (note that `git graph` also + makes it clear what branch you are on: `HEAD -> branchname`): + ```console + $ git branch + + * experiment + main + ``` + This command shows where we are, it does not create a branch. + +- Then add 2 tbsp cilantro **on top** of the `ingredients.txt`: + + ```{code-block} shell + --- + emphasize-lines: 1 + --- + * 2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + * 2 tsp salt + * 1/2 onion + ``` + +- Stage this and commit it with the message "let us try with some cilantro". +- Then reduce the amount of cilantro to 1 tbsp, stage and commit again with "maybe little bit less cilantro". + +We have created **two new commits**: + +```{code-block} console +--- +emphasize-lines: 3-4 +--- +$ git graph + +* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro +* f6ec7b7 let us try with some cilantro +* e7cf023 (main) don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +- The branch `experiment` is two commits ahead of `main`. +- We commit our changes to this branch. + + +(exercise-branches)= + +## Exercise: Create and commit to branches + +````{exercise} Branch-1: Create and commit to branches + In this exercise, you will create another new branch and few more commits. + We will use this in the next section, to practice + merging. **The goal of the exercise is to end up with 3 branches**. + + - Change to the branch `main`. + - Create another branch called `less-salt`. + - Note! makes sure you are on main branch when you create the `less-salt` branch. + - A safer way would be to explicitly mention to create from the main branch + as shown below: + ```console + $ git branch less-salt main + ``` + - Switch to the `less-salt` branch. + - On the `less-salt` branch reduce the amount of salt. + - Commit your changes to the `less-salt` branch. + + Use the same commands as we used above. + + We now have three branches (in this case `HEAD` points to `less-salt`): + + ```console + $ git branch + + experiment + * less-salt + main + + $ git graph + + * bf28166 (HEAD -> less-salt) reduce amount of salt + | * bcb8b78 (experiment) maybe little bit less cilantro + | * f6ec7b7 let us try with some cilantro + |/ + * e7cf023 (main) don't forget to enjoy + * 79161b6 add half an onion + * a3394e3 adding README + * 3696246 adding instructions + * f146d25 adding ingredients + ``` + + Here is a graphical representation of what we have created: + + ```{figure} img/gitink/git-branch-2.svg + ``` + + - Now switch to `main`. + - In a new commit, improve the `README.md` file (we added the word "Guacamole"): + + ```markdown + # Guacamole recipe + + This is an exercise repository. + ``` + + Now you should have this situation: + + ```console + $ git graph + + * b4af65b (HEAD -> main) improve the documentation + | * bf28166 (less-salt) reduce amount of salt + |/ + | * bcb8b78 (experiment) maybe little bit less cilantro + | * f6ec7b7 let us try with some cilantro + |/ + * e7cf023 don't forget to enjoy + * 79161b6 add half an onion + * a3394e3 adding README + * 3696246 adding instructions + * f146d25 adding ingredients + ``` + + ```{figure} img/gitink/git-branch-3.svg + ``` + + And for comparison this is how it looks [on GitHub](https://github.com/coderefinery/recipe-before-merge/network). +```` + +(exercise-branches-merging)= + +## Exercise: Merging branches + +It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge `experiment` into `main`. + +```{exercise} Branch-2: Merge branches +Merge `experiment` and `less-salt` back into `main` following the lesson below +until the point where we start deleting branches. +``` + +````{admonition} If you got stuck in the above exercises or joined later + **If you got stuck in the above exercises or joined later**, + you can apply the commands below. + But **skip this box if you managed to create branches**. + + ```console + $ cd .. # step out of the current directory + + $ git clone https://github.com/coderefinery/recipe-before-merge.git + $ cd recipe-before-merge + + $ git switch experiment + $ git switch less-salt + $ git switch main + + $ git remote remove origin + + $ git graph + ``` + + Or call a helper to un-stuck it for you. +```` + +First we make sure we are on the branch we wish to merge **into**: + +```{code-block} console +--- +emphasize-lines: 5 +--- +$ git branch + + experiment + less-salt +* main +``` + +Then we merge `experiment` into `main`: + +```console +$ git merge experiment +``` + +```{figure} img/gitink/git-merge-1.svg +``` + +We can verify the result: + +```console +$ git graph + +* 81fcc0c (HEAD -> main) Merge branch 'experiment' +|\ +| * bcb8b78 (experiment) maybe little bit less cilantro +| * f6ec7b7 let us try with some cilantro +* | b4af65b improve the documentation +|/ +| * bf28166 (less-salt) reduce amount of salt +|/ +* e7cf023 don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents. + +To view the branches that are merged into the current branch we can use the command: + +```console +$ git branch --merged + + experiment +* main +``` + +We are also happy with the work on the `less-salt` branch. Let us merge that +one, too, into `main`: + +```console +$ git branch # make sure you are on main +$ git merge less-salt +``` + +```{figure} img/gitink/git-merge-2.svg +:alt: Commit graph after merge + +Commit graph after merge. +``` + +We can verify the result in the terminal: + +```console +$ git graph + +* 4e03d4b (HEAD -> main) Merge branch 'less-salt' +|\ +| * bf28166 (less-salt) reduce amount of salt +* | 81fcc0c Merge branch 'experiment' +|\ \ +| * | bcb8b78 (experiment) maybe little bit less cilantro +| * | f6ec7b7 let us try with some cilantro +| |/ +* / b4af65b improve the documentation +|/ +* e7cf023 don't forget to enjoy +* 79161b6 add half an onion +* a3394e3 adding README +* 3696246 adding instructions +* f146d25 adding ingredients +``` + +Observe how Git nicely merged the changed amount of salt and the new ingredient **in the same file +without us merging it manually**: + +```console +$ cat ingredients.txt + +* 1 tbsp cilantro +* 2 avocados +* 1 chili +* 1 lime +* 1 tsp salt +* 1/2 onion +``` + +If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually *settle merge conflicts* (we will do that later). + + +## Deleting branches safely + +Both feature branches are merged: + +```console +$ git branch --merged + + experiment + less-salt +* main +``` + +This means we can delete the branches: + +```console +$ git branch -d experiment +$ git branch -d less-salt +``` + +This is the result: + +```{figure} img/gitink/git-deleted-branches.svg +:alt: Commit graph after merged branches were deleted + +Commit graph after merged branches were deleted. +``` + +We observe that when deleting branches, +only the pointers ("sticky notes") disappeared, not the commits. + +Git will not let you delete a branch which has not been reintegrated unless you +insist using `git branch -D`. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them. + + +(exercise-branches-optional)= + +## Optional exercises with branches + +The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section. + +````{exercise} (optional) Branch-3: Perform a fast-forward merge +1. Create a new branch from `main` and switch to it. +2. Create a couple of commits on the new branch (for instance edit `README.md`): + ```{figure} img/gitink/git-pre-ff.svg + ``` +3. Now switch to `main`. +4. Merge the new branch to `main`. +5. Examine the result with `git graph`. +6. Have you expected the result? Discuss what you see. + + ```{solution} + You will see that in this case no merge commit was created and Git merged the + two branches by moving (fast-forwarding) the "main" branch (label) three + commits forward. + + This was possible since one branch is the ancestor of the other and their + developments did not diverge. + + A merge that does not require any merge commit is a fast-forward merge. + ``` +```` + +````{exercise} (optional) Branch-4: Rebase a branch (instead of merge) +As an alternative to merging branches, one can also *rebase* branches. +Rebasing means that the new commits are *replayed* on top of another branch +(instead of creating an explicit merge commit). +**Note that rebasing changes history and should not be done on public commits!** +1. Create a new branch, and make a couple of commits on it. +2. Switch back to `main`, and make a couple of commits on it. +3. Inspect the situation with `git graph`. +4. Now rebase the new branch on top of `main` by first switching to the new branch, and then `git rebase main`. +5. Inspect again the situation with `git graph`. Notice that the commit hashes have changed - think about why! + + ```{solution} + You will notice two things: + - History is now linear and does not contain merge commits. + - All the commit hashes that were on the branch that got rebased, have + changed. This also demonstrates that `git rebase` is a command that alters + history. The commit history looks as if the rebased commits were all done + after the `main` commits. + ``` +```` + + +## Tags + +- A tag is a pointer to a commit but in contrast to a branch it **does not ever + move** when creating new commits later. +- It can be useful to think of branches as sticky notes and of tags as + [commemorative plaques](https://en.wikipedia.org/wiki/Commemorative_plaque). +- We use tags to record particular states or milestones of a project at a given + point in time, like for instance versions (have a look at [semantic versioning](http://semver.org), + v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a). +- There are two basic types of tags: annotated and lightweight. +- **Use annotated tags** since they contain the author and can be cryptographically signed using + GPG, timestamped, and a message attached. + +Let's add an annotated tag to our current state of the guacamole recipe: +```console +$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet" +``` + +As you may have found out already, `git show` is a very versatile command. Try this: + +```console +$ git show nobel-2023 +``` + +For more information about tags see for example +[the Pro Git book](https://git-scm.com/book/en/v2/Git-Basics-Tagging) chapter on the +subject. + +--- + +## Summary + +Let us pause for a moment and recapitulate what we have just learned: + +```console +$ git branch # see where we are +$ git branch NAME # create branch NAME +$ git switch NAME # switch to branch NAME +$ git merge NAME # merge branch NAME (to current branch) +$ git branch -d NAME # delete branch NAME +$ git branch -D NAME # delete unmerged branch NAME +``` + +Since the following command combo is so frequent: + +```console +$ git branch NAME # create branch NAME +$ git switch NAME # switch to branch NAME +``` + +There is a shortcut for it: + +```console +$ git switch --create NAME # create branch NAME and switch to it +``` + +### Typical workflows + +With this there are two typical workflows: + +```console +$ git switch --create new-feature # create branch, switch to it +$ git commit # work, work, work, ..., and test +$ git switch main # once feature is ready, switch to main +$ git merge new-feature # merge work to main +$ git branch -d new-feature # remove branch +``` + +Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging: + +```console +$ git switch --create wild-idea # create branch, switch to it, work, work, work ... +$ git switch main # realize it was a bad idea, back to main +$ git branch -D wild-idea # it is gone, off to a new idea +``` + +--- + +````{challenge} Branch-5: Test your understanding + Which of the following combos (one or more) creates a new branch and makes a commit to it? + 1. ```console + $ git branch new-branch + $ git add file.txt + $ git commit + ``` + 2. ```console + $ git add file.txt + $ git branch new-branch + $ git switch new-branch + $ git commit + ``` + 3. ```console + $ git switch --create new-branch + $ git add file.txt + $ git commit + ``` + 4. ```console + $ git switch new-branch + $ git add file.txt + $ git commit + ``` + + ```{solution} + Both 2 and 3 would do the job. Note that in 2 we first stage the file, and then create the + branch and commit to it. In 1 we create the branch but do not switch to it, while in 4 we + don't give the `--create` flag to `git switch` to create the new branch. + ``` +```` + +```{keypoints} +- A branch is a division unit of work, to be merged with other units of work. +- A tag is a pointer to a moment in the history of a project. +``` diff --git a/branch/main/_sources/browsing.md.txt b/branch/main/_sources/browsing.md.txt new file mode 100644 index 00000000..538dfbe9 --- /dev/null +++ b/branch/main/_sources/browsing.md.txt @@ -0,0 +1,394 @@ +# Copy and browse an existing project + +In this episode, we will look at an **existing repository** to +understand how all the pieces work together. Along the way, we will make a copy +(a {term}`fork`) of the {term}`repository` for us, which will be used for our +own changes in the next episode. + +- We used to start by directly going and creating a repository from scratch. This + was abstract and hard to understand. +- Instead, we'll show you all the cool stuff in a Git repository + first, and then start adding files. +- We use an example recipe book we created just for this course. +- By the end of the course, you'll know how to contribute your own + recipes to it. + +:::{objectives} +* See a real Git repository and understand what is inside of it. +* Understand how version control allows advanced inspection of a + repository. +* See how Git allows multiple people to collaborate easily. +* See the big picture instead of remembering a bunch of commands. +::: + + +## GitHub, VS Code, Command line, and more + +We offer **three different paths** of how to do this exercise: +- **GitHub** (this is the one we will demonstrate on day 1) +- **VS Code** (if you prefer to follow along using an editor; we will + do this on day 2) +- **Command line** (for people comfortable with the command line; you + will see more of this on day 2) + +In the future we'll add more paths, for example Jupyter and RStudio +(contributions welcome!). + + +## Creating a copy of the repository by "forking" + +A {term}`repository` is a collection of files in one directory tracked +by git. A {term}`GitHub repository` is GitHub's copy, which adds +things like access control. Each GitHub repository is owned by a user +or organization, who controls what is in it. + +First, we need to make our own copy of the exercise repository. This will +become important later, when we make our own changes. + +1. Go to the repository view on GitHub: + - : you can use this one if you don't want your fork and contributions + to be visible on the stream or the recording + - : we will use this one for the demonstration which is streamed and recorded +1. First, on GitHub, click the button that says "Fork". It is towards + the top-right of the screen: + :::{figure} img/browsing/forking.png + :alt: Screenshot on GitHub before clicking on "Fork" + :width: 80% + :class: with-border + ::: +1. You should shortly be redirected to your copy of the repository + **YOUR_USER_NAME/recipe-book**. + +At all times you should be aware of if you looking at *your* repository +or the *CodeRefinery {term}`upstream`* repository. +* Your repository: https://github.com/**USERNAME**/recipe-book +* CodeRefinery upstream repository: https://github.com/**coderefinery**/recipe-book + +:::::{tabs} +::::{group-tab} GitHub +You only need to open your own view, as described above. The browser +URL should look like `https://github.com/USER/recipe-book`, where +`USER` is your GitHub username. +:::: + +::::{group-tab} VS Code +You need to have forked the repository as described above. + +We need to start by making a copy of this repository locally. + +1. Start VS Code. +1. If you don't have the default view (you already have a project +open), go to File → New Window. +1. Under "Start" on the screen, select "Clone Git Repository...". Alternatively + navigate to the "Source Control" tab on the left sidebar and click on the "Clone Repository" button. +1. Paste in this URL: `https://github.com/USER/recipe-book`, where + `USER` is your username. You can copy this from the browser. +1. Browse and select the folder in which you want to clone the + repository. +1. Say yes, you want to open this repository. +1. Select "Yes, I trust the authors" (the other option works too). +:::: + +::::{group-tab} Command line +**This path is advanced and we do not include all command line +information: you need to be somewhat +comfortable with the command line already.** + +We need to start by making a copy of this repository locally. You +need to have forked the repository as described above. + +1. Start the terminal in which you use Git (terminal application, or + Git Bash). +1. Change to the directory where you would want the repository to be + (`cd ~/code` for example, if the `~/code` directory is where you + store your files). +1. Run the following command: `git clone + https://github.com/USER/recipe-book`, where `USER` is your + username. You might need to use a SSH clone command instead of + HTTPS, depending on your setup. +1. Change to that directory: `cd recipe-book` +:::: +::::: + + +## Exercise + +Work on this by yourself or in your team. + +:::{instructor-note} +Before starting the exercise session: +- Make sure you have shown how to fork the repository to own account + (above). +::: + +:::{exercise} Exercise: Browsing an existing project (25 min) + +Browse the recipe-book project (introduced above) and explore commits and branches. Take notes +and prepare questions. The hints are for the GitHub path in the +browser. + +1. Browse the **commit history**: Are commit messages understandable? + (Hint: "Commit history", the timeline symbol, above the file list) +1. Compare the commit history with the **network graph** ("Insights" -> "Network"). Can you find the branches? +1. How can you find out when a recipe was **last modified**? +1. **How many changes** did the Guacamole recipe receive (you find it under "sides")? + Try to click on some of the commits to see what changed. + (Hint: "History" in the view of a single file) +1. **Which recipes include the ingredient "salt"**? + (Hint: the GitHub search. From the repository view, it should offer + the filter "repo:USER/recipe-book" by default. What if you + add a search term?) +1. In the Guacamole recipe, find out **who modified each line last and when** + (click on file, then click "Blame" button). Find out who added the cilantro + and in which commit. + (Hint: "Blame" view in the file view) +1. Can you use these recipes yourself? **Are you allowed to share + modifications**? + (Hint: look for a license file) +1. **Browse issues and pull requests** in the {term}`upstream` repository (the + repository you forked from). Any idea what these might be good for? + (Hint: tabs in the repository view) +::: + + +The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren't enough - this is by +design. + + +## Solution and walk-through + +### (1) Basic browsing + +The most basic thing to look at is the history of commits. + +* This is visible from a button in the repository view. We see every + change, when, and who has committed. +* Every change has a unique identifier, such as `554c187`. This can + be used to identify both this change, and the whole project's + version as of that change. +* Clicking on a change in the view shows more. + +:::::{tabs} + +::::{group-tab} GitHub +Click on the timeline symbol in the repository view: + :::{figure} img/browsing/history.png + :alt: Screenshot on GitHub of where to find the commit history + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +This can be done from "Timeline", in the bottom of explorer, but only +for a single file. +:::: + +::::{group-tab} Command line +Run: +```console +$ git log +``` + +Try also: +```console +$ git log --oneline +``` +:::: + +::::: + + +### (2) Compare commit history with network graph + +The commit history we saw above looks linear: one commit after +another. But if we look at the network view, we see some branches and +merges. We'll see how to do these later. This is another one of the +basic Git views. + +:::::{tabs} +::::{group-tab} GitHub +In a new browser tab, open the "Insights" tab, and click on "Network". +You can hover over the commit dots to see the person who committed and +how they correspond with the commits in the other view: + :::{figure} img/browsing/network.png + :alt: Screenshot on GitHub of the network graph + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +We don't know how to do this without an extension. Try starting a terminal and using the +"Command Line" option. +:::: + +::::{group-tab} Command line +If you defined the `git graph` alias as in {doc}`configuration`, you +can view the network graph with: +```console +$ git graph +``` +If not, you can use the basic command: +```console +$ git log --graph --oneline --decorate --all +:::: + +::::: + + +### (3) When was a recipe last modified? + +We see the history for the whole repository, but we can also see it +for a single file. + +:::::{tabs} + +::::{group-tab} GitHub +Navigate to the file view: Main page → sides directory → +guacamole.md. Click the "History" button near the top right: + :::{figure} img/browsing/file-history.png + :alt: Screenshot on GitHub showing the history of a single file + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +Open sides/guacamole.md file in the editor. Under the file browser, +we see a "Timeline" view there. +:::: + +::::{group-tab} Command line +The `git log` command can take a filename and provide the log of only +a single file: + +``` +$ git log sides/guacamole.md +``` +:::: + +::::: + + +### (4) How many changes did the Guacamole recipe receive? + +According to the view above, it seems to have five changes (as of +2024-03-07). This could change later on. + + +### (5) Which recipes include the ingredient "salt" + +Version control makes it very easy to find all occurrences of a single +word. This is useful for things like finding where functions or +variables are defined or used. + +:::::{tabs} +::::{group-tab} GitHub +We go to the main recipe book view. We click the Search magnifying +class at the very top, type "salt", and click enter. We see every +instance, including the context. + ```{admonition} Searching in a forked repository will not work instantaneously! + + It usually takes a few minutes before one can search for keywords in a forked repository + since it first needs to build the search index the very first time we search. + Start it, continue with other steps, then come back to this. + ``` + + :::{figure} img/browsing/search.png + :alt: Screenshot on GitHub performing a search + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +If you use the "Search" magnifying class on the left sidebar, and +search for "Salt" it shows the occurrences in every file. You can +click to see the usage in context. +:::: + +::::{group-tab} Command line +`grep` is the command line tool that searches for lines matching a term +```console +$ git grep salt # only the lines +$ git grep -C 3 salt # three lines of context +$ git grep -i salt # case insensitive +``` +:::: + +::::: + + +### (6) Who modified each line last and when? + +This is called the "annotate" or "blame" view. The name "blame" +is very unfortunate, but it is the standard term for historical reasons +for this functionality and it is not meant to blame anyone. + +:::::{tabs} + +::::{group-tab} GitHub +From a recipe view, change preview to "Blame" towards the top-left. +To get the actual commit, click on the commit message. + :::{figure} img/browsing/annotate.png + :alt: Screenshot on GitHub showing the "Blame" view + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +This requires an extension. We recommend for now you use the command +line version, after opening a terminal. +:::: + +::::{group-tab} Command line +These two commands are similar but have slightly different output. +```console +$ git annotate sides/guacamole.md +$ git blame sides/guacamole.md +``` +:::: + +::::: + + +### (7) Can you use these recipes yourself? Are you allowed to share modifications? + +* Look at the file `LICENSE`. +* It says it is "Creative Commons Zero 1.0", which is equivalent to + public domain. You can use them without conditions. +* Note the GitHub view of the file `LICENSE` gives a nice summary of what it + means. Try it out: + :::{figure} img/browsing/license.png + :alt: Screenshot on GitHub summarizing license terms + :width: 100% + :class: with-border + ::: + + +### (8) Browse issues and pull requests in the {term}`upstream` repository + +This can only be done through the GitHub view. Go to the main +repository **coderefinery/recipe-book**, (not your fork): +. {term}`Issues ` +and {term}`Pull requests ` are different for each GitHub +copy. + +* Click on the "Issues" tab. These are notes that people have added, + which allow discussion about the project. Often they are used to communicate + problems or ideas. +* Click on the "Pull requests" tab. This allows anyone to *propose + changes*, but only the repository owners can accept. + + +## Summary + +- Git allowed us to understand this simple project much better than we + could, if it was just a few files on our own computer. +- It was also very easy to share the project with the course. +- By forking the repository, we created our own copy. This is + important for the next episode, where we will make changes to + our copy. diff --git a/branch/main/_sources/commits.md.txt b/branch/main/_sources/commits.md.txt new file mode 100644 index 00000000..20f65d6f --- /dev/null +++ b/branch/main/_sources/commits.md.txt @@ -0,0 +1,452 @@ +# Committing changes + +The first and most basic task to do in Git is *record changes* using +commits. In this part, we will record changes in two +ways: on a new branch (which supports multiple lines of work at once), and directly +on the "main" branch (which happens to be the default branch here). + +:::{objectives} +* Record new changes to our own copy of the project. +* Understand adding changes in two separate branches. +* See how to compare different versions. +::: + + +## Background + +- In the previous episode we have browsed an existing {term}`repository` and saw {term}`commits ` + and branches. +- Each commit is a snapshot of the entire project at a certain + point in time and has a unique identifier ({term}`hash`) . +- A {term}`branch` is a line of development, and the `main` branch or `master` branch + are often the default branch in Git. +- A branch in Git is like a sticky note that is attached to a commit. When we add + new commits to a branch, the sticky note moves to the new commit. +- {term}`Tags ` are a way to mark a specific commit as important, for example a release + version. They are also like a sticky note, but they don't move when new + commits are added. + +:::{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +What if two people, at the same time, make two different changes? Git +can merge them together easily. Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +::: + + +## Exercise + +We offer **three different paths** of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the **GitHub +path** only and recommend you do that. (You can get experience with +the other paths on day 2) + +:::{exercise} Exercise: Practice creating commits and branches (20 min) +1. Make sure that you now work **on your fork** of the recipe-book + repository (`USER/recipe-book`, *not* `coderefinery/recipe-book`) +1. First create a new branch and then add a recipe to the branch and commit the change. +1. In a new commit, modify the recipe you just added. +1. Switch to the `main` branch and modify a recipe there. +1. Browse the network and locate the commits that you just created ("Insights" -> "Network"). +1. Compare the branch that you created with the `main` branch. Can you find an easy way to see the differences? +1. Can you find a way to compare versions between two arbitrary commits in the repository? +1. Try to rename the branch that you created and then browse the network again. +1. Try to create a tag for one of the commits that you created (on GitHub, + create a "release"). +::: + +The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren't enough - this is by +design. + + +## Solution and walk-through + + +### (1) Make sure you are on your fork + +:::{figure} img/commits/fork.png +:alt: Screenshot on GitHub where we verify that we are on our fork. +:width: 60% +:class: with-border + +You want to see your username in the URL and you want to see the "forked from +..." part. +::: + + +### (2) Create a branch and add a recipe to the branch + +A recipe template is below. This format is called "Markdown", but it +doesn't matter right now. You don't have to use this particular template. +```markdown +# Recipe name + +## Ingredients + +- Ingredient 1 +- Ingredient 2 + + +## Instructions + +- Step 1 +- Step 2 +``` + +There is a {term}`main` branch that is default. We want to create a +*different* {term}`branch` for our new commit, because we will *merge* it later. +{term}`Commit ` is the verb to describe recording more changes, and also the +name of the thing you make. A commit is identified by something such as +`554c187`. + +:::::{tabs} +::::{group-tab} GitHub +1. Where it says "main" at the top left, click, enter a new branch + name `new-recipe`, click on the offer to create the new branch + ("Create branch new-recipe from main"). + :::{figure} img/commits/github-create-branch.png + :alt: Screenshot on GitHub where we create a new branch. + :width: 60% + :class: with-border + ::: +1. Change to some sub-directory, for example `sides` +1. Make sure you are still on the `new-recipe` branch (it should say + it at the top), and click "Add file" → "Create new file" from the + upper right. +1. Enter a filename where it says "Name your file...", with a `.md` at + the end. Example: `mixed-nuts.md`. +1. Enter the recipe. You can use the template above. +1. Click "Commit changes" +1. Enter a commit message. Then click "Commit + changes". + +You should appear back at the file browser view, and see your new +recipe there. +:::: + +::::{group-tab} VS Code +1. Make sure that you are on the main branch. +1. Version control button on left sidebar → Three dots in upper right of source control → Branch → Create branch. +1. VS Code automatically switches to the new branch. + +:::{figure} img/commits/vscode-create-branch.png +:width: 80% +:class: with-border +:alt: VS Code screenshot of create branch + +Creating a new branch in VS Code. +::: + +4. Create a new file, for example `sides/mixed-nuts.md`. +4. In the version control sidebar, click the `+` sign to add the file for the next commit. +4. Enter a brief message and click "Commit". + +:::{figure} img/commits/vscode-add-and-commit.png +:alt: Screenshot of VS Code commit process +:width: 80% +:class: with-border + +Committing a new file in VS Code. +::: +:::: + +::::{group-tab} Command line +Create a new branch called `new-recipe` from `main` and switch to it: +```console +$ git switch --create new-recipe main +``` + +Then create the new file. Finally add and commit the file: +```console +$ git add sides/mixed-nuts.md +$ git commit -m "Add mixed nuts recipe" +``` +:::: +::::: + + +### (3) Modify the recipe with a new commit + +:::::{tabs} +::::{group-tab} GitHub +This is similar to before, but we click on the existing file to +modify. + +1. Click on your new recipe, for example `mixed-nuts.md`. +2. Click the edit button, the pencil icon at top-right. +3. Follow the "Commit changes" instructions as in the previous step. +:::: + +::::{group-tab} VS Code +Repeat as in the previous step. +:::: + +::::{group-tab} Command line +Modify the file. Then commit the new change: +```console +$ git add sides/mixed-nuts.md +$ git commit -m "Short summary of the change" +``` + +Make sure to replace "Short summary of the change" with a meaningful commit +message. +:::: +::::: + + +### (4) Switch to the main branch and modify a recipe there + +:::::{tabs} +::::{group-tab} GitHub +1. Go back to the main repository page (your user's page). +1. In the branch switch view (top left above the file view), switch to + `main`. +1. Modify another recipe that already exists, following the pattern + from above. Don't modify the one you just created (but it shouldn't + even be visible on the `main` branch). +:::: + +::::{group-tab} VS Code +Use the branch selector at the bottom to switch back to the main branch. Repeat the same steps as above. + +:::{figure} img/commits/vscode-change-branch.png +:class: with-border +:width: 80% +:alt: VS Code screenshot + +Switching branch via selector at bottom. +:::: + +::::{group-tab} Command line +First switch to the `main` branch: +```console +$ git switch main +``` + +Then modify a file. Finally `git add` and then commit the change: +```console +$ git commit -m "Short summary of the change" +``` +:::: +::::: + + +### (5) Browse the commits you just made + +Let's look at what we did. Now, the `main` and `new-recipe` branches +have diverged: both have some modifications. Try to find the commits +you created. + +:::::{tabs} +::::{group-tab} GitHub +Insights tab → Network view (just like we have done before). +:::: + +::::{group-tab} VS Code +This requires an extension. Opening the VS Code terminal lets you use the command line method. + +:::{figure} img/commits/vscode-open-terminal.png +:class: with-border +:width: 80% +:alt: VS Code screenshot as described + +View → Terminal will open a terminal at bottom. This is a normal command line interface and very useful for work. (Note the git-aware prompt that shows the current branch. This requires other setup.) +:::: + +::::{group-tab} Command line +```console +$ git graph +$ git log --graph --oneline --decorate --all # If you didn't define git graph yet. +``` + +In my case I got: +```{code-block} +--- +emphasize-lines: 1-3 +--- +* b4de93b (HEAD -> main) add spring onion to poke +| * dc5d6f0 (origin/new-recipe, new-recipe) adding chocolate to the mixed nuts recipe +| * b4035e3 add mixed nuts recipe +|/ +* 554c187 (origin/main, origin/HEAD) Merge branch 'alex/fruit-salad' +|\ +| * 89d5ef9 fruit salad: instructions +| * 3bd2468 fruit salad: ingredients +* | 8bcb766 a todo note to not forget the instructions +|/ +* b950c5c just fixing capitalization +* d18035e fix formatting +* 7051cca add some cilantro +* ae19e81 add categories for easier browsing +* a6fe629 we also need salad +* 30b89c4 document what this is about +* fd12dc1 Merge branch 'radovan/lasagna' +|\ +| * 7753d43 vegetarian lasagna: instructions +| * aa0473e vegetarian lasagna: ingredients +* | 1e5a24a Merge branch 'radovan/poke' +|\ \ +| * | 5aa6687 oh no! forgot onion - adding +| * | cc84e4f working on a poke recipe +| |/ +* | 9500901 a classic pumpkin pie recipe - yum! +* | 34ce939 drafting a recipe for a pasta, so far only ingredients +* | 28e5f26 recipe for a mushroom soup +|/ +* a550963 reduce amount of salt +* f2d6d58 don't forget to enjoy +* 1fde064 add half an onion +* 4c1873e drafting a guacamole recipe +* 2992443 this will be licensed under CC0 +* 084a1ea starting with an almost empty readme +``` +:::: +::::: + + +### (6) Compare the branches + +Comparing changes is an important thing we need to do. When using the +GitHub view only, this may not be so common, but we'll show it so that +it makes sense later on. + +:::::{tabs} + +::::{group-tab} GitHub +Next to the branch name switcher, click on "Branches" to get an overview. + +Another way to compare branches or commits on GitHub is to adjust the following URL: +`https://github.com/USER/recipe-book/compare/VERSION1..VERSION2` + +Replace `USER` with your username and `VERSION1` and `VERSION2` with a commit hash or branch name. +Please try it out. +:::: + +::::{group-tab} VS Code +This seems to require an extension. We recommend you use the command line method. +:::: + +::::{group-tab} Command line +```console +$ git diff main new-recipe +``` + +Try also the other way around: +```console +$ git diff new-recipe main +``` + +Try also this if you only want to see the file names that are different: +```console +$ git diff --name-only main new-recipe +``` +:::: +::::: + + +### (7) Compare two arbitrary commits + +This is similar to above, but not only between branches. + +:::::{tabs} +::::{group-tab} GitHub +Like above, one can compare commits on GitHub by adjusting the following URL: +`https://github.com/USER/recipe-book/compare/VERSION1..VERSION2` + +Replace `USER` with your username and `VERSION1` and `VERSION2` with a commit hash or branch name. +Please try it out. +:::: + +::::{group-tab} VS Code +Again, we recommend using the Command Line method. +:::: + +::::{group-tab} Command line +First try this to get a short overview of the commits: +```console +$ git log --oneline +``` + +Then try to compare any two commit identifiers with `git diff`. +:::: +::::: + + +### (8) Renaming a branch + +:::::{tabs} +::::{group-tab} GitHub + +Branch button → View all branches → three dots at right side → Rename branch. + +:::: +::::{group-tab} VS Code +Version control sidebar → Three dots (same as in step 2) → Branch → Rename branch. Make sure you are on the right branch before you start. +:::: + +::::{group-tab} Command line +Renaming the current branch: +```console +$ git branch -m better-recipe +``` + +Renaming a different branch: +```console +$ git branch -m new-recipe better-recipe +``` +:::: +::::: + + +### (9) Creating a tag + +Tags are a way to mark a specific commit as important, for example a release +version. They are also like a sticky note, but they don't move when new +commits are added. + +:::::{tabs} +::::{group-tab} GitHub +Click on the branch switcher, and then on "Tags", then on "View all tags", then +"Create a new release": + :::{figure} img/commits/github-create-tag.png + :alt: Screenshot on GitHub where we create a new tag. + :width: 60% + :class: with-border + ::: + +What GitHub calls releases are actually tags in Git with additional metadata. +For the purpose of this exercise we can use them interchangeably. +:::: + +::::{group-tab} VS Code +Version control sidebar → Three dots (same as in step 2) → Tags → Creat tag. Make sure you are on the expected commit before you do this. +:::: + +::::{group-tab} Command line +Creating a tag: +```console +$ git tag -a v1.0 -m "New manuscript version of my recipe for the pre-print" +``` +:::: +::::: + + +## Discussion + +In this part, we saw how we can make changes to our files. +With {term}`branches `, we can +track several lines of work at once, and can compare +their differences. + +- You could commit directly to `main` if there is only one single line + of work and it's only you. +- You could commit to branches if there are multiple lines of work at + once, and you don't want them to interfere with each other. +- Tags are useful to mark a specific commit as important, for example a + release version. +- In Git, commits form a so-called "graph". Branches are tags in Git function + like sticky notes that stick to specific commits. What this means for us is + that it does not cost any significant disk space to create new branches. diff --git a/branch/main/_sources/configuration.md.txt b/branch/main/_sources/configuration.md.txt new file mode 100644 index 00000000..b00b7a89 --- /dev/null +++ b/branch/main/_sources/configuration.md.txt @@ -0,0 +1,147 @@ +(configuration)= + +# Configuring Git command line and editor + +We have a longer version of this in the [installation +instructions](https://coderefinery.github.io/installation/git-in-terminal/). +But for clarity, we will review the most important parts here. + +You don't need to set these if you work only through the GitHub web interface. +If you use VS Code or other editors or integrated development environments, +the editor might prompt you to set these up. + +These configuration settings are saved in a file called `.gitconfig` in your +home directory. If this file exists, editors like VS Code will use this +configuration. + +If you want to see your configuration settings, you can use the +command (`--show-origin` means it shows the file *where* each setting +is defined): +```console +$ git config --list --show-origin +``` + + +## Name and email address for Git commit metadata + +Git commits carry metadata about the author and two things you will always need +to define somewhere are: +```console +$ git config --global user.name "Your Name" +$ git config --global user.email yourname@example.com +``` + +For the email address we recommend to use the one you use for your GitHub account. +If you prefer to not use it, you can instead use +`YOUR_GITHUB_USERNAME@users.noreply.github.com` as the email address (replace `YOUR_GITHUB_USERNAME`). +This means that nobody can write to this email address, but GitHub will still +be able to connect your contributions with your GitHub account. + +Note that these can, in theory, be anything: this is just data, not a +registration or identity requirement. + + +## Default branch name + +The default branch name in Git has been `master` for a long time, but it is +changing to `main` in many places. We recommend to set it to `main` for new +repositories that you create locally: +```console +$ git config --global init.defaultbranch main +``` + + +## Useful alias for the command line + +We recommend to define an {term}`alias` in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command: +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` + +We have an own section about aliases: {ref}`aliases`. + + +## Default text editor for commit messages + +Git sometimes needs to start a text editor for you to enter messages (unless you create +commits from inside an editor or on the web). +This may have already been set to something (like VS Code), but if not +`nano` is usually a safe choice: + +```console +$ git config --global core.editor nano +``` + +The [installation instructions text editor page](https://coderefinery.github.io/installation/editors/) gives ways +to set other editors, or do a web search for "git set editor to +[editor name]". + + +% This anchor used for linking from other lessons +(clone-method)= + +## Authenticating to GitHub: SSH or HTTPS or VS Code? + +**How does GitHub know who you are?** There are three options: +- **SSH** is the classic method, using [Secure Shell + Protocol](https://en.wikipedia.org/wiki/Secure_Shell) remote connection + keys. +- **HTTPS** works with the **Git Credential Manager**, which is an + extra add-on that works easily in Windows and Mac. +- **VS Code** editor can authenticate with GitHub using its own + authentication method. + +Read how to install them from the [installation +instructions](https://coderefinery.github.io/installation/ssh/). + +Test which one you should use: + +:::::{tabs} + ::::{group-tab} Command line: SSH + Try this command: + ```console + $ ssh -T git@github.com + ``` + + If it returns `Hi USERNAME! You've successfully authenticated, ...`, + then SSH is configured and the following steps will work with the SSH + cloning. + + See our [installation + instructions](https://coderefinery.github.io/installation/ssh/) to + set up SSH access. + + **From now on, if you know that SSH works, you should always select + SSH as the clone URL from GitHub, or translate the URL to start with + the right thing yourself:** `git@github.com:` (with the `:`). + :::: + + ::::{group-tab} Command line: HTTPS + Try this command: + ```console + $ git config --get credential.helper + ``` + + If this shows something, then the credential manager is probably + configured and HTTPS cloning will work (but you can't verify it until + you try using it). + + From now on, **if you know that HTTPS works, you should always select + HTTPS as the clone URL from GitHub, or translate the URL to start with + the right thing yourself:** `https://github.com/` + :::: + + ::::{group-tab} VS Code + VS Code has its own authentication method and the editor will guide you + through the process. If you are using VS Code, you can skip the SSH and + HTTPS checks. + + From now on, you should **Select HTTPS as the clone URL from + GitHub, or translate the URL to start with the right thing + yourself:** `https://github.com/` + + If you don't want VS Code to be connected to your GitHub account, + set up and use the SSH method instead. + :::: +::::: diff --git a/branch/main/_sources/conflicts.md.txt b/branch/main/_sources/conflicts.md.txt new file mode 100644 index 00000000..34b978ad --- /dev/null +++ b/branch/main/_sources/conflicts.md.txt @@ -0,0 +1,463 @@ +(conflict-resolution)= + +# Conflict resolution + +```{objectives} +- Understand merge conflicts sufficiently well to be able to fix them. +``` + +```{instructor-note} +- 20 min teaching/type-along +- 20 min exercise +``` + + +## Conflicts in Git and why they are good + +Imagine we start with the following text file: +```{code-block} +1 tbsp cilantro +2 avocados +1 chili +1 lime +1 tsp salt +1/2 onion +``` + +On branch A somebody modifies: +```{code-block} +--- +emphasize-lines: 1, 4 +--- +2 tbsp cilantro +2 avocados +1 chili +2 lime +1 tsp salt +1/2 onion +``` + +On branch B somebody else modifies: +```{code-block} +--- +emphasize-lines: 1, 6 +--- +1/2 tbsp cilantro +2 avocados +1 chili +1 lime +1 tsp salt +1 onion +``` + +When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro: +```{code-block} +--- +emphasize-lines: 1 +--- +????????????????? +2 avocados +1 chili +2 lime +1 tsp salt +1 onion +``` + +Git is very good at resolving modifications when merging branches and +in most cases a `git merge` runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see {ref}`exercise-branches-optional`) without you even noticing. + +But sometimes the **same portion** of the code/text is modified on two branches +**in two different ways** and Git issues a **conflict**. +Then you need to tell Git which version to keep (**resolve** it). + +There are several ways to do that as we will see. + +Please remember: + +- It is good that Git conflicts exist: Git will not silently overwrite one of + two differing modifications. +- Conflicts may look scary, but are not that bad after a little bit of + practice. Also they are luckily rare. +- Don't be afraid of Git because of conflicts. You may not meet some conflicts + using other systems because you simply can't do the kinds of things you do + in Git. +- You can take human measures to reduce them. + +--- + +```{discussion} The human side of conflicts +- What does it mean if two people do the same thing in two different ways? +- What if you work on the same file but do two different things in the different sections? +- What if you do something, don't tell someone from 6 months, and then try to combine it with other people's work? +- How are conflicts avoided in other work? (Only one person working at once? + Declaring what you are doing before you start, if there is any chance someone + else might do the same thing, helps.) +- Minor conflicts (two people revise spelling) vs semantic (two people rewrite + a function to add two different new features). How did Git solve these in + branching/merging easily? +``` + +Now we can go to show how Git controls when there is actually a conflict. + + +## Preparing a conflict + +```{instructor-note} +We do the following together as type-along/demo. +``` + +````{admonition} If you got stuck previously or joined later + **If you got stuck previously or joined later**, + you can apply the commands below. + But **skip this box if you managed to create branches**. + + ```console + $ cd .. # step out of the current directory + + $ git clone https://github.com/coderefinery/recipe-before-merge.git + $ cd recipe-before-merge + + $ git remote remove origin + + $ git graph + ``` + + Or call a helper to un-stuck it for you. +```` + +We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together. + +- Create two branches from `main`: one called `like-cilantro`, one called `dislike-cilantro`: + ```console + $ git branch like-cilantro main + $ git branch dislike-cilantro main + ``` + +- On the two branches make **different modifications** to the amount of the **same ingredient**: + +- On the branch `like-cilantro` we have the following change: + ```console + $ git diff main like-cilantro + ``` + + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index e83294b..6cacd50 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -1,4 +1,4 @@ + -* 1 tbsp cilantro + +* 2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + ``` + +- And on the branch `dislike-cilantro` we have the following change: + ```console + $ git diff main dislike-cilantro + ``` + + ```diff + diff --git a/ingredients.txt b/ingredients.txt + index e83294b..6484462 100644 + --- a/ingredients.txt + +++ b/ingredients.txt + @@ -1,4 +1,4 @@ + -* 1 tbsp cilantro + +* 1/2 tbsp cilantro + * 2 avocados + * 1 chili + * 1 lime + ``` + + +## Merging conflicting changes + +What do you expect will happen when we try to merge these two branches into +main? + +```{note} +In case `git switch` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git switch`. +``` + +The first merge will work: + +```console +$ git switch main +$ git status +$ git merge like-cilantro + +Updating 4e03d4b..3caa632 +Fast-forward + ingredients.txt | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) +``` + +But the second will fail: + +```console +$ git merge dislike-cilantro + +Auto-merging ingredients.txt +CONFLICT (content): Merge conflict in ingredients.txt +Automatic merge failed; fix conflicts and then commit the result. +``` + +Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit: + +```{code-block} console +--- +emphasize-lines: 9 +--- +$ git status + +You have unmerged paths. + (fix conflicts and run "git commit") + (use "git merge --abort" to abort the merge) + +Unmerged paths: + (use "git add ..." to mark resolution) + both modified: ingredients.txt + +no changes added to commit (use "git add" and/or "git commit -a") +``` + +Git won't decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward. + +Let us inspect the conflicting file: + +```console +$ cat ingredients.txt + +<<<<<<< HEAD +* 2 tbsp cilantro +======= +* 1/2 tbsp cilantro +>>>>>>> dislike-cilantro +* 2 avocados +* 1 chili +* 1 lime +* 1 tsp salt +* 1/2 onion +``` + +Git inserted resolution markers (the `<<<<<<<`, `>>>>>>>`, and `=======`). + +Try also `git diff`: + +```console +$ git diff +``` + +```diff +diff --cc ingredients.txt +index 6cacd50,6484462..0000000 +--- a/ingredients.txt ++++ b/ingredients.txt +@@@ -1,4 -1,4 +1,10 @@@ +++<<<<<<< HEAD + +* 2 tbsp cilantro +++======= ++ * 1/2 tbsp cilantro +++>>>>>>> dislike-cilantro + * 2 avocados + * 1 chili + * 1 lime +``` + +`git diff` now only shows the conflicting part, nothing else. + + +## Conflict resolution + +``` +<<<<<<< HEAD +* 2 tbsp cilantro +======= +* 1/2 tbsp cilantro +>>>>>>> dislike-cilantro +``` + +We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged. + +```{admonition} Steps to resolve a conflict + +- Check status with `git status` and `git diff`. +- Decide what you keep (the one, the other, or both or something + else). Edit the file to do this. + - Remove the resolution markers, if not already done. + - The file(s) should now look exactly how you want them. +- Check status with `git status` and `git diff`. +- Tell Git that you have resolved the conflict with `git add ingredients.txt` + (if you use the Emacs editor with a certain plugin the editor may stage the + change for you after you have removed the conflict markers). +- Verify the result with `git status`. +- Finally commit the merge with only `git commit`. Everything is pre-filled. +``` + +(exercise-conflicts)= + +## Exercise: Create and resolve a conflict + +````{exercise} Conflict-1: Create another conflict and resolve +In this exercise, we repeat almost exactly what we did above with a +different ingredient. + +1. Create two branches before making any modifications. +2. Again modify some ingredient on both branches. +3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge. +4. What happens if you apply the same modification on both branches? +5. If you create a branch `like-avocados`, commit a change, then from this + branch create another banch `dislike-avocados`, commit again, and try to + merge both branches into `main` you will not see a conflict. Can you + explain, why it is different this time? +```{solution} +4: No conflict in this case if the change is the same. + +5: No conflict in this case since in Git history one change happened after the other. The two changes + are related and linked by Git history and one is a Git ancestor of the + other. Git will assume that since we applied one change after the other, + we meant this. There is nothing to resolve. +``` +```` + +(exercise-conflicts-optional)= + +## Optional exercises with conflict resolution + +````{exercise} (optional) Conflict-2: Resolve a conflict when rebasing a branch +1. Create two branches where you anticipate a conflict. +2. Try to merge them and observe that indeed they conflict. +3. Abort the merge with `git merge --abort`. +4. What do you expect will happen if you rebase one branch on top of the + other? Do you anticipate a conflict? Try it out. +```{solution} +Yes, this will conflict. If it conflicts during a merge, it will also conflict +during rebase but the conflict resolution looks slightly different: +You still need to look for conflict markers but you tell Git that you resolved +a conflict with `git add` and then you continue with `git rebase --continue`. +Follow instructions that you get from the Git command line. +``` +```` + +````{exercise} (optional) Conflict-3: Resolve a conflict using mergetool + - Again create a conflict (for instance disagree on the number of avocados). + - Stop at this stage: + + ```markdown + Auto-merging ingredients.txt + CONFLICT (content): Merge conflict in ingredients.txt + Automatic merge failed; fix conflicts and then commit the result. + ``` + + - Instead of resolving the conflict manually, use a visual tool + (requires installing one of the [visual diff tools](https://coderefinery.github.io/installation/difftools/)): + + ```console + $ git mergetool + ``` + + ```{figure} img/conflict-resolution/mergetool.png + :alt: Conflict resolution using mergetool + :width: 100% + ``` + + - Your current branch is left, the branch you merge is right, result is in the middle. + - After you are done, close and commit, `git add` is not needed when using `git mergetool`. + + If you have not instructed Git to avoid creating backups when using mergetool, then to be on + the safe side there will be additional temporary files created. To remove those you can do + a git clean after the merging. + + To view what will be removed: + + ```console + $ git clean -n + ``` + + To remove: + + ```console + $ git clean -f + ``` + + To configure Git to avoid creating backups at all: + + ```console + $ git config --global mergetool.keepBackup false + ``` +```` + +--- + +## Using "ours" or "theirs" strategy + +- Sometimes you know that you want to keep "ours" version (version on the branch you are on) + or "theirs" (version on the merged branch). +- Then you do not have to resolve conflicts manually. +- See [merge strategies](https://git-scm.com/docs/merge-strategies). + +Example (merge and in doubt take the changes from current branch): +```console +$ git merge -s recursive -Xours less-avocados +``` + +Or (merge and in doubt take the changes from less-avocados branch): +```console +$ git merge -s recursive -Xtheirs less-avocados +``` + +--- + +## Aborting a conflicting merge + +Sometimes you get a merge conflict but realize that you can't solve it without +talking to a colleague (who created the other change) first. What to do? + +You can abort the merge and postponing conflict resolution by resetting the +repository to `HEAD` (last committed state): + +```console +$ git merge --abort +``` + +The repository looks then exactly as it was before the merge. + +--- + +## Avoiding conflicts + +- Human measures + - Think and plan to which branch you will commit to. + - Do not put unrelated changes on the same branch. +- Collaboration measures + - Open an issue and discuss with collaborators before starting a long-living + branch. +- Project layout measures + - Modifying global data often causes conflicts. + - Modular programming reduces this risk. +- Technical measures + - **Share your changes early and often** - this is one of the happy, + rare circumstances when everyone doing the selfish thing (e.g. `git push` as + early as practical) results in best case for everyone! + - Pull/rebase often to keep up to date with upstream. + - Resolve conflicts early. + +```{discussion} +Discuss how Git handles conflicts compared to services like Google Drive. +``` + +```{keypoints} +- Conflicts often appear because of not enough communication or not optimal + branching strategy. +``` diff --git a/branch/main/_sources/customizing.md.txt b/branch/main/_sources/customizing.md.txt new file mode 100644 index 00000000..c8fdf72b --- /dev/null +++ b/branch/main/_sources/customizing.md.txt @@ -0,0 +1,25 @@ +# Customizing Git + +## Shell prompt + +```{instructor-note} +Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like. +``` + +You can make your shell display contextual information about +your Git state even at all times. + +Here are few example projects that make this possible and easy: +- (bash) +- (zsh) +- (fish) +- (bash and fish) + + +## More useful "diff" output + +[Delta](https://github.com/dandavison/delta) is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +"diff" output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more. diff --git a/branch/main/_sources/exercises.md.txt b/branch/main/_sources/exercises.md.txt new file mode 100644 index 00000000..fe455cfa --- /dev/null +++ b/branch/main/_sources/exercises.md.txt @@ -0,0 +1,10 @@ +# List of exercises + +This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests. + +```{exerciselist} +``` diff --git a/branch/main/_sources/guide.md.txt b/branch/main/_sources/guide.md.txt new file mode 100644 index 00000000..89b3eda7 --- /dev/null +++ b/branch/main/_sources/guide.md.txt @@ -0,0 +1,221 @@ +# Instructor guide + + +:::warning +## Exercise preparation: one day before the workshop + +- Create two exercise repository from + preserving history + (this means **not** using "generating from template") + - + - +- You can create these using `git clone --mirror` and `git push --mirror` to make sure to copy all branches. +- Create one or two issues to both +- Create one or two pull requests to both +- In both, try to search for something in the recipes to trigger a search index + update +::: + + +## Privacy + +When presenting the material in a streamed and recorded workshop, make sure to +only show the +repository. + + +## Schedule Day 1 + +Times here are in CE(S)T. + +- 08:50 - 09:00 (10 min) Soft start and icebreaker question +- 09:00 - 09:20 (20 min) Welcome and practical information + +- 09:20 - 09:35 (15 min) [Motivation](https://coderefinery.github.io/git-intro/motivation/) +- 09:35 - 10:00 (25 min) [Copy and browse an existing project](https://coderefinery.github.io/git-intro/browsing/) + +- 10:00 - 10:10 (10 min) Break + +- 10:10 - 11:00 (50 min) [Committing changes](https://coderefinery.github.io/git-intro/commits/) + +- 11:00 - 12:00 (60 min) Break + +- 12:00 - 12:50 (50 min) [Merging changes and contributing to the project](https://coderefinery.github.io/git-intro/merging/) + +- 12:50 - 13:00 (10 min) Break + +- 13:00 - 13:30 (20 min) Demonstrating conflict resolution, Q&A, feedback, and what will we be doing tomorrow? + + +## Schedule Day 2 + +Times here are in CE(S)T. + +- 08:50 - 09:00 (10 min) Soft start and icebreaker question +- 09:00 - 09:50 (50 min) [Cloning a Git repository and working locally](https://coderefinery.github.io/git-intro/local-workflow/) + +- 09:50 - 10:00 (10 min) Break + +- 10:00 - 11:00 (60 min) [Inspecting history](https://coderefinery.github.io/git-intro/archaeology/) + +- 11:00 - 12:00 (60 min) Break + +- 12:00 - 12:50 (50 min) [How to turn your project to a Git repo and share it](https://coderefinery.github.io/git-intro/sharing/) + +- 12:50 - 13:00 (10 min) Break + +- 13:00 - 13:30 (20 min) Practical advice, Q&A, feedback, and what will we be doing tomorrow? + + +## Why we teach this lesson + +Everyone should be using a version control system for their work, even if they're working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories. + +Specific motivations: +- Code easily becomes a disaster without version control +- Mistakes happen - Git offers roll-back functionality and easy backup mechanism +- One often needs to work on multiple things in parallel - branches solve that problem +- Git enables people to collaborate on code or text without stepping on each other's toes +- Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, + and if bugs are found one can find out exactly when it was introduced + +Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices. + + +## Intended learning outcomes + +By the end of this lesson, learners should: +- realize that version control is very important and Git is a valuable tool to learn and use +- understand that Git is configurable and know how to set basic configurations +- be able to set up Git repositories and make commits +- know how to write good commit messages +- have an idea of how the staging area can be used to craft good commits +- know how to create branches and switch between branches +- have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way +- know how to merge branches and understand what that means in terms of combining different modifications +- realize that conflicts are generally a good thing since they prevent incorrect merges +- be able to set up a repository on GitHub and connect it with local repository +- push changes to a remote repository +- know a few ways to search through a repository and its history + + +## Inspecting history + +Key lesson is *how to find when something is broken or what commit has broken +the code*. + +It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that `git annotate` +and `git show` are available on GitHub and GitLab. + +When discussing `git annotate` and `git bisect` the "when" is more important +than "who". It is not to blame anybody but rather to find out whether published +results are affected. + +Discuss how one would find out this information without version control. + +**Questions to involve participants:** + +- Have you ever found a bug in your code and wondered whether it has affected published results? +- Have you ever wondered when, and by whom, a particular line of code was introduced? +- Have you ever found out that a code behaves differently than it used to but you are not sure when + precisely this changed? + + +**Confusion during `git bisect` exercise:** + +Learners may get stuck in the `git bisect` exercise if they incorrectly assign a commit +as *bad* or *good*. +To leave the bisect mode and return to the commit before `git bisect start` was issued, +one can do +```shell +$ git bisect reset +``` +and start over if needed. + + +### Live better than reading the website material + +It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier. + + +### Log your history in a separate window + +The screencasting (shell window cheatsheet) hints have been moved to +the [presenting +manual](https://coderefinery.github.io/manuals/instructor-tech-setup/). + + +### Create a cheatsheet on the board + +For in-person workshops, create a "cheatsheet" on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven't forgotten anything. Re-create and expand in future git lessons. +One strategy is: + +- a common section for basic commands: `init`, `config`, `clone`, `help`, `stash` +- info commands, can be run anytime: `status`, `log`, `diff`, `graph` +- A section for all the commands that move code from different states: + `add`, `commit`, etc. See the visual cheat sheet below. + +You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it's probably too confusing to use after this course. But, the idea +of commands moving from the "working dir", "staging area", "commits", +etc is good. + +```{figure} img/cheat-sheet.jpg +:alt: Example cheat sheet +:width: 100% + +Example cheat sheet. +``` + +We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to. + + +### Draw a graph on the board + +Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run `git graph`, then do the command, +then look at `git graph` again. + + +### Repeat the following points + +- Always check `git status`, `git diff`, and `git graph` (our alias) before and + after every command until you get used to things. These give you a clear view + into what is going on, the key to knowing what you are doing. Even + after you are used to things... anytime you do something you do + infrequently, it's good to check. + +- `git graph` is a direct representation of what we are drawing on the + board and should constantly be compared to it. + +- Once you `git add` something, it's almost impossible to lose it. + This is used all the time, for example once you commit or even add + it is hard to lose. Commit before you merge or rebase. And so on. + + +### Start from identical environment + +You probably have a highly optimized bash and git environment - one +that is different from students. Move `.gitconfig` and `.bashrc` out +of the way before you start so that your environment is identical to +what students have. diff --git a/branch/main/_sources/index.md.txt b/branch/main/_sources/index.md.txt new file mode 100644 index 00000000..ccbd5471 --- /dev/null +++ b/branch/main/_sources/index.md.txt @@ -0,0 +1,124 @@ +# Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version + +```{warning} +In February and March 2024 we rewrote this lesson from the ground up. +If you are looking for the previous version, you can browse the +[2023 version of this lesson](https://coderefinery.github.io/git-intro/branch/2023-version/). +``` + +This is the introductory lesson to version control using +[Git](https://git-scm.com/). + +We start with an existing repository on the web to visually explain the basic +concepts of version control. We later move to a local +repository. Our goal there is not only to be able to apply changes to an +existing repository but to also be able to turn own projects into Git +repositories and to share them with others. + +In the separate [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/), we teach more use +of remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with Git to +be able to work well. + +The goals of the module as a whole are that the learner will feel comfortable +about committing changes, branching, and merging. + +```{prereq} +We offer several options to go through the material: **on the web, in an editor, +or in the terminal**. +Please see the [installation instructions](https://coderefinery.github.io/installation/). + +We recommend to have a [GitHub](https://github.com) account. +**Why GitHub?** +Also [GitLab](https://gitlab.com) and [Bitbucket](https://bitbucket.org) would +allow similar workflows and basically everything that we will discuss is +transferable. With this material and these exercises we do not implicitly +endorse the company [GitHub](https://github.com). We have chosen to demonstrate +a number of concepts using examples with [GitHub](https://github.com) because +it is currently the most popular web platform for hosting Git repositories and +the chance is high that you will interact with +[GitHub](https://github.com)-based repositories even if you choose to host your +Git repository on another service. +``` + +```{toctree} +:maxdepth: 1 +:caption: Getting started + +motivation +configuration +``` + +```{toctree} +:maxdepth: 1 +:caption: Modifying an existing project + +browsing +commits +merging +local-workflow +``` + +```{toctree} +:maxdepth: 1 +:caption: Studying an existing project + +archaeology +``` + +```{toctree} +:maxdepth: 1 +:caption: Sharing your work + +sharing +``` + +```{toctree} +:maxdepth: 1 +:caption: Finding the balance + +level +what-to-avoid +``` + +```{toctree} +:maxdepth: 1 +:caption: Older episodes + +basics +branches +conflicts +``` + +```{toctree} +:maxdepth: 1 +:caption: Optional episodes + +staging-area +recovering +interrupted +aliases +under-the-hood +``` + +```{toctree} +:maxdepth: 1 +:caption: Reference + +reference +customizing +resources +exercises +guide +PDF version +``` + +```{toctree} +:maxdepth: 1 +:caption: About + +All lessons +CodeRefinery +Reusing +``` diff --git a/branch/main/_sources/interrupted.md.txt b/branch/main/_sources/interrupted.md.txt new file mode 100644 index 00000000..0516cad1 --- /dev/null +++ b/branch/main/_sources/interrupted.md.txt @@ -0,0 +1,106 @@ +# Interrupted work + +```{objectives} +- Learn to switch context or abort work without panicking. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 15 min exercise +``` + +```{keypoints} +- There is almost never reason to clone a fresh copy to complete a task that + you have in mind. +``` + + +## Frequent situation: interrupted work + +We all wish that we could write beautiful perfect code. But the real world is +much more chaotic: + +- You are in the middle of a "Jackson-Pollock-style" debugging spree with 27 modified files + and debugging prints everywhere. +- Your colleague comes in and wants you to fix/commit something right now. +- What to do? + +Git provides lots of ways to switch tasks without ruining everything. + + +## Option 1: Stashing + +The **stash** is the first and easiest place to temporarily "stash" +things. + +- `git stash` will put working directory and staging area changes + away. Your code will be same as last commit. +- `git stash pop` will return to the state you were before. Can give it a list. +- `git stash list` will list the current stashes. +- `git stash save NAME` is like the first, but will give it a name. + Useful if it might last a while. +- `git stash save [-p] [filename]` will stash certain files files + and/or by patches. +- `git stash drop` will drop the most recent stash (or whichever stash + you give). +- The stashes form a stack, so you can stash several batches of modifications. + + +(exercise-stashing)= + +### Exercise: Stashing + +````{exercise} Interrupted-1: Stash some uncommitted work +1. Make a change. +2. Check status/diff, stash the change with `git stash`, check status/diff again. +3. Make a separate, unrelated change which doesn't touch the same + lines. Commit this change. +4. Pop off the stash you saved with `git stash pop`, and check status/diff. +5. Optional: Do the same but stash twice. Also check `git stash list`. + Can you pop the stashes in the opposite order? +6. Advanced: What happens if stashes conflict with other changes? Make + a change and stash it. Modify the same line or one right above or + below. Pop the stash back. Resolve the conflict. Note there is no + extra commit. +7. Advanced: what does `git graph` show when you have something + stashed? + +```{solution} +5: Yes you can. With `git stash pop INDEX` you can decie which stash +index to pop. + +6: In this case Git will ask us to resolve the conflict the same way +when resolving conflicts between two branches. + +7: It shows an additional commit hash with `refs/stash`. +``` +```` + + +## Option 2: Create branches + +You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch. + +You basically know how to do this: + +```console +$ git switch --create temporary # create a branch and switch to it +$ git add PATHS # stage changes +$ git commit # commit them +$ git switch main # back to main, continue your work there ... +$ git switch temporary # continue again on "temporary" where you left off +``` + +Later you can merge it to main or rebase it on top of main and resume work. + + +## Storing various junk you don't need but don't want to get rid of + +It happens often that you do something and don't need it, but you don't want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still. diff --git a/branch/main/_sources/level.md.txt b/branch/main/_sources/level.md.txt new file mode 100644 index 00000000..b191088c --- /dev/null +++ b/branch/main/_sources/level.md.txt @@ -0,0 +1,120 @@ +# Practical advice: how much Git is necessary? + +:::{instructor-note} +- 20 min teaching/discussion +::: + + +## Writing useful commit messages + +Useful commit messages summarize the change and provide context. + +If you need a commit message that is longer than one line, +then the convention is: **one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary**. + +Good example: +```text +increase alpha to 2.0 for faster convergence + +the motivation for this change is +to enable ... +... +(more context) +... +this is based on a discussion in #123 +``` + +- **Why something was changed is more important than what has changed.** +- Cross-reference to issues and discussions if possible/relevant. +- Bad commit messages: "fix", "oops", "save work" +- Bad examples: [http://whatthecommit.com](http://whatthecommit.com) +- Write commit messages in English that will be understood + 15 years from now by someone else than you. Or by your future you. +- Many projects start out as projects "just for me" and end up to be successful projects + that are developed by 50 people over decades. +- [Commits with multiple authors](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) are possible. + +Good references: + +- ["My favourite Git commit"](https://fatbusinessman.com/2019/my-favourite-git-commit) +- ["On commit messages"](https://who-t.blogspot.com/2009/12/on-commit-messages.html) +- ["How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/) + +```{note} +A great way to learn how to write commit messages and to get inspired by their +style choices: **browse repositories of codes that you use/like**: + +Some examples (but there are so many good examples): +- [SciPy](https://github.com/scipy/scipy/commits/main) +- [NumPy](https://github.com/numpy/numpy/commits/main) +- [Pandas](https://github.com/pandas-dev/pandas/commits/main) +- [Julia](https://github.com/JuliaLang/julia/commits/master) +- [ggplot2](https://github.com/tidyverse/ggplot2/commits/main), + compare with their [release + notes](https://github.com/tidyverse/ggplot2/releases) +- [Flask](https://github.com/pallets/flask/commits/main), + compare with their [release + notes](https://github.com/pallets/flask/blob/main/CHANGES.rst) + +When designing commit message styles consider also these: +- How will you easily generate a changelog or release notes? +- During code review, you can help each other improving commit messages. +``` + +But remember: it is better to make any commit, than no commit. Especially in small projects. +**Let not the perfect be the enemy of the good enough**. + + +## What level of branching complexity is necessary for each project? + +**Simple personal projects**: +- Typically start with just the `main` branch. +- Use branches for unfinished/untested ideas. +- Use branches when you are not sure about a change. +- Use tags to mark important milestones. +- If you are unsure what to do with unfinished and not working code, commit it + to a branch. + +**Projects with few persons: you accept things breaking sometimes** +- It might be reasonable to commit to the `main` branch and feature branches. + +**Projects with few persons: changes are reviewed by others** +- You create new feature branches for changes. +- Changes are reviewed before they are merged to the `main` branch + (more about that in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/)). +- Consider to write-protect the `main` branch so that it can only be changed + with pull requests or merge requests. + + +## How about staging and committing? + +- Commit early and often: rather create too many commits than too few. + You can always combine commits later. +- Once you commit, it is very, very hard to really lose your code. +- Always fully commit (or stash) before you do dangerous things, so that you know you are safe. + Otherwise it can be hard to recover. +- Later you can start using the staging area (where you first stage and then commit in a second step). +- Later start using `git add -p` and/or `git commit -p`. + + +## How large should a commit be? + +- Better too small than too large (easier to combine than to split). +- Often I make a commit at the end of the day (this is a unit I would not like to lose). +- Smaller sized commits may be easier to review for others than huge commits. +- Imperfect commits are better than no commits. +- A commit should not contain unrelated changes to simplify review and possible + repair/adjustments/undo later (but again: imperfect commits are better than no commits). + +--- + +:::{keypoints} +- There is no one size fits all - start simple and grow your project. +::: + +:::{discussion} +How do you [plan to] use Git? + +- Advanced users or beginners, please provide your input in the online collaborative document. +::: diff --git a/branch/main/_sources/local-workflow.md.txt b/branch/main/_sources/local-workflow.md.txt new file mode 100644 index 00000000..1414d608 --- /dev/null +++ b/branch/main/_sources/local-workflow.md.txt @@ -0,0 +1,371 @@ +# Cloning a Git repository and working locally + +If you've been following the main path, you have just had interacted +with repositories on GitHub. This might not be what you usually +do, so now we move to working on your own computer. + +:::{objectives} +- We are able to clone a repository from the web and modify it locally. +- We can do the same things we did before (commit, branch, merge), but locally. +- We get a feeling for remote repositories ([more later](https://coderefinery.github.io/git-collaborative/)). +::: + +:::{instructor-note} +- 10 min introduction and setup +- 25 min exercise +- 15 min discussion +::: + + +## What is in a Git repository and what are we cloning? + +**Git repository**: +- Contains all the files and directories of a project. +- Contains the complete history of all changes (commits) to these files and directories. +- Each commit is a snapshot of the entire project at a certain point in time and has a unique identifier ("hash"). +- Sometimes it contains multiple branches and tags. +- All the commits and history of a local repository are stored in a directory + called `.git` which is located at the root of the repository. + +**Cloning**: +- Copying (downloading) the entire repository with all commits, branches, and tags to your computer. +- It is a full backup of the repository, including all history. +- You can then work on your local clone of the repository. +- Changes on local clone will not automatically appear in the repository where + we cloned from. We have to actively "push" them there (we will practice this + in a later episode: {ref}`sharing-repositories`). + + +## Exercise + +Work on this by yourself or in your teams. Conceptually this episode should +seem familiar, from the browser-based exercises we did yesterday. + +We offer the **Command Line and VS Code** paths for this exercise. +GitHub isn't an option in this episode, since that is what we already +demonstrated in {doc}`commits` and {doc}`merging` and since the point of this +episode is to work **locally**. + +It is also possible to use the command line (terminal) from inside VS Code. + +```{exercise} Exercise: Cloning a Git repository and working locally (25 min) +1. {ref}`Configure Git command line and editor ` if you haven't done that already. +1. **Decide which repository you want to clone**: your fork or the original repository? Both will work for this exercise. + Then, **clone the recipe book**. +1. **Create a new branch**. +1. Make a **commit** on your new branch. +1. **Switch** back to the `main` branch and create one or two commits there. +1. **Merge** the new branch into `main`. +1. Compare the graph locally and on GitHub and observe that the **changes only exist locally on your computer**. +1. Where are the **remote branches**? Practice how you can see all remote branches + also locally and how you can fetch them and make local changes to them. +``` + +The solution below goes over most of the answer and should be used as +your guide (you can't figure it out just from the exercise instructions). + + +## Solution and walk-through + + +### (1) Configure Git command line and editor + +We have an own section for this: {ref}`configuration`. + + +### (2) Cloning a repository + +Now you need to decide which repository you want to clone. All of these options will work for this exercise +since we don't plan to push changes back (for step 8 it might be easier to use the original repository): +- Clone the recipe book from your fork. +- Or clone the recipe book from the original repository: +- Or first fork the original repository and then clone your fork. + +The examples below assume you are cloning the original repository. If you are cloning your fork, you should +replace `coderefinery` with your GitHub username. + +:::::::{tabs} +::::::{group-tab} Command line +If you are unsure whether you are using SSH or HTTPS, please read {ref}`clone-method`. + :::::{tabs} + ::::{group-tab} SSH + ```console + $ git clone git@github.com:coderefinery/recipe-book.git + ``` + :::: + + ::::{group-tab} HTTPS + ```console + $ git clone https://github.com/coderefinery/recipe-book.git + ``` + :::: + ::::: + +This creates a directory called "recipe-book" unless it already exists. You can also specify the target directory +on your computer (in this case "my-recipe-book"): + :::::{tabs} + ::::{group-tab} SSH + ```console + $ git clone git@github.com:coderefinery/recipe-book.git my-recipe-book + ``` + :::: + + ::::{group-tab} HTTPS + ```console + $ git clone https://github.com/coderefinery/recipe-book.git my-recipe-book + ``` + :::: + ::::: +:::::: + +::::::{group-tab} VS Code +Under "Start" on the screen, select "Clone Git Repository...". + +Alternatively navigate to the "Source Control" tab on the left sidebar and +click on the "Clone Repository" button. + +Paste in this URL: `https://github.com/USER/recipe-book` (replace `USER`) +:::::: +::::::: + + +### (3) Creating branches locally + +:::::{tabs} +::::{group-tab} Command line +Create a new branch called `another-recipe` from `main` and switch to it: +```console +$ git switch --create another-recipe main +``` + +If you leave out the last argument, it will create a branch from the current +branch: +```console +$ git switch --create another-recipe +``` +:::: + +::::{group-tab} VS Code +1. Make sure that you are on the main branch. +1. Source Control button on left sidebar → Three dots in upper right of source control → Branch → Create Branch. +1. VS Code automatically switches to the new branch. + +:::{figure} img/commits/vscode-create-branch.png +:width: 80% +:class: with-border +:alt: VS Code screenshot of create branch + +Creating a new branch in VS Code. +:::: +::::: + + +### (4) Creating commits locally + +:::::{tabs} +::::{group-tab} Command line +Create a new file. **After we have created it**, we can stage and commit +the change: +```console +$ git add new-file.md +$ git commit -m "Short summary of the change" +``` + +Make sure to replace "new-file.md" with the actual name of the file you created +and to replace "Short summary of the change" with a meaningful commit message. +:::: + +::::{group-tab} VS Code +1. Create a new file. +1. In the version control sidebar, click the `+` sign to add the file for the next commit. +1. Enter a brief message and click "Commit". + +:::{figure} img/commits/vscode-add-and-commit.png +:alt: Screenshot of VS Code commit process +:width: 80% +:class: with-border + +Committing a new file in VS Code. +::: +:::: +::::: + + +### (5) Switching branches and creating commits + +:::::{tabs} +::::{group-tab} Command line +First switch to the `main` branch: +```console +$ git switch main +``` + +Then modify a file. Finally `git add` and then commit the change: +```console +$ git commit -m "Short summary of the change" +``` +:::: + +::::{group-tab} VS Code +Use the branch selector at the bottom to switch back to the main branch. +Repeat the same steps as above. + +:::{figure} img/commits/vscode-change-branch.png +:class: with-border +:width: 80% +:alt: VS Code screenshot + +Switching branch via selector at bottom. +:::: +::::: + + +### (6) Merging branches locally + +:::::{tabs} +::::{group-tab} Command line +On the command line, when we merge, we always modify our current branch. + +If you are not sure anymore what your current branch is, type: +```console +$ git branch +``` + +Another way to find out where we are in Git: +```console +$ git status +``` + +In this case we merge the `another-recipe` branch into our current branch: +```console +$ git merge another-recipe +``` +:::: + +::::{group-tab} VS Code +Just like with the command line, when we merge we modify our *current* branch. Verify you are on the `main` branch. + +1. Verify current branch at the bottom. +1. From the version control sidebar → Three dots → Branch → Merge +1. In the selector that comes up, choose the branch you want to merge *from*. The commits on that branch will be added to the current branch. + +:::{figure} img/merging/vscode-merging.png +:alt: VSCode screenshot as described +:width: 80% +:class: with-border +:::: +::::: + + +### (7) How to compare the graph locally and on GitHub + +:::::{tabs} +::::{group-tab} Command line +```console +$ git log --graph --oneline --decorate --all +``` + +We recommend to define an {term}`alias` in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command: +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +``` +Then you can just type `git graph` from there on. We have an own section about +aliases: {ref}`aliases`. + +Compare this with the graph on GitHub: Insights tab → Network view (just like +we have done before). + +The result is that we should not be able to see the new branch and the new +commits on GitHub. +:::: + +::::{group-tab} VS Code +This requires an extension. Opening the VS Code terminal lets you use the command line method. + +:::{figure} img/commits/vscode-open-terminal.png +:class: with-border +:width: 80% +:alt: VS Code screenshot as described + +View → Terminal will open a terminal at bottom. This is a normal command line interface and very useful for work. (Note the git-aware prompt that shows the current branch. This requires other setup.) +:::: +::::: + + +### (8) Browsing remote branches and creating local branches from them + +:::::{tabs} +::::{group-tab} Command line +With `git branch` you can list all local branches: +```console +$ git branch + + another-recipe +* main +``` + +But where are the remote branches? We expect to see [a couple of +them](https://github.com/coderefinery/recipe-book/branches/all). + +We can see them by asking for all branches (your output might vary depending on +where you cloned from): +```console +$ git branch --all + + another-recipe +* main + remotes/origin/HEAD -> origin/main + remotes/origin/alex/fruit-salad + remotes/origin/main + remotes/origin/radovan/lasagna + remotes/origin/radovan/poke +``` + +You can create a local branch from a remote branch which will "track" the remote branch. +For instance, to create a local branch `alex/fruit-salad` from the remote branch `origin/alex/fruit-salad` +and switch to it, you can do: +```console +$ git switch --create alex/fruit-salad origin/alex/fruit-salad +``` + +This shortcut will do the same thing: +```console +$ git switch --track origin/alex/fruit-salad +``` + +Or even shorter: +```console +$ git switch alex/fruit-salad +``` + +If you want to create a branch and not switch to it, you can use `git branch`. +```console +$ git branch alex/fruit-salad +``` +:::: + +::::{group-tab} VS Code +To create a local branch from a remote branch: + +Source Control button on left sidebar → Three dots in upper right of source control → Branch → +"Create Branch From ...". + +Then select the remote branch you want to create a local branch from. +:::: +::::: + + +## Summary + +- When we clone a repository, we get a full backup of the repository, including + all history: all commits, branches, and tags. +- Yesterday we learned about branches and commits, and now we created and used them locally. +- **Creating local branches and commits does not automatically modify the remote + repository**. To "push" our local changes to the remote repository, we have to actively + "push" them there. We will practice this in a later episode: + {ref}`sharing-repositories` +- Remote branches and local branches are not the same thing. If we want to + create local commits, we always need to create a local branch first. But the local branch can + "track" the remote branch and we can push and pull changes to and from the + remote branch. diff --git a/branch/main/_sources/merging.md.txt b/branch/main/_sources/merging.md.txt new file mode 100644 index 00000000..8bfba557 --- /dev/null +++ b/branch/main/_sources/merging.md.txt @@ -0,0 +1,435 @@ +# Merging changes and contributing to the project + +Git allows us to have different development lines where we can try things out. +It also allows different people to work on the same project at the same. This +means that we have to somehow combine the changes later. In this part we will +practice this: {term}`merging`. + +:::{objectives} +- Understand that on GitHub merging is done through a {term}`pull request`. Think of it as a change proposal. +- Create and merge a pull request within your own repository. +- Understand (and optionally) do the same across repositories, to contribute to + the {term}`upstream` public repository. +::: + +:::{instructor-note} +- 10 min introduction and setup +- 25 min exercise +- 15 min discussion +::: + + +## Background + +* In the last episode, we added a new recipe on a branch. This allows + us to test it before it becomes "live". +* Now, we want to bring that change into the "main" branch. +* We will find it's not that hard! But you do have to keep track of the + steps and make sure that you work very precisely. + + +## Exercise + +In this exercise, we will show how we can **propose changes** and **merge +changes** within our own repository. Optionally, you can propose a recipe to +the {term}`upstream` recipe book - which shows the true purpose of this. But +this is only a preview and we will practice collaboration much more in the +[collaborative Git lesson](https://coderefinery.github.io/git-collaborative/). + +We offer **three different paths** of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the **GitHub +path** only and recommend you do that. The exercise text below has +some GitHub-specific notes, but most is possibly with any path. + +:::::{tabs} +::::{group-tab} GitHub + +First, we make something called a {term}`pull request`, which allows +review and commenting before the actual merge. + +:::{exercise} Exercise: Merging branches with pull requests (20 min) +We assume that in the previous exercise you have created a new branch +with a recipe. In our previous example, it is called `new-recipe`. +If not, create it first and add a recipe to your new branch, see +{doc}`commits`. + +We provide basic hints. You should refer to the solution as needed. + +1. Navigate to your branch from the previous episode + (Hint: the same branch view we used last time). + +1. Begin the pull request process. + (Hint: There is a "Contribute" button in the branch view). + +1. Add or modify the pull request title and description, and verify the other data. + In the pull request verify the target repository and the target + branch. Make sure that you are merging within your own repository. + **GitHub: By default, it will offer to make the change to the + upstream repository, `coderefinery`. You should change this**, you + shouldn't contribute your test recipe upstream yet. Where it says + `base repository`, select your own user's repository. + +1. Create the pull request by clicking "Create pull request". Browse + the network view to see if anything has changed yet. + +1. Merge the pull request, or if you are not on GitHub you can merge + the branch locally. Browse the network again. What has changed? + +1. Find out which branches are merged and thus safe to delete. Then remove them + and verify that the commits are still there, only the branch labels are + gone. (Hint: you can delete branches that have been merged into `main`). + +1. Optional: Try to create a new branch with a new change, then open a pull + request but towards the central repository. We will later merge few of + those. + (Hint: this is mostly the same as above, for the GitHub path. But, + you set the base repository as CodeRefinery. You might need to + compare across forks.) +::: +:::: + +::::{group-tab} Local (VS Code, Command line) + +When working locally, it's easier to merge branches: we can just do +the merge, without making a pull request. But we don't have that step +of review and commenting and possibly adjusting. + +:::{exercise} + +1. Switch to the `main` branch that you want to merge the *other* + branch into. (Note that this is the other way around from the + GitHub path). + +Then: + +5. Merge the other branch into `main` (which is then your current branch). + +6. Find out which branches are merged and thus safe to delete. Then remove them + and verify that the commits are still there, only the branch labels are + gone. (Hint: you can delete branches that have been merged into `main`). + +7. (optional, advanced) Try to create a new branch, and make a + GitHub pull request with your recipe, and contribute it to our + upstream repository. *This is very complex right now since your + change has to get to GitHub, and we haven't shown that yet. We + don't give a solution for this.* +::: + +:::: +::::: + +The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren't enough - this is by design. + + +## Solution and walk-through + +### (1) Navigate to your branch + +Before making the pull request, or doing a merge, it's important to +make sure that you are on the right branch. Many people have been +frustrated because they forgot this! + +:::::{tabs} +::::{group-tab} GitHub +On GitHub make sure you are on the branch you want to merge **from**: + :::{figure} img/merging/github-navigate-to-branch.png + :alt: Screenshot on GitHub where we navigate to the branch we wish to merge. + :width: 80% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +Remember, you need to switch to the `main` branch, the branch we want to merge **to**. +This is different from the GitHub path. +:::: + +::::{group-tab} Command line +Remember, you need to switch to the `main` branch, the branch we want to merge **to**. +This is different from the GitHub path: +```console +$ git switch main +``` +:::: +::::: + + +### (2) Begin the pull request process + +In GitHub, the pull request is the way we propose to merge two +branches together. We start the process of making one. + +:::::{tabs} +::::{group-tab} GitHub + :::{figure} img/merging/github-contribute.png + :alt: Screenshot on GitHub where we get to the pull request process. + :width: 80% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +It is possible to open pull requests from the editor, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: + +::::{group-tab} Command line +It is possible to open pull requests from the command line, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: +::::: + + +### (3) Fill out and verify the pull request + +Check that the pull request is directed to the right repository and branch +and that it contains the changes that you meant to merge. + +:::::{tabs} +::::{group-tab} GitHub +Things to check: +- Base repository: this should be your own +- Title: make it descriptive +- Description: make it informative +- Scroll down to see commits: are these the ones you want to merge? +- Scroll down to see the changes: are these the ones you want to merge? + :::{figure} img/merging/github-comparing-changes.png + :alt: Screenshot on GitHub where we verify the changes we want to merge. + :width: 80% + :class: with-border + + This screenshot only shows the top part. If you scroll down, you + can see the commits and the changes. We recommend to do this before + clicking on "Create pull request". + ::: +:::: + +::::{group-tab} VS Code +If you are working locally, continue to step 5. +:::: + +::::{group-tab} Command line +If you are working locally, continue to step 5. +:::: +::::: + + +### (4) Create the pull request + +We actually create the pull request. Don't forget to navigate to the Network +view after opening the pull request. Note that the changes proposed in the +pull request are not yet merged. + +:::::{tabs} +::::{group-tab} GitHub +Click on the green button "Create pull request". + +If you click on the little arrow next to "Create pull request", you can also +see the option to "Create draft pull request". This will be interesting later +when collaborating with others. It allows you to open a pull request that is +not ready to be merged yet, but you want to show it to others and get feedback. +:::: + +::::{group-tab} VS Code +It is possible to create pull requests from the editor, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: + +::::{group-tab} Command line +It is possible to create pull requests from the command line, but +we don't cover that here. + +If you are working locally, continue to step 5. +:::: +::::: + + +### (5) Merge the pull request + +Now, we do the actual merging. We see some effects now. + +:::::{tabs} +::::{group-tab} GitHub +Review it again (commits and changes), and then click "Merge pull request". + +After merging, verify the network view. Also navigate then to your "main" +branch and check that your new recipe is there. +:::: + +::::{group-tab} VS Code +Just like with the command line, when we merge we modify our *current* branch. Verify you are on the `main` branch. + +1. Verify current branch at the bottom. +1. From the version control sidebar → Three dots → Branch → Merge +1. In the selector that comes up, choose the branch you want to merge *from*. The commits on that branch will be added to the current branch. + +:::{figure} img/merging/vscode-merging.png +:alt: VSCode screenshot as described +:width: 80% +:class: with-border +:::: + +::::{group-tab} Command line +On the command line, when we merge, we always modify our *current* branch. + +If you are not sure anymore what your current branch is, type: +```console +$ git branch +``` +... or equally useful to see where we are right now: +```console +$ git status +``` + +In this case we merge the `new-recipe` branch into our current branch: +```console +$ git merge new-recipe +``` +:::: +::::: + + +### (6) Delete merged branches + +Before deleting branches, first check whether they are merged. + +If you delete an un-merged branch, it will be difficult to find the commits +that were on that branch. If you delete a merged branch, the commits are now +also part of the branch where we have merged to. + +:::::{tabs} +::::{group-tab} GitHub +One way to delete the branch is to click on the "Delete branch" button after the pull +request is merged: + :::{figure} img/merging/github-merged.png + :alt: Screenshot on GitHub suggesting us to delete a branch after it has been merged. + :width: 80% + :class: with-border + ::: + +But what if we forgot? Then navigate to the branch view: + :::{figure} img/merging/github-branches.png + :alt: Screenshot on GitHub where we navigate to the branches view. + :width: 80% + :class: with-border + ::: + +In the overview we can see that it has been merged and we can delete it: + :::{figure} img/merging/github-branches-overview.png + :alt: Screenshot on GitHub where we see an overview of branches and can delete them. + :width: 100% + :class: with-border + ::: +:::: + +::::{group-tab} VS Code +From the Source Control sidebar → the three dots (as before) → Branch → Delete Branch. Select the branch name to delete. +:::: + +::::{group-tab} Command line +Verify which branches are merged to the current branch: +```console +$ git branch --merged + +* main + new-recipe +``` + +This means that it is safe to delete the `new-recipe` branch: +```console +$ git branch -d new-recipe +``` + +Verify then that the branch is gone but that the commits are still there: +```console +$ git branch +$ git log --oneline +``` +:::: +::::: + + +### (7) Contribute to the original repository with a pull request + +Remember, this is an advanced step. If you do this, you are donating +a recipe to everyone. + +:::::{tabs} +::::{group-tab} GitHub +Now that you know how to create branches and opening a pull request, try to +open a new pull request with a new change but this time the base repository +should be the upstream one. + +In other words, you now send a pull request across repositories: from your fork +to the original repository. + +Another thing that is different now is that you might not have permissions to +merge the pull request. We can then together review and browse the pull +request. +:::: + +::::{group-tab} VS Code +Not described. We will return to this in the [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/). + +You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `coderefinery/recipe-book`. Or you do it all through VS Code. +:::: + +::::{group-tab} Command line +Not described. We will return to this in the [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/). + +You would create a new branch locally like above, {term}`push` it to GitHub to your own user's repository `USER/recipe-book`, then go to GitHub and open a pull request *to* `coderefinery/recipe-book`. + +:::: +::::: + + +## Resolving a conflict (demonstration) + +A conflict is when Git asks humans to decide during a merge which of two +changes to keep if the same portion of a file has been changed in two different +ways on two different branches. + +We will practice conflict resolution in the [collaborative Git +lesson](https://coderefinery.github.io/git-collaborative/). + +Here we will only demonstrate how to create a conflict and how to resolve it, +all on GitHub. Once we understand how this works, we will be more confident to +resolve conflicts also in the command line. + +How to create a conflict (please try this in your own time *and just watch now*): +- Create a new branch from `main` and on it make a change to a file. +- On `main`, make a different change to the same part of the same file. +- Now try to merge the new branch to `main`. You will get a conflict. + +How to resolve conflicts: +- On GitHub, you can resolve conflicts by clicking on the "Resolve conflicts" + button. This will open a text editor where you can choose which changes to + keep. + Make sure to remove the conflict markers. + After resolving the conflict, you can commit the changes and merge the + pull request. +- Sometimes a conflict is between your change and somebody else's change. In + that case, you might have to discuss with the other person which changes to + keep. + +How to avoid conflicts: +- We will talk about it in the [collaborative Git + lesson](https://coderefinery.github.io/git-collaborative/). + + +## Summary + +- We learned how to merge two branches together. +- When is this useful? This is not only useful to combine development lines in + your own work. Being able to merge branches also forms a basis for collaboration. +- Branches which are merged to other branches are safe to delete, since we only + delete the "sticky note" next to a commit, not the commits themselves. diff --git a/branch/main/_sources/motivation.md.txt b/branch/main/_sources/motivation.md.txt new file mode 100644 index 00000000..60c0e11c --- /dev/null +++ b/branch/main/_sources/motivation.md.txt @@ -0,0 +1,184 @@ +# Motivation + +```{objectives} +- Make sure nobody leaves the workshop without starting to use some form of version control. +- Discuss the reasons why we advocate distributed version control. +``` + +```{instructor-note} +- 15 min discussion/demonstration +``` + + +## Git is all about keeping track of changes + +We will learn how to keep track of changes first in the web browser. +Below are screenshots of **tracked changes with Git** +(from this [example repository](https://github.com/bast/runtest/commits/main/runtest/run.py)): +```{figure} img/git-log-github.png +:alt: Screenshot of a git log on GitHub +:width: 80% +:class: with-border + +Web browser, GitHub view +``` +Later also using the terminal or the editor +(the same [example repository](https://github.com/bast/runtest/commits/main/runtest/run.py)): +```{figure} img/git-log-terminal.png +:alt: Screenshot of a git log in terminal +:width: 80% + +The same as above, but the terminal view +``` + + +## Why do we need to keep track of versions? + +**Problem: If you have to identify and find your code from 17 days +ago, can you?** + +Version control is an answer to the following questions (do you recognize some +of them?): + +- "It broke ... hopefully I have a working version somewhere?" + +- "Can you please send me the latest version?" + +- "Where is the latest version?" + +- "Which version are you using?" + +- "Which version have the authors used in the paper I am trying to reproduce?" + +- "Found a bug! Since when was it there?" + +- "I am sure it used to work. When did it change?" + +- "My laptop is gone. Is my thesis now gone?" + + +## Features: roll-back, branching, merging, collaboration + +**Problem: Your code worked two days ago, but is giving an error now. +You don't know what you changed.** + +**Problem: You and your colleague want to work on the same code at the +same time.** + + +- **Roll-back**: you can always go back to a previous version and compare + +- **Branching and merging**: + - Work on different ideas at the same time + - Different people can work on the same code/project without interfering + - You can experiment with an idea and discard it if it turns out to be a bad idea + +```{figure} img/gopher/gophers.png +:alt: Branching explained with a gopher +:width: 100% + +Image created using +([inspiration](https://twitter.com/jay_gee/status/703360688618536960)). +``` + +- **Collaboration**: review, compare, share, discuss + +- [Example network graph](https://github.com/coderefinery/git-intro/network) + + +## Reproducibility + +**Problem: Someone asks you about your results from 5 years ago. Can +you get the same results now?** + +- How do you indicate which version of your code you have used in your paper? +- When you find a bug, how do you know **when precisely** this bug was introduced + (Are published results affected? Do you need to inform collaborators or users of your code?). + +With version control we can "annotate" code +([browse this example online](https://github.com/networkx/networkx/blame/main/networkx/algorithms/boundary.py)): + +```{figure} img/git-annotate.png +:alt: Example of a git-annotated code with code and history side-by-side +:width: 100% +:class: with-border + +Example of a git-annotated code with code and history side-by-side. +``` + + +## Talking about code + +**Problem: You want to show someone a few lines from one of your projects.** + +Which of these two is more practical? +- "Clone the code, go to the file 'src/util.rs', and search for 'time_iso8601'". + Oh! But make sure you use the version from August 2023." +- Or I can send you a [permalink](https://github.com/NordicHPC/sonar/blob/75daafc86582feb06299d6a47c82112f39888152/src/util.rs#L40-L44): + +```{figure} img/code-portion.png +:alt: Screen-shot of a code portion +:width: 100% +:class: with-border + +Permalink that points to a code portion. +``` + + +## What we typically like to snapshot + +- Software (this is how it started but Git/GitHub can track a lot more) +- Scripts +- Documents (plain text files much better suitable than Word documents) +- Manuscripts (Git is great for collaborating/sharing LaTeX or [Quarto](https://quarto.org/) manuscripts) +- Configuration files +- Website sources +- Data + +````{discussion} + In this example somebody tried to keep track of versions without a version + control system tool like Git. Discuss the following directory listing. What + possible problems do you anticipate with this kind of "version control": + ```shell + myproject-2019.zip + myproject-2020-February.zip + myproject-2021-August.zip + myproject-2023-09-19-working.zip + myproject-2023-09-21.zip + myproject-2023-09-21-test.zip + myproject-2023-09-21-myversion.zip + myproject-2023-09-21-newfeature.zip + ... + ``` + + ```{solution} + - Giving a version to a collaborator and merging changes later with own + changes sounds like lots of work. + - What if you discover a bug and want to know since when the bug existed? + ``` +```` + + +## Difficulties of version control + +Despite the benefits, let's be honest, there are some difficulties: + +- One more thing to learn (it's probably worth it and will save you more time in the long run; basic career skill). +- Difficult if your collaborators don't want to use it (in the worst case, you can version control on your side and email them versions). +- Advanced things can be difficult, but basics are often enough (ask others for help when needed). + + +## Why Git and not another tool? + +- **Easy to set up**: no server needed. +- **Very popular**: chances are high you will need to contribute to somebody else's code which is tracked with Git. +- **Distributed**: good backup, no single point of failure, you can track and + clean-up changes offline, simplifies collaboration model for open-source + projects. +- Important **platforms** such as [GitHub](https://github.com), [GitLab](https://gitlab.com), and [Bitbucket](https://bitbucket.org) + build on top of Git. + +However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +[Subversion](https://subversion.apache.org), +[Mercurial](https://www.mercurial-scm.org), [Pijul](https://pijul.org/), or others. diff --git a/branch/main/_sources/recovering.md.txt b/branch/main/_sources/recovering.md.txt new file mode 100644 index 00000000..3c705f3e --- /dev/null +++ b/branch/main/_sources/recovering.md.txt @@ -0,0 +1,260 @@ +# Undoing and recovering + +```{objectives} +- Learn to undo changes safely +- See when undone changes are permanently deleted and when they can be retrieved +``` + +```{instructor-note} +- 25 min teaching/type-along +- 25 min exercise +``` + +One of the main points of version control is that you can *go back in +time to recover*. Unlike this xkcd comic implies: + +In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn't a "commit" permanent? + +- You can modify old commit history. +- But if you have shared that history already, *modifying it can make + a huge mess*. + +```{admonition} It is almost always possible to recover +As long as you commit something once (or at least `git add` it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru... *until that guru becomes you*. +``` + +```{admonition} Nice resource to visually simulate Git operation +[git-sim](https://github.com/initialcommit-com/git-sim#video-animation-examples) +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command. +``` + +--- + +## Undoing your recent, uncommitted and unstaged changes (preserves history) + +```{note} +In case `git restore` does not work, your Git version might be older than from 2019. +On older Git it is `git checkout` instead of `git restore`. +``` + +You do some work, and want to **undo your uncommitted and unstaged modifications**. +You can always do that with: + +- `git restore .` (the dot means "here and in all folders below") + +You can also undo things selectively: + +- `git restore -p` (decide which portions of changes to undo) or `git restore PATH` (decide which path/file) + +If you have staged changes, you have at least two options to undo the staging: +- `git restore --staged .` followed by `git status` and `git restore .` +- `git reset --hard HEAD` throws away everything that is not in last + commit (`HEAD` - this literal word, this isn't a placeholder) + +--- + +## Reverting commits (preserves history) + +Imagine we made a few commits. +We realize that the latest commit `e02efcd` was a mistake and we wish to undo it: +```console +$ git log --oneline + +e02efcd (HEAD -> main) not sure this is a good idea +b4af65b improve the documentation +e7cf023 don't forget to enjoy +79161b6 add half an onion +a3394e3 adding README +3696246 adding instructions +f146d25 adding ingredients +``` + +A safe way to undo the commit is to revert the commit with `git revert`: +```console +$ git revert e02efcd +``` + +This creates a **new commit** that does the opposite of the reverted commit. +The old commit remains in the history: +```console +$ git log --oneline + +d3fc63a (HEAD -> main) Revert "not sure this is a good idea" +e02efcd not sure this is a good idea +b4af65b improve the documentation +e7cf023 don't forget to enjoy +79161b6 add half an onion +a3394e3 adding README +3696246 adding instructions +f146d25 adding ingredients +``` + +You can revert any commit, no matter how old it is. It doesn't affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we'll learn about later). + +(exercise-revert)= + +### Exercise: Revert a commit + +```{exercise} Undoing-1: Revert a commit +- Create a commit (commit A). +- Revert the commit with `git revert` (commit B). +- Inspect the history with `git log --oneline`. +- Now try `git show` on both the reverted (commit A) and the newly created commit (commit B). +``` + + +## Adding to the previous commit (modifies history) + +Sometimes we commit but realize we forgot something. +We can amend to the last commit: + +```console +$ git commit --amend +``` + +This can also be used to modify the last commit message. + +Note that this **will change the commit hash**. This command **modifies the history**. +This means that we avoid this command on commits that we have shared with others. + +(exercise-amend)= + +### Exercise: Modify a previous commit + +````{exercise} Undoing-2: Modify a previous commit +1. Make an incomplete change to the recipe or a typo in your change, `git + add` and `git commit` the incomplete/unsatisfactory change. +2. Inspect the unsatisfactory but committed change with `git show`. Remember + or write down the commit hash. +3. Now complete/fix the change but instead of creating a new commit, add the + correction to the previous commit with `git add`, followed by `git commit + --amend`. What changed? + + ```{solution} + One thing that has changed now is the commit hash. Modifying the previous + commit has changed the history. This is OK to do on commits that other people + don't depend on yet. + ``` +```` + + +## Rewinding branches (modifies history) + +You can **reset branch history** to move your branch back to some +point in the past. + +* `git reset --hard HASH` will force a branch label to any other point. All + other changes are lost (but it is possible to recover if you force reset by mistake). +* Be careful if you do this - it can mess stuff up. Use `git graph` a + lot before and after. + + +(exercise-reset)= + +### Exercise: Git reset + +````{exercise} Undoing-3: Destroy our experimentation in this episode + After we have experimented with reverts and amending, let us destroy + all of that and get our repositories to a similar state. + + - First, we will look at our history (`git log`/`git graph`) and + find the last commit `HASH` before our tests. + - Then, we will `git reset --hard HASH` to that. + - Then, `git graph` again to see what happened. + + ```console + $ git log --oneline + + d3fc63a (HEAD -> main) Revert "not sure this is a good idea" + e02efcd not sure this is a good idea + b4af65b improve the documentation + e7cf023 don't forget to enjoy + 79161b6 add half an onion + a3394e3 adding README + 3696246 adding instructions + f146d25 adding ingredients + + $ git reset --hard b4af65b + + HEAD is now at b4af65b improve the documentation + + $ git log --oneline + + b4af65b (HEAD -> main) improve the documentation + e7cf023 don't forget to enjoy + 79161b6 add half an onion + a3394e3 adding README + 3696246 adding instructions + f146d25 adding ingredients + ``` +```` + +--- + +## Recovering from committing to the wrong branch + +It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes. + +Here we assume that we made a couple of commits but we realize they went to the +wrong branch. + +**Solution 1 using git cherry-pick**: +1. Make sure that the correct branch exists and if not, create it. Make sure to + create it from the commit hash where you wish you had created it from: `git + branch BRANCHNAME HASH` +2. Switch to the correct branch. +3. `git cherry-pick HASH` can be used to take a specific commit to the + current branch. Cherry-pick all commits that should have gone to the correct + branch, **from oldest to most recent**. +4. Rewind the branch that accidentally got wrong commits with `git reset --hard` (see also above). + +**Solution 2 using `git reset --hard`** (makes sense if the correct branch should +contain all commits of the accidentally modified branch): +1. Create the correct branch, pointing at the latest commit: `git branch BRANCHNAME`. +2. Check with `git log` or `git graph` that both branches point to the same, latest, commit. +3. Rewind the branch that accidentally got wrong commits with `git reset --hard` (see also above). + + +## Recovering from merging/pulling into the wrong branch + +`git merge`, `git rebase`, and `git pull` modify the **current** branch, never +the other branch. But sometimes we run this command on the wrong branch. + +1. Check with `git log` the commit hash that you would like to rewind the + wrongly modified branch to. +2. Rewind the branch that accidentally got wrong commits with `git reset --hard HASH` (see also above). + + +## Recovering from conflict after pulling changes + +Pulling changes with +`git pull` can create a conflict since `git pull` always also includes a `git merge` (more about this +in the [collaborative Git lesson](https://coderefinery.github.io/git-collaborative/)). + +The recovery is same as described in {ref}`conflict-resolution`. Either +resolve conflicts or abort the merge with `git merge --abort`. + +--- + +````{challenge} Undoing-4: Test your understanding + 1. What happens if you accidentally remove a tracked file with `git rm`, is it gone forever? + 2. Is it OK to modify commits that nobody has seen yet? + 3. What situations would justify to modify the Git history and possibly remove commits? + + ```{solution} + 1. It is not gone forever since `git rm` creates a new commit. You can revert the commit to get the file back. + 2. If you haven't shared your commits with anyone it can be alright to modify them. + 3. If you have shared your commits with others (e.g. pushed them to GitHub), only extraordinary + conditions would justify modifying history. For example to remove sensitive or secret information. + ``` +```` diff --git a/branch/main/_sources/reference.md.txt b/branch/main/_sources/reference.md.txt new file mode 100644 index 00000000..80a5cce8 --- /dev/null +++ b/branch/main/_sources/reference.md.txt @@ -0,0 +1,158 @@ +# Quick reference + +## Other cheatsheets + +* [Detailed 2-page Git + cheatsheet](https://aaltoscicomp.github.io/cheatsheets/git-the-way-you-need-it-cheatsheet.pdf) +* [Interactive Git cheatsheet](http://www.ndpsoftware.com/git-cheatsheet.html) + + +## Glossary + +:::::{glossary} + +alias + With aliases you can define your own shortcuts for Git commands. + +version control system + A system that records changes to a file or set of files over time so that + you can recall specific versions later. + +git + Implementation of a version control system. Currently the most popular one. + +commit + As a verb, the process of recording more changes. + As a noun, the name of the record of changes. + A commit is identified by something such as `554c187`. + +working directory +workspace + the actual files you see and edit + +staging area + Place files go after `git add` and before `git commit` + +hash + Unique reference of any commit or state. Comes from [hash + functions](https://en.wikipedia.org/wiki/Hash_function) such as MD5 + or SHA1. + +branch + One line of work. Different branches can exist at the same time + and split/merge. Committing on a branch updates that branch. + +tag + Like a {term}`branch` in that it points to a commit for reference. + It is designed to be permanent an not updated. + +HEAD + Pointer to the most recent commit on the current branch. + +remote + Roughly, another server that holds .git. + +origin + Default name for a remote repository. + +repository + One collection of files managed by Git. It contains entire history + of all files managed by git. GitHub has one repository as one + GitHub repository. VS Code has one repository as one directory you + can open. The command line has one repository as one directory. + +clone + As a verb, the process of making a copy of a repository locally. + It brings in all history and all files. (As a noun, the copy that + was made when cloning). + +GitHub repository + The files from the Git repository, but also other things from + GitHub such as access permissions, issues, and pull requests. + +upstream + The original repository from which the code comes. If you + {term}`fork` the repository, it is your upstream and it is easy to + send changes back to there. + +fork + As a noun: a one person's copy of a repository. + As a verb: making that copy. + As a verb on GitHub: Making a copy of a repository linked to the + original. It is easy to send changes to the original + +issue + Within a web repository like GitHub, discussion of a topic, for + example a problem or improvement suggestion. These are a property + of the web platform and not of the Git program itself. + +pull request + A GitHub concept: change proposal. A proposal to merge one branch + into another. Usually used to contribute code back to + {term}`upstream`. + +push + Moving changes from your local copy to another copy + +pull + Getting changes from another copy to your own copy. `git pull` + does this fetch, and also tries to automatically merge. + +master + Default name for main branch on Git. Depending on the configuration and service, + the default branch is sometimes **main**. + In this lesson we configure Git so that the default branch is + called **main** to be more consistent with GitHub and GitLab. + +main + Default name for main branch on GitLab and GitHub. + In this lesson we configure Git so that the default branch is + called **main** to be more consistent with GitHub and GitLab. + +merge +merging + Bringing changes from one branch into another, either as a noun or + verb. + +VS Code + A text editor and development environment by Microsoft. It's quite + popular, partly because it is powerful and easy to use. [VS + Codium](https://vscodium.com/) is the same but without Microsoft + tracking. +::::: + +## Commands we use + +Setup: + +* `git config`: edit configuration options +* `git init -b main`: create new repository with `main` as the default branch + +See our status: + +* `git status`: see status of files - use often! +* `git log`: see history of commits and their messages, newest first +* `git graph`: see a detailed graph of commits. Create this command + with `git config --global alias.graph "log --all --graph --decorate --oneline"` +* `git diff`: show difference between working directory and last commit +* `git diff --staged`: show difference between staging area and last commit +* `git show COMMIT`: inspect individual commits + +General work: + +* `git add FILE`: + - Add a new file + - Add a file to staging +* `git commit`: record a version, add it to current branch +* `git commit --amend`: amend our last commit +* `git branch`: show which branch we're on +* `git branch NAME`: create a new branch called "name" +* `git restore FILE`: restore last committed/staged version of FILE, losing unstaged changes +* `git switch --create BRANCH-NAME`: create a new branch and switch to it +* `git revert HASH`: create a new commit which reverts commit HASH +* `git reset --soft HASH`: remove all commits after HASH, but keep their modifications as staged changes +* `git reset --hard HASH`: remove all commits after HASH, permanently throwing away their changes +* `git merge BRANCH-NAME`: merge branch BRANCH-NAME into current branch +* `git grep PATTERN`: search for patterns in tracked files +* `git annotate FILE`: find out when a specific line got introduced and by whom +* `git bisect`: find a commit which broke some functionality diff --git a/branch/main/_sources/resources.md.txt b/branch/main/_sources/resources.md.txt new file mode 100644 index 00000000..564f5247 --- /dev/null +++ b/branch/main/_sources/resources.md.txt @@ -0,0 +1,11 @@ +# Other resources + +- [Learn Git branching](http://pcottle.github.io/learnGitBranching/) +- [The entire Pro Git book, written by Scott Chacon and Ben Straub](http://git-scm.com/book) +- [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/) +- [Commit Often, Perfect Later, Publish Once: Git Best Practices](http://sethrobertson.github.io/GitBestPractices/) +- [PeepCode Git Internals](https://github.com/pluralsight/git-internals-pdf/releases) +- [Git Workflows for Pros: A Good Git Guide](https://www.toptal.com/git/git-workflows-for-pros-a-good-git-guide) +- [Branch-per-Feature](http://dymitruk.com/blog/2012/02/05/branch-per-feature/) +- [Git on XKCD](http://xkcd.com/1597/) +- [An efficient GIT workflow for mid/long term projects](http://fle.github.io/an-efficient-git-workflow-for-midlong-term-projects.html) diff --git a/branch/main/_sources/sharing.md.txt b/branch/main/_sources/sharing.md.txt new file mode 100644 index 00000000..661e96d7 --- /dev/null +++ b/branch/main/_sources/sharing.md.txt @@ -0,0 +1,300 @@ +(sharing-repositories)= + +# How to turn your project to a Git repo and share it + +:::{objectives} +- Turn our own coding project (small or large, finished or unfinished) into a + Git repository. +- Be able to share a repository on the web to have a backup or so that others + can reuse and collaborate or even just find it. +::: + +:::{instructor-note} +- 10 min introduction and setup +- 25 min exercise +- 15 min discussion +::: + + +## Exercise + +:::::{exercise} Exercise: Turn your project to a Git repo and share it (25 min) + +1. Create a new directory called **myproject** with one or few files in it. + This represents our own project. It is not yet a Git repository. You can try + that with your own project or use a simple placeholder example. +2. Turn this new directory into a Git repository. +3. Share this repository on GitHub (or GitLab, since it really works the same). + +We offer **three different paths** of how to do this exercise. +* Via **GitHub web interface**: easy and can be a good starting point if you are completely + new to Git. +* **VS Code** is quite easy, since VS Code can offer to create the + GitHub repositories for you. +* **Command line**: you need to create the + repository on GitHub and link it yourself. + +::::{tabs} + +:::{group-tab} Only using GitHub +### Create an repository on GitHub + +First log into GitHub, then follow the screenshots and descriptions below. +```{figure} img/sharing/new-repository.png +:alt: Screenshot on GitHub before a new repository form is opened +:width: 60% +:class: with-border + +Click on the "plus" symbol on top right, then on "New repository". +``` + +Then: +```{figure} img/sharing/create-repository-with-readme.png +:alt: Screenshot on GitHub just before a new repository is created +:width: 100% +:class: with-border + +Choose a repository name, add a short description, and in this case **make sure to check** "Add a +README file". Finally "Create repository". +``` + + +### Upload your files + +Now that the repository is created, you can upload your files: +```{figure} img/sharing/upload-files.png +:alt: Screenshot on GitHub just before uploading files +:width: 100% +:class: with-border + +Click on the "+" symbol and then on "Upload files". +``` +::: + +:::{group-tab} VS Code +In VS Code it only takes few clicks. + +First, open the folder in VS Code. My example project here contains two files. +Then click on the source control icon: +```{figure} img/sharing/vscode-start.png +:alt: Screenshot of VS Code before clicking on the source control icon +:width: 100% +:class: with-border + +Open the folder in VS Code. Then click on the source control icon. +``` + +```{figure} img/sharing/vscode-publish-to-github1.png +:alt: Screenshot of VS Code before publishing to GitHub +:width: 100% +:class: with-border + +Choose "Publish to GitHub". In this case I never even clicked on "Initialize Repository". +``` + +```{figure} img/sharing/vscode-publish-to-github2.png +:alt: Screenshot of VS Code before publishing to GitHub +:width: 100% +:class: with-border + +In my case I chose to "Publish to GitHub public repository". Here you can also rename +the repository if needed. +``` + +```{figure} img/sharing/vscode-authorize.png +:alt: Screenshot of VS Code asking for authorization +:width: 50% +:class: with-border + +First time you do this you might need to authorize VS Code to access your +GitHub account by redirecting you to https://github.com/login/oauth/authorize. +``` + +```{figure} img/sharing/vscode-publish-to-github3.png +:alt: Screenshot of VS Code after publishing to GitHub +:width: 100% +:class: with-border + +After it is published, click on "Open on GitHub". +``` +::: + +:::{group-tab} Command line +### Make sure your Git is configured + +We have an own section on this: {ref}`configuration`. + + +### Put your project under version control + +My example project here consists of two files. Replace this with your own +example files: +```console +$ ls -l + +.rw------- 19k user 7 Mar 17:36 LICENSE +.rw------- 21 user 7 Mar 17:36 myscript.py +``` + +I will first initialize a Git repository in this directory. +If you get an error, try without the `-b main` (and your default branch will +then be called `master`, this will happen for Git versions older than +2.28): +```console +$ git init -b main +``` + +Now add and commit the two files to the Git repository: +```console +$ git add LICENSE myscript.py +$ git commit -m "putting my project under version control" +``` + +If you want to add all files in one go, you can use `git +add .` instead of `git add LICENSE myscript.py`. + +Now you have a Git repository with one commit. Verify this with `git log`. +But it's still only on your computer. Let's put it on GitHub next. + + +### Create an empty repository on GitHub + +First log into GitHub, then follow the screenshots and descriptions below. +```{figure} img/sharing/new-repository.png +:alt: Screenshot on GitHub before a new repository form is opened +:width: 60% +:class: with-border + +Click on the "plus" symbol on top right, then on "New repository". +``` + +Then create an empty repository without any files and without any commits: +```{figure} img/sharing/create-repository.png +:alt: Screenshot on GitHub just before a new repository is created +:width: 100% +:class: with-border + +Choose a repository name, add a short description, but please **do not check** "Add a +README file". For "Add .gitignore" and "Choose a license" also leave as "None". Finally "Create repository". +``` + +Once you click the green "Create repository", you will see a page similar to: +```{figure} img/sharing/bare-repository.png +:alt: Screenshot on GitHub after a bare repository was created +:width: 100% +:class: with-border +``` + +What this means is that we have now an empty project with either an HTTPS or an +SSH address: click on the HTTPS and SSH buttons to see what happens. + + +### Push an existing repository from your computer to GitHub + +We now want to follow the "**... or push an existing repository from the command line**": + +1. In your terminal make sure you are still in your myproject directory. +2. Copy paste the three lines below the red arrow to the terminal and execute + those, in my case (**you need to replace the "USER" part and possibly also + the repository name**): + +`````{tabs} + ````{group-tab} SSH + ```console + $ git remote add origin git@github.com:USER/myproject.git + ``` + ```` + ````{group-tab} HTTPS + ```console + $ git remote add origin https://github.com/USER/myproject.git + ``` + ```` +````` + +Then: +```console +$ git branch -M main +$ git push -u origin main +``` + +The meaning of the above lines: +- Add a remote reference with the name "origin" +- Rename current branch to "main" +- Push branch "main" to "origin" + +You should now see: + +```text +Enumerating objects: 4, done. +Counting objects: 100% (4/4), done. +Delta compression using up to 12 threads +Compressing objects: 100% (3/3), done. +Writing objects: 100% (4/4), 6.08 KiB | 6.08 MiB/s, done. +Total 4 (delta 0), reused 0 (delta 0), pack-reused 0 +To github.com:USER/myproject.git + * [new branch] main -> main +branch 'main' set up to track 'origin/main'. +``` + +Reload your GitHub project website and your commits should now be +online! + + +### Troubleshooting + +**error: remote origin already exists** +- Explanation: You probably ran a `git remote add origin ...` command, then changed your + mind about HTTPS or SSH and then tried to run the other `git remote add + origin ...` command but "origin" then already exists. +- Recovery: + - First remove "origin" with `git remote remove origin` + - Then run the correct `git remote add origin ...` command + +**remote contains work that you do not have** +- Explanation: You probably clicked on "Add a README file" and now the + repository on GitHub is not empty but contains one commit and locally you + have a different history. Git now prevents you from accidentally overwriting + the history on GitHub. +- Recovery: + - Use `git push --force` instead of `git push`, which will force Git to overwrite the history on GitHub + - Note that this is a powerful but also possibly dangerous option but here it + helps us. If it's a brand new repo, it probably is fine to do this. For real + repositories, don't do this unless you are very sure what is happening. +::: + +:::: +::::: + + +## Remote repositories + +In this exercise we have pushed our local repository to a remote repository. +We will learn how to work with remote repositories in detail in the +[collaborative distributed version +control](https://coderefinery.github.io/git-collaborative/) lesson. To store +your git data on another server, you use **remotes**. A remote is a repository +on its own, with its own branches. We can **push** changes to the remote and +**pull** from the remote. + +You might use remotes to: +- Back up your own work or make your work findable. +- To collaborate with other people. + +There are different types of remotes: +- If you have a server you can SSH to, you can use that as a remote. +- [GitHub](https://github.com) is a popular, closed-source commercial site. +- [GitLab](https://about.gitlab.com) is a popular, open-core + commercial site. Many universities have their own private GitLab servers + set up. +- [Bitbucket](https://bitbucket.org) is yet another popular commercial site. +- Another option is [NotABug](https://notabug.org). +- There are more ... + + +## Is putting software on GitHub/GitLab/... publishing? + +It is a good first step but to make your code truly **findable and +accessible**, condider making your code **citable and persistent**: Get a +persistent identifier (PID) such as DOI in addition to sharing the code +publicly, by using services like [Zenodo](https://zenodo.org) or similar +services. diff --git a/branch/main/_sources/staging-area.md.txt b/branch/main/_sources/staging-area.md.txt new file mode 100644 index 00000000..94d0fe83 --- /dev/null +++ b/branch/main/_sources/staging-area.md.txt @@ -0,0 +1,330 @@ +# Using the Git staging area + +```{objectives} +- Learn how to tell a story with your commit history. +- Demystify the Git staging area. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 10 min exercise +``` + + +## Commit history is telling a story + +Your *current code* is very important, but the *history* can be just +as important - it tells a story about how your code came to be. + +- Each individual line of code rarely stands alone. +- You often want to see all the related changes together. +- But you also hardly ever do one thing at once. + +Along with your code, Git creates a *history* for you, and if your +history is clear then you are a long way to organized code. + +````{discussion} + Here are five types of history. What are the advantages and + disadvantages of each, when you look at it later? + + **Example 1**: + ```shell + b135ec8 add features A, B, and C + ``` + + **Example 2** (newest commit is on top): + ```shell + 6f0d49f implement feature C + fee1807 implement feature B + 6fe2f23 implement feature A + ``` + + **Example 3**: + ```shell + ab990f4 saving three months of miscellaneous work I forgot to commit + ``` + + **Example 4** (newest commit is on top): + ```shell + bf39f9d more work on feature B + 45831a5 removing debug prints for feature A and add new file + bddb280 more work on feature B and make feature A compile again + 72d78e7 feature A did not work and started work on feature B + b135ec8 now feature A should work + 72e0211 another fix to make it compile + 61dd3a3 forgot file and bugfix + 49dc419 wip (work in progress) + ``` + + **Example 5** (newest commit is on top): + ```shell + 1949dc4 Work of 2020-04-07 + a361dd3 Work of 2020-04-06 + 1172e02 Work of 2020-04-03 + e772d78 Work of 2020-04-02 + ``` + + Discuss these examples. Can you anticipate problems? +```` + +We want to have nice commits. But we also want to "save often" +(checkpointing) - how can we have both? + +- We will now learn to create nice commits using `git commit --patch` and/or the staging area. +- Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits. +- The staging area isn't the only way to organize your history nicely, some alternatives are discussed at the end of the lesson. + + +## Interactive commits + +- The simplest ways to solve this is to do **interactive commits**: + the `git commit --patch` option (or `git commit -p` for short). +- It will present you with every change you have made individually, + and you can decide which ones to commit right now. +- Reference and key commands + - `git commit --patch` to start the interactive commit + - `y` to use the change + - `n` to skip the change + - `s` (split) if there are several changes grouped together, but + separated by a blank line, split them into separate choices. + - `q` aborts everything. + - `?` for more options. +- The `-p` option is also available on `commit`, `restore`, `checkout`, `reset`, and `add`. + + +(exercise-interactive-commits)= + +## Exercise: Interactive commits + +````{exercise} Staging-1: Perform an interactive commit +One option to help us create nice logical commits is to stage *interactively* +with `git commit --patch`: + +1. Make two changes in `instructions.txt`, at the top and bottom + of the file. + **Make sure that they are separated by at least several unmodified lines.** +2. Run `git commit --patch`. Using the keystrokes above, commit one of + the changes. +3. Do it again for the other change. +4. When you're done, inspect the situation with `git log`, `git status`, `git diff` and `git diff --staged`. +5. When would this be useful? + + ```{solution} + This can be useful if you have several modification in a file (or several + files) but you decide that it would be beneficial to save them as two (or + more) separate commits. + ``` +```` + + +## The staging area + +- The interactive commits above are great, but what if there are so + many changes that you can't sort them out in one shot? +- What if you make progress and want to record it somehow, but it's + not ready to be committed? +- The **staging area** is a place to record things before committing. + +```{instructor-note} +We give two examples and the instructor can pick one or both: +- Analogy using moving boxes +- Analogy using shopping receipts +``` + +```{discussion} + **Analogy using moving boxes** + + - You're moving and you have a box to pack your things in. + - You can put stuff into the box, but you can also take stuff out of the box. + - You wouldn't want to mix items from the bathroom, kitchen, and living room + into the same box. + - The box corresponds to the staging area of Git, where you can craft your commits. + - Committing is like sealing the box and sticking a label on it. + - You wouldn't want to label your box with "stuff", but rather give a more + descriptive label. + - See also + + + **Analogy using shopping receipts** + + - You need to go shopping and buy some stuff for work and for home. + You need two separate receipts. + - Bad idea: go through the store get home stuff, pay, start at the + beginning and go through the store again. This is inefficient and + annoying. + - What you actually do: + - Go through the store and put everything you need in your shopping + basket. + - Get to the check-out. Put your home stuff on the conveyor belt + (`git add`). Check both the belt (`git diff --staged`) and your + basket (`git diff`) to make sure you got all your home stuff. + - Pay (`git commit`) + - Repeat for work stuff. + + In order to keep organized, you have to use multiple locations to + stage things in sequence. +``` + + +## Staging area commands + +The staging area is a middle ground between what you have done to your files +(the **working directory**) and what you have last committed (the **HEAD commit**). +Just like the name implies, it lets you prepare (**stage**) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since **you can modify and stage several times before committing**. + +**git add** stages/prepares for the next commit: +```text + git add + [project*] <------------ project* + ^ + | modify with editor + | + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +**git commit** creates a new commit: +```text + + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + HEAD~2 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +**git reset \\--soft HEAD~1** (move HEAD back by one but keep changes and stage +them) would do the opposite of **git commit**. (in this case, `HEAD` +is literally this - not a replacement) + +Going back to the last staged version: +```text + git restore + [project*] ------------> project* + + + + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Unstaging changes with **git restore \\--staged**: +```text + git restore --staged + ------------> project* + + + + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Discarding unstaged changes: +```text + + project* + | + | git restore + v + HEAD . project + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +Comparing: +```text + git diff + [project*] <-----------> project* + ^ ^ + | git diff --staged | git diff HEAD + v v + HEAD . + | . + | . + | . + HEAD~1 . + | . + | . + | . + . + .git . working directory +(history) . (files we see) +``` + +```{figure} img/staging-basics.svg +:alt: Staging basics +:width: 100% + +The different states of the repository and the commands to move from one to +another. +``` + +(exercise-staging-area)= + +## Exercise: Using the staging area + +```{exercise} Staging-2: Use the staging area to make a commit in two steps +1. In your recipe example, make two different changes to + `ingredients.txt` and `instructions.txt` which do not go together. +2. Use `git add` to stage one of the changes. +3. Use `git status` to see what's going on, and use `git diff` and `git diff --staged` to see the changes. +4. Feel some regret and unstage the staged change. +``` + +```{discussion} +- When is it better to "save" a change as commit, when is it better to "save" + it with `git add`? +- Is it a problem to commit many small changes? +``` + +```{keypoints} +- The staging area helps us to create well-defined commits. +``` diff --git a/branch/main/_sources/under-the-hood.md.txt b/branch/main/_sources/under-the-hood.md.txt new file mode 100644 index 00000000..977968da --- /dev/null +++ b/branch/main/_sources/under-the-hood.md.txt @@ -0,0 +1,185 @@ +# Git under the hood + +```{objectives} +- Verify that branches are pointers to commits and extremely lightweight. +``` + +```{instructor-note} +- 10 min teaching/type-along +- 15 min exercise +``` + +```{figure} img/stranger.jpg +:alt: Git under the hood +:width: 100% +``` + + +## Down the rabbit hole + +When working with Git, **you will never need to go inside .git**, but in this +exercise we will, in order to learn about how branches are implemented in Git. + +For this exercise create a new repository and commit a couple of changes. + +Now that we've made a couple of commits let us look at what is happening under +the hood. + +```console +$ cd .git +$ ls -l + +drwxr-xr-x - user 25 Aug 15:51 branches +.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG +.rw-r--r-- 92 user 25 Aug 15:51 config +.rw-r--r-- 73 user 25 Aug 15:51 description +.rw-r--r-- 21 user 25 Aug 15:51 HEAD +drwxr-xr-x - user 25 Aug 15:51 hooks +.rw-r--r-- 137 user 25 Aug 15:52 index +drwxr-xr-x - user 25 Aug 15:51 info +drwxr-xr-x - user 25 Aug 15:52 logs +drwxr-xr-x - user 25 Aug 15:52 objects +drwxr-xr-x - user 25 Aug 15:51 refs +``` + +Git stores everything under the .git folder in your repository. In fact, **the +.git directory is the Git repository.** + +Previously when you wrote the commit messages using your text editor, they +were in fact saved to `COMMIT_EDITMSG`. + +Each commit in Git is stored as a "blob". This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file. + +Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string). + +```{figure} img/commit-and-tree.png +:alt: A commit inside Git +:width: 100% + +States of a Git file. Image from the [Pro Git book](https://git-scm.com/book/). License CC BY 3.0. +``` + +Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a [directed acyclic +graph](http://eagain.net/articles/git-for-computer-scientists/) (do not worry +if the term is not familiar). + +```{figure} img/commits-and-parents.png +:alt: A commit and its parents +:width: 100% + +A commit and its parents. Image from the [Pro Git book](https://git-scm.com/book/). License CC BY 3.0. +``` + +All branches and tags in Git are pointers to commits. + + +## Git is basically a content-addressed storage system + +- CAS: ["mechanism for storing information that can be retrieved based on its content, not its storage location"](https://en.wikipedia.org/wiki/Content-addressable_storage) +- Content address is the content digest (SHA-1 checksum) +- Stored data does not change - so when we modify commits, we always create new + commits. Git doesn't delete these right away, which is why it is *very hard + to lose data if you commit it once*. + +Let us poke a bit into raw objects! Start with: + +```console +$ git cat-file -p HEAD +``` + +Then explore the `tree` object, then the `file` object, etc. recursively using the hashes you see. + + +## Demonstration: experimenting with branches + +Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an "Aha!" moment and provide us a +good understanding of the underlying model. + +We are starting from the `main` branch and create an `idea` branch: + +```console +$ git status + +On branch main +nothing to commit, working tree clean +``` + +```console +$ git switch --create idea + +Switched to a new branch 'idea' +``` + +```console +$ git branch + +* idea + main +``` + +Now let us go in: + +```console +$ cd .git +$ cd refs/heads +$ ls -l + +.rw-r--r-- 41 user 25 Aug 15:54 idea +.rw-r--r-- 41 user 25 Aug 15:52 main +``` + +Let us check what the `idea` file looks like +(do not worry if the hash is different): +```console +$ cat idea + +045e3db14740c60684d745e5fb891ae71e335611 +``` + +Now let us replicate this file: +```console +$ cp idea idea-2 +$ cp idea idea-3 +$ cp idea idea-4 +$ cp idea idea-5 +``` + +Let us go up two levels and inspect the file `HEAD`: +```console +$ cd ../.. +$ cat HEAD + +ref: refs/heads/idea +``` + +Let us open this file and change it to: +``` +ref: refs/heads/idea-3 +``` + +**Now we are ready for the aha moment!** +First let us go back to the working area: +```console +$ cd .. +``` + +Now - on which branch are we? +```console +$ git branch + + idea + idea-2 +* idea-3 + idea-4 + idea-5 + main +``` + +```{discussion} +Discuss the findings with other course participants. +``` diff --git a/branch/main/_sources/what-to-avoid.md.txt b/branch/main/_sources/what-to-avoid.md.txt new file mode 100644 index 00000000..ed76c118 --- /dev/null +++ b/branch/main/_sources/what-to-avoid.md.txt @@ -0,0 +1,62 @@ +# What to avoid + +The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas. + +**Postponing commits because the changes are "unfinished"/"ugly"**: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all. + +**Not updating your branch before starting new work**: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later. +So update your branch before adding new commits. + +**Commit unrelated changes together**: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects. + +**Too ambitious branch which risks to never get completed**: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere. + +**Committing generated files**: Compiled and generated files are not +committed to version control. There are many reasons for this: + +- These files can make it more difficult to run on different platforms. +- These files are automatically generated and thus do not contribute in any meaningful way. +- When tracking generated files you could see differences in the code although you haven't touched the code. + +For this we use [.gitignore files](https://git-scm.com/docs/gitignore) where +you can list which files and paths should be ignored by Git. You can also use +wild-cards to ignore files with a certain extension or files in a certain +directory. + +**Over-engineering the branch layout and safeguards in small projects**: This +may prevent people from contributing (maybe even including yourself?). Add more +restrictions and safeguards only as the project and the group of collaborators +grows. + +**Commit messages that explain what has been changed but do not explain why it has been +changed**: This is as useful as code comments which describe the "obvious" such +as "this is a loop" instead of explaining why something is done this way. +But don't let perfect commit messages stop you from the most important point, committing often (first point). + +**Commit huge files**: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent `git rm` does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request. + +:::{discussion} +Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements. +::: diff --git a/branch/main/_static/_sphinx_javascript_frameworks_compat.js b/branch/main/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/branch/main/_static/_sphinx_javascript_frameworks_compat.js @@ -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; +} diff --git a/branch/main/_static/basic.css b/branch/main/_static/basic.css new file mode 100644 index 00000000..30fee9d0 --- /dev/null +++ b/branch/main/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/branch/main/_static/check-solid.svg b/branch/main/_static/check-solid.svg new file mode 100644 index 00000000..92fad4b5 --- /dev/null +++ b/branch/main/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/main/_static/clipboard.min.js b/branch/main/_static/clipboard.min.js new file mode 100644 index 00000000..54b3c463 --- /dev/null +++ b/branch/main/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/branch/main/_static/copybutton.css b/branch/main/_static/copybutton.css new file mode 100644 index 00000000..40eafe5f --- /dev/null +++ b/branch/main/_static/copybutton.css @@ -0,0 +1,93 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +.highlight:hover button.copybtn { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/branch/main/_static/copybutton.js b/branch/main/_static/copybutton.js new file mode 100644 index 00000000..f3ecd034 --- /dev/null +++ b/branch/main/_static/copybutton.js @@ -0,0 +1,241 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copié dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for two seconds, then changes it back +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000) + setTimeout(() => el.classList.remove('success'), 2000) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, 2000) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos, .gp'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/branch/main/_static/copybutton_funcs.js b/branch/main/_static/copybutton_funcs.js new file mode 100644 index 00000000..dbe1aaad --- /dev/null +++ b/branch/main/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/branch/main/_static/css/badge_only.css b/branch/main/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/branch/main/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/branch/main/_static/css/fonts/Roboto-Slab-Bold.woff b/branch/main/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/branch/main/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/branch/main/_static/css/fonts/Roboto-Slab-Bold.woff2 b/branch/main/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/branch/main/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/branch/main/_static/css/fonts/Roboto-Slab-Regular.woff b/branch/main/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/branch/main/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/branch/main/_static/css/fonts/Roboto-Slab-Regular.woff2 b/branch/main/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/branch/main/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/branch/main/_static/css/fonts/fontawesome-webfont.eot b/branch/main/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/branch/main/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/branch/main/_static/css/fonts/fontawesome-webfont.svg b/branch/main/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/branch/main/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/main/_static/css/fonts/fontawesome-webfont.ttf b/branch/main/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/branch/main/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/branch/main/_static/css/fonts/fontawesome-webfont.woff b/branch/main/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/branch/main/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/branch/main/_static/css/fonts/fontawesome-webfont.woff2 b/branch/main/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/branch/main/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/branch/main/_static/css/fonts/lato-bold-italic.woff b/branch/main/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/branch/main/_static/css/fonts/lato-bold-italic.woff differ diff --git a/branch/main/_static/css/fonts/lato-bold-italic.woff2 b/branch/main/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/branch/main/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/branch/main/_static/css/fonts/lato-bold.woff b/branch/main/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/branch/main/_static/css/fonts/lato-bold.woff differ diff --git a/branch/main/_static/css/fonts/lato-bold.woff2 b/branch/main/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/branch/main/_static/css/fonts/lato-bold.woff2 differ diff --git a/branch/main/_static/css/fonts/lato-normal-italic.woff b/branch/main/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/branch/main/_static/css/fonts/lato-normal-italic.woff differ diff --git a/branch/main/_static/css/fonts/lato-normal-italic.woff2 b/branch/main/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/branch/main/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/branch/main/_static/css/fonts/lato-normal.woff b/branch/main/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/branch/main/_static/css/fonts/lato-normal.woff differ diff --git a/branch/main/_static/css/fonts/lato-normal.woff2 b/branch/main/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/branch/main/_static/css/fonts/lato-normal.woff2 differ diff --git a/branch/main/_static/css/theme.css b/branch/main/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/branch/main/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/branch/main/_static/doctools.js b/branch/main/_static/doctools.js new file mode 100644 index 00000000..d06a71d7 --- /dev/null +++ b/branch/main/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/branch/main/_static/documentation_options.js b/branch/main/_static/documentation_options.js new file mode 100644 index 00000000..87fc516a --- /dev/null +++ b/branch/main/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'dirhtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/branch/main/_static/file.png b/branch/main/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/branch/main/_static/file.png differ diff --git a/branch/main/_static/jquery.js b/branch/main/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/branch/main/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/main/_static/js/html5shiv.min.js b/branch/main/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/branch/main/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/main/_static/js/theme.js b/branch/main/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/branch/main/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/branch/main/_static/minipres.js b/branch/main/_static/minipres.js new file mode 100644 index 00000000..ad11c871 --- /dev/null +++ b/branch/main/_static/minipres.js @@ -0,0 +1,223 @@ +// Add goTo method to elements +// http://stackoverflow.com/questions/4801655/how-to-go-to-a-specific-element-on-page +(function($) { + $.fn.goTo = function() { + $('html, body').animate({ + scrollTop: $(this).offset().top //+ 'px' + }, 'fast'); + return this; // for chaining... + } +})(jQuery); + +// NO good way to do this!. Copy a hack from here +// https://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript +// https://stackoverflow.com/a/2880929 +var urlParams; +(window.onpopstate = function () { + var match, + pl = /\+/g, // Regex for replacing addition symbol with a space + search = /([^&=]+)=?([^&]*)/g, + decode = function (s) { return decodeURIComponent(s.replace(pl, " ")); }, + query = window.location.search.substring(1); + urlParams = {}; + while (match = search.exec(query)) + urlParams[decode(match[1])] = decode(match[2]); +})(); + +// Select heading levels +var maxHeading = urlParams['h'] +if (maxHeading === undefined) maxHeading = 2 +var headingLevels = []; +for (h=2 ; h (sections.length-1) ) { + // if we would scroll past bottom, or above top, do nothing + return; + } + + console.log('xxxxxx'); + var targetSection = sections[targetPos]; + console.log(targetSection, typeof(targetSection)); + + // Return targetSection top and height + var secProperties = section_top_and_height(targetSection); + var top = secProperties['top']; + var height = secProperties['height'] + var win_height = window.innerHeight; + //console.info(top, height, win_height) + + var scroll_to = 0; + if (height >= win_height || height == 0) { + scroll_to = top; + } else { + scroll_to = top - (win_height-height)/3.; + } + //console.info(top, height, win_height, scroll_to) + + $('html, body').animate({ + scrollTop: scroll_to //+ 'px' + }, 'fast'); + +} + + +function minipres() { + /* Enable the minipres mode: + - call the hide() function + - set up the scrolling listener + */ + document.addEventListener('keydown', function (event) { + switch(event.which) { + case 37: // left + switch_slide(-1); + event.preventDefault(); + return false; + break; + //case 38: // up + case 39: // right + switch_slide(+1); + event.preventDefault(); + return false; + break; + //case 40: // down + default: + return; // exit this handler for other keys + } + }, true) + + hide() + + // Increase space between sections + //$("div .section").css('margin-bottom', '50%'); + $(sectionSelector).css('margin-top', '50%'); + + // Reduce size/color of other sections + if (hiddenSectionSelector.length > 0) { + var hideNodes = $(hiddenSectionSelector); + console.log(typeof hideNodes, hideNodes); + for (node in hideNodes) { + console.log("a", typeof node, node); + node = hideNodes[node]; // what's right way to iterate values? + console.log("b", typeof node, node); + if (node.parentNode && node.parentNode.className == "section") { + node = node.parentNode; + console.log("c", typeof node, node); + //node.css['transform'] = 'scale(.5)'; + //node.css['transform-origin'] = 'top center'; + $(node).css('color', 'lightgrey'); + //$(node).css('font-size', '20%'); + //$(node).css('visibility', 'collapse'); + //ntahousnatouhasno; + } + } + } +} + +function hide() { + /* Hide all non-essential elements on the page + */ + + // This is for sphinx_rst_theme and readthedocs + $(".wy-nav-side").remove(); + $(".wy-nav-content-wrap").css('margin-left', 0); + $('.rst-versions').remove(); // readthedocs version selector + + // Add other formats here. +} + + +var slideshow = minipres; + +if (window.location.search.match(/[?&](minipres|slideshow|pres)([=&]|$)/) ) { + //minipres() + window.addEventListener("load", minipres); +} else if (window.location.search.match(/[?&](plain)([=&]|$)/) ) { + window.addEventListener("load", hide); +} diff --git a/branch/main/_static/minus.png b/branch/main/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/branch/main/_static/minus.png differ diff --git a/branch/main/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css b/branch/main/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css new file mode 100644 index 00000000..33566310 --- /dev/null +++ b/branch/main/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css @@ -0,0 +1,2342 @@ +/* Variables */ +:root { + --mystnb-source-bg-color: #f7f7f7; + --mystnb-stdout-bg-color: #fcfcfc; + --mystnb-stderr-bg-color: #fdd; + --mystnb-traceback-bg-color: #fcfcfc; + --mystnb-source-border-color: #ccc; + --mystnb-source-margin-color: green; + --mystnb-stdout-border-color: #f7f7f7; + --mystnb-stderr-border-color: #f7f7f7; + --mystnb-traceback-border-color: #ffd6d6; + --mystnb-hide-prompt-opacity: 70%; + --mystnb-source-border-radius: .4em; + --mystnb-source-border-width: 1px; +} + +/* Whole cell */ +div.container.cell { + padding-left: 0; + margin-bottom: 1em; +} + +/* Removing all background formatting so we can control at the div level */ +.cell_input div.highlight, +.cell_output pre, +.cell_input pre, +.cell_output .output { + border: none; + box-shadow: none; +} + +.cell_output .output pre, +.cell_input pre { + margin: 0px; +} + +/* Input cells */ +div.cell div.cell_input, +div.cell details.above-input>summary { + padding-left: 0em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + background-color: var(--mystnb-source-bg-color); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; + border-radius: var(--mystnb-source-border-radius); +} + +div.cell_input>div, +div.cell_output div.output>div.highlight { + margin: 0em !important; + border: none !important; +} + +/* All cell outputs */ +.cell_output { + padding-left: 1em; + padding-right: 0em; + margin-top: 1em; +} + +/* Text outputs from cells */ +.cell_output .output.text_plain, +.cell_output .output.traceback, +.cell_output .output.stream, +.cell_output .output.stderr { + margin-top: 1em; + margin-bottom: 0em; + box-shadow: none; +} + +.cell_output .output.text_plain, +.cell_output .output.stream { + background: var(--mystnb-stdout-bg-color); + border: 1px solid var(--mystnb-stdout-border-color); +} + +.cell_output .output.stderr { + background: var(--mystnb-stderr-bg-color); + border: 1px solid var(--mystnb-stderr-border-color); +} + +.cell_output .output.traceback { + background: var(--mystnb-traceback-bg-color); + border: 1px solid var(--mystnb-traceback-border-color); +} + +/* Collapsible cell content */ +div.cell details.above-input div.cell_input { + border-top-left-radius: 0; + border-top-right-radius: 0; + border-top: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; +} + +div.cell div.cell_input.above-output-prompt { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} + +div.cell details.above-input>summary { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + border-bottom: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; + padding-left: 1em; + margin-bottom: 0; +} + +div.cell details.above-output>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.below-input>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-top: none; + border-bottom-left-radius: var(--mystnb-source-border-radius); + border-bottom-right-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.hide>summary>span { + opacity: var(--mystnb-hide-prompt-opacity); +} + +div.cell details.hide[open]>summary>span.collapsed { + display: none; +} + +div.cell details.hide:not([open])>summary>span.expanded { + display: none; +} + +@keyframes collapsed-fade-in { + 0% { + opacity: 0; + } + + 100% { + opacity: 1; + } +} +div.cell details.hide[open]>summary~* { + -moz-animation: collapsed-fade-in 0.3s ease-in-out; + -webkit-animation: collapsed-fade-in 0.3s ease-in-out; + animation: collapsed-fade-in 0.3s ease-in-out; +} + +/* Math align to the left */ +.cell_output .MathJax_Display { + text-align: left !important; +} + +/* Pandas tables. Pulled from the Jupyter / nbsphinx CSS */ +div.cell_output table { + border: none; + border-collapse: collapse; + border-spacing: 0; + color: black; + font-size: 1em; + table-layout: fixed; +} + +div.cell_output thead { + border-bottom: 1px solid black; + vertical-align: bottom; +} + +div.cell_output tr, +div.cell_output th, +div.cell_output td { + text-align: right; + vertical-align: middle; + padding: 0.5em 0.5em; + line-height: normal; + white-space: normal; + max-width: none; + border: none; +} + +div.cell_output th { + font-weight: bold; +} + +div.cell_output tbody tr:nth-child(odd) { + background: #f5f5f5; +} + +div.cell_output tbody tr:hover { + background: rgba(66, 165, 245, 0.2); +} + +/** source code line numbers **/ +span.linenos { + opacity: 0.5; +} + +/* Inline text from `paste` operation */ + +span.pasted-text { + font-weight: bold; +} + +span.pasted-inline img { + max-height: 2em; +} + +tbody span.pasted-inline img { + max-height: none; +} + +/* Font colors for translated ANSI escape sequences +Color values are copied from Jupyter Notebook +https://github.com/jupyter/notebook/blob/52581f8eda9b319eb0390ac77fe5903c38f81e3e/notebook/static/notebook/less/ansicolors.less#L14-L21 +Background colors from +https://nbsphinx.readthedocs.io/en/latest/code-cells.html#ANSI-Colors +*/ +div.highlight .-Color-Bold { + font-weight: bold; +} + +div.highlight .-Color[class*=-Black] { + color: #3E424D +} + +div.highlight .-Color[class*=-Red] { + color: #E75C58 +} + +div.highlight .-Color[class*=-Green] { + color: #00A250 +} + +div.highlight .-Color[class*=-Yellow] { + color: #DDB62B +} + +div.highlight .-Color[class*=-Blue] { + color: #208FFB +} + +div.highlight .-Color[class*=-Magenta] { + color: #D160C4 +} + +div.highlight .-Color[class*=-Cyan] { + color: #60C6C8 +} + +div.highlight .-Color[class*=-White] { + color: #C5C1B4 +} + +div.highlight .-Color[class*=-BGBlack] { + background-color: #3E424D +} + +div.highlight .-Color[class*=-BGRed] { + background-color: #E75C58 +} + +div.highlight .-Color[class*=-BGGreen] { + background-color: #00A250 +} + +div.highlight .-Color[class*=-BGYellow] { + background-color: #DDB62B +} + +div.highlight .-Color[class*=-BGBlue] { + background-color: #208FFB +} + +div.highlight .-Color[class*=-BGMagenta] { + background-color: #D160C4 +} + +div.highlight .-Color[class*=-BGCyan] { + background-color: #60C6C8 +} + +div.highlight .-Color[class*=-BGWhite] { + background-color: #C5C1B4 +} + +/* Font colors for 8-bit ANSI */ + +div.highlight .-Color[class*=-C0] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC0] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C1] { + color: #800000 +} + +div.highlight .-Color[class*=-BGC1] { + background-color: #800000 +} + +div.highlight .-Color[class*=-C2] { + color: #008000 +} + +div.highlight .-Color[class*=-BGC2] { + background-color: #008000 +} + +div.highlight .-Color[class*=-C3] { + color: #808000 +} + +div.highlight .-Color[class*=-BGC3] { + background-color: #808000 +} + +div.highlight .-Color[class*=-C4] { + color: #000080 +} + +div.highlight .-Color[class*=-BGC4] { + background-color: #000080 +} + +div.highlight .-Color[class*=-C5] { + color: #800080 +} + +div.highlight .-Color[class*=-BGC5] { + background-color: #800080 +} + +div.highlight .-Color[class*=-C6] { + color: #008080 +} + +div.highlight .-Color[class*=-BGC6] { + background-color: #008080 +} + +div.highlight .-Color[class*=-C7] { + color: #C0C0C0 +} + +div.highlight .-Color[class*=-BGC7] { + background-color: #C0C0C0 +} + +div.highlight .-Color[class*=-C8] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC8] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C9] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC9] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C10] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC10] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C11] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC11] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C12] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC12] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C13] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC13] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C14] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC14] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C15] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC15] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C16] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC16] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C17] { + color: #00005F +} + +div.highlight .-Color[class*=-BGC17] { + background-color: #00005F +} + +div.highlight .-Color[class*=-C18] { + color: #000087 +} + +div.highlight .-Color[class*=-BGC18] { + background-color: #000087 +} + +div.highlight .-Color[class*=-C19] { + color: #0000AF +} + +div.highlight .-Color[class*=-BGC19] { + background-color: #0000AF +} + +div.highlight .-Color[class*=-C20] { + color: #0000D7 +} + +div.highlight .-Color[class*=-BGC20] { + background-color: #0000D7 +} + +div.highlight .-Color[class*=-C21] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC21] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C22] { + color: #005F00 +} + +div.highlight .-Color[class*=-BGC22] { + background-color: #005F00 +} + +div.highlight .-Color[class*=-C23] { + color: #005F5F +} + +div.highlight .-Color[class*=-BGC23] { + background-color: #005F5F +} + +div.highlight .-Color[class*=-C24] { + color: #005F87 +} + +div.highlight .-Color[class*=-BGC24] { + background-color: #005F87 +} + +div.highlight .-Color[class*=-C25] { + color: #005FAF +} + +div.highlight .-Color[class*=-BGC25] { + background-color: #005FAF +} + +div.highlight .-Color[class*=-C26] { + color: #005FD7 +} + +div.highlight .-Color[class*=-BGC26] { + background-color: #005FD7 +} + +div.highlight .-Color[class*=-C27] { + color: #005FFF +} + +div.highlight .-Color[class*=-BGC27] { + background-color: #005FFF +} + +div.highlight .-Color[class*=-C28] { + color: #008700 +} + +div.highlight .-Color[class*=-BGC28] { + background-color: #008700 +} + +div.highlight .-Color[class*=-C29] { + color: #00875F +} + +div.highlight .-Color[class*=-BGC29] { + background-color: #00875F +} + +div.highlight .-Color[class*=-C30] { + color: #008787 +} + +div.highlight .-Color[class*=-BGC30] { + background-color: #008787 +} + +div.highlight .-Color[class*=-C31] { + color: #0087AF +} + +div.highlight .-Color[class*=-BGC31] { + background-color: #0087AF +} + +div.highlight .-Color[class*=-C32] { + color: #0087D7 +} + +div.highlight .-Color[class*=-BGC32] { + background-color: #0087D7 +} + +div.highlight .-Color[class*=-C33] { + color: #0087FF +} + +div.highlight .-Color[class*=-BGC33] { + background-color: #0087FF +} + +div.highlight .-Color[class*=-C34] { + color: #00AF00 +} + +div.highlight .-Color[class*=-BGC34] { + background-color: #00AF00 +} + +div.highlight .-Color[class*=-C35] { + color: #00AF5F +} + +div.highlight .-Color[class*=-BGC35] { + background-color: #00AF5F +} + +div.highlight .-Color[class*=-C36] { + color: #00AF87 +} + +div.highlight .-Color[class*=-BGC36] { + background-color: #00AF87 +} + +div.highlight .-Color[class*=-C37] { + color: #00AFAF +} + +div.highlight .-Color[class*=-BGC37] { + background-color: #00AFAF +} + +div.highlight .-Color[class*=-C38] { + color: #00AFD7 +} + +div.highlight .-Color[class*=-BGC38] { + background-color: #00AFD7 +} + +div.highlight .-Color[class*=-C39] { + color: #00AFFF +} + +div.highlight .-Color[class*=-BGC39] { + background-color: #00AFFF +} + +div.highlight .-Color[class*=-C40] { + color: #00D700 +} + +div.highlight .-Color[class*=-BGC40] { + background-color: #00D700 +} + +div.highlight .-Color[class*=-C41] { + color: #00D75F +} + +div.highlight .-Color[class*=-BGC41] { + background-color: #00D75F +} + +div.highlight .-Color[class*=-C42] { + color: #00D787 +} + +div.highlight .-Color[class*=-BGC42] { + background-color: #00D787 +} + +div.highlight .-Color[class*=-C43] { + color: #00D7AF +} + +div.highlight .-Color[class*=-BGC43] { + background-color: #00D7AF +} + +div.highlight .-Color[class*=-C44] { + color: #00D7D7 +} + +div.highlight .-Color[class*=-BGC44] { + background-color: #00D7D7 +} + +div.highlight .-Color[class*=-C45] { + color: #00D7FF +} + +div.highlight .-Color[class*=-BGC45] { + background-color: #00D7FF +} + +div.highlight .-Color[class*=-C46] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC46] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C47] { + color: #00FF5F +} + +div.highlight .-Color[class*=-BGC47] { + background-color: #00FF5F +} + +div.highlight .-Color[class*=-C48] { + color: #00FF87 +} + +div.highlight .-Color[class*=-BGC48] { + background-color: #00FF87 +} + +div.highlight .-Color[class*=-C49] { + color: #00FFAF +} + +div.highlight .-Color[class*=-BGC49] { + background-color: #00FFAF +} + +div.highlight .-Color[class*=-C50] { + color: #00FFD7 +} + +div.highlight .-Color[class*=-BGC50] { + background-color: #00FFD7 +} + +div.highlight .-Color[class*=-C51] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC51] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C52] { + color: #5F0000 +} + +div.highlight .-Color[class*=-BGC52] { + background-color: #5F0000 +} + +div.highlight .-Color[class*=-C53] { + color: #5F005F +} + +div.highlight .-Color[class*=-BGC53] { + background-color: #5F005F +} + +div.highlight .-Color[class*=-C54] { + color: #5F0087 +} + +div.highlight .-Color[class*=-BGC54] { + background-color: #5F0087 +} + +div.highlight .-Color[class*=-C55] { + color: #5F00AF +} + +div.highlight .-Color[class*=-BGC55] { + background-color: #5F00AF +} + +div.highlight .-Color[class*=-C56] { + color: #5F00D7 +} + +div.highlight .-Color[class*=-BGC56] { + background-color: #5F00D7 +} + +div.highlight .-Color[class*=-C57] { + color: #5F00FF +} + +div.highlight .-Color[class*=-BGC57] { + background-color: #5F00FF +} + +div.highlight .-Color[class*=-C58] { + color: #5F5F00 +} + +div.highlight .-Color[class*=-BGC58] { + background-color: #5F5F00 +} + +div.highlight .-Color[class*=-C59] { + color: #5F5F5F +} + +div.highlight .-Color[class*=-BGC59] { + background-color: #5F5F5F +} + +div.highlight .-Color[class*=-C60] { + color: #5F5F87 +} + +div.highlight .-Color[class*=-BGC60] { + background-color: #5F5F87 +} + +div.highlight .-Color[class*=-C61] { + color: #5F5FAF +} + +div.highlight .-Color[class*=-BGC61] { + background-color: #5F5FAF +} + +div.highlight .-Color[class*=-C62] { + color: #5F5FD7 +} + +div.highlight .-Color[class*=-BGC62] { + background-color: #5F5FD7 +} + +div.highlight .-Color[class*=-C63] { + color: #5F5FFF +} + +div.highlight .-Color[class*=-BGC63] { + background-color: #5F5FFF +} + +div.highlight .-Color[class*=-C64] { + color: #5F8700 +} + +div.highlight .-Color[class*=-BGC64] { + background-color: #5F8700 +} + +div.highlight .-Color[class*=-C65] { + color: #5F875F +} + +div.highlight .-Color[class*=-BGC65] { + background-color: #5F875F +} + +div.highlight .-Color[class*=-C66] { + color: #5F8787 +} + +div.highlight .-Color[class*=-BGC66] { + background-color: #5F8787 +} + +div.highlight .-Color[class*=-C67] { + color: #5F87AF +} + +div.highlight .-Color[class*=-BGC67] { + background-color: #5F87AF +} + +div.highlight .-Color[class*=-C68] { + color: #5F87D7 +} + +div.highlight .-Color[class*=-BGC68] { + background-color: #5F87D7 +} + +div.highlight .-Color[class*=-C69] { + color: #5F87FF +} + +div.highlight .-Color[class*=-BGC69] { + background-color: #5F87FF +} + +div.highlight .-Color[class*=-C70] { + color: #5FAF00 +} + +div.highlight .-Color[class*=-BGC70] { + background-color: #5FAF00 +} + +div.highlight .-Color[class*=-C71] { + color: #5FAF5F +} + +div.highlight .-Color[class*=-BGC71] { + background-color: #5FAF5F +} + +div.highlight .-Color[class*=-C72] { + color: #5FAF87 +} + +div.highlight .-Color[class*=-BGC72] { + background-color: #5FAF87 +} + +div.highlight .-Color[class*=-C73] { + color: #5FAFAF +} + +div.highlight .-Color[class*=-BGC73] { + background-color: #5FAFAF +} + +div.highlight .-Color[class*=-C74] { + color: #5FAFD7 +} + +div.highlight .-Color[class*=-BGC74] { + background-color: #5FAFD7 +} + +div.highlight .-Color[class*=-C75] { + color: #5FAFFF +} + +div.highlight .-Color[class*=-BGC75] { + background-color: #5FAFFF +} + +div.highlight .-Color[class*=-C76] { + color: #5FD700 +} + +div.highlight .-Color[class*=-BGC76] { + background-color: #5FD700 +} + +div.highlight .-Color[class*=-C77] { + color: #5FD75F +} + +div.highlight .-Color[class*=-BGC77] { + background-color: #5FD75F +} + +div.highlight .-Color[class*=-C78] { + color: #5FD787 +} + +div.highlight .-Color[class*=-BGC78] { + background-color: #5FD787 +} + +div.highlight .-Color[class*=-C79] { + color: #5FD7AF +} + +div.highlight .-Color[class*=-BGC79] { + background-color: #5FD7AF +} + +div.highlight .-Color[class*=-C80] { + color: #5FD7D7 +} + +div.highlight .-Color[class*=-BGC80] { + background-color: #5FD7D7 +} + +div.highlight .-Color[class*=-C81] { + color: #5FD7FF +} + +div.highlight .-Color[class*=-BGC81] { + background-color: #5FD7FF +} + +div.highlight .-Color[class*=-C82] { + color: #5FFF00 +} + +div.highlight .-Color[class*=-BGC82] { + background-color: #5FFF00 +} + +div.highlight .-Color[class*=-C83] { + color: #5FFF5F +} + +div.highlight .-Color[class*=-BGC83] { + background-color: #5FFF5F +} + +div.highlight .-Color[class*=-C84] { + color: #5FFF87 +} + +div.highlight .-Color[class*=-BGC84] { + background-color: #5FFF87 +} + +div.highlight .-Color[class*=-C85] { + color: #5FFFAF +} + +div.highlight .-Color[class*=-BGC85] { + background-color: #5FFFAF +} + +div.highlight .-Color[class*=-C86] { + color: #5FFFD7 +} + +div.highlight .-Color[class*=-BGC86] { + background-color: #5FFFD7 +} + +div.highlight .-Color[class*=-C87] { + color: #5FFFFF +} + +div.highlight .-Color[class*=-BGC87] { + background-color: #5FFFFF +} + +div.highlight .-Color[class*=-C88] { + color: #870000 +} + +div.highlight .-Color[class*=-BGC88] { + background-color: #870000 +} + +div.highlight .-Color[class*=-C89] { + color: #87005F +} + +div.highlight .-Color[class*=-BGC89] { + background-color: #87005F +} + +div.highlight .-Color[class*=-C90] { + color: #870087 +} + +div.highlight .-Color[class*=-BGC90] { + background-color: #870087 +} + +div.highlight .-Color[class*=-C91] { + color: #8700AF +} + +div.highlight .-Color[class*=-BGC91] { + background-color: #8700AF +} + +div.highlight .-Color[class*=-C92] { + color: #8700D7 +} + +div.highlight .-Color[class*=-BGC92] { + background-color: #8700D7 +} + +div.highlight .-Color[class*=-C93] { + color: #8700FF +} + +div.highlight .-Color[class*=-BGC93] { + background-color: #8700FF +} + +div.highlight .-Color[class*=-C94] { + color: #875F00 +} + +div.highlight .-Color[class*=-BGC94] { + background-color: #875F00 +} + +div.highlight .-Color[class*=-C95] { + color: #875F5F +} + +div.highlight .-Color[class*=-BGC95] { + background-color: #875F5F +} + +div.highlight .-Color[class*=-C96] { + color: #875F87 +} + +div.highlight .-Color[class*=-BGC96] { + background-color: #875F87 +} + +div.highlight .-Color[class*=-C97] { + color: #875FAF +} + +div.highlight .-Color[class*=-BGC97] { + background-color: #875FAF +} + +div.highlight .-Color[class*=-C98] { + color: #875FD7 +} + +div.highlight .-Color[class*=-BGC98] { + background-color: #875FD7 +} + +div.highlight .-Color[class*=-C99] { + color: #875FFF +} + +div.highlight .-Color[class*=-BGC99] { + background-color: #875FFF +} + +div.highlight .-Color[class*=-C100] { + color: #878700 +} + +div.highlight .-Color[class*=-BGC100] { + background-color: #878700 +} + +div.highlight .-Color[class*=-C101] { + color: #87875F +} + +div.highlight .-Color[class*=-BGC101] { + background-color: #87875F +} + +div.highlight .-Color[class*=-C102] { + color: #878787 +} + +div.highlight .-Color[class*=-BGC102] { + background-color: #878787 +} + +div.highlight .-Color[class*=-C103] { + color: #8787AF +} + +div.highlight .-Color[class*=-BGC103] { + background-color: #8787AF +} + +div.highlight .-Color[class*=-C104] { + color: #8787D7 +} + +div.highlight .-Color[class*=-BGC104] { + background-color: #8787D7 +} + +div.highlight .-Color[class*=-C105] { + color: #8787FF +} + +div.highlight .-Color[class*=-BGC105] { + background-color: #8787FF +} + +div.highlight .-Color[class*=-C106] { + color: #87AF00 +} + +div.highlight .-Color[class*=-BGC106] { + background-color: #87AF00 +} + +div.highlight .-Color[class*=-C107] { + color: #87AF5F +} + +div.highlight .-Color[class*=-BGC107] { + background-color: #87AF5F +} + +div.highlight .-Color[class*=-C108] { + color: #87AF87 +} + +div.highlight .-Color[class*=-BGC108] { + background-color: #87AF87 +} + +div.highlight .-Color[class*=-C109] { + color: #87AFAF +} + +div.highlight .-Color[class*=-BGC109] { + background-color: #87AFAF +} + +div.highlight .-Color[class*=-C110] { + color: #87AFD7 +} + +div.highlight .-Color[class*=-BGC110] { + background-color: #87AFD7 +} + +div.highlight .-Color[class*=-C111] { + color: #87AFFF +} + +div.highlight .-Color[class*=-BGC111] { + background-color: #87AFFF +} + +div.highlight .-Color[class*=-C112] { + color: #87D700 +} + +div.highlight .-Color[class*=-BGC112] { + background-color: #87D700 +} + +div.highlight .-Color[class*=-C113] { + color: #87D75F +} + +div.highlight .-Color[class*=-BGC113] { + background-color: #87D75F +} + +div.highlight .-Color[class*=-C114] { + color: #87D787 +} + +div.highlight .-Color[class*=-BGC114] { + background-color: #87D787 +} + +div.highlight .-Color[class*=-C115] { + color: #87D7AF +} + +div.highlight .-Color[class*=-BGC115] { + background-color: #87D7AF +} + +div.highlight .-Color[class*=-C116] { + color: #87D7D7 +} + +div.highlight .-Color[class*=-BGC116] { + background-color: #87D7D7 +} + +div.highlight .-Color[class*=-C117] { + color: #87D7FF +} + +div.highlight .-Color[class*=-BGC117] { + background-color: #87D7FF +} + +div.highlight .-Color[class*=-C118] { + color: #87FF00 +} + +div.highlight .-Color[class*=-BGC118] { + background-color: #87FF00 +} + +div.highlight .-Color[class*=-C119] { + color: #87FF5F +} + +div.highlight .-Color[class*=-BGC119] { + background-color: #87FF5F +} + +div.highlight .-Color[class*=-C120] { + color: #87FF87 +} + +div.highlight .-Color[class*=-BGC120] { + background-color: #87FF87 +} + +div.highlight .-Color[class*=-C121] { + color: #87FFAF +} + +div.highlight .-Color[class*=-BGC121] { + background-color: #87FFAF +} + +div.highlight .-Color[class*=-C122] { + color: #87FFD7 +} + +div.highlight .-Color[class*=-BGC122] { + background-color: #87FFD7 +} + +div.highlight .-Color[class*=-C123] { + color: #87FFFF +} + +div.highlight .-Color[class*=-BGC123] { + background-color: #87FFFF +} + +div.highlight .-Color[class*=-C124] { + color: #AF0000 +} + +div.highlight .-Color[class*=-BGC124] { + background-color: #AF0000 +} + +div.highlight .-Color[class*=-C125] { + color: #AF005F +} + +div.highlight .-Color[class*=-BGC125] { + background-color: #AF005F +} + +div.highlight .-Color[class*=-C126] { + color: #AF0087 +} + +div.highlight .-Color[class*=-BGC126] { + background-color: #AF0087 +} + +div.highlight .-Color[class*=-C127] { + color: #AF00AF +} + +div.highlight .-Color[class*=-BGC127] { + background-color: #AF00AF +} + +div.highlight .-Color[class*=-C128] { + color: #AF00D7 +} + +div.highlight .-Color[class*=-BGC128] { + background-color: #AF00D7 +} + +div.highlight .-Color[class*=-C129] { + color: #AF00FF +} + +div.highlight .-Color[class*=-BGC129] { + background-color: #AF00FF +} + +div.highlight .-Color[class*=-C130] { + color: #AF5F00 +} + +div.highlight .-Color[class*=-BGC130] { + background-color: #AF5F00 +} + +div.highlight .-Color[class*=-C131] { + color: #AF5F5F +} + +div.highlight .-Color[class*=-BGC131] { + background-color: #AF5F5F +} + +div.highlight .-Color[class*=-C132] { + color: #AF5F87 +} + +div.highlight .-Color[class*=-BGC132] { + background-color: #AF5F87 +} + +div.highlight .-Color[class*=-C133] { + color: #AF5FAF +} + +div.highlight .-Color[class*=-BGC133] { + background-color: #AF5FAF +} + +div.highlight .-Color[class*=-C134] { + color: #AF5FD7 +} + +div.highlight .-Color[class*=-BGC134] { + background-color: #AF5FD7 +} + +div.highlight .-Color[class*=-C135] { + color: #AF5FFF +} + +div.highlight .-Color[class*=-BGC135] { + background-color: #AF5FFF +} + +div.highlight .-Color[class*=-C136] { + color: #AF8700 +} + +div.highlight .-Color[class*=-BGC136] { + background-color: #AF8700 +} + +div.highlight .-Color[class*=-C137] { + color: #AF875F +} + +div.highlight .-Color[class*=-BGC137] { + background-color: #AF875F +} + +div.highlight .-Color[class*=-C138] { + color: #AF8787 +} + +div.highlight .-Color[class*=-BGC138] { + background-color: #AF8787 +} + +div.highlight .-Color[class*=-C139] { + color: #AF87AF +} + +div.highlight .-Color[class*=-BGC139] { + background-color: #AF87AF +} + +div.highlight .-Color[class*=-C140] { + color: #AF87D7 +} + +div.highlight .-Color[class*=-BGC140] { + background-color: #AF87D7 +} + +div.highlight .-Color[class*=-C141] { + color: #AF87FF +} + +div.highlight .-Color[class*=-BGC141] { + background-color: #AF87FF +} + +div.highlight .-Color[class*=-C142] { + color: #AFAF00 +} + +div.highlight .-Color[class*=-BGC142] { + background-color: #AFAF00 +} + +div.highlight .-Color[class*=-C143] { + color: #AFAF5F +} + +div.highlight .-Color[class*=-BGC143] { + background-color: #AFAF5F +} + +div.highlight .-Color[class*=-C144] { + color: #AFAF87 +} + +div.highlight .-Color[class*=-BGC144] { + background-color: #AFAF87 +} + +div.highlight .-Color[class*=-C145] { + color: #AFAFAF +} + +div.highlight .-Color[class*=-BGC145] { + background-color: #AFAFAF +} + +div.highlight .-Color[class*=-C146] { + color: #AFAFD7 +} + +div.highlight .-Color[class*=-BGC146] { + background-color: #AFAFD7 +} + +div.highlight .-Color[class*=-C147] { + color: #AFAFFF +} + +div.highlight .-Color[class*=-BGC147] { + background-color: #AFAFFF +} + +div.highlight .-Color[class*=-C148] { + color: #AFD700 +} + +div.highlight .-Color[class*=-BGC148] { + background-color: #AFD700 +} + +div.highlight .-Color[class*=-C149] { + color: #AFD75F +} + +div.highlight .-Color[class*=-BGC149] { + background-color: #AFD75F +} + +div.highlight .-Color[class*=-C150] { + color: #AFD787 +} + +div.highlight .-Color[class*=-BGC150] { + background-color: #AFD787 +} + +div.highlight .-Color[class*=-C151] { + color: #AFD7AF +} + +div.highlight .-Color[class*=-BGC151] { + background-color: #AFD7AF +} + +div.highlight .-Color[class*=-C152] { + color: #AFD7D7 +} + +div.highlight .-Color[class*=-BGC152] { + background-color: #AFD7D7 +} + +div.highlight .-Color[class*=-C153] { + color: #AFD7FF +} + +div.highlight .-Color[class*=-BGC153] { + background-color: #AFD7FF +} + +div.highlight .-Color[class*=-C154] { + color: #AFFF00 +} + +div.highlight .-Color[class*=-BGC154] { + background-color: #AFFF00 +} + +div.highlight .-Color[class*=-C155] { + color: #AFFF5F +} + +div.highlight .-Color[class*=-BGC155] { + background-color: #AFFF5F +} + +div.highlight .-Color[class*=-C156] { + color: #AFFF87 +} + +div.highlight .-Color[class*=-BGC156] { + background-color: #AFFF87 +} + +div.highlight .-Color[class*=-C157] { + color: #AFFFAF +} + +div.highlight .-Color[class*=-BGC157] { + background-color: #AFFFAF +} + +div.highlight .-Color[class*=-C158] { + color: #AFFFD7 +} + +div.highlight .-Color[class*=-BGC158] { + background-color: #AFFFD7 +} + +div.highlight .-Color[class*=-C159] { + color: #AFFFFF +} + +div.highlight .-Color[class*=-BGC159] { + background-color: #AFFFFF +} + +div.highlight .-Color[class*=-C160] { + color: #D70000 +} + +div.highlight .-Color[class*=-BGC160] { + background-color: #D70000 +} + +div.highlight .-Color[class*=-C161] { + color: #D7005F +} + +div.highlight .-Color[class*=-BGC161] { + background-color: #D7005F +} + +div.highlight .-Color[class*=-C162] { + color: #D70087 +} + +div.highlight .-Color[class*=-BGC162] { + background-color: #D70087 +} + +div.highlight .-Color[class*=-C163] { + color: #D700AF +} + +div.highlight .-Color[class*=-BGC163] { + background-color: #D700AF +} + +div.highlight .-Color[class*=-C164] { + color: #D700D7 +} + +div.highlight .-Color[class*=-BGC164] { + background-color: #D700D7 +} + +div.highlight .-Color[class*=-C165] { + color: #D700FF +} + +div.highlight .-Color[class*=-BGC165] { + background-color: #D700FF +} + +div.highlight .-Color[class*=-C166] { + color: #D75F00 +} + +div.highlight .-Color[class*=-BGC166] { + background-color: #D75F00 +} + +div.highlight .-Color[class*=-C167] { + color: #D75F5F +} + +div.highlight .-Color[class*=-BGC167] { + background-color: #D75F5F +} + +div.highlight .-Color[class*=-C168] { + color: #D75F87 +} + +div.highlight .-Color[class*=-BGC168] { + background-color: #D75F87 +} + +div.highlight .-Color[class*=-C169] { + color: #D75FAF +} + +div.highlight .-Color[class*=-BGC169] { + background-color: #D75FAF +} + +div.highlight .-Color[class*=-C170] { + color: #D75FD7 +} + +div.highlight .-Color[class*=-BGC170] { + background-color: #D75FD7 +} + +div.highlight .-Color[class*=-C171] { + color: #D75FFF +} + +div.highlight .-Color[class*=-BGC171] { + background-color: #D75FFF +} + +div.highlight .-Color[class*=-C172] { + color: #D78700 +} + +div.highlight .-Color[class*=-BGC172] { + background-color: #D78700 +} + +div.highlight .-Color[class*=-C173] { + color: #D7875F +} + +div.highlight .-Color[class*=-BGC173] { + background-color: #D7875F +} + +div.highlight .-Color[class*=-C174] { + color: #D78787 +} + +div.highlight .-Color[class*=-BGC174] { + background-color: #D78787 +} + +div.highlight .-Color[class*=-C175] { + color: #D787AF +} + +div.highlight .-Color[class*=-BGC175] { + background-color: #D787AF +} + +div.highlight .-Color[class*=-C176] { + color: #D787D7 +} + +div.highlight .-Color[class*=-BGC176] { + background-color: #D787D7 +} + +div.highlight .-Color[class*=-C177] { + color: #D787FF +} + +div.highlight .-Color[class*=-BGC177] { + background-color: #D787FF +} + +div.highlight .-Color[class*=-C178] { + color: #D7AF00 +} + +div.highlight .-Color[class*=-BGC178] { + background-color: #D7AF00 +} + +div.highlight .-Color[class*=-C179] { + color: #D7AF5F +} + +div.highlight .-Color[class*=-BGC179] { + background-color: #D7AF5F +} + +div.highlight .-Color[class*=-C180] { + color: #D7AF87 +} + +div.highlight .-Color[class*=-BGC180] { + background-color: #D7AF87 +} + +div.highlight .-Color[class*=-C181] { + color: #D7AFAF +} + +div.highlight .-Color[class*=-BGC181] { + background-color: #D7AFAF +} + +div.highlight .-Color[class*=-C182] { + color: #D7AFD7 +} + +div.highlight .-Color[class*=-BGC182] { + background-color: #D7AFD7 +} + +div.highlight .-Color[class*=-C183] { + color: #D7AFFF +} + +div.highlight .-Color[class*=-BGC183] { + background-color: #D7AFFF +} + +div.highlight .-Color[class*=-C184] { + color: #D7D700 +} + +div.highlight .-Color[class*=-BGC184] { + background-color: #D7D700 +} + +div.highlight .-Color[class*=-C185] { + color: #D7D75F +} + +div.highlight .-Color[class*=-BGC185] { + background-color: #D7D75F +} + +div.highlight .-Color[class*=-C186] { + color: #D7D787 +} + +div.highlight .-Color[class*=-BGC186] { + background-color: #D7D787 +} + +div.highlight .-Color[class*=-C187] { + color: #D7D7AF +} + +div.highlight .-Color[class*=-BGC187] { + background-color: #D7D7AF +} + +div.highlight .-Color[class*=-C188] { + color: #D7D7D7 +} + +div.highlight .-Color[class*=-BGC188] { + background-color: #D7D7D7 +} + +div.highlight .-Color[class*=-C189] { + color: #D7D7FF +} + +div.highlight .-Color[class*=-BGC189] { + background-color: #D7D7FF +} + +div.highlight .-Color[class*=-C190] { + color: #D7FF00 +} + +div.highlight .-Color[class*=-BGC190] { + background-color: #D7FF00 +} + +div.highlight .-Color[class*=-C191] { + color: #D7FF5F +} + +div.highlight .-Color[class*=-BGC191] { + background-color: #D7FF5F +} + +div.highlight .-Color[class*=-C192] { + color: #D7FF87 +} + +div.highlight .-Color[class*=-BGC192] { + background-color: #D7FF87 +} + +div.highlight .-Color[class*=-C193] { + color: #D7FFAF +} + +div.highlight .-Color[class*=-BGC193] { + background-color: #D7FFAF +} + +div.highlight .-Color[class*=-C194] { + color: #D7FFD7 +} + +div.highlight .-Color[class*=-BGC194] { + background-color: #D7FFD7 +} + +div.highlight .-Color[class*=-C195] { + color: #D7FFFF +} + +div.highlight .-Color[class*=-BGC195] { + background-color: #D7FFFF +} + +div.highlight .-Color[class*=-C196] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC196] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C197] { + color: #FF005F +} + +div.highlight .-Color[class*=-BGC197] { + background-color: #FF005F +} + +div.highlight .-Color[class*=-C198] { + color: #FF0087 +} + +div.highlight .-Color[class*=-BGC198] { + background-color: #FF0087 +} + +div.highlight .-Color[class*=-C199] { + color: #FF00AF +} + +div.highlight .-Color[class*=-BGC199] { + background-color: #FF00AF +} + +div.highlight .-Color[class*=-C200] { + color: #FF00D7 +} + +div.highlight .-Color[class*=-BGC200] { + background-color: #FF00D7 +} + +div.highlight .-Color[class*=-C201] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC201] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C202] { + color: #FF5F00 +} + +div.highlight .-Color[class*=-BGC202] { + background-color: #FF5F00 +} + +div.highlight .-Color[class*=-C203] { + color: #FF5F5F +} + +div.highlight .-Color[class*=-BGC203] { + background-color: #FF5F5F +} + +div.highlight .-Color[class*=-C204] { + color: #FF5F87 +} + +div.highlight .-Color[class*=-BGC204] { + background-color: #FF5F87 +} + +div.highlight .-Color[class*=-C205] { + color: #FF5FAF +} + +div.highlight .-Color[class*=-BGC205] { + background-color: #FF5FAF +} + +div.highlight .-Color[class*=-C206] { + color: #FF5FD7 +} + +div.highlight .-Color[class*=-BGC206] { + background-color: #FF5FD7 +} + +div.highlight .-Color[class*=-C207] { + color: #FF5FFF +} + +div.highlight .-Color[class*=-BGC207] { + background-color: #FF5FFF +} + +div.highlight .-Color[class*=-C208] { + color: #FF8700 +} + +div.highlight .-Color[class*=-BGC208] { + background-color: #FF8700 +} + +div.highlight .-Color[class*=-C209] { + color: #FF875F +} + +div.highlight .-Color[class*=-BGC209] { + background-color: #FF875F +} + +div.highlight .-Color[class*=-C210] { + color: #FF8787 +} + +div.highlight .-Color[class*=-BGC210] { + background-color: #FF8787 +} + +div.highlight .-Color[class*=-C211] { + color: #FF87AF +} + +div.highlight .-Color[class*=-BGC211] { + background-color: #FF87AF +} + +div.highlight .-Color[class*=-C212] { + color: #FF87D7 +} + +div.highlight .-Color[class*=-BGC212] { + background-color: #FF87D7 +} + +div.highlight .-Color[class*=-C213] { + color: #FF87FF +} + +div.highlight .-Color[class*=-BGC213] { + background-color: #FF87FF +} + +div.highlight .-Color[class*=-C214] { + color: #FFAF00 +} + +div.highlight .-Color[class*=-BGC214] { + background-color: #FFAF00 +} + +div.highlight .-Color[class*=-C215] { + color: #FFAF5F +} + +div.highlight .-Color[class*=-BGC215] { + background-color: #FFAF5F +} + +div.highlight .-Color[class*=-C216] { + color: #FFAF87 +} + +div.highlight .-Color[class*=-BGC216] { + background-color: #FFAF87 +} + +div.highlight .-Color[class*=-C217] { + color: #FFAFAF +} + +div.highlight .-Color[class*=-BGC217] { + background-color: #FFAFAF +} + +div.highlight .-Color[class*=-C218] { + color: #FFAFD7 +} + +div.highlight .-Color[class*=-BGC218] { + background-color: #FFAFD7 +} + +div.highlight .-Color[class*=-C219] { + color: #FFAFFF +} + +div.highlight .-Color[class*=-BGC219] { + background-color: #FFAFFF +} + +div.highlight .-Color[class*=-C220] { + color: #FFD700 +} + +div.highlight .-Color[class*=-BGC220] { + background-color: #FFD700 +} + +div.highlight .-Color[class*=-C221] { + color: #FFD75F +} + +div.highlight .-Color[class*=-BGC221] { + background-color: #FFD75F +} + +div.highlight .-Color[class*=-C222] { + color: #FFD787 +} + +div.highlight .-Color[class*=-BGC222] { + background-color: #FFD787 +} + +div.highlight .-Color[class*=-C223] { + color: #FFD7AF +} + +div.highlight .-Color[class*=-BGC223] { + background-color: #FFD7AF +} + +div.highlight .-Color[class*=-C224] { + color: #FFD7D7 +} + +div.highlight .-Color[class*=-BGC224] { + background-color: #FFD7D7 +} + +div.highlight .-Color[class*=-C225] { + color: #FFD7FF +} + +div.highlight .-Color[class*=-BGC225] { + background-color: #FFD7FF +} + +div.highlight .-Color[class*=-C226] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC226] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C227] { + color: #FFFF5F +} + +div.highlight .-Color[class*=-BGC227] { + background-color: #FFFF5F +} + +div.highlight .-Color[class*=-C228] { + color: #FFFF87 +} + +div.highlight .-Color[class*=-BGC228] { + background-color: #FFFF87 +} + +div.highlight .-Color[class*=-C229] { + color: #FFFFAF +} + +div.highlight .-Color[class*=-BGC229] { + background-color: #FFFFAF +} + +div.highlight .-Color[class*=-C230] { + color: #FFFFD7 +} + +div.highlight .-Color[class*=-BGC230] { + background-color: #FFFFD7 +} + +div.highlight .-Color[class*=-C231] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC231] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C232] { + color: #080808 +} + +div.highlight .-Color[class*=-BGC232] { + background-color: #080808 +} + +div.highlight .-Color[class*=-C233] { + color: #121212 +} + +div.highlight .-Color[class*=-BGC233] { + background-color: #121212 +} + +div.highlight .-Color[class*=-C234] { + color: #1C1C1C +} + +div.highlight .-Color[class*=-BGC234] { + background-color: #1C1C1C +} + +div.highlight .-Color[class*=-C235] { + color: #262626 +} + +div.highlight .-Color[class*=-BGC235] { + background-color: #262626 +} + +div.highlight .-Color[class*=-C236] { + color: #303030 +} + +div.highlight .-Color[class*=-BGC236] { + background-color: #303030 +} + +div.highlight .-Color[class*=-C237] { + color: #3A3A3A +} + +div.highlight .-Color[class*=-BGC237] { + background-color: #3A3A3A +} + +div.highlight .-Color[class*=-C238] { + color: #444444 +} + +div.highlight .-Color[class*=-BGC238] { + background-color: #444444 +} + +div.highlight .-Color[class*=-C239] { + color: #4E4E4E +} + +div.highlight .-Color[class*=-BGC239] { + background-color: #4E4E4E +} + +div.highlight .-Color[class*=-C240] { + color: #585858 +} + +div.highlight .-Color[class*=-BGC240] { + background-color: #585858 +} + +div.highlight .-Color[class*=-C241] { + color: #626262 +} + +div.highlight .-Color[class*=-BGC241] { + background-color: #626262 +} + +div.highlight .-Color[class*=-C242] { + color: #6C6C6C +} + +div.highlight .-Color[class*=-BGC242] { + background-color: #6C6C6C +} + +div.highlight .-Color[class*=-C243] { + color: #767676 +} + +div.highlight .-Color[class*=-BGC243] { + background-color: #767676 +} + +div.highlight .-Color[class*=-C244] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC244] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C245] { + color: #8A8A8A +} + +div.highlight .-Color[class*=-BGC245] { + background-color: #8A8A8A +} + +div.highlight .-Color[class*=-C246] { + color: #949494 +} + +div.highlight .-Color[class*=-BGC246] { + background-color: #949494 +} + +div.highlight .-Color[class*=-C247] { + color: #9E9E9E +} + +div.highlight .-Color[class*=-BGC247] { + background-color: #9E9E9E +} + +div.highlight .-Color[class*=-C248] { + color: #A8A8A8 +} + +div.highlight .-Color[class*=-BGC248] { + background-color: #A8A8A8 +} + +div.highlight .-Color[class*=-C249] { + color: #B2B2B2 +} + +div.highlight .-Color[class*=-BGC249] { + background-color: #B2B2B2 +} + +div.highlight .-Color[class*=-C250] { + color: #BCBCBC +} + +div.highlight .-Color[class*=-BGC250] { + background-color: #BCBCBC +} + +div.highlight .-Color[class*=-C251] { + color: #C6C6C6 +} + +div.highlight .-Color[class*=-BGC251] { + background-color: #C6C6C6 +} + +div.highlight .-Color[class*=-C252] { + color: #D0D0D0 +} + +div.highlight .-Color[class*=-BGC252] { + background-color: #D0D0D0 +} + +div.highlight .-Color[class*=-C253] { + color: #DADADA +} + +div.highlight .-Color[class*=-BGC253] { + background-color: #DADADA +} + +div.highlight .-Color[class*=-C254] { + color: #E4E4E4 +} + +div.highlight .-Color[class*=-BGC254] { + background-color: #E4E4E4 +} + +div.highlight .-Color[class*=-C255] { + color: #EEEEEE +} + +div.highlight .-Color[class*=-BGC255] { + background-color: #EEEEEE +} diff --git a/branch/main/_static/plus.png b/branch/main/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/branch/main/_static/plus.png differ diff --git a/branch/main/_static/pygments.css b/branch/main/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/branch/main/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/branch/main/_static/searchtools.js b/branch/main/_static/searchtools.js new file mode 100644 index 00000000..7918c3fa --- /dev/null +++ b/branch/main/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/branch/main/_static/sphinx_highlight.js b/branch/main/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/branch/main/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.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: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/branch/main/_static/sphinx_lesson.css b/branch/main/_static/sphinx_lesson.css new file mode 100644 index 00000000..14b20c64 --- /dev/null +++ b/branch/main/_static/sphinx_lesson.css @@ -0,0 +1,51 @@ +/* sphinx_lesson.css */ + +body.wy-body-for-nav img.with-border { + border: 2px solid; +} + +.rst-content .admonition-no-content { + padding-bottom: 0px; +} + +.rst-content .demo > .admonition-title::before { + content: "\01F440"; /* Eyes */ } +.rst-content .type-along > .admonition-title::before { + content: "\02328\0FE0F"; /* Keyboard */ } +.rst-content .exercise > .admonition-title::before { + content: "\0270D\0FE0F"; /* Hand */ } +.rst-content .solution > .admonition-title::before { + content: "\02714\0FE0E"; /* Check mark */ } +.rst-content .homework > .admonition-title::before { + content: "\01F4DD"; /* Memo */ } +.rst-content .discussion > .admonition-title::before { + content: "\01F4AC"; /* Speech balloon */ } +.rst-content .questions > .admonition-title::before { + content: "\02753\0FE0E"; /* Question mark */ } +.rst-content .prerequisites > .admonition-title::before { + content: "\02699"; /* Gear */ } +.rst-content .seealso > .admonition-title::before { + content: "\027A1\0FE0E"; /* Question mark */ } + + +/* instructor-note */ +.rst-content .instructor-note { + background: #e7e7e7; +} +.rst-content .instructor-note > .admonition-title { + background: #6a6a6a; +} +.rst-content .instructor-note > .admonition-title::before { + content: ""; +} + + +/* sphinx_toggle_button, make the font white */ +.rst-content .toggle.admonition button.toggle-button { + color: white; +} + +/* sphinx-togglebutton, remove underflow when toggled to hidden mode */ +.rst-content .admonition.toggle-hidden { + padding-bottom: 0px; +} diff --git a/branch/main/_static/sphinx_rtd_theme_ext_color_contrast.css b/branch/main/_static/sphinx_rtd_theme_ext_color_contrast.css new file mode 100644 index 00000000..e68feb82 --- /dev/null +++ b/branch/main/_static/sphinx_rtd_theme_ext_color_contrast.css @@ -0,0 +1,47 @@ +/* The following are for web accessibility of sphinx_rtd_theme: they + * solve some of the most frequent contrast issues. Remove when this + * solved: + * https://github.com/readthedocs/sphinx_rtd_theme/issues/971 + */ +/* background: #fcfcfc, note boxes #E7F2FA */ +a { color: #2573A7; } /* original #2980B9, #1F5C84; */ +body { color: #242424; } /* original #404040, #383838 */ +.wy-side-nav-search>a, .wy-side-nav-search .wy-dropdown>a { + color: #ffffff; +} /* original #fcfcfc */ +footer { color: #737373; } /* original gray=#808080*/ +footer span.commit code, footer span.commit .rst-content tt, .rst-content footer span.commit tt { + color: #737373; +} /* original gray=#808080*/ +.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { + color: #AB2314; +} +/* Sidebar background */ +.wy-side-nav-search { background-color: #277CB4;} + +/* Same, but for pygments */ +.highlight .ch { color: #3E7A89; } /* #! line */ +.highlight .c1 { color: #3E7A89; } /* also comments */ +.highlight .nv { color: #AD3ECC; } /* variable */ +.highlight .gp { color: #B45608; } /* prompt character, $*/ +.highlight .si { color: #3975B1; } /* ${} variable text */ +.highlight .nc { color: #0C78A7; } + +/* Sphinx admonitions */ +/* warning */ +.wy-alert.wy-alert-warning .wy-alert-title, .rst-content .wy-alert-warning.note .wy-alert-title, .rst-content .attention .wy-alert-title, .rst-content .caution .wy-alert-title, .rst-content .wy-alert-warning.danger .wy-alert-title, .rst-content .wy-alert-warning.error .wy-alert-title, .rst-content .wy-alert-warning.hint .wy-alert-title, .rst-content .wy-alert-warning.important .wy-alert-title, .rst-content .wy-alert-warning.tip .wy-alert-title, .rst-content .warning .wy-alert-title, .rst-content .wy-alert-warning.seealso .wy-alert-title, .rst-content .admonition-todo .wy-alert-title, .rst-content .wy-alert-warning.admonition .wy-alert-title, .wy-alert.wy-alert-warning .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-warning .admonition-title, .rst-content .wy-alert-warning.note .admonition-title, .rst-content .attention .admonition-title, .rst-content .caution .admonition-title, .rst-content .wy-alert-warning.danger .admonition-title, .rst-content .wy-alert-warning.error .admonition-title, .rst-content .wy-alert-warning.hint .admonition-title, .rst-content .wy-alert-warning.important .admonition-title, .rst-content .wy-alert-warning.tip .admonition-title, .rst-content .warning .admonition-title, .rst-content .wy-alert-warning.seealso .admonition-title, .rst-content .admonition-todo .admonition-title, .rst-content .wy-alert-warning.admonition .admonition-title { + background: #B15E16; } +/* important */ +.wy-alert.wy-alert-success .wy-alert-title, .rst-content .wy-alert-success.note .wy-alert-title, .rst-content .wy-alert-success.attention .wy-alert-title, .rst-content .wy-alert-success.caution .wy-alert-title, .rst-content .wy-alert-success.danger .wy-alert-title, .rst-content .wy-alert-success.error .wy-alert-title, .rst-content .hint .wy-alert-title, .rst-content .important .wy-alert-title, .rst-content .tip .wy-alert-title, .rst-content .wy-alert-success.warning .wy-alert-title, .rst-content .wy-alert-success.seealso .wy-alert-title, .rst-content .wy-alert-success.admonition-todo .wy-alert-title, .rst-content .wy-alert-success.admonition .wy-alert-title, .wy-alert.wy-alert-success .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-success .admonition-title, .rst-content .wy-alert-success.note .admonition-title, .rst-content .wy-alert-success.attention .admonition-title, .rst-content .wy-alert-success.caution .admonition-title, .rst-content .wy-alert-success.danger .admonition-title, .rst-content .wy-alert-success.error .admonition-title, .rst-content .hint .admonition-title, .rst-content .important .admonition-title, .rst-content .tip .admonition-title, .rst-content .wy-alert-success.warning .admonition-title, .rst-content .wy-alert-success.seealso .admonition-title, .rst-content .wy-alert-success.admonition-todo .admonition-title, .rst-content .wy-alert-success.admonition .admonition-title { + background: #12826C; } +/* seealso, note, etc */ +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition .admonition-title { + background: #277CB4; } +/* error, danger */ +.rst-content .danger .admonition-title, .rst-content .danger .wy-alert-title, .rst-content .error .admonition-title, .rst-content .error .wy-alert-title, .rst-content .wy-alert-danger.admonition-todo .admonition-title, .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, .rst-content .wy-alert-danger.admonition .admonition-title, .rst-content .wy-alert-danger.admonition .wy-alert-title, .rst-content .wy-alert-danger.attention .admonition-title, .rst-content .wy-alert-danger.attention .wy-alert-title, .rst-content .wy-alert-danger.caution .admonition-title, .rst-content .wy-alert-danger.caution .wy-alert-title, .rst-content .wy-alert-danger.hint .admonition-title, .rst-content .wy-alert-danger.hint .wy-alert-title, .rst-content .wy-alert-danger.important .admonition-title, .rst-content .wy-alert-danger.important .wy-alert-title, .rst-content .wy-alert-danger.note .admonition-title, .rst-content .wy-alert-danger.note .wy-alert-title, .rst-content .wy-alert-danger.seealso .admonition-title, .rst-content .wy-alert-danger.seealso .wy-alert-title, .rst-content .wy-alert-danger.tip .admonition-title, .rst-content .wy-alert-danger.tip .wy-alert-title, .rst-content .wy-alert-danger.warning .admonition-title, .rst-content .wy-alert-danger.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-danger .admonition-title, .wy-alert.wy-alert-danger .rst-content .admonition-title, .wy-alert.wy-alert-danger .wy-alert-title { + background: #e31704; +} + +/* Generic admonition titles */ +.wy-alert-title, .rst-content .admonition-title { + background: #277CB4; } diff --git a/branch/main/_static/tabs.css b/branch/main/_static/tabs.css new file mode 100644 index 00000000..957ba60d --- /dev/null +++ b/branch/main/_static/tabs.css @@ -0,0 +1,89 @@ +.sphinx-tabs { + margin-bottom: 1rem; +} + +[role="tablist"] { + border-bottom: 1px solid #a0b3bf; +} + +.sphinx-tabs-tab { + position: relative; + font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif; + color: #1D5C87; + line-height: 24px; + margin: 0; + font-size: 16px; + font-weight: 400; + background-color: rgba(255, 255, 255, 0); + border-radius: 5px 5px 0 0; + border: 0; + padding: 1rem 1.5rem; + margin-bottom: 0; +} + +.sphinx-tabs-tab[aria-selected="true"] { + font-weight: 700; + border: 1px solid #a0b3bf; + border-bottom: 1px solid white; + margin: -1px; + background-color: white; +} + +.sphinx-tabs-tab:focus { + z-index: 1; + outline-offset: 1px; +} + +.sphinx-tabs-panel { + position: relative; + padding: 1rem; + border: 1px solid #a0b3bf; + margin: 0px -1px -1px -1px; + border-radius: 0 0 5px 5px; + border-top: 0; + background: white; +} + +.sphinx-tabs-panel.code-tab { + padding: 0.4rem; +} + +.sphinx-tab img { + margin-bottom: 24 px; +} + +/* Dark theme preference styling */ + +@media (prefers-color-scheme: dark) { + body[data-theme="auto"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); + } + + body[data-theme="auto"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); + } + + body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 1px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); + } +} + +/* Explicit dark theme styling */ + +body[data-theme="dark"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); +} + +body[data-theme="dark"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); +} + +body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 2px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); +} diff --git a/branch/main/_static/tabs.js b/branch/main/_static/tabs.js new file mode 100644 index 00000000..48dc303c --- /dev/null +++ b/branch/main/_static/tabs.js @@ -0,0 +1,145 @@ +try { + var session = window.sessionStorage || {}; +} catch (e) { + var session = {}; +} + +window.addEventListener("DOMContentLoaded", () => { + const allTabs = document.querySelectorAll('.sphinx-tabs-tab'); + const tabLists = document.querySelectorAll('[role="tablist"]'); + + allTabs.forEach(tab => { + tab.addEventListener("click", changeTabs); + }); + + tabLists.forEach(tabList => { + tabList.addEventListener("keydown", keyTabs); + }); + + // Restore group tab selection from session + const lastSelected = session.getItem('sphinx-tabs-last-selected'); + if (lastSelected != null) selectNamedTabs(lastSelected); +}); + +/** + * Key focus left and right between sibling elements using arrows + * @param {Node} e the element in focus when key was pressed + */ +function keyTabs(e) { + const tab = e.target; + let nextTab = null; + if (e.keyCode === 39 || e.keyCode === 37) { + tab.setAttribute("tabindex", -1); + // Move right + if (e.keyCode === 39) { + nextTab = tab.nextElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.firstElementChild; + } + // Move left + } else if (e.keyCode === 37) { + nextTab = tab.previousElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.lastElementChild; + } + } + } + + if (nextTab !== null) { + nextTab.setAttribute("tabindex", 0); + nextTab.focus(); + } +} + +/** + * Select or deselect clicked tab. If a group tab + * is selected, also select tab in other tabLists. + * @param {Node} e the element that was clicked + */ +function changeTabs(e) { + // Use this instead of the element that was clicked, in case it's a child + const notSelected = this.getAttribute("aria-selected") === "false"; + const positionBefore = this.parentNode.getBoundingClientRect().top; + const notClosable = !this.parentNode.classList.contains("closeable"); + + deselectTabList(this); + + if (notSelected || notClosable) { + selectTab(this); + const name = this.getAttribute("name"); + selectNamedTabs(name, this.id); + + if (this.classList.contains("group-tab")) { + // Persist during session + session.setItem('sphinx-tabs-last-selected', name); + } + } + + const positionAfter = this.parentNode.getBoundingClientRect().top; + const positionDelta = positionAfter - positionBefore; + // Scroll to offset content resizing + window.scrollTo(0, window.scrollY + positionDelta); +} + +/** + * Select tab and show associated panel. + * @param {Node} tab tab to select + */ +function selectTab(tab) { + tab.setAttribute("aria-selected", true); + + // Show the associated panel + document + .getElementById(tab.getAttribute("aria-controls")) + .removeAttribute("hidden"); +} + +/** + * Hide the panels associated with all tabs within the + * tablist containing this tab. + * @param {Node} tab a tab within the tablist to deselect + */ +function deselectTabList(tab) { + const parent = tab.parentNode; + const grandparent = parent.parentNode; + + Array.from(parent.children) + .forEach(t => t.setAttribute("aria-selected", false)); + + Array.from(grandparent.children) + .slice(1) // Skip tablist + .forEach(panel => panel.setAttribute("hidden", true)); +} + +/** + * Select grouped tabs with the same name, but no the tab + * with the given id. + * @param {Node} name name of grouped tab to be selected + * @param {Node} clickedId id of clicked tab + */ +function selectNamedTabs(name, clickedId=null) { + const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`); + const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode); + + tabLists + .forEach(tabList => { + // Don't want to change the tabList containing the clicked tab + const clickedTab = tabList.querySelector(`[id="${clickedId}"]`); + if (clickedTab === null ) { + // Select first tab with matching name + const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`); + deselectTabList(tab); + selectTab(tab); + } + }) +} + +if (typeof exports === 'undefined') { + exports = {}; +} + +exports.keyTabs = keyTabs; +exports.changeTabs = changeTabs; +exports.selectTab = selectTab; +exports.deselectTabList = deselectTabList; +exports.selectNamedTabs = selectNamedTabs; diff --git a/branch/main/_static/term_role_formatting.css b/branch/main/_static/term_role_formatting.css new file mode 100644 index 00000000..0b66095c --- /dev/null +++ b/branch/main/_static/term_role_formatting.css @@ -0,0 +1,4 @@ +/* Make terms bold */ +a.reference span.std-term { + font-weight: bold; +} diff --git a/branch/main/_static/togglebutton.css b/branch/main/_static/togglebutton.css new file mode 100644 index 00000000..54a67879 --- /dev/null +++ b/branch/main/_static/togglebutton.css @@ -0,0 +1,160 @@ +/** + * Admonition-based toggles + */ + +/* Visibility of the target */ +.admonition.toggle .admonition-title ~ * { + transition: opacity .3s, height .3s; +} + +/* Toggle buttons inside admonitions so we see the title */ +.admonition.toggle { + position: relative; +} + +/* Titles should cut off earlier to avoid overlapping w/ button */ +.admonition.toggle .admonition-title { + padding-right: 25%; + cursor: pointer; +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:hover { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 1%); +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:active { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 3%); +} + +/* Remove extra whitespace below the admonition title when hidden */ +.admonition.toggle-hidden { + padding-bottom: 0; +} + +.admonition.toggle-hidden .admonition-title { + margin-bottom: 0; +} + +/* hides all the content of a page until de-toggled */ +.admonition.toggle-hidden .admonition-title ~ * { + height: 0; + margin: 0; + opacity: 0; + visibility: hidden; +} + +/* General button style and position*/ +button.toggle-button { + /** + * Background and shape. By default there's no background + * but users can style as they wish + */ + background: none; + border: none; + outline: none; + + /* Positioning just inside the admonition title */ + position: absolute; + right: 0.5em; + padding: 0px; + border: none; + outline: none; +} + +/* Display the toggle hint on wide screens */ +@media (min-width: 768px) { + button.toggle-button.toggle-button-hidden:before { + content: attr(data-toggle-hint); /* This will be filled in by JS */ + font-size: .8em; + align-self: center; + } +} + +/* Icon behavior */ +.tb-icon { + transition: transform .2s ease-out; + height: 1.5em; + width: 1.5em; + stroke: currentColor; /* So that we inherit the color of other text */ +} + +/* The icon should point right when closed, down when open. */ +/* Open */ +.admonition.toggle button .tb-icon { + transform: rotate(90deg); +} + +/* Closed */ +.admonition.toggle button.toggle-button-hidden .tb-icon { + transform: rotate(0deg); +} + +/* With details toggles, we don't rotate the icon so it points right */ +details.toggle-details .tb-icon { + height: 1.4em; + width: 1.4em; + margin-top: 0.1em; /* To center the button vertically */ +} + + +/** + * Details-based toggles. + * In this case, we wrap elements with `.toggle` in a details block. + */ + +/* Details blocks */ +details.toggle-details { + margin: 1em 0; +} + + +details.toggle-details summary { + display: flex; + align-items: center; + cursor: pointer; + list-style: none; + border-radius: .2em; + border-left: 3px solid #1976d2; + background-color: rgb(204 204 204 / 10%); + padding: 0.2em 0.7em 0.3em 0.5em; /* Less padding on left because the SVG has left margin */ + font-size: 0.9em; +} + +details.toggle-details summary:hover { + background-color: rgb(204 204 204 / 20%); +} + +details.toggle-details summary:active { + background: rgb(204 204 204 / 28%); +} + +.toggle-details__summary-text { + margin-left: 0.2em; +} + +details.toggle-details[open] summary { + margin-bottom: .5em; +} + +details.toggle-details[open] summary .tb-icon { + transform: rotate(90deg); +} + +details.toggle-details[open] summary ~ * { + animation: toggle-fade-in .3s ease-out; +} + +@keyframes toggle-fade-in { + from {opacity: 0%;} + to {opacity: 100%;} +} + +/* Print rules - we hide all toggle button elements at print */ +@media print { + /* Always hide the summary so the button doesn't show up */ + details.toggle-details summary { + display: none; + } +} \ No newline at end of file diff --git a/branch/main/_static/togglebutton.js b/branch/main/_static/togglebutton.js new file mode 100644 index 00000000..215a7eef --- /dev/null +++ b/branch/main/_static/togglebutton.js @@ -0,0 +1,187 @@ +/** + * Add Toggle Buttons to elements + */ + +let toggleChevron = ` + + + +`; + +var initToggleItems = () => { + var itemsToToggle = document.querySelectorAll(togglebuttonSelector); + console.log(`[togglebutton]: Adding toggle buttons to ${itemsToToggle.length} items`) + // Add the button to each admonition and hook up a callback to toggle visibility + itemsToToggle.forEach((item, index) => { + if (item.classList.contains("admonition")) { + // If it's an admonition block, then we'll add a button inside + // Generate unique IDs for this item + var toggleID = `toggle-${index}`; + var buttonID = `button-${toggleID}`; + + item.setAttribute('id', toggleID); + if (!item.classList.contains("toggle")){ + item.classList.add("toggle"); + } + // This is the button that will be added to each item to trigger the toggle + var collapseButton = ` + `; + + title = item.querySelector(".admonition-title") + title.insertAdjacentHTML("beforeend", collapseButton); + thisButton = document.getElementById(buttonID); + + // Add click handlers for the button + admonition title (if admonition) + admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`) + if (admonitionTitle) { + // If an admonition, then make the whole title block clickable + admonitionTitle.addEventListener('click', toggleClickHandler); + admonitionTitle.dataset.target = toggleID + admonitionTitle.dataset.button = buttonID + } else { + // If not an admonition then we'll listen for the button click + thisButton.addEventListener('click', toggleClickHandler); + } + + // Now hide the item for this toggle button unless explicitly noted to show + if (!item.classList.contains("toggle-shown")) { + toggleHidden(thisButton); + } + } else { + // If not an admonition, wrap the block in a
block + // Define the structure of the details block and insert it as a sibling + var detailsBlock = ` +
+ + ${toggleChevron} + ${toggleHintShow} + +
`; + item.insertAdjacentHTML("beforebegin", detailsBlock); + + // Now move the toggle-able content inside of the details block + details = item.previousElementSibling + details.appendChild(item) + item.classList.add("toggle-details__container") + + // Set up a click trigger to change the text as needed + details.addEventListener('click', (click) => { + let parent = click.target.parentElement; + if (parent.tagName.toLowerCase() == "details") { + summary = parent.querySelector("summary"); + details = parent; + } else { + summary = parent; + details = parent.parentElement; + } + // Update the inner text for the proper hint + if (details.open) { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintShow; + } else { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintHide; + } + + }); + + // If we have a toggle-shown class, open details block should be open + if (item.classList.contains("toggle-shown")) { + details.click(); + } + } + }) +}; + +// This should simply add / remove the collapsed class and change the button text +var toggleHidden = (button) => { + target = button.dataset['target'] + var itemToToggle = document.getElementById(target); + if (itemToToggle.classList.contains("toggle-hidden")) { + itemToToggle.classList.remove("toggle-hidden"); + button.classList.remove("toggle-button-hidden"); + } else { + itemToToggle.classList.add("toggle-hidden"); + button.classList.add("toggle-button-hidden"); + } +} + +var toggleClickHandler = (click) => { + // Be cause the admonition title is clickable and extends to the whole admonition + // We only look for a click event on this title to trigger the toggle. + + if (click.target.classList.contains("admonition-title")) { + button = click.target.querySelector(".toggle-button"); + } else if (click.target.classList.contains("tb-icon")) { + // We've clicked the icon and need to search up one parent for the button + button = click.target.parentElement; + } else if (click.target.tagName == "polyline") { + // We've clicked the SVG elements inside the button, need to up 2 layers + button = click.target.parentElement.parentElement; + } else if (click.target.classList.contains("toggle-button")) { + // We've clicked the button itself and so don't need to do anything + button = click.target; + } else { + console.log(`[togglebutton]: Couldn't find button for ${click.target}`) + } + target = document.getElementById(button.dataset['button']); + toggleHidden(target); +} + +// If we want to blanket-add toggle classes to certain cells +var addToggleToSelector = () => { + const selector = ""; + if (selector.length > 0) { + document.querySelectorAll(selector).forEach((item) => { + item.classList.add("toggle"); + }) + } +} + +// Helper function to run when the DOM is finished +const sphinxToggleRunWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} +sphinxToggleRunWhenDOMLoaded(addToggleToSelector) +sphinxToggleRunWhenDOMLoaded(initToggleItems) + +/** Toggle details blocks to be open when printing */ +if (toggleOpenOnPrint == "true") { + window.addEventListener("beforeprint", () => { + // Open the details + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.dataset["togglestatus"] = el.open; + el.open = true; + }); + + // Open the admonitions + document.querySelectorAll(".admonition.toggle.toggle-hidden").forEach((el) => { + console.log(el); + el.querySelector("button.toggle-button").click(); + el.dataset["toggle_after_print"] = "true"; + }); + }); + window.addEventListener("afterprint", () => { + // Re-close the details that were closed + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.open = el.dataset["togglestatus"] == "true"; + delete el.dataset["togglestatus"]; + }); + + // Re-close the admonition toggle buttons + document.querySelectorAll(".admonition.toggle").forEach((el) => { + if (el.dataset["toggle_after_print"] == "true") { + el.querySelector("button.toggle-button").click(); + delete el.dataset["toggle_after_print"]; + } + }); + }); +} diff --git a/branch/main/aliases/index.html b/branch/main/aliases/index.html new file mode 100644 index 00000000..6213cc4b --- /dev/null +++ b/branch/main/aliases/index.html @@ -0,0 +1,337 @@ + + + + + + + Aliases and configuration — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Aliases and configuration

+
+

Objectives

+
    +

  • Learn to use aliases for most common commands.

    • +
+
+

Are you getting tired of typing so much? In Git you can define aliases (shortcuts):

+
    +

  • These are great because they can save you time typing.

    • +

  • But it’s easy to forget them, get confused, or be inconsistent with your colleagues.

    • +
+

There is plenty of other configuration for Git, that can make it nicer.

+
+

Aliases

+
    +

  • Aliases offer a way to improve the usability of Git: for +example git ci instead of git commit.

    • +

  • Aliases are based on simple string replacement in the command.

    • +

  • Aliases can either be specific to a repository or global.

    +
      +

    • Global aliases help you do the things you are used to across Git projects.

      • +

    • Per-project aliases can also be created.

      • +
    +
    • +

  • Global aliases are stored in ~/.gitconfig.

    • +
+
+
+

Example alias: git graph

+

A very useful shortcut which we use a lot in our workshops:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ cd your_git_repository
+$ git graph
+
+
+
+
+

Using external commands

+

It is possible to call external commands using the exclamation mark character “!”. +In this example here we create a local alias which is +stored in .git/config and not synchronized with remotes:

+
$ cd your_git_repository
+$ git config alias.hi '!echo hello'
+$ git hi
+
+
+
+

Food for thought: When to alias?

+
    +

  • How many times should you wait before aliasing a command?

    • +

  • Do you believe a list of generic two-letter acronyms for common commands will +save your time?

    • +
+
+
+
+

List of aliases the instructors use

+

You are welcome to reuse, suggest, improve. +You can see your current aliases in ~/.gitconfig.

+
$ git config --global alias.ap "add --patch"
+$ git config --global alias.br branch
+$ git config --global alias.ci "commit -v"
+$ git config --global alias.cip "commit --patch -v"
+$ git config --global alias.cl "clone --recursive"
+$ git config --global alias.di diff
+$ git config --global alias.dic "diff --staged --color-words"
+$ git config --global alias.diw "diff --color-words"
+$ git config --global alias.dis "!git --no-pager diff --stat"
+$ git config --global alias.fe fetch
+$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ git config --global alias.rem remote
+$ git config --global alias.st status
+$ git config --global alias.su "submodule update --init --recursive"
+
+
+

Here is what they do:

+
    +

  • ap: add, selecting parts individually, interactively.

    • +

  • br: branch (obvious)

    • +

  • ci: commit (check in), with -v option for clarity

    • +

  • cip: commit, selecting parts individually, interactively.

    • +

  • cl: clone, init submodules (submodules are an advanced topic)

    • +

  • di: diff (obvious)

    • +

  • dic: diff of staging area vs last commit (what is about to be committed)

    • +

  • diw: a word diff, color. Useful for small changes.

    • +

  • dis: a “diffstat”: what files are changed, not contents

    • +

  • fe: fetch (obvious)

    • +

  • graph: show whole git graph (so useful, some of us call it l)

    • +

  • rem: remote (obvious)

    • +

  • st: status (obvious)

    • +

  • su: submodule update (advanced)

    • +
+

A useful setting for the p aliases:

+
$ git config --global interactive.singlekey true
+
+
+
+
+

Advanced aliases

+

These are advanced aliases and configuration options. We won’t explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages!

+
$ git config --global alias.cif "commit -v -p --fixup"
+$ git config --global alias.rb "rebase --autosquash"
+$ git config --global alias.rbi "rebase --interactive --autosquash"
+$ git config --global alias.rbis "rebase --interactive --autosquash --autostash"
+$ git config --global alias.rbs "rebase --autosquash --autostash"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard"
+$ git config --global alias.new "log HEAD..HEAD@{upstream}"
+$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}"
+$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}"
+$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all"
+$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD"
+$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat"
+
+
+
+
+

Advanced Git configuration

+

Besides aliases, you can do plenty of other configuration of git. +Here are some of the most common ones:

+
$ git config --global interactive.singlekey true
+$ git config --global core.pager "less -RS"
+$ git config --global core.excludesfile ~/.gitignore
+$ git config --global merge.conflictstyle diff3
+$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]"
+$ git config --global diff.mnemonicPrefix true
+
+
+

Do you get tired of typing and copying and pasting your remote names +all the time, like git@github.com:myusername? You can create remote +aliases like this:

+
$ git config --global url.git@github.com:.insteadOf gh:
+$ git config --global url.git@github.com:/username/.insteadOf ghu:
+
+
+

Then, when you add a remote ghu:recipe, it will automatically be +translated to git@github.com:/username/recipe using a simple prefix +matching.

+
+

Keypoints

+
    +

  • If you are frustrated about remembering a command, you should create an alias.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/archaeology/index.html b/branch/main/archaeology/index.html new file mode 100644 index 00000000..1855a63a --- /dev/null +++ b/branch/main/archaeology/index.html @@ -0,0 +1,595 @@ + + + + + + + Inspecting history — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Inspecting history

+
+

Objectives

+
    +

  • Be able find a line of code, find out why it was introduced and when.

    • +

  • Be able to quickly find the commit that changed a behavior.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Command line, GitHub, and VS Code

+

As usual, we offer ways to do this with the command line, VS Code, and +GitHub.

+
    +

  • Command line is most powerful and relatively easy with this. +You may also use it along with other things. If you haven’t tried +it yet, we’d recommend you to give it a try.

    • +

  • The GitHub web interface allows many things to be done, but not +everything.

    • +

  • VS Code allows some of these, but for some it’s easier to open +the VS Code terminal and run git there.

    • +
+
+
+

Our toolbox for history inspection

+
+

Instructor note

+

First the instructor demonstrates few commands on a real life example +repository https://github.com/networkx/networkx (mentioned in the amazing site The +Programming Historian). +Later we will practice these in an archaeology exercise (below).

+
+
+

Warm-up: “Git History” browser

+

As a warm-up we can try the “Git History” browser +on the README.rst file of the networkx repository:

+ +
+
+

Searching text patterns in the repository

+

With git grep you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or +some error message printed.

+
+

The Git command is as described above:

+
$ git grep TEXT
+$ git grep "some text with spaces"
+
+
+

In the networkx repository you can try:

+
$ git clone https://github.com/networkx/networkx
+$ cd networkx
+$ git grep -i fixme
+
+
+

While git grep searches the current state of the repository, +it is also possible to search through all changes with git log -S sometext +which can be useful to find where something got removed.

+
+
+
+

Inspecting individual commits

+
+

We have seen this one before already. Using git show we can inspect an individual commit if +we know its hash:

+
$ git show HASH
+
+
+

For instance:

+
$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7
+
+
+
+
+
+

Line-by-line code annotation with metadata

+

With git annotate you can see line by line who and when the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility.

+
+
$ git annotate FILE
+
+
+

Example:

+
$ git annotate networkx/convert_matrix.py
+
+
+

If you annotate in a terminal and the file is longer than the screen, Git by default uses the program less to +scroll the output. +Use /sometext <ENTER> to find “sometext” and you can cycle through the results with n (next) and N (last). +You can also use page up/down to scroll. You can quit with q.

+
+
+

Discussion

+

Discuss how these relatively trivial changes affect the annotation:

+
    +

  • Wrapping long lines of text/code into shorter lines

    • +

  • Auto-formatting tools such as black

    • +

  • Editors that automatically remove trailing whitespace

    • +
+
+
+
+

Inspecting code in the past

+
+

We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code:

+
$ git switch --create BRANCHNAME HASH
+
+
+

Example (lines starting with “#” are only comments):

+
$ # create branch called "older-code" from hash 347e6292419b
+$ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9
+
+$ # now you can navigate and inspect the code as it was back then
+$ # ...
+
+$ # after we are done we can switch back to "main"
+$ git switch main
+
+$ # if we like we can delete the "older-code" branch
+$ git branch -d older-code
+
+
+

On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

+
$ git checkout -b BRANCHNAME SOMEHASH
+
+
+
+
+
+
+

Exercise

+

This is described with the command line method, but by looking above +you can translate to the other options.

+
+

Exercise: Explore basic archaeology commands (20 min)

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Make sure you are not inside another Git repository when running this +exercise. If you are, first step “outside” of it. +We want to avoid creating a Git repository inside another Git repository.

    +
    +

    You can check if you are inside a Git repository with:

    +
    $ git status
+
+fatal: not a git repository (or any of the parent directories): .git
+
    +
    +

    You want to see the above message which tells us that this is not a Git repository.

    +
    +
    • +

  • Clone this repository: +https://github.com/networkx/networkx.git.

    +
    +
    $ git clone https://github.com/networkx/networkx.git
+
    +
    +
    +
    • +

  • Then let us all make sure we are working on a well-defined version of the repository.

    +
    +

    Step into the new directory and create an exercise branch from the +networkx-2.6.3 tag/release:

    +
    $ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+
+
+
+

Finding out when something broke/changed with git bisect

+

This only works with the command line.

+
+

“But I am sure it used to work! Strange.”

+
+

Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke.

+
+

How would you solve this?

+

Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now.

+
    +

  • How would you find the commit which changed it?

    • +

  • Why could it be useful to know the commit that changed it?

    • +
+
+

We will probably arrive at a solution which is similar to git bisect:

+
    +

  • First find out a commit in past when it worked.

    +
    $ git bisect start
+$ git bisect good f0ea950  # this is a commit that worked
+$ git bisect bad main      # last commit is broken
+
    +
    +
    • +

  • Now compile and/or run and/or test and decide whether “good” or “bad”.

    • +

  • This is how you can tell Git that this was a working commit:

    +
    $ git bisect good
+
    +
    +
    • +

  • And this is how you can tell Git that this was not a working commit:

    +
    $ git bisect bad
+
    +
    +
    • +

  • Then bisect/iterate your way until you find the commit that broke it.

    • +

  • If you want to go back to start, type git bisect reset.

    • +

  • This can even be automatized with git bisect run SCRIPT. +For this you write a script that returns zero/non-zero (success/failure).

    • +
+
+
+

Optional exercise: Git bisect

+

This only works with the command line.

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+
+

Summary

+
    +

  • git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project on the command line.

    • +

  • git switch --create NAME HASH is the recommended mechanism to inspect old code on the command line.

    • +

  • Most of these commands can be used in the GitHub web interface (except git bisect).

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/basics/index.html b/branch/main/basics/index.html new file mode 100644 index 00000000..e0659e5e --- /dev/null +++ b/branch/main/basics/index.html @@ -0,0 +1,837 @@ + + + + + + + Basics — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Basics

+
+

Objectives

+
    +

  • Learn to create Git repositories and make commits.

    • +

  • Get a grasp of the structure of a repository.

    • +

  • Learn how to inspect the project history.

    • +

  • Learn how to write useful commit log messages.

    • +
+
+
+

Instructor note

+
    +

  • 35 min teaching/type-along

    • +

  • 40 min exercise

    • +
+
+
+

What is Git, and what is a Git repository?

+
    +

  • Git is a version control system: can record/save snapshots and track the content of a folder as it changes over time.

    • +

  • Every time we commit a snapshot, Git records a snapshot of the entire project, saves it, and assigns it a version.

    • +

  • These snapshots are kept inside a sub-folder called .git.

    • +

  • If we remove .git, we remove the repository and history (but keep the working directory!).

    • +

  • The directory .git uses relative paths - you can move the whole repository somewhere else and it will still work.

    • +

  • Git doesn’t do anything unless you ask it to (it does not record anything automatically).

    • +

  • Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces).

    • +
+
+
+

Recording a snapshot with Git

+
    +

  • Git takes snapshots only if we request it.

    • +

  • We will record changes in two steps (we will later explain why this is a recommended practice).

    • +

  • Example (we don’t need to type yet):

    +
    $ git add FILE.txt
+$ git commit
+
+$ git add FILE.txt ANOTHERFILE.txt
+$ git commit
+
    +
    +
    • +

  • We first focus (git add, we “stage” the change), then record (git commit):

    • +
+
+Git staging +
+

Git staging and committing.

+
+
+
+

Question for the more advanced participants

+

What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end.

+
+
+
+

Configuring Git command line

+

Before we start using Git on the command line, we need to configure Git. +This is also part of the +installation instructions +but we need to make sure we all have +set name, email address, editor, and +default branch:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+$ git config --global core.editor nano
+$ git config --global init.defaultBranch main
+
+
+

Verify with:

+
$ git config --list
+
+
+
+

Instructor note

+

Instructors, give learners enough time to do the above configuration steps.

+
+
+
+

Type-along: Tracking a guacamole recipe with Git

+

We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list)

+

The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language.

+
+

Instructor note

+

Instructors, please encourage now that participants type along.

+
+
+

Note

+

It is possible to go through this lesson in the command line or in the browser +(on GitHub).

+
    +

  • We recommend to start with the command line but later to also try in the browser.

    • +

  • If you get really stuck in the command line, try following in the browser and +later you can try to return to the command line.

    • +
+
+
+
+

Creating a repository

+

One of the basic principles of Git is that it is easy to create repositories:

+
+
$ mkdir recipe
+$ cd recipe
+$ git init -b main
+
+
+

That’s it! With git init -b main have now created an empty Git repository +where main is the default branch (more about branches later).

+

We will use git status a lot to check out what is going on:

+
$ git status
+
+On branch main
+
+No commits yet
+
+nothing to commit (create/copy files and use "git add" to track)
+
+
+

We will make sense of this information during this workshop.

+
+
+
+

Adding files and committing changes

+

Let us now create two files.

+

One file is called ingredients.txt and contains:

+
* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+
+
+

The second file is called instructions.txt and contains:

+
* chop avocados
+* chop onion
+* chop chili
+* squeeze lime
+* add salt
+* and mix well
+
+
+
+

As mentioned above, in Git you can always check the status of files in your repository using +git status. It is always a safe command to run and in general a good idea to +do when you are trying to figure out what to do next:

+
$ git status
+
+On branch main
+
+No commits yet
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    ingredients.txt
+    instructions.txt
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+

The two files are untracked in the repository (directory). You want to add the files (focus the camera) +to the list of files tracked by Git. Git does not track +any files automatically and you need make a conscious decision to add a file. Let’s do what +Git hints at, and add the files, one by one:

+
$ git add ingredients.txt
+$ git status
+
+On branch main
+
+No commits yet
+
+Changes to be committed:
+  (use "git rm --cached <file>..." to unstage)
+    new file:   ingredients.txt
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    instructions.txt
+
+
+

Now this change is staged and ready to be committed. +Let us now commit the change to the repository:

+
$ git commit -m "adding ingredients"
+
+[main (root-commit) f146d25] adding ingredients
+ 1 file changed, 4 insertions(+)
+ create mode 100644 ingredients.txt
+
+
+

Right after we query the status to get this useful command into our muscle memory:

+
$ git status
+
+
+

Now stage and commit also the other file:

+
$ git add instructions.txt
+$ git commit -m "adding instructions"
+
+
+

We will add a third file to the repository, README.md, containing:

+
# recipe
+
+This is an exercise repository.
+
+
+

Now stage and commit also the README.md file:

+
$ git add README.md
+$ git commit -m "adding README"
+
+
+

What does the -m flag mean? Let us check the help page for that command:

+
$ git help commit
+
+
+

You should see a very long help page as the tool is very versatile (press q to quit). +Do not worry about this now but keep in mind that you can always read the help files +when in doubt. Searching online can also be useful, but choosing search terms +to find relevant information takes some practice and discussions in some +online threads may be confusing. +Note that help pages also work when you don’t have a network connection!

+
+
+
+

Exercise: Record changes

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+
+
+

Git history and log

+
+

If you haven’t yet, please try now git log:

+
$ git log
+
+commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main)
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:47 2023 +0200
+
+    don't forget to enjoy
+
+commit 79161b6e67c62ad4688a58c1e54183334611a390
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:32 2023 +0200
+
+    add half an onion
+
+commit a3394e39535343c4dae3bb4f703741a31aa8b78a
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:47:14 2023 +0200
+
+    adding README
+
+commit 369624674e63de48055a65bf63055bd59c985d22
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:46:58 2023 +0200
+
+    adding instructions
+
+commit f146d25b94569a15e94d7f0da6f15d7554f76c49
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:35:52 2023 +0200
+
+    adding ingredients
+
+
+
+
    +

  • We can browse the development and access each state that we have committed.

    • +

  • The long hashes uniquely label a state of the code.

    • +

  • They are not just integers counting 1, 2, 3, 4, … (why?).

    • +

  • Output is in reverse chronological order, i.e. newest commits on top.

    • +

  • We will use them when comparing versions and when going back in time.

    • +

  • git log --oneline only shows the first 7 characters of the commit hash and is good to get an overview.

    • +

  • If the first characters of the hash are unique it is not necessary to type the entire hash.

    • +

  • git log --stat is nice to show which files have been modified.

    • +
+
+
+

Optional exercises: Comparing changes

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+
+
+

Writing useful commit messages

+

Using git log --oneline or browsing a repository on the web, we better +understand that the first line of the commit message is very important.

+

Good example:

+
increase threshold alpha to 2.0
+
+the motivation for this change is
+to enable ...
+...
+this is based on a discussion in #123
+
+
+

Convention: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

Ignoring files and paths with .gitignore

+
+

Discussion

+
    +

  • Should we add and track all files in a project?

    • +

  • How about generated files?

    • +

  • Why is it considered a bad idea to commit compiled binaries to version control?

    • +

  • What types of generated files do you know?

    • +
+
+

Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files. Example:

+
# ignore compiled python 2 files
+*.pyc
+# ignore compiled python 3 files
+__pycache__
+
+
+

An example taken from the official Git documentation:

+
# ignore objects and archives, anywhere in the tree.
+*.[oa]
+# ignore generated html files,
+*.html
+# except foo.html which is maintained by hand
+!foo.html
+# ignore everything under build directory
+build/
+
+
+
    +

  • .gitignore should be part of the repository because we want to make sure that all developers see the same behavior.

    • +

  • All files should be either tracked or ignored.

    • +

  • .gitignore uses something called a +shell glob syntax for +determining file patterns to ignore. You can read more about the syntax in the +documentation.

    • +

  • You can have .gitignore files in lower level directories and they affect the paths below.

    • +
+
+
+

Graphical user interfaces

+

We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI):

+ +
+
+

Summary

+

Now we know how to save snapshots:

+
$ git add FILE(S)
+$ git commit
+
+
+

And this is what we do as we program.

+

Every state is then saved and later we will learn how to go back to these “checkpoints” +and how to undo things.

+
$ git init -b main  # initialize new repository (main is default branch)
+$ git add           # add files or stage file(s)
+$ git commit        # commit staged file(s)
+$ git status        # see what is going on
+$ git log           # see history
+$ git diff          # show unstaged/uncommitted modifications
+$ git show          # show the change for a specific commit
+$ git mv            # move/rename tracked files
+$ git rm            # remove tracked files
+
+
+

Git is not ideal for large binary files +(for this consider git-annex).

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • It takes only one command to initialize a Git repository: git init -b main.

    • +

  • Commits should be used to tell a story.

    • +

  • Git uses the .git folder to store the snapshots.

    • +

  • Don’t be afraid to stage and commit often. Better too often than not often enough.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/branches/index.html b/branch/main/branches/index.html new file mode 100644 index 00000000..1d6d27f6 --- /dev/null +++ b/branch/main/branches/index.html @@ -0,0 +1,758 @@ + + + + + + + Branching and merging — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Branching and merging

+
+

Objectives

+
    +

  • Be able to create and merge branches.

    • +

  • Know the difference between a branch and a tag.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Motivation for branches

+

In the previous section we tracked a guacamole recipe with Git.

+

Up until now our repository had only one branch with one commit coming +after the other:

+
+Linear Git repository +
+

Linear Git repository.

+
+
+
    +

  • Commits are depicted here as little boxes with abbreviated hashes.

    • +

  • Here the branch main points to a commit.

    • +

  • “HEAD” is the current position (remember the recording head of tape +recorders?). When we say HEAD, we mean those literal letters - +this isn’t a placeholder for something else.

    • +

  • When we talk about branches, we often mean all parent commits, not only the commit pointed to.

    • +
+

Now we want to do this:

+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+

Software development is often not linear:

+
    +

  • We typically need at least one version of the code to “work” (to compile, to give expected results, …).

    • +

  • At the same time we work on new features, often several features concurrently. +Often they are unfinished.

    • +

  • We need to be able to separate different lines of work really well.

    • +
+

The strength of version control is that it permits the researcher to isolate +different tracks of work, which can later be merged to create a composite +version that contains all changes:

+
+Isolated tracks of work +
+

Isolated tracks of work.

+
+
+
    +

  • We see branching points and merging points.

    • +

  • Main line development is often called main or master.

    • +

  • Other than this convention there is nothing special about main or master, it is a branch like any other.

    • +

  • Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow).

    • +
+

A group of commits that create a single narrative are called a branch. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. “fast sequence extraction” or “Python interface” or “fixing bug in +matrix inversion algorithm”.

+
+

An important alias

+

We will now define an alias in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). This is extensively used in the rest of this +and other lessons:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+
+
+

Instructor note

+

Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative.

+
+

Let us inspect the project history using the git graph alias:

+
$ git graph
+
+* e7cf023 (HEAD -> main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • We have a couple commits and only +one development line (branch) and this branch is called main.

    • +

  • Commits are states characterized by a 40-character hash (checksum).

    • +

  • git graph print abbreviations of these checksums.

    • +

  • Branches are pointers that point to a commit.

    • +

  • Branch main points to a commit (in this example it is e7cf023efe382340e5284c278c6ae2c087dd3ff7 but on your computer +the hash will be different).

    • +

  • HEAD is another pointer, it points to where we are right now (currently main)

    • +
+

In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards.

+
+
+

Creating and working with branches

+
+

Instructor note

+

We do the following part together. Encourage participants to type along.

+
+
+

It is possible to create and merge branches directly on GitHub

+
    +

  • However, we do not have screenshots for that in this episode

    • +

  • But if you prefer to work in the browser, please try it

    • +

  • Please contribute screenshots to this lesson

    • +
+
+

Let’s create a branch called experiment where we add cilantro to ingredients.txt +(text after “#” are comments and not part of the command).

+
$ git branch experiment main  # creates branch "experiment" from "main"
+$ git switch experiment       # switch to branch "experiment"
+$ git branch                  # list all local branches and show on which branch we are
+
+
+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+
    +

  • Verify that you are on the experiment branch (note that git graph also +makes it clear what branch you are on: HEAD -> branchname):

    +
    $ git branch
+
+* experiment
+  main
+
    +
    +

    This command shows where we are, it does not create a branch.

    +
    • +

  • Then add 2 tbsp cilantro on top of the ingredients.txt:

    +
    * 2 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+* 1/2 onion
+
    +
    +
    • +

  • Stage this and commit it with the message “let us try with some cilantro”.

    • +

  • Then reduce the amount of cilantro to 1 tbsp, stage and commit again with “maybe little bit less cilantro”.

    • +
+

We have created two new commits:

+
$ git graph
+
+* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro
+* f6ec7b7 let us try with some cilantro
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • The branch experiment is two commits ahead of main.

    • +

  • We commit our changes to this branch.

    • +
+
+
+

Exercise: Create and commit to branches

+
+

Branch-1: Create and commit to branches

+

In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging. The goal of the exercise is to end up with 3 branches.

+
    +

  • Change to the branch main.

    • +

  • Create another branch called less-salt.

    +
      +

    • Note! makes sure you are on main branch when you create the less-salt branch.

      • +

    • A safer way would be to explicitly mention to create from the main branch +as shown below:

      +
      $ git branch less-salt main
+
      +
      +
      • +
    +
    • +

  • Switch to the less-salt branch.

    • +

  • On the less-salt branch reduce the amount of salt.

    • +

  • Commit your changes to the less-salt branch.

    • +
+

Use the same commands as we used above.

+

We now have three branches (in this case HEAD points to less-salt):

+
$ git branch
+
+  experiment
+* less-salt
+  main
+
+$ git graph
+
+* bf28166 (HEAD -> less-salt) reduce amount of salt
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Here is a graphical representation of what we have created:

+
+../_images/git-branch-2.svg
+
    +

  • Now switch to main.

    • +

  • In a new commit, improve the README.md file (we added the word “Guacamole”):

    +
    # Guacamole recipe
+
+This is an exercise repository.
+
    +
    +
    • +
+

Now you should have this situation:

+
$ git graph
+
+* b4af65b (HEAD -> main) improve the documentation
+| * bf28166 (less-salt) reduce amount of salt
+|/
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
+../_images/git-branch-3.svg
+

And for comparison this is how it looks on GitHub.

+
+
+
+

Exercise: Merging branches

+

It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge experiment into main.

+
+

Branch-2: Merge branches

+

Merge experiment and less-salt back into main following the lesson below +until the point where we start deleting branches.

+
+
+

If you got stuck in the above exercises or joined later

+

If you got stuck in the above exercises or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git switch experiment
+$ git switch less-salt
+$ git switch main
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

First we make sure we are on the branch we wish to merge into:

+
$ git branch
+
+  experiment
+  less-salt
+* main
+
+
+

Then we merge experiment into main:

+
$ git merge experiment
+
+
+
+../_images/git-merge-1.svg
+

We can verify the result:

+
$ git graph
+
+*   81fcc0c (HEAD -> main) Merge branch 'experiment'
+|\
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+* | b4af65b improve the documentation
+|/
+| * bf28166 (less-salt) reduce amount of salt
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents.

+

To view the branches that are merged into the current branch we can use the command:

+
$ git branch --merged
+
+  experiment
+* main
+
+
+

We are also happy with the work on the less-salt branch. Let us merge that +one, too, into main:

+
$ git branch  # make sure you are on main
+$ git merge less-salt
+
+
+
+Commit graph after merge
+

Commit graph after merge.

+
+
+

We can verify the result in the terminal:

+
$ git graph
+
+*   4e03d4b (HEAD -> main) Merge branch 'less-salt'
+|\
+| * bf28166 (less-salt) reduce amount of salt
+* |   81fcc0c Merge branch 'experiment'
+|\ \
+| * | bcb8b78 (experiment) maybe little bit less cilantro
+| * | f6ec7b7 let us try with some cilantro
+| |/
+* / b4af65b improve the documentation
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Observe how Git nicely merged the changed amount of salt and the new ingredient in the same file +without us merging it manually:

+
$ cat ingredients.txt
+
+* 1 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually settle merge conflicts (we will do that later).

+
+
+

Deleting branches safely

+

Both feature branches are merged:

+
$ git branch --merged
+
+  experiment
+  less-salt
+* main
+
+
+

This means we can delete the branches:

+
$ git branch -d experiment
+$ git branch -d less-salt
+
+
+

This is the result:

+
+Commit graph after merged branches were deleted
+

Commit graph after merged branches were deleted.

+
+
+

We observe that when deleting branches, +only the pointers (“sticky notes”) disappeared, not the commits.

+

Git will not let you delete a branch which has not been reintegrated unless you +insist using git branch -D. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them.

+
+
+

Optional exercises with branches

+

The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section.

+
+

(optional) Branch-3: Perform a fast-forward merge

+
    +

  1. Create a new branch from main and switch to it.

    2. +

  2. Create a couple of commits on the new branch (for instance edit README.md):

    +
    +../_images/git-pre-ff.svg
    +
    3. +

  3. Now switch to main.

    4. +

  4. Merge the new branch to main.

    5. +

  5. Examine the result with git graph.

    6. +

  6. Have you expected the result? Discuss what you see.

    7. +
+ +
+
+

(optional) Branch-4: Rebase a branch (instead of merge)

+

As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

+
    +

  1. Create a new branch, and make a couple of commits on it.

    2. +

  2. Switch back to main, and make a couple of commits on it.

    3. +

  3. Inspect the situation with git graph.

    4. +

  4. Now rebase the new branch on top of main by first switching to the new branch, and then git rebase main.

    5. +

  5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

    6. +
+ +
+
+
+

Tags

+
    +

  • A tag is a pointer to a commit but in contrast to a branch it does not ever +move when creating new commits later.

    • +

  • It can be useful to think of branches as sticky notes and of tags as +commemorative plaques.

    • +

  • We use tags to record particular states or milestones of a project at a given +point in time, like for instance versions (have a look at semantic versioning, +v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a).

    • +

  • There are two basic types of tags: annotated and lightweight.

    • +

  • Use annotated tags since they contain the author and can be cryptographically signed using +GPG, timestamped, and a message attached.

    • +
+

Let’s add an annotated tag to our current state of the guacamole recipe:

+
$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet"
+
+
+

As you may have found out already, git show is a very versatile command. Try this:

+
$ git show nobel-2023
+
+
+

For more information about tags see for example +the Pro Git book chapter on the +subject.

+
+
+
+

Summary

+

Let us pause for a moment and recapitulate what we have just learned:

+
$ git branch               # see where we are
+$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+$ git merge NAME           # merge branch NAME (to current branch)
+$ git branch -d NAME       # delete branch NAME
+$ git branch -D NAME       # delete unmerged branch NAME
+
+
+

Since the following command combo is so frequent:

+
$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+
+
+

There is a shortcut for it:

+
$ git switch --create NAME  # create branch NAME and switch to it
+
+
+
+

Typical workflows

+

With this there are two typical workflows:

+
$ git switch --create new-feature  # create branch, switch to it
+$ git commit                       # work, work, work, ..., and test
+$ git switch main                  # once feature is ready, switch to main
+$ git merge new-feature            # merge work to main
+$ git branch -d new-feature        # remove branch
+
+
+

Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging:

+
$ git switch --create wild-idea    # create branch, switch to it, work, work, work ...
+$ git switch main                  # realize it was a bad idea, back to main
+$ git branch -D wild-idea          # it is gone, off to a new idea
+
+
+
+
+

Branch-5: Test your understanding

+

Which of the following combos (one or more) creates a new branch and makes a commit to it?

+
    +
  1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    2. +
  2. $ git add file.txt
+$ git branch new-branch
+$ git switch new-branch
+$ git commit
+
    +
    +
    3. +
  3. $ git switch --create new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    4. +
  4. $ git switch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • A branch is a division unit of work, to be merged with other units of work.

    • +

  • A tag is a pointer to a moment in the history of a project.

    • +
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/browsing/index.html b/branch/main/browsing/index.html new file mode 100644 index 00000000..ebd9421f --- /dev/null +++ b/branch/main/browsing/index.html @@ -0,0 +1,515 @@ + + + + + + + Copy and browse an existing project — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Copy and browse an existing project

+

In this episode, we will look at an existing repository to +understand how all the pieces work together. Along the way, we will make a copy +(a fork) of the repository for us, which will be used for our +own changes in the next episode.

+
    +

  • We used to start by directly going and creating a repository from scratch. This +was abstract and hard to understand.

    • +

  • Instead, we’ll show you all the cool stuff in a Git repository +first, and then start adding files.

    • +

  • We use an example recipe book we created just for this course.

    • +

  • By the end of the course, you’ll know how to contribute your own +recipes to it.

    • +
+
+

Objectives

+
    +

  • See a real Git repository and understand what is inside of it.

    • +

  • Understand how version control allows advanced inspection of a +repository.

    • +

  • See how Git allows multiple people to collaborate easily.

    • +

  • See the big picture instead of remembering a bunch of commands.

    • +
+
+
+

GitHub, VS Code, Command line, and more

+

We offer three different paths of how to do this exercise:

+
    +

  • GitHub (this is the one we will demonstrate on day 1)

    • +

  • VS Code (if you prefer to follow along using an editor; we will +do this on day 2)

    • +

  • Command line (for people comfortable with the command line; you +will see more of this on day 2)

    • +
+

In the future we’ll add more paths, for example Jupyter and RStudio +(contributions welcome!).

+
+
+

Creating a copy of the repository by “forking”

+

A repository is a collection of files in one directory tracked +by git. A GitHub repository is GitHub’s copy, which adds +things like access control. Each GitHub repository is owned by a user +or organization, who controls what is in it.

+

First, we need to make our own copy of the exercise repository. This will +become important later, when we make our own changes.

+
    +

  1. Go to the repository view on GitHub:

    + +
    2. +

  2. First, on GitHub, click the button that says “Fork”. It is towards +the top-right of the screen:

    +
    +Screenshot on GitHub before clicking on "Fork" +
    +
    3. +

  3. You should shortly be redirected to your copy of the repository +YOUR_USER_NAME/recipe-book.

    4. +
+

At all times you should be aware of if you looking at your repository +or the CodeRefinery upstream repository.

+
    +

  • Your repository: https://github.com/USERNAME/recipe-book

    • +

  • CodeRefinery upstream repository: https://github.com/coderefinery/recipe-book

    • +
+
+

You only need to open your own view, as described above. The browser +URL should look like https://github.com/USER/recipe-book, where +USER is your GitHub username.

+
+
+
+

Exercise

+

Work on this by yourself or in your team.

+
+

Instructor note

+

Before starting the exercise session:

+
    +

  • Make sure you have shown how to fork the repository to own account +(above).

    • +
+
+
+

Exercise: Browsing an existing project (25 min)

+

Browse the recipe-book project (introduced above) and explore commits and branches. Take notes +and prepare questions. The hints are for the GitHub path in the +browser.

+
    +

  1. Browse the commit history: Are commit messages understandable? +(Hint: “Commit history”, the timeline symbol, above the file list)

    2. +

  2. Compare the commit history with the network graph (“Insights” -> “Network”). Can you find the branches?

    3. +

  3. How can you find out when a recipe was last modified?

    4. +

  4. How many changes did the Guacamole recipe receive (you find it under “sides”)? +Try to click on some of the commits to see what changed. +(Hint: “History” in the view of a single file)

    5. +

  5. Which recipes include the ingredient “salt”? +(Hint: the GitHub search. From the repository view, it should offer +the filter “repo:USER/recipe-book” by default. What if you +add a search term?)

    6. +

  6. In the Guacamole recipe, find out who modified each line last and when +(click on file, then click “Blame” button). Find out who added the cilantro +and in which commit. +(Hint: “Blame” view in the file view)

    7. +

  7. Can you use these recipes yourself? Are you allowed to share +modifications? +(Hint: look for a license file)

    8. +

  8. Browse issues and pull requests in the upstream repository (the +repository you forked from). Any idea what these might be good for? +(Hint: tabs in the repository view)

    9. +
+
+

The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren’t enough - this is by +design.

+
+
+

Solution and walk-through

+
+

(1) Basic browsing

+

The most basic thing to look at is the history of commits.

+
    +

  • This is visible from a button in the repository view. We see every +change, when, and who has committed.

    • +

  • Every change has a unique identifier, such as 554c187. This can +be used to identify both this change, and the whole project’s +version as of that change.

    • +

  • Clicking on a change in the view shows more.

    • +
+
+

Click on the timeline symbol in the repository view:

+
+Screenshot on GitHub of where to find the commit history +
+
+
+
+

(2) Compare commit history with network graph

+

The commit history we saw above looks linear: one commit after +another. But if we look at the network view, we see some branches and +merges. We’ll see how to do these later. This is another one of the +basic Git views.

+
+

In a new browser tab, open the “Insights” tab, and click on “Network”. +You can hover over the commit dots to see the person who committed and +how they correspond with the commits in the other view:

+
+Screenshot on GitHub of the network graph +
+
+
+
+

(3) When was a recipe last modified?

+

We see the history for the whole repository, but we can also see it +for a single file.

+
+

Navigate to the file view: Main page → sides directory → +guacamole.md. Click the “History” button near the top right:

+
+Screenshot on GitHub showing the history of a single file +
+
+
+
+

(4) How many changes did the Guacamole recipe receive?

+

According to the view above, it seems to have five changes (as of +2024-03-07). This could change later on.

+
+
+

(5) Which recipes include the ingredient “salt”

+

Version control makes it very easy to find all occurrences of a single +word. This is useful for things like finding where functions or +variables are defined or used.

+
+

We go to the main recipe book view. We click the Search magnifying +class at the very top, type “salt”, and click enter. We see every +instance, including the context.

+
+

Searching in a forked repository will not work instantaneously!

+

It usually takes a few minutes before one can search for keywords in a forked repository +since it first needs to build the search index the very first time we search. +Start it, continue with other steps, then come back to this.

+
+
+Screenshot on GitHub performing a search +
+
+
+
+

(6) Who modified each line last and when?

+

This is called the “annotate” or “blame” view. The name “blame” +is very unfortunate, but it is the standard term for historical reasons +for this functionality and it is not meant to blame anyone.

+
+

From a recipe view, change preview to “Blame” towards the top-left. +To get the actual commit, click on the commit message.

+
+Screenshot on GitHub showing the "Blame" view +
+
+
+
+

(7) Can you use these recipes yourself? Are you allowed to share modifications?

+
    +

  • Look at the file LICENSE.

    • +

  • It says it is “Creative Commons Zero 1.0”, which is equivalent to +public domain. You can use them without conditions.

    • +

  • Note the GitHub view of the file LICENSE gives a nice summary of what it +means. Try it out:

    +
    +Screenshot on GitHub summarizing license terms +
    +
    • +
+
+
+

(8) Browse issues and pull requests in the upstream repository

+

This can only be done through the GitHub view. Go to the main +repository coderefinery/recipe-book, (not your fork): +https://github.com/coderefinery/recipe-book. Issues +and Pull requests are different for each GitHub +copy.

+
    +

  • Click on the “Issues” tab. These are notes that people have added, +which allow discussion about the project. Often they are used to communicate +problems or ideas.

    • +

  • Click on the “Pull requests” tab. This allows anyone to propose +changes, but only the repository owners can accept.

    • +
+
+
+
+

Summary

+
    +

  • Git allowed us to understand this simple project much better than we +could, if it was just a few files on our own computer.

    • +

  • It was also very easy to share the project with the course.

    • +

  • By forking the repository, we created our own copy. This is +important for the next episode, where we will make changes to +our copy.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/commits/index.html b/branch/main/commits/index.html new file mode 100644 index 00000000..1f0a6126 --- /dev/null +++ b/branch/main/commits/index.html @@ -0,0 +1,550 @@ + + + + + + + Committing changes — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Committing changes

+

The first and most basic task to do in Git is record changes using +commits. In this part, we will record changes in two +ways: on a new branch (which supports multiple lines of work at once), and directly +on the “main” branch (which happens to be the default branch here).

+
+

Objectives

+
    +

  • Record new changes to our own copy of the project.

    • +

  • Understand adding changes in two separate branches.

    • +

  • See how to compare different versions.

    • +
+
+
+

Background

+
    +

  • In the previous episode we have browsed an existing repository and saw commits +and branches.

    • +

  • Each commit is a snapshot of the entire project at a certain +point in time and has a unique identifier (hash) .

    • +

  • A branch is a line of development, and the main branch or master branch +are often the default branch in Git.

    • +

  • A branch in Git is like a sticky note that is attached to a commit. When we add +new commits to a branch, the sticky note moves to the new commit.

    • +

  • Tags are a way to mark a specific commit as important, for example a release +version. They are also like a sticky note, but they don’t move when new +commits are added.

    • +
+
+Branching explained with a gopher +
+

What if two people, at the same time, make two different changes? Git +can merge them together easily. Image created using https://gopherize.me/ +(inspiration).

+
+
+
+
+

Exercise

+

We offer three different paths of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the GitHub +path only and recommend you do that. (You can get experience with +the other paths on day 2)

+
+

Exercise: Practice creating commits and branches (20 min)

+
    +

  1. Make sure that you now work on your fork of the recipe-book +repository (USER/recipe-book, not coderefinery/recipe-book)

    2. +

  2. First create a new branch and then add a recipe to the branch and commit the change.

    3. +

  3. In a new commit, modify the recipe you just added.

    4. +

  4. Switch to the main branch and modify a recipe there.

    5. +

  5. Browse the network and locate the commits that you just created (“Insights” -> “Network”).

    6. +

  6. Compare the branch that you created with the main branch. Can you find an easy way to see the differences?

    7. +

  7. Can you find a way to compare versions between two arbitrary commits in the repository?

    8. +

  8. Try to rename the branch that you created and then browse the network again.

    9. +

  9. Try to create a tag for one of the commits that you created (on GitHub, +create a “release”).

    10. +
+
+

The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren’t enough - this is by +design.

+
+
+

Solution and walk-through

+
+

(1) Make sure you are on your fork

+
+Screenshot on GitHub where we verify that we are on our fork. +
+

You want to see your username in the URL and you want to see the “forked from +…” part.

+
+
+
+
+

(2) Create a branch and add a recipe to the branch

+

A recipe template is below. This format is called “Markdown”, but it +doesn’t matter right now. You don’t have to use this particular template.

+
# Recipe name
+
+## Ingredients
+
+- Ingredient 1
+- Ingredient 2
+
+
+## Instructions
+
+- Step 1
+- Step 2
+
+
+

There is a main branch that is default. We want to create a +different branch for our new commit, because we will merge it later. +Commit is the verb to describe recording more changes, and also the +name of the thing you make. A commit is identified by something such as +554c187.

+
+
    +

  1. Where it says “main” at the top left, click, enter a new branch +name new-recipe, click on the offer to create the new branch +(“Create branch new-recipe from main”).

    +
    +Screenshot on GitHub where we create a new branch. +
    +
    2. +

  2. Change to some sub-directory, for example sides

    3. +

  3. Make sure you are still on the new-recipe branch (it should say +it at the top), and click “Add file” → “Create new file” from the +upper right.

    4. +

  4. Enter a filename where it says “Name your file…”, with a .md at +the end. Example: mixed-nuts.md.

    5. +

  5. Enter the recipe. You can use the template above.

    6. +

  6. Click “Commit changes”

    7. +

  7. Enter a commit message. Then click “Commit +changes”.

    8. +
+

You should appear back at the file browser view, and see your new +recipe there.

+
+
+
+

(3) Modify the recipe with a new commit

+
+

This is similar to before, but we click on the existing file to +modify.

+
    +

  1. Click on your new recipe, for example mixed-nuts.md.

    2. +

  2. Click the edit button, the pencil icon at top-right.

    3. +

  3. Follow the “Commit changes” instructions as in the previous step.

    4. +
+
+
+
+

(4) Switch to the main branch and modify a recipe there

+
+
    +

  1. Go back to the main repository page (your user’s page).

    2. +

  2. In the branch switch view (top left above the file view), switch to +main.

    3. +

  3. Modify another recipe that already exists, following the pattern +from above. Don’t modify the one you just created (but it shouldn’t +even be visible on the main branch).

    4. +
+
+
+
+

(5) Browse the commits you just made

+

Let’s look at what we did. Now, the main and new-recipe branches +have diverged: both have some modifications. Try to find the commits +you created.

+
+

Insights tab → Network view (just like we have done before).

+
+
+
+

(6) Compare the branches

+

Comparing changes is an important thing we need to do. When using the +GitHub view only, this may not be so common, but we’ll show it so that +it makes sense later on.

+
+

Next to the branch name switcher, click on “Branches” to get an overview.

+

Another way to compare branches or commits on GitHub is to adjust the following URL: +https://github.com/USER/recipe-book/compare/VERSION1..VERSION2

+

Replace USER with your username and VERSION1 and VERSION2 with a commit hash or branch name. +Please try it out.

+
+
+
+

(7) Compare two arbitrary commits

+

This is similar to above, but not only between branches.

+
+

Like above, one can compare commits on GitHub by adjusting the following URL: +https://github.com/USER/recipe-book/compare/VERSION1..VERSION2

+

Replace USER with your username and VERSION1 and VERSION2 with a commit hash or branch name. +Please try it out.

+
+
+
+

(8) Renaming a branch

+
+

Branch button → View all branches → three dots at right side → Rename branch.

+
+
+
+

(9) Creating a tag

+

Tags are a way to mark a specific commit as important, for example a release +version. They are also like a sticky note, but they don’t move when new +commits are added.

+
+

Click on the branch switcher, and then on “Tags”, then on “View all tags”, then +“Create a new release”:

+
+Screenshot on GitHub where we create a new tag. +
+

What GitHub calls releases are actually tags in Git with additional metadata. +For the purpose of this exercise we can use them interchangeably.

+
+
+
+
+

Discussion

+

In this part, we saw how we can make changes to our files. +With branches, we can +track several lines of work at once, and can compare +their differences.

+
    +

  • You could commit directly to main if there is only one single line +of work and it’s only you.

    • +

  • You could commit to branches if there are multiple lines of work at +once, and you don’t want them to interfere with each other.

    • +

  • Tags are useful to mark a specific commit as important, for example a +release version.

    • +

  • In Git, commits form a so-called “graph”. Branches are tags in Git function +like sticky notes that stick to specific commits. What this means for us is +that it does not cost any significant disk space to create new branches.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/configuration/index.html b/branch/main/configuration/index.html new file mode 100644 index 00000000..65fceaeb --- /dev/null +++ b/branch/main/configuration/index.html @@ -0,0 +1,298 @@ + + + + + + + Configuring Git command line and editor — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Configuring Git command line and editor

+

We have a longer version of this in the installation +instructions. +But for clarity, we will review the most important parts here.

+

You don’t need to set these if you work only through the GitHub web interface. +If you use VS Code or other editors or integrated development environments, +the editor might prompt you to set these up.

+

These configuration settings are saved in a file called .gitconfig in your +home directory. If this file exists, editors like VS Code will use this +configuration.

+

If you want to see your configuration settings, you can use the +command (--show-origin means it shows the file where each setting +is defined):

+
$ git config --list --show-origin
+
+
+
+

Name and email address for Git commit metadata

+

Git commits carry metadata about the author and two things you will always need +to define somewhere are:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+
+
+

For the email address we recommend to use the one you use for your GitHub account. +If you prefer to not use it, you can instead use +YOUR_GITHUB_USERNAME@users.noreply.github.com as the email address (replace YOUR_GITHUB_USERNAME). +This means that nobody can write to this email address, but GitHub will still +be able to connect your contributions with your GitHub account.

+

Note that these can, in theory, be anything: this is just data, not a +registration or identity requirement.

+
+
+

Default branch name

+

The default branch name in Git has been master for a long time, but it is +changing to main in many places. We recommend to set it to main for new +repositories that you create locally:

+
$ git config --global init.defaultbranch main
+
+
+
+
+

Useful alias for the command line

+

We recommend to define an alias in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+

We have an own section about aliases: Aliases and configuration.

+
+
+

Default text editor for commit messages

+

Git sometimes needs to start a text editor for you to enter messages (unless you create +commits from inside an editor or on the web). +This may have already been set to something (like VS Code), but if not +nano is usually a safe choice:

+
$ git config --global core.editor nano
+
+
+

The installation instructions text editor page gives ways +to set other editors, or do a web search for “git set editor to +[editor name]”.

+
+
+

Authenticating to GitHub: SSH or HTTPS or VS Code?

+

How does GitHub know who you are? There are three options:

+
    +

  • SSH is the classic method, using Secure Shell +Protocol remote connection +keys.

    • +

  • HTTPS works with the Git Credential Manager, which is an +extra add-on that works easily in Windows and Mac.

    • +

  • VS Code editor can authenticate with GitHub using its own +authentication method.

    • +
+

Read how to install them from the installation +instructions.

+

Test which one you should use:

+
+

Try this command:

+
$ ssh -T git@github.com
+
+
+

If it returns Hi USERNAME! You've successfully authenticated, ..., +then SSH is configured and the following steps will work with the SSH +cloning.

+

See our installation +instructions to +set up SSH access.

+

From now on, if you know that SSH works, you should always select +SSH as the clone URL from GitHub, or translate the URL to start with +the right thing yourself: git@github.com: (with the :).

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/conflicts/index.html b/branch/main/conflicts/index.html new file mode 100644 index 00000000..56d4b4d0 --- /dev/null +++ b/branch/main/conflicts/index.html @@ -0,0 +1,621 @@ + + + + + + + Conflict resolution — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Conflict resolution

+
+

Objectives

+
    +

  • Understand merge conflicts sufficiently well to be able to fix them.

    • +
+
+
+

Instructor note

+
    +

  • 20 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Conflicts in Git and why they are good

+

Imagine we start with the following text file:

+
1 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch A somebody modifies:

+
2 tbsp cilantro
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch B somebody else modifies:

+
1/2 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1 onion
+
+
+

When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro:

+
?????????????????
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1 onion
+
+
+

Git is very good at resolving modifications when merging branches and +in most cases a git merge runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see Optional exercises with branches) without you even noticing.

+

But sometimes the same portion of the code/text is modified on two branches +in two different ways and Git issues a conflict. +Then you need to tell Git which version to keep (resolve it).

+

There are several ways to do that as we will see.

+

Please remember:

+
    +

  • It is good that Git conflicts exist: Git will not silently overwrite one of +two differing modifications.

    • +

  • Conflicts may look scary, but are not that bad after a little bit of +practice. Also they are luckily rare.

    • +

  • Don’t be afraid of Git because of conflicts. You may not meet some conflicts +using other systems because you simply can’t do the kinds of things you do +in Git.

    • +

  • You can take human measures to reduce them.

    • +
+
+
+

The human side of conflicts

+
    +

  • What does it mean if two people do the same thing in two different ways?

    • +

  • What if you work on the same file but do two different things in the different sections?

    • +

  • What if you do something, don’t tell someone from 6 months, and then try to combine it with other people’s work?

    • +

  • How are conflicts avoided in other work? (Only one person working at once? +Declaring what you are doing before you start, if there is any chance someone +else might do the same thing, helps.)

    • +

  • Minor conflicts (two people revise spelling) vs semantic (two people rewrite +a function to add two different new features). How did Git solve these in +branching/merging easily?

    • +
+
+

Now we can go to show how Git controls when there is actually a conflict.

+
+
+

Preparing a conflict

+
+

Instructor note

+

We do the following together as type-along/demo.

+
+
+

If you got stuck previously or joined later

+

If you got stuck previously or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together.

+
    +

  • Create two branches from main: one called like-cilantro, one called dislike-cilantro:

    +
    $ git branch like-cilantro main
+$ git branch dislike-cilantro main
+
    +
    +
    • +

  • On the two branches make different modifications to the amount of the same ingredient:

    • +

  • On the branch like-cilantro we have the following change:

    +
    $ git diff main like-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6cacd50 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +

  • And on the branch dislike-cilantro we have the following change:

    +
    $ git diff main dislike-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6484462 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 1/2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +
+
+
+

Merging conflicting changes

+

What do you expect will happen when we try to merge these two branches into +main?

+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+

The first merge will work:

+
$ git switch main
+$ git status
+$ git merge like-cilantro
+
+Updating 4e03d4b..3caa632
+Fast-forward
+ ingredients.txt | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+

But the second will fail:

+
$ git merge dislike-cilantro
+
+Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+

Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit:

+
$ git status
+
+You have unmerged paths.
+  (fix conflicts and run "git commit")
+  (use "git merge --abort" to abort the merge)
+
+Unmerged paths:
+  (use "git add <file>..." to mark resolution)
+	both modified:   ingredients.txt
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+

Git won’t decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward.

+

Let us inspect the conflicting file:

+
$ cat ingredients.txt
+
+<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

Git inserted resolution markers (the <<<<<<<, >>>>>>>, and =======).

+

Try also git diff:

+
$ git diff
+
+
+
diff --cc ingredients.txt
+index 6cacd50,6484462..0000000
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@@ -1,4 -1,4 +1,10 @@@
+++<<<<<<< HEAD
+ +* 2 tbsp cilantro
+++=======
++ * 1/2 tbsp cilantro
+++>>>>>>> dislike-cilantro
+  * 2 avocados
+  * 1 chili
+  * 1 lime
+
+
+

git diff now only shows the conflicting part, nothing else.

+
+
+

Conflict resolution

+
<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+
+
+

We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged.

+
+

Steps to resolve a conflict

+
    +

  • Check status with git status and git diff.

    • +

  • Decide what you keep (the one, the other, or both or something +else). Edit the file to do this.

    +
      +

    • Remove the resolution markers, if not already done.

      • +

    • The file(s) should now look exactly how you want them.

      • +
    +
    • +

  • Check status with git status and git diff.

    • +

  • Tell Git that you have resolved the conflict with git add ingredients.txt +(if you use the Emacs editor with a certain plugin the editor may stage the +change for you after you have removed the conflict markers).

    • +

  • Verify the result with git status.

    • +

  • Finally commit the merge with only git commit. Everything is pre-filled.

    • +
+
+
+
+

Exercise: Create and resolve a conflict

+
+

Conflict-1: Create another conflict and resolve

+

In this exercise, we repeat almost exactly what we did above with a +different ingredient.

+
    +

  1. Create two branches before making any modifications.

    2. +

  2. Again modify some ingredient on both branches.

    3. +

  3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

    4. +

  4. What happens if you apply the same modification on both branches?

    5. +

  5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into main you will not see a conflict. Can you +explain, why it is different this time?

    6. +
+ +
+
+
+

Optional exercises with conflict resolution

+
+

(optional) Conflict-2: Resolve a conflict when rebasing a branch

+
    +

  1. Create two branches where you anticipate a conflict.

    2. +

  2. Try to merge them and observe that indeed they conflict.

    3. +

  3. Abort the merge with git merge --abort.

    4. +

  4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

    5. +
+ +
+
+

(optional) Conflict-3: Resolve a conflict using mergetool

+
    +

  • Again create a conflict (for instance disagree on the number of avocados).

    • +

  • Stop at this stage:

    +
    Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +
    • +

  • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

    +
    $ git mergetool
+
    +
    +
    +Conflict resolution using mergetool +
    +
    • +

  • Your current branch is left, the branch you merge is right, result is in the middle.

    • +

  • After you are done, close and commit, git add is not needed when using git mergetool.

    • +
+

If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

+

To view what will be removed:

+
$ git clean -n
+
+
+

To remove:

+
$ git clean -f
+
+
+

To configure Git to avoid creating backups at all:

+
$ git config --global mergetool.keepBackup false
+
+
+
+
+
+
+

Using “ours” or “theirs” strategy

+
    +

  • Sometimes you know that you want to keep “ours” version (version on the branch you are on) +or “theirs” (version on the merged branch).

    • +

  • Then you do not have to resolve conflicts manually.

    • +

  • See merge strategies.

    • +
+

Example (merge and in doubt take the changes from current branch):

+
$ git merge -s recursive -Xours less-avocados
+
+
+

Or (merge and in doubt take the changes from less-avocados branch):

+
$ git merge -s recursive -Xtheirs less-avocados
+
+
+
+
+
+

Aborting a conflicting merge

+

Sometimes you get a merge conflict but realize that you can’t solve it without +talking to a colleague (who created the other change) first. What to do?

+

You can abort the merge and postponing conflict resolution by resetting the +repository to HEAD (last committed state):

+
$ git merge --abort
+
+
+

The repository looks then exactly as it was before the merge.

+
+
+
+

Avoiding conflicts

+
    +

  • Human measures

    +
      +

    • Think and plan to which branch you will commit to.

      • +

    • Do not put unrelated changes on the same branch.

      • +
    +
    • +

  • Collaboration measures

    +
      +

    • Open an issue and discuss with collaborators before starting a long-living +branch.

      • +
    +
    • +

  • Project layout measures

    +
      +

    • Modifying global data often causes conflicts.

      • +

    • Modular programming reduces this risk.

      • +
    +
    • +

  • Technical measures

    +
      +

    • Share your changes early and often - this is one of the happy, +rare circumstances when everyone doing the selfish thing (e.g. git push as +early as practical) results in best case for everyone!

      • +

    • Pull/rebase often to keep up to date with upstream.

      • +

    • Resolve conflicts early.

      • +
    +
    • +
+
+

Discussion

+

Discuss how Git handles conflicts compared to services like Google Drive.

+
+
+

Keypoints

+
    +

  • Conflicts often appear because of not enough communication or not optimal +branching strategy.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/customizing/index.html b/branch/main/customizing/index.html new file mode 100644 index 00000000..111371ed --- /dev/null +++ b/branch/main/customizing/index.html @@ -0,0 +1,207 @@ + + + + + + + Customizing Git — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Customizing Git

+
+

Shell prompt

+
+

Instructor note

+

Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like.

+
+

You can make your shell display contextual information about +your Git state even at all times.

+

Here are few example projects that make this possible and easy:

+ +
+
+

More useful “diff” output

+

Delta is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +“diff” output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/exercises/index.html b/branch/main/exercises/index.html new file mode 100644 index 00000000..1bae01d3 --- /dev/null +++ b/branch/main/exercises/index.html @@ -0,0 +1,1260 @@ + + + + + + + List of exercises — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

List of exercises

+

This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests.

+
+

Motivation

+

In motivation.md:

+ +
+
+

Copy and browse an existing project

+

In browsing.md:

+
+

Exercise: Browsing an existing project (25 min)

+

Browse the recipe-book project (introduced above) and explore commits and branches. Take notes +and prepare questions. The hints are for the GitHub path in the +browser.

+
    +

  1. Browse the commit history: Are commit messages understandable? +(Hint: “Commit history”, the timeline symbol, above the file list)

    2. +

  2. Compare the commit history with the network graph (“Insights” -> “Network”). Can you find the branches?

    3. +

  3. How can you find out when a recipe was last modified?

    4. +

  4. How many changes did the Guacamole recipe receive (you find it under “sides”)? +Try to click on some of the commits to see what changed. +(Hint: “History” in the view of a single file)

    5. +

  5. Which recipes include the ingredient “salt”? +(Hint: the GitHub search. From the repository view, it should offer +the filter “repo:USER/recipe-book” by default. What if you +add a search term?)

    6. +

  6. In the Guacamole recipe, find out who modified each line last and when +(click on file, then click “Blame” button). Find out who added the cilantro +and in which commit. +(Hint: “Blame” view in the file view)

    7. +

  7. Can you use these recipes yourself? Are you allowed to share +modifications? +(Hint: look for a license file)

    8. +

  8. Browse issues and pull requests in the upstream repository (the +repository you forked from). Any idea what these might be good for? +(Hint: tabs in the repository view)

    9. +
+
+
+
+

Committing changes

+

In commits.md:

+
+

Exercise: Practice creating commits and branches (20 min)

+
    +

  1. Make sure that you now work on your fork of the recipe-book +repository (USER/recipe-book, not coderefinery/recipe-book)

    2. +

  2. First create a new branch and then add a recipe to the branch and commit the change.

    3. +

  3. In a new commit, modify the recipe you just added.

    4. +

  4. Switch to the main branch and modify a recipe there.

    5. +

  5. Browse the network and locate the commits that you just created (“Insights” -> “Network”).

    6. +

  6. Compare the branch that you created with the main branch. Can you find an easy way to see the differences?

    7. +

  7. Can you find a way to compare versions between two arbitrary commits in the repository?

    8. +

  8. Try to rename the branch that you created and then browse the network again.

    9. +

  9. Try to create a tag for one of the commits that you created (on GitHub, +create a “release”).

    10. +
+
+
+
+

Merging changes and contributing to the project

+

In merging.md:

+
+

Exercise: Merging branches with pull requests (20 min)

+

We assume that in the previous exercise you have created a new branch +with a recipe. In our previous example, it is called new-recipe. +If not, create it first and add a recipe to your new branch, see +Committing changes.

+

We provide basic hints. You should refer to the solution as needed.

+
    +

  1. Navigate to your branch from the previous episode +(Hint: the same branch view we used last time).

    2. +

  2. Begin the pull request process. +(Hint: There is a “Contribute” button in the branch view).

    3. +

  3. Add or modify the pull request title and description, and verify the other data. +In the pull request verify the target repository and the target +branch. Make sure that you are merging within your own repository. +GitHub: By default, it will offer to make the change to the +upstream repository, coderefinery. You should change this, you +shouldn’t contribute your test recipe upstream yet. Where it says +base repository, select your own user’s repository.

    4. +

  4. Create the pull request by clicking “Create pull request”. Browse +the network view to see if anything has changed yet.

    5. +

  5. Merge the pull request, or if you are not on GitHub you can merge +the branch locally. Browse the network again. What has changed?

    6. +

  6. Find out which branches are merged and thus safe to delete. Then remove them +and verify that the commits are still there, only the branch labels are +gone. (Hint: you can delete branches that have been merged into main).

    7. +

  7. Optional: Try to create a new branch with a new change, then open a pull +request but towards the central repository. We will later merge few of +those. +(Hint: this is mostly the same as above, for the GitHub path. But, +you set the base repository as CodeRefinery. You might need to +compare across forks.)

    8. +
+
+

In merging.md:

+
+

Exercise

+
    +

  1. Switch to the main branch that you want to merge the other +branch into. (Note that this is the other way around from the +GitHub path).

    2. +
+

Then:

+
    +

  1. Merge the other branch into main (which is then your current branch).

    2. +

  2. Find out which branches are merged and thus safe to delete. Then remove them +and verify that the commits are still there, only the branch labels are +gone. (Hint: you can delete branches that have been merged into main).

    3. +

  3. (optional, advanced) Try to create a new branch, and make a +GitHub pull request with your recipe, and contribute it to our +upstream repository. This is very complex right now since your +change has to get to GitHub, and we haven’t shown that yet. We +don’t give a solution for this.

    4. +
+
+
+
+

Cloning a Git repository and working locally

+

In local-workflow.md:

+
+

Exercise: Cloning a Git repository and working locally (25 min)

+
    +

  1. Configure Git command line and editor if you haven’t done that already.

    2. +

  2. Decide which repository you want to clone: your fork or the original repository? Both will work for this exercise. +Then, clone the recipe book.

    3. +

  3. Create a new branch.

    4. +

  4. Make a commit on your new branch.

    5. +

  5. Switch back to the main branch and create one or two commits there.

    6. +

  6. Merge the new branch into main.

    7. +

  7. Compare the graph locally and on GitHub and observe that the changes only exist locally on your computer.

    8. +

  8. Where are the remote branches? Practice how you can see all remote branches +also locally and how you can fetch them and make local changes to them.

    9. +
+
+
+
+

Inspecting history

+

In archaeology.md:

+
+

Exercise: Explore basic archaeology commands (20 min)

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Make sure you are not inside another Git repository when running this +exercise. If you are, first step “outside” of it. +We want to avoid creating a Git repository inside another Git repository.

    +
    +

    You can check if you are inside a Git repository with:

    +
    $ git status
+
+fatal: not a git repository (or any of the parent directories): .git
+
    +
    +

    You want to see the above message which tells us that this is not a Git repository.

    +
    +
    • +

  • Clone this repository: +https://github.com/networkx/networkx.git.

    +
    +
    $ git clone https://github.com/networkx/networkx.git
+
    +
    +
    +
    • +

  • Then let us all make sure we are working on a well-defined version of the repository.

    +
    +

    Step into the new directory and create an exercise branch from the +networkx-2.6.3 tag/release:

    +
    $ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+

In archaeology.md:

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+
+

How to turn your project to a Git repo and share it

+

In sharing.md:

+
+

Exercise: Turn your project to a Git repo and share it (25 min)

+
    +

  1. Create a new directory called myproject with one or few files in it. +This represents our own project. It is not yet a Git repository. You can try +that with your own project or use a simple placeholder example.

    2. +

  2. Turn this new directory into a Git repository.

    3. +

  3. Share this repository on GitHub (or GitLab, since it really works the same).

    4. +
+

We offer three different paths of how to do this exercise.

+
    +

  • Via GitHub web interface: easy and can be a good starting point if you are completely +new to Git.

    • +

  • VS Code is quite easy, since VS Code can offer to create the +GitHub repositories for you.

    • +

  • Command line: you need to create the +repository on GitHub and link it yourself.

    • +
+
+

Create an repository on GitHub

+

First log into GitHub, then follow the screenshots and descriptions below.

+
+Screenshot on GitHub before a new repository form is opened +
+

Click on the “plus” symbol on top right, then on “New repository”.

+
+
+

Then:

+
+Screenshot on GitHub just before a new repository is created +
+

Choose a repository name, add a short description, and in this case make sure to check “Add a +README file”. Finally “Create repository”.

+
+
+

Upload your files

+

Now that the repository is created, you can upload your files:

+
+Screenshot on GitHub just before uploading files +
+

Click on the “+” symbol and then on “Upload files”.

+
+
+
+
+
+
+

Basics

+

In basics.md:

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+

In basics.md:

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+

In basics.md:

+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+

In basics.md:

+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+

In basics.md:

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+
+

Branching and merging

+

In branches.md:

+
+

Branch-1: Create and commit to branches

+

In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging. The goal of the exercise is to end up with 3 branches.

+
    +

  • Change to the branch main.

    • +

  • Create another branch called less-salt.

    +
      +

    • Note! makes sure you are on main branch when you create the less-salt branch.

      • +

    • A safer way would be to explicitly mention to create from the main branch +as shown below:

      +
      $ git branch less-salt main
+
      +
      +
      • +
    +
    • +

  • Switch to the less-salt branch.

    • +

  • On the less-salt branch reduce the amount of salt.

    • +

  • Commit your changes to the less-salt branch.

    • +
+

Use the same commands as we used above.

+

We now have three branches (in this case HEAD points to less-salt):

+
$ git branch
+
+  experiment
+* less-salt
+  main
+
+$ git graph
+
+* bf28166 (HEAD -> less-salt) reduce amount of salt
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Here is a graphical representation of what we have created:

+
+../_images/git-branch-2.svg
+
    +

  • Now switch to main.

    • +

  • In a new commit, improve the README.md file (we added the word “Guacamole”):

    +
    # Guacamole recipe
+
+This is an exercise repository.
+
    +
    +
    • +
+

Now you should have this situation:

+
$ git graph
+
+* b4af65b (HEAD -> main) improve the documentation
+| * bf28166 (less-salt) reduce amount of salt
+|/
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
+../_images/git-branch-3.svg
+

And for comparison this is how it looks on GitHub.

+
+

In branches.md:

+
+

Branch-2: Merge branches

+

Merge experiment and less-salt back into main following the lesson below +until the point where we start deleting branches.

+
+

In branches.md:

+
+

(optional) Branch-3: Perform a fast-forward merge

+
    +

  1. Create a new branch from main and switch to it.

    2. +

  2. Create a couple of commits on the new branch (for instance edit README.md):

    +
    +../_images/git-pre-ff.svg
    +
    3. +

  3. Now switch to main.

    4. +

  4. Merge the new branch to main.

    5. +

  5. Examine the result with git graph.

    6. +

  6. Have you expected the result? Discuss what you see.

    7. +
+ +
+

In branches.md:

+
+

(optional) Branch-4: Rebase a branch (instead of merge)

+

As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

+
    +

  1. Create a new branch, and make a couple of commits on it.

    2. +

  2. Switch back to main, and make a couple of commits on it.

    3. +

  3. Inspect the situation with git graph.

    4. +

  4. Now rebase the new branch on top of main by first switching to the new branch, and then git rebase main.

    5. +

  5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

    6. +
+ +
+

In branches.md:

+
+

Branch-5: Test your understanding

+

Which of the following combos (one or more) creates a new branch and makes a commit to it?

+
    +
  1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    2. +
  2. $ git add file.txt
+$ git branch new-branch
+$ git switch new-branch
+$ git commit
+
    +
    +
    3. +
  3. $ git switch --create new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    4. +
  4. $ git switch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    5. +
+ +
+
+
+

Conflict resolution

+

In conflicts.md:

+
+

Conflict-1: Create another conflict and resolve

+

In this exercise, we repeat almost exactly what we did above with a +different ingredient.

+
    +

  1. Create two branches before making any modifications.

    2. +

  2. Again modify some ingredient on both branches.

    3. +

  3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

    4. +

  4. What happens if you apply the same modification on both branches?

    5. +

  5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into main you will not see a conflict. Can you +explain, why it is different this time?

    6. +
+ +
+

In conflicts.md:

+
+

(optional) Conflict-2: Resolve a conflict when rebasing a branch

+
    +

  1. Create two branches where you anticipate a conflict.

    2. +

  2. Try to merge them and observe that indeed they conflict.

    3. +

  3. Abort the merge with git merge --abort.

    4. +

  4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

    5. +
+ +
+

In conflicts.md:

+
+

(optional) Conflict-3: Resolve a conflict using mergetool

+
    +

  • Again create a conflict (for instance disagree on the number of avocados).

    • +

  • Stop at this stage:

    +
    Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +
    • +

  • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

    +
    $ git mergetool
+
    +
    +
    +Conflict resolution using mergetool +
    +
    • +

  • Your current branch is left, the branch you merge is right, result is in the middle.

    • +

  • After you are done, close and commit, git add is not needed when using git mergetool.

    • +
+

If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

+

To view what will be removed:

+
$ git clean -n
+
+
+

To remove:

+
$ git clean -f
+
+
+

To configure Git to avoid creating backups at all:

+
$ git config --global mergetool.keepBackup false
+
+
+
+
+
+

Using the Git staging area

+

In staging-area.md:

+
+

Staging-1: Perform an interactive commit

+

One option to help us create nice logical commits is to stage interactively +with git commit --patch:

+
    +

  1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

    2. +

  2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

    3. +

  3. Do it again for the other change.

    4. +

  4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

    5. +

  5. When would this be useful?

    6. +
+ +
+

In staging-area.md:

+
+

Staging-2: Use the staging area to make a commit in two steps

+
    +

  1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

    2. +

  2. Use git add to stage one of the changes.

    3. +

  3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

    4. +

  4. Feel some regret and unstage the staged change.

    5. +
+
+
+
+

Undoing and recovering

+

In recovering.md:

+
+

Undoing-1: Revert a commit

+
    +

  • Create a commit (commit A).

    • +

  • Revert the commit with git revert (commit B).

    • +

  • Inspect the history with git log --oneline.

    • +

  • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

    • +
+
+

In recovering.md:

+
+

Undoing-2: Modify a previous commit

+
    +

  1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

    2. +

  2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

    3. +

  3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

    4. +
+ +
+

In recovering.md:

+
+

Undoing-3: Destroy our experimentation in this episode

+

After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

+
    +

  • First, we will look at our history (git log/git graph) and +find the last commit HASH before our tests.

    • +

  • Then, we will git reset --hard HASH to that.

    • +

  • Then, git graph again to see what happened.

    • +
+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+$ git reset --hard b4af65b
+
+HEAD is now at b4af65b improve the documentation
+
+$ git log --oneline
+
+b4af65b (HEAD -> main) improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+
+

In recovering.md:

+
+

Undoing-4: Test your understanding

+
    +

  1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

    2. +

  2. Is it OK to modify commits that nobody has seen yet?

    3. +

  3. What situations would justify to modify the Git history and possibly remove commits?

    4. +
+ +
+
+
+

Interrupted work

+

In interrupted.md:

+
+

Interrupted-1: Stash some uncommitted work

+
    +

  1. Make a change.

    2. +

  2. Check status/diff, stash the change with git stash, check status/diff again.

    3. +

  3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

    4. +

  4. Pop off the stash you saved with git stash pop, and check status/diff.

    5. +

  5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

    6. +

  6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

    7. +

  7. Advanced: what does git graph show when you have something +stashed?

    8. +
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/genindex/index.html b/branch/main/genindex/index.html new file mode 100644 index 00000000..6ae2ef4d --- /dev/null +++ b/branch/main/genindex/index.html @@ -0,0 +1,359 @@ + + + + + + Index — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | F + | G + | H + | I + | M + | O + | P + | R + | S + | T + | U + | V + | W + +
+

A

+ + +
+ +

B

+ + +
+ +

C

+ + + +
+ +

F

+ + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + +
+ +

M

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + +
+ +

T

+ + +
+ +

U

+ + +
+ +

V

+ + + +
+ +

W

+ + + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/guide/index.html b/branch/main/guide/index.html new file mode 100644 index 00000000..11ffba7b --- /dev/null +++ b/branch/main/guide/index.html @@ -0,0 +1,386 @@ + + + + + + + Instructor guide — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Instructor guide

+
+

Exercise preparation: one day before the workshop

+ +
+
+

Privacy

+

When presenting the material in a streamed and recorded workshop, make sure to +only show the https://github.com/coderefinery/recipe-book-recorded +repository.

+
+
+

Schedule Day 1

+

Times here are in CE(S)T.

+ +
+
+

Schedule Day 2

+

Times here are in CE(S)T.

+ +
+
+

Why we teach this lesson

+

Everyone should be using a version control system for their work, even if they’re working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories.

+

Specific motivations:

+
    +

  • Code easily becomes a disaster without version control

    • +

  • Mistakes happen - Git offers roll-back functionality and easy backup mechanism

    • +

  • One often needs to work on multiple things in parallel - branches solve that problem

    • +

  • Git enables people to collaborate on code or text without stepping on each other’s toes

    • +

  • Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, +and if bugs are found one can find out exactly when it was introduced

    • +
+

Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices.

+
+
+

Intended learning outcomes

+

By the end of this lesson, learners should:

+
    +

  • realize that version control is very important and Git is a valuable tool to learn and use

    • +

  • understand that Git is configurable and know how to set basic configurations

    • +

  • be able to set up Git repositories and make commits

    • +

  • know how to write good commit messages

    • +

  • have an idea of how the staging area can be used to craft good commits

    • +

  • know how to create branches and switch between branches

    • +

  • have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way

    • +

  • know how to merge branches and understand what that means in terms of combining different modifications

    • +

  • realize that conflicts are generally a good thing since they prevent incorrect merges

    • +

  • be able to set up a repository on GitHub and connect it with local repository

    • +

  • push changes to a remote repository

    • +

  • know a few ways to search through a repository and its history

    • +
+
+
+

Inspecting history

+

Key lesson is how to find when something is broken or what commit has broken +the code.

+

It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that git annotate +and git show are available on GitHub and GitLab.

+

When discussing git annotate and git bisect the “when” is more important +than “who”. It is not to blame anybody but rather to find out whether published +results are affected.

+

Discuss how one would find out this information without version control.

+

Questions to involve participants:

+
    +

  • Have you ever found a bug in your code and wondered whether it has affected published results?

    • +

  • Have you ever wondered when, and by whom, a particular line of code was introduced?

    • +

  • Have you ever found out that a code behaves differently than it used to but you are not sure when +precisely this changed?

    • +
+

Confusion during git bisect exercise:

+

Learners may get stuck in the git bisect exercise if they incorrectly assign a commit +as bad or good. +To leave the bisect mode and return to the commit before git bisect start was issued, +one can do

+
$ git bisect reset
+
+
+

and start over if needed.

+
+

Live better than reading the website material

+

It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier.

+
+
+

Log your history in a separate window

+

The screencasting (shell window cheatsheet) hints have been moved to +the presenting +manual.

+
+
+

Create a cheatsheet on the board

+

For in-person workshops, create a “cheatsheet” on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven’t forgotten anything. Re-create and expand in future git lessons. +One strategy is:

+
    +

  • a common section for basic commands: init, config, clone, help, stash

    • +

  • info commands, can be run anytime: status, log, diff, graph

    • +

  • A section for all the commands that move code from different states: +add, commit, etc. See the visual cheat sheet below.

    • +
+

You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it’s probably too confusing to use after this course. But, the idea +of commands moving from the “working dir”, “staging area”, “commits”, +etc is good.

+
+Example cheat sheet +
+

Example cheat sheet.

+
+
+

We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to.

+
+
+

Draw a graph on the board

+

Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run git graph, then do the command, +then look at git graph again.

+
+
+

Repeat the following points

+
    +

  • Always check git status, git diff, and git graph (our alias) before and +after every command until you get used to things. These give you a clear view +into what is going on, the key to knowing what you are doing. Even +after you are used to things… anytime you do something you do +infrequently, it’s good to check.

    • +

  • git graph is a direct representation of what we are drawing on the +board and should constantly be compared to it.

    • +

  • Once you git add something, it’s almost impossible to lose it. +This is used all the time, for example once you commit or even add +it is hard to lose. Commit before you merge or rebase. And so on.

    • +
+
+
+

Start from identical environment

+

You probably have a highly optimized bash and git environment - one +that is different from students. Move .gitconfig and .bashrc out +of the way before you start so that your environment is identical to +what students have.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/index.html b/branch/main/index.html new file mode 100644 index 00000000..7dda5cff --- /dev/null +++ b/branch/main/index.html @@ -0,0 +1,286 @@ + + + + + + + Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version
    • +
  • + Edit on GitHub +
    • +
+
+
+
+
+ +
+

Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version

+
+

Warning

+

In February and March 2024 we rewrote this lesson from the ground up. +If you are looking for the previous version, you can browse the +2023 version of this lesson.

+
+

This is the introductory lesson to version control using +Git.

+

We start with an existing repository on the web to visually explain the basic +concepts of version control. We later move to a local +repository. Our goal there is not only to be able to apply changes to an +existing repository but to also be able to turn own projects into Git +repositories and to share them with others.

+

In the separate collaborative Git +lesson, we teach more use +of remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with Git to +be able to work well.

+

The goals of the module as a whole are that the learner will feel comfortable +about committing changes, branching, and merging.

+
+

Prerequisites

+

We offer several options to go through the material: on the web, in an editor, +or in the terminal. +Please see the installation instructions.

+

We recommend to have a GitHub account. +Why GitHub? +Also GitLab and Bitbucket would +allow similar workflows and basically everything that we will discuss is +transferable. With this material and these exercises we do not implicitly +endorse the company GitHub. We have chosen to demonstrate +a number of concepts using examples with GitHub because +it is currently the most popular web platform for hosting Git repositories and +the chance is high that you will interact with +GitHub-based repositories even if you choose to host your +Git repository on another service.

+
+
+

Getting started

+ +
+
+

Modifying an existing project

+ +
+
+

Studying an existing project

+ +
+
+

Sharing your work

+ +
+
+

Finding the balance

+ +
+
+

Older episodes

+ +
+
+

Optional episodes

+ +
+
+

Reference

+ +
+
+

About

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/interrupted/index.html b/branch/main/interrupted/index.html new file mode 100644 index 00000000..1673c90f --- /dev/null +++ b/branch/main/interrupted/index.html @@ -0,0 +1,291 @@ + + + + + + + Interrupted work — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Interrupted work

+
+

Objectives

+
    +

  • Learn to switch context or abort work without panicking.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+

Keypoints

+
    +

  • There is almost never reason to clone a fresh copy to complete a task that +you have in mind.

    • +
+
+
+

Frequent situation: interrupted work

+

We all wish that we could write beautiful perfect code. But the real world is +much more chaotic:

+
    +

  • You are in the middle of a “Jackson-Pollock-style” debugging spree with 27 modified files +and debugging prints everywhere.

    • +

  • Your colleague comes in and wants you to fix/commit something right now.

    • +

  • What to do?

    • +
+

Git provides lots of ways to switch tasks without ruining everything.

+
+
+

Option 1: Stashing

+

The stash is the first and easiest place to temporarily “stash” +things.

+
    +

  • git stash will put working directory and staging area changes +away. Your code will be same as last commit.

    • +

  • git stash pop will return to the state you were before. Can give it a list.

    • +

  • git stash list will list the current stashes.

    • +

  • git stash save NAME is like the first, but will give it a name. +Useful if it might last a while.

    • +

  • git stash save [-p] [filename] will stash certain files files +and/or by patches.

    • +

  • git stash drop will drop the most recent stash (or whichever stash +you give).

    • +

  • The stashes form a stack, so you can stash several batches of modifications.

    • +
+
+

Exercise: Stashing

+
+

Interrupted-1: Stash some uncommitted work

+
    +

  1. Make a change.

    2. +

  2. Check status/diff, stash the change with git stash, check status/diff again.

    3. +

  3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

    4. +

  4. Pop off the stash you saved with git stash pop, and check status/diff.

    5. +

  5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

    6. +

  6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

    7. +

  7. Advanced: what does git graph show when you have something +stashed?

    8. +
+ +
+
+
+
+

Option 2: Create branches

+

You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch.

+

You basically know how to do this:

+
$ git switch --create temporary  # create a branch and switch to it
+$ git add PATHS                  # stage changes
+$ git commit                     # commit them
+$ git switch main                # back to main, continue your work there ...
+$ git switch temporary           # continue again on "temporary" where you left off
+
+
+

Later you can merge it to main or rebase it on top of main and resume work.

+
+
+

Storing various junk you don’t need but don’t want to get rid of

+

It happens often that you do something and don’t need it, but you don’t want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/lesson.pdf b/branch/main/lesson.pdf new file mode 100644 index 00000000..be932471 Binary files /dev/null and b/branch/main/lesson.pdf differ diff --git a/branch/main/level/index.html b/branch/main/level/index.html new file mode 100644 index 00000000..973ee734 --- /dev/null +++ b/branch/main/level/index.html @@ -0,0 +1,312 @@ + + + + + + + Practical advice: how much Git is necessary? — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Practical advice: how much Git is necessary?

+
+

Instructor note

+
    +

  • 20 min teaching/discussion

    • +
+
+
+

Writing useful commit messages

+

Useful commit messages summarize the change and provide context.

+

If you need a commit message that is longer than one line, +then the convention is: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+

Good example:

+
increase alpha to 2.0 for faster convergence
+
+the motivation for this change is
+to enable ...
+...
+(more context)
+...
+this is based on a discussion in #123
+
+
+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

What level of branching complexity is necessary for each project?

+

Simple personal projects:

+
    +

  • Typically start with just the main branch.

    • +

  • Use branches for unfinished/untested ideas.

    • +

  • Use branches when you are not sure about a change.

    • +

  • Use tags to mark important milestones.

    • +

  • If you are unsure what to do with unfinished and not working code, commit it +to a branch.

    • +
+

Projects with few persons: you accept things breaking sometimes

+
    +

  • It might be reasonable to commit to the main branch and feature branches.

    • +
+

Projects with few persons: changes are reviewed by others

+
    +

  • You create new feature branches for changes.

    • +

  • Changes are reviewed before they are merged to the main branch +(more about that in the collaborative Git lesson).

    • +

  • Consider to write-protect the main branch so that it can only be changed +with pull requests or merge requests.

    • +
+
+
+

How about staging and committing?

+
    +

  • Commit early and often: rather create too many commits than too few. +You can always combine commits later.

    • +

  • Once you commit, it is very, very hard to really lose your code.

    • +

  • Always fully commit (or stash) before you do dangerous things, so that you know you are safe. +Otherwise it can be hard to recover.

    • +

  • Later you can start using the staging area (where you first stage and then commit in a second step).

    • +

  • Later start using git add -p and/or git commit -p.

    • +
+
+
+

How large should a commit be?

+
    +

  • Better too small than too large (easier to combine than to split).

    • +

  • Often I make a commit at the end of the day (this is a unit I would not like to lose).

    • +

  • Smaller sized commits may be easier to review for others than huge commits.

    • +

  • Imperfect commits are better than no commits.

    • +

  • A commit should not contain unrelated changes to simplify review and possible +repair/adjustments/undo later (but again: imperfect commits are better than no commits).

    • +
+
+
+

Keypoints

+
    +

  • There is no one size fits all - start simple and grow your project.

    • +
+
+
+

Discussion

+

How do you [plan to] use Git?

+
    +

  • Advanced users or beginners, please provide your input in the online collaborative document.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/local-workflow/index.html b/branch/main/local-workflow/index.html new file mode 100644 index 00000000..412d6950 --- /dev/null +++ b/branch/main/local-workflow/index.html @@ -0,0 +1,495 @@ + + + + + + + Cloning a Git repository and working locally — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Cloning a Git repository and working locally

+

If you’ve been following the main path, you have just had interacted +with repositories on GitHub. This might not be what you usually +do, so now we move to working on your own computer.

+
+

Objectives

+
    +

  • We are able to clone a repository from the web and modify it locally.

    • +

  • We can do the same things we did before (commit, branch, merge), but locally.

    • +

  • We get a feeling for remote repositories (more later).

    • +
+
+
+

Instructor note

+
    +

  • 10 min introduction and setup

    • +

  • 25 min exercise

    • +

  • 15 min discussion

    • +
+
+
+

What is in a Git repository and what are we cloning?

+

Git repository:

+
    +

  • Contains all the files and directories of a project.

    • +

  • Contains the complete history of all changes (commits) to these files and directories.

    • +

  • Each commit is a snapshot of the entire project at a certain point in time and has a unique identifier (“hash”).

    • +

  • Sometimes it contains multiple branches and tags.

    • +

  • All the commits and history of a local repository are stored in a directory +called .git which is located at the root of the repository.

    • +
+

Cloning:

+
    +

  • Copying (downloading) the entire repository with all commits, branches, and tags to your computer.

    • +

  • It is a full backup of the repository, including all history.

    • +

  • You can then work on your local clone of the repository.

    • +

  • Changes on local clone will not automatically appear in the repository where +we cloned from. We have to actively “push” them there (we will practice this +in a later episode: How to turn your project to a Git repo and share it).

    • +
+
+
+

Exercise

+

Work on this by yourself or in your teams. Conceptually this episode should +seem familiar, from the browser-based exercises we did yesterday.

+

We offer the Command Line and VS Code paths for this exercise. +GitHub isn’t an option in this episode, since that is what we already +demonstrated in Committing changes and Merging changes and contributing to the project and since the point of this +episode is to work locally.

+

It is also possible to use the command line (terminal) from inside VS Code.

+
+

Exercise: Cloning a Git repository and working locally (25 min)

+
    +

  1. Configure Git command line and editor if you haven’t done that already.

    2. +

  2. Decide which repository you want to clone: your fork or the original repository? Both will work for this exercise. +Then, clone the recipe book.

    3. +

  3. Create a new branch.

    4. +

  4. Make a commit on your new branch.

    5. +

  5. Switch back to the main branch and create one or two commits there.

    6. +

  6. Merge the new branch into main.

    7. +

  7. Compare the graph locally and on GitHub and observe that the changes only exist locally on your computer.

    8. +

  8. Where are the remote branches? Practice how you can see all remote branches +also locally and how you can fetch them and make local changes to them.

    9. +
+
+

The solution below goes over most of the answer and should be used as +your guide (you can’t figure it out just from the exercise instructions).

+
+
+

Solution and walk-through

+
+

(1) Configure Git command line and editor

+

We have an own section for this: Configuring Git command line and editor.

+
+
+

(2) Cloning a repository

+

Now you need to decide which repository you want to clone. All of these options will work for this exercise +since we don’t plan to push changes back (for step 8 it might be easier to use the original repository):

+ +

The examples below assume you are cloning the original repository. If you are cloning your fork, you should +replace coderefinery with your GitHub username.

+
+

If you are unsure whether you are using SSH or HTTPS, please read Authenticating to GitHub: SSH or HTTPS or VS Code?.

+
+
$ git clone git@github.com:coderefinery/recipe-book.git
+
+
+
+

This creates a directory called “recipe-book” unless it already exists. You can also specify the target directory +on your computer (in this case “my-recipe-book”):

+
+
$ git clone git@github.com:coderefinery/recipe-book.git my-recipe-book
+
+
+
+
+
+
+

(3) Creating branches locally

+
+

Create a new branch called another-recipe from main and switch to it:

+
$ git switch --create another-recipe main
+
+
+

If you leave out the last argument, it will create a branch from the current +branch:

+
$ git switch --create another-recipe
+
+
+
+
+
+

(4) Creating commits locally

+
+

Create a new file. After we have created it, we can stage and commit +the change:

+
$ git add new-file.md
+$ git commit -m "Short summary of the change"
+
+
+

Make sure to replace “new-file.md” with the actual name of the file you created +and to replace “Short summary of the change” with a meaningful commit message.

+
+
+
+

(5) Switching branches and creating commits

+
+

First switch to the main branch:

+
$ git switch main
+
+
+

Then modify a file. Finally git add and then commit the change:

+
$ git commit -m "Short summary of the change"
+
+
+
+
+
+

(6) Merging branches locally

+
+

On the command line, when we merge, we always modify our current branch.

+

If you are not sure anymore what your current branch is, type:

+
$ git branch
+
+
+

Another way to find out where we are in Git:

+
$ git status
+
+
+

In this case we merge the another-recipe branch into our current branch:

+
$ git merge another-recipe
+
+
+
+
+
+

(7) How to compare the graph locally and on GitHub

+
+
$ git log --graph --oneline --decorate --all
+
+
+

We recommend to define an alias in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+

Then you can just type git graph from there on. We have an own section about +aliases: Aliases and configuration.

+

Compare this with the graph on GitHub: Insights tab → Network view (just like +we have done before).

+

The result is that we should not be able to see the new branch and the new +commits on GitHub.

+
+
+
+

(8) Browsing remote branches and creating local branches from them

+
+

With git branch you can list all local branches:

+
$ git branch
+
+  another-recipe
+* main
+
+
+

But where are the remote branches? We expect to see a couple of +them.

+

We can see them by asking for all branches (your output might vary depending on +where you cloned from):

+
$ git branch --all
+
+  another-recipe
+* main
+  remotes/origin/HEAD -> origin/main
+  remotes/origin/alex/fruit-salad
+  remotes/origin/main
+  remotes/origin/radovan/lasagna
+  remotes/origin/radovan/poke
+
+
+

You can create a local branch from a remote branch which will “track” the remote branch. +For instance, to create a local branch alex/fruit-salad from the remote branch origin/alex/fruit-salad +and switch to it, you can do:

+
$ git switch --create alex/fruit-salad origin/alex/fruit-salad
+
+
+

This shortcut will do the same thing:

+
$ git switch --track origin/alex/fruit-salad
+
+
+

Or even shorter:

+
$ git switch alex/fruit-salad
+
+
+

If you want to create a branch and not switch to it, you can use git branch.

+
$ git branch alex/fruit-salad
+
+
+
+
+
+
+

Summary

+
    +

  • When we clone a repository, we get a full backup of the repository, including +all history: all commits, branches, and tags.

    • +

  • Yesterday we learned about branches and commits, and now we created and used them locally.

    • +

  • Creating local branches and commits does not automatically modify the remote +repository. To “push” our local changes to the remote repository, we have to actively +“push” them there. We will practice this in a later episode: +How to turn your project to a Git repo and share it

    • +

  • Remote branches and local branches are not the same thing. If we want to +create local commits, we always need to create a local branch first. But the local branch can +“track” the remote branch and we can push and pull changes to and from the +remote branch.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/merging/index.html b/branch/main/merging/index.html new file mode 100644 index 00000000..41772a30 --- /dev/null +++ b/branch/main/merging/index.html @@ -0,0 +1,520 @@ + + + + + + + Merging changes and contributing to the project — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Merging changes and contributing to the project
    • +
  • + Edit on GitHub +
    • +
+
+
+
+
+ +
+

Merging changes and contributing to the project

+

Git allows us to have different development lines where we can try things out. +It also allows different people to work on the same project at the same. This +means that we have to somehow combine the changes later. In this part we will +practice this: merging.

+
+

Objectives

+
    +

  • Understand that on GitHub merging is done through a pull request. Think of it as a change proposal.

    • +

  • Create and merge a pull request within your own repository.

    • +

  • Understand (and optionally) do the same across repositories, to contribute to +the upstream public repository.

    • +
+
+
+

Instructor note

+
    +

  • 10 min introduction and setup

    • +

  • 25 min exercise

    • +

  • 15 min discussion

    • +
+
+
+

Background

+
    +

  • In the last episode, we added a new recipe on a branch. This allows +us to test it before it becomes “live”.

    • +

  • Now, we want to bring that change into the “main” branch.

    • +

  • We will find it’s not that hard! But you do have to keep track of the +steps and make sure that you work very precisely.

    • +
+
+
+

Exercise

+

In this exercise, we will show how we can propose changes and merge +changes within our own repository. Optionally, you can propose a recipe to +the upstream recipe book - which shows the true purpose of this. But +this is only a preview and we will practice collaboration much more in the +collaborative Git lesson.

+

We offer three different paths of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the GitHub +path only and recommend you do that. The exercise text below has +some GitHub-specific notes, but most is possibly with any path.

+
+

First, we make something called a pull request, which allows +review and commenting before the actual merge.

+
+

Exercise: Merging branches with pull requests (20 min)

+

We assume that in the previous exercise you have created a new branch +with a recipe. In our previous example, it is called new-recipe. +If not, create it first and add a recipe to your new branch, see +Committing changes.

+

We provide basic hints. You should refer to the solution as needed.

+
    +

  1. Navigate to your branch from the previous episode +(Hint: the same branch view we used last time).

    2. +

  2. Begin the pull request process. +(Hint: There is a “Contribute” button in the branch view).

    3. +

  3. Add or modify the pull request title and description, and verify the other data. +In the pull request verify the target repository and the target +branch. Make sure that you are merging within your own repository. +GitHub: By default, it will offer to make the change to the +upstream repository, coderefinery. You should change this, you +shouldn’t contribute your test recipe upstream yet. Where it says +base repository, select your own user’s repository.

    4. +

  4. Create the pull request by clicking “Create pull request”. Browse +the network view to see if anything has changed yet.

    5. +

  5. Merge the pull request, or if you are not on GitHub you can merge +the branch locally. Browse the network again. What has changed?

    6. +

  6. Find out which branches are merged and thus safe to delete. Then remove them +and verify that the commits are still there, only the branch labels are +gone. (Hint: you can delete branches that have been merged into main).

    7. +

  7. Optional: Try to create a new branch with a new change, then open a pull +request but towards the central repository. We will later merge few of +those. +(Hint: this is mostly the same as above, for the GitHub path. But, +you set the base repository as CodeRefinery. You might need to +compare across forks.)

    8. +
+
+
+

The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren’t enough - this is by design.

+
+
+

Solution and walk-through

+ +
+

(2) Begin the pull request process

+

In GitHub, the pull request is the way we propose to merge two +branches together. We start the process of making one.

+
+
+Screenshot on GitHub where we get to the pull request process. +
+
+
+
+

(3) Fill out and verify the pull request

+

Check that the pull request is directed to the right repository and branch +and that it contains the changes that you meant to merge.

+
+

Things to check:

+
    +

  • Base repository: this should be your own

    • +

  • Title: make it descriptive

    • +

  • Description: make it informative

    • +

  • Scroll down to see commits: are these the ones you want to merge?

    • +

  • Scroll down to see the changes: are these the ones you want to merge?

    +
    +Screenshot on GitHub where we verify the changes we want to merge. +
    +

    This screenshot only shows the top part. If you scroll down, you +can see the commits and the changes. We recommend to do this before +clicking on “Create pull request”.

    +
    +
    +
    • +
+
+
+
+

(4) Create the pull request

+

We actually create the pull request. Don’t forget to navigate to the Network +view after opening the pull request. Note that the changes proposed in the +pull request are not yet merged.

+
+

Click on the green button “Create pull request”.

+

If you click on the little arrow next to “Create pull request”, you can also +see the option to “Create draft pull request”. This will be interesting later +when collaborating with others. It allows you to open a pull request that is +not ready to be merged yet, but you want to show it to others and get feedback.

+
+
+
+

(5) Merge the pull request

+

Now, we do the actual merging. We see some effects now.

+
+

Review it again (commits and changes), and then click “Merge pull request”.

+

After merging, verify the network view. Also navigate then to your “main” +branch and check that your new recipe is there.

+
+
+
+

(6) Delete merged branches

+

Before deleting branches, first check whether they are merged.

+

If you delete an un-merged branch, it will be difficult to find the commits +that were on that branch. If you delete a merged branch, the commits are now +also part of the branch where we have merged to.

+
+

One way to delete the branch is to click on the “Delete branch” button after the pull +request is merged:

+
+Screenshot on GitHub suggesting us to delete a branch after it has been merged. +
+

But what if we forgot? Then navigate to the branch view:

+
+Screenshot on GitHub where we navigate to the branches view. +
+

In the overview we can see that it has been merged and we can delete it:

+
+Screenshot on GitHub where we see an overview of branches and can delete them. +
+
+
+
+

(7) Contribute to the original repository with a pull request

+

Remember, this is an advanced step. If you do this, you are donating +a recipe to everyone.

+
+

Now that you know how to create branches and opening a pull request, try to +open a new pull request with a new change but this time the base repository +should be the upstream one.

+

In other words, you now send a pull request across repositories: from your fork +to the original repository.

+

Another thing that is different now is that you might not have permissions to +merge the pull request. We can then together review and browse the pull +request.

+
+
+
+
+

Resolving a conflict (demonstration)

+

A conflict is when Git asks humans to decide during a merge which of two +changes to keep if the same portion of a file has been changed in two different +ways on two different branches.

+

We will practice conflict resolution in the collaborative Git +lesson.

+

Here we will only demonstrate how to create a conflict and how to resolve it, +all on GitHub. Once we understand how this works, we will be more confident to +resolve conflicts also in the command line.

+

How to create a conflict (please try this in your own time and just watch now):

+
    +

  • Create a new branch from main and on it make a change to a file.

    • +

  • On main, make a different change to the same part of the same file.

    • +

  • Now try to merge the new branch to main. You will get a conflict.

    • +
+

How to resolve conflicts:

+
    +

  • On GitHub, you can resolve conflicts by clicking on the “Resolve conflicts” +button. This will open a text editor where you can choose which changes to +keep. +Make sure to remove the conflict markers. +After resolving the conflict, you can commit the changes and merge the +pull request.

    • +

  • Sometimes a conflict is between your change and somebody else’s change. In +that case, you might have to discuss with the other person which changes to +keep.

    • +
+

How to avoid conflicts:

+ +
+
+

Summary

+
    +

  • We learned how to merge two branches together.

    • +

  • When is this useful? This is not only useful to combine development lines in +your own work. Being able to merge branches also forms a basis for collaboration.

    • +

  • Branches which are merged to other branches are safe to delete, since we only +delete the “sticky note” next to a commit, not the commits themselves.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/motivation/index.html b/branch/main/motivation/index.html new file mode 100644 index 00000000..194c9d9c --- /dev/null +++ b/branch/main/motivation/index.html @@ -0,0 +1,363 @@ + + + + + + + Motivation — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Motivation

+
+

Objectives

+
    +

  • Make sure nobody leaves the workshop without starting to use some form of version control.

    • +

  • Discuss the reasons why we advocate distributed version control.

    • +
+
+
+

Instructor note

+
    +

  • 15 min discussion/demonstration

    • +
+
+
+

Git is all about keeping track of changes

+

We will learn how to keep track of changes first in the web browser. +Below are screenshots of tracked changes with Git +(from this example repository):

+
+Screenshot of a git log on GitHub +
+

Web browser, GitHub view

+
+
+

Later also using the terminal or the editor +(the same example repository):

+
+Screenshot of a git log in terminal +
+

The same as above, but the terminal view

+
+
+
+
+

Why do we need to keep track of versions?

+

Problem: If you have to identify and find your code from 17 days +ago, can you?

+

Version control is an answer to the following questions (do you recognize some +of them?):

+
    +

  • “It broke … hopefully I have a working version somewhere?”

    • +

  • “Can you please send me the latest version?”

    • +

  • “Where is the latest version?”

    • +

  • “Which version are you using?”

    • +

  • “Which version have the authors used in the paper I am trying to reproduce?”

    • +

  • “Found a bug! Since when was it there?”

    • +

  • “I am sure it used to work. When did it change?”

    • +

  • “My laptop is gone. Is my thesis now gone?”

    • +
+
+
+

Features: roll-back, branching, merging, collaboration

+

Problem: Your code worked two days ago, but is giving an error now. +You don’t know what you changed.

+

Problem: You and your colleague want to work on the same code at the +same time.

+
    +

  • Roll-back: you can always go back to a previous version and compare

    • +

  • Branching and merging:

    +
      +

    • Work on different ideas at the same time

      • +

    • Different people can work on the same code/project without interfering

      • +

    • You can experiment with an idea and discard it if it turns out to be a bad idea

      • +
    +
    • +
+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+ +
+
+

Reproducibility

+

Problem: Someone asks you about your results from 5 years ago. Can +you get the same results now?

+
    +

  • How do you indicate which version of your code you have used in your paper?

    • +

  • When you find a bug, how do you know when precisely this bug was introduced +(Are published results affected? Do you need to inform collaborators or users of your code?).

    • +
+

With version control we can “annotate” code +(browse this example online):

+
+Example of a git-annotated code with code and history side-by-side +
+

Example of a git-annotated code with code and history side-by-side.

+
+
+
+
+

Talking about code

+

Problem: You want to show someone a few lines from one of your projects.

+

Which of these two is more practical?

+
    +

  • “Clone the code, go to the file ‘src/util.rs’, and search for ‘time_iso8601’”. +Oh! But make sure you use the version from August 2023.”

    • +

  • Or I can send you a permalink:

    • +
+
+Screen-shot of a code portion +
+

Permalink that points to a code portion.

+
+
+
+
+

What we typically like to snapshot

+
    +

  • Software (this is how it started but Git/GitHub can track a lot more)

    • +

  • Scripts

    • +

  • Documents (plain text files much better suitable than Word documents)

    • +

  • Manuscripts (Git is great for collaborating/sharing LaTeX or Quarto manuscripts)

    • +

  • Configuration files

    • +

  • Website sources

    • +

  • Data

    • +
+
+

Discussion

+

In this example somebody tried to keep track of versions without a version +control system tool like Git. Discuss the following directory listing. What +possible problems do you anticipate with this kind of “version control”:

+
myproject-2019.zip
+myproject-2020-February.zip
+myproject-2021-August.zip
+myproject-2023-09-19-working.zip
+myproject-2023-09-21.zip
+myproject-2023-09-21-test.zip
+myproject-2023-09-21-myversion.zip
+myproject-2023-09-21-newfeature.zip
+...
+
+
+ +
+
+
+

Difficulties of version control

+

Despite the benefits, let’s be honest, there are some difficulties:

+
    +

  • One more thing to learn (it’s probably worth it and will save you more time in the long run; basic career skill).

    • +

  • Difficult if your collaborators don’t want to use it (in the worst case, you can version control on your side and email them versions).

    • +

  • Advanced things can be difficult, but basics are often enough (ask others for help when needed).

    • +
+
+
+

Why Git and not another tool?

+
    +

  • Easy to set up: no server needed.

    • +

  • Very popular: chances are high you will need to contribute to somebody else’s code which is tracked with Git.

    • +

  • Distributed: good backup, no single point of failure, you can track and +clean-up changes offline, simplifies collaboration model for open-source +projects.

    • +

  • Important platforms such as GitHub, GitLab, and Bitbucket +build on top of Git.

    • +
+

However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +Subversion, +Mercurial, Pijul, or others.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/objects.inv b/branch/main/objects.inv new file mode 100644 index 00000000..47d7569a Binary files /dev/null and b/branch/main/objects.inv differ diff --git a/branch/main/recovering/index.html b/branch/main/recovering/index.html new file mode 100644 index 00000000..fa94eedd --- /dev/null +++ b/branch/main/recovering/index.html @@ -0,0 +1,450 @@ + + + + + + + Undoing and recovering — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Undoing and recovering

+
+

Objectives

+
    +

  • Learn to undo changes safely

    • +

  • See when undone changes are permanently deleted and when they can be retrieved

    • +
+
+
+

Instructor note

+
    +

  • 25 min teaching/type-along

    • +

  • 25 min exercise

    • +
+
+

One of the main points of version control is that you can go back in +time to recover. Unlike this xkcd comic implies: https://xkcd.com/1597/

+

In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn’t a “commit” permanent?

+
    +

  • You can modify old commit history.

    • +

  • But if you have shared that history already, modifying it can make +a huge mess.

    • +
+
+

It is almost always possible to recover

+

As long as you commit something once (or at least git add it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru… until that guru becomes you.

+
+
+

Nice resource to visually simulate Git operation

+

git-sim +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command.

+
+
+
+

Undoing your recent, uncommitted and unstaged changes (preserves history)

+
+

Note

+

In case git restore does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git restore.

+
+

You do some work, and want to undo your uncommitted and unstaged modifications. +You can always do that with:

+
    +

  • git restore . (the dot means “here and in all folders below”)

    • +
+

You can also undo things selectively:

+
    +

  • git restore -p (decide which portions of changes to undo) or git restore PATH (decide which path/file)

    • +
+

If you have staged changes, you have at least two options to undo the staging:

+
    +

  • git restore --staged . followed by git status and git restore .

    • +

  • git reset --hard HEAD throws away everything that is not in last +commit (HEAD - this literal word, this isn’t a placeholder)

    • +
+
+
+
+

Reverting commits (preserves history)

+

Imagine we made a few commits. +We realize that the latest commit e02efcd was a mistake and we wish to undo it:

+
$ git log --oneline
+
+e02efcd (HEAD -> main) not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

A safe way to undo the commit is to revert the commit with git revert:

+
$ git revert e02efcd
+
+
+

This creates a new commit that does the opposite of the reverted commit. +The old commit remains in the history:

+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

You can revert any commit, no matter how old it is. It doesn’t affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we’ll learn about later).

+
+

Exercise: Revert a commit

+
+

Undoing-1: Revert a commit

+
    +

  • Create a commit (commit A).

    • +

  • Revert the commit with git revert (commit B).

    • +

  • Inspect the history with git log --oneline.

    • +

  • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

    • +
+
+
+
+
+

Adding to the previous commit (modifies history)

+

Sometimes we commit but realize we forgot something. +We can amend to the last commit:

+
$ git commit --amend
+
+
+

This can also be used to modify the last commit message.

+

Note that this will change the commit hash. This command modifies the history. +This means that we avoid this command on commits that we have shared with others.

+
+

Exercise: Modify a previous commit

+
+

Undoing-2: Modify a previous commit

+
    +

  1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

    2. +

  2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

    3. +

  3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

    4. +
+ +
+
+
+
+

Rewinding branches (modifies history)

+

You can reset branch history to move your branch back to some +point in the past.

+
    +

  • git reset --hard HASH will force a branch label to any other point. All +other changes are lost (but it is possible to recover if you force reset by mistake).

    • +

  • Be careful if you do this - it can mess stuff up. Use git graph a +lot before and after.

    • +
+
+

Exercise: Git reset

+
+

Undoing-3: Destroy our experimentation in this episode

+

After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

+
    +

  • First, we will look at our history (git log/git graph) and +find the last commit HASH before our tests.

    • +

  • Then, we will git reset --hard HASH to that.

    • +

  • Then, git graph again to see what happened.

    • +
+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+$ git reset --hard b4af65b
+
+HEAD is now at b4af65b improve the documentation
+
+$ git log --oneline
+
+b4af65b (HEAD -> main) improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+
+
+
+
+
+

Recovering from committing to the wrong branch

+

It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes.

+

Here we assume that we made a couple of commits but we realize they went to the +wrong branch.

+

Solution 1 using git cherry-pick:

+
    +

  1. Make sure that the correct branch exists and if not, create it. Make sure to +create it from the commit hash where you wish you had created it from: git branch BRANCHNAME HASH

    2. +

  2. Switch to the correct branch.

    3. +

  3. git cherry-pick HASH can be used to take a specific commit to the +current branch. Cherry-pick all commits that should have gone to the correct +branch, from oldest to most recent.

    4. +

  4. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    5. +
+

Solution 2 using git reset --hard (makes sense if the correct branch should +contain all commits of the accidentally modified branch):

+
    +

  1. Create the correct branch, pointing at the latest commit: git branch BRANCHNAME.

    2. +

  2. Check with git log or git graph that both branches point to the same, latest, commit.

    3. +

  3. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    4. +
+
+
+

Recovering from merging/pulling into the wrong branch

+

git merge, git rebase, and git pull modify the current branch, never +the other branch. But sometimes we run this command on the wrong branch.

+
    +

  1. Check with git log the commit hash that you would like to rewind the +wrongly modified branch to.

    2. +

  2. Rewind the branch that accidentally got wrong commits with git reset --hard HASH (see also above).

    3. +
+
+
+

Recovering from conflict after pulling changes

+

Pulling changes with +git pull can create a conflict since git pull always also includes a git merge (more about this +in the collaborative Git lesson).

+

The recovery is same as described in Conflict resolution. Either +resolve conflicts or abort the merge with git merge --abort.

+
+
+

Undoing-4: Test your understanding

+
    +

  1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

    2. +

  2. Is it OK to modify commits that nobody has seen yet?

    3. +

  3. What situations would justify to modify the Git history and possibly remove commits?

    4. +
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/reference/index.html b/branch/main/reference/index.html new file mode 100644 index 00000000..e10a03f0 --- /dev/null +++ b/branch/main/reference/index.html @@ -0,0 +1,319 @@ + + + + + + + Quick reference — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Quick reference

+
+

Other cheatsheets

+ +
+
+

Glossary

+
+
alias

With aliases you can define your own shortcuts for Git commands.

+
+
version control system

A system that records changes to a file or set of files over time so that +you can recall specific versions later.

+
+
git

Implementation of a version control system. Currently the most popular one.

+
+
commit

As a verb, the process of recording more changes. +As a noun, the name of the record of changes. +A commit is identified by something such as 554c187.

+
+
working directory
workspace

the actual files you see and edit

+
+
staging area

Place files go after git add and before git commit

+
+
hash

Unique reference of any commit or state. Comes from hash +functions such as MD5 +or SHA1.

+
+
branch

One line of work. Different branches can exist at the same time +and split/merge. Committing on a branch updates that branch.

+
+
tag

Like a branch in that it points to a commit for reference. +It is designed to be permanent an not updated.

+
+
HEAD

Pointer to the most recent commit on the current branch.

+
+
remote

Roughly, another server that holds .git.

+
+
origin

Default name for a remote repository.

+
+
repository

One collection of files managed by Git. It contains entire history +of all files managed by git. GitHub has one repository as one +GitHub repository. VS Code has one repository as one directory you +can open. The command line has one repository as one directory.

+
+
clone

As a verb, the process of making a copy of a repository locally. +It brings in all history and all files. (As a noun, the copy that +was made when cloning).

+
+
GitHub repository

The files from the Git repository, but also other things from +GitHub such as access permissions, issues, and pull requests.

+
+
upstream

The original repository from which the code comes. If you +fork the repository, it is your upstream and it is easy to +send changes back to there.

+
+
fork

As a noun: a one person’s copy of a repository. +As a verb: making that copy. +As a verb on GitHub: Making a copy of a repository linked to the +original. It is easy to send changes to the original

+
+
issue

Within a web repository like GitHub, discussion of a topic, for +example a problem or improvement suggestion. These are a property +of the web platform and not of the Git program itself.

+
+
pull request

A GitHub concept: change proposal. A proposal to merge one branch +into another. Usually used to contribute code back to +upstream.

+
+
push

Moving changes from your local copy to another copy

+
+
pull

Getting changes from another copy to your own copy. git pull +does this fetch, and also tries to automatically merge.

+
+
master

Default name for main branch on Git. Depending on the configuration and service, +the default branch is sometimes main. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

+
+
main

Default name for main branch on GitLab and GitHub. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

+
+
merge
merging

Bringing changes from one branch into another, either as a noun or +verb.

+
+
VS Code

A text editor and development environment by Microsoft. It’s quite +popular, partly because it is powerful and easy to use. VS +Codium is the same but without Microsoft +tracking.

+
+
+
+
+

Commands we use

+

Setup:

+
    +

  • git config: edit configuration options

    • +

  • git init -b main: create new repository with main as the default branch

    • +
+

See our status:

+
    +

  • git status: see status of files - use often!

    • +

  • git log: see history of commits and their messages, newest first

    • +

  • git graph: see a detailed graph of commits. Create this command +with git config --global alias.graph "log --all --graph --decorate --oneline"

    • +

  • git diff: show difference between working directory and last commit

    • +

  • git diff --staged: show difference between staging area and last commit

    • +

  • git show COMMIT: inspect individual commits

    • +
+

General work:

+
    +

  • git add FILE:

    +
      +

    • Add a new file

      • +

    • Add a file to staging

      • +
    +
    • +

  • git commit: record a version, add it to current branch

    • +

  • git commit --amend: amend our last commit

    • +

  • git branch: show which branch we’re on

    • +

  • git branch NAME: create a new branch called “name”

    • +

  • git restore FILE: restore last committed/staged version of FILE, losing unstaged changes

    • +

  • git switch --create BRANCH-NAME: create a new branch and switch to it

    • +

  • git revert HASH: create a new commit which reverts commit HASH

    • +

  • git reset --soft HASH: remove all commits after HASH, but keep their modifications as staged changes

    • +

  • git reset --hard HASH: remove all commits after HASH, permanently throwing away their changes

    • +

  • git merge BRANCH-NAME: merge branch BRANCH-NAME into current branch

    • +

  • git grep PATTERN: search for patterns in tracked files

    • +

  • git annotate FILE: find out when a specific line got introduced and by whom

    • +

  • git bisect: find a commit which broke some functionality

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/resources/index.html b/branch/main/resources/index.html new file mode 100644 index 00000000..f4c8d5d7 --- /dev/null +++ b/branch/main/resources/index.html @@ -0,0 +1,190 @@ + + + + + + + Other resources — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/search/index.html b/branch/main/search/index.html new file mode 100644 index 00000000..bfb1ef09 --- /dev/null +++ b/branch/main/search/index.html @@ -0,0 +1,191 @@ + + + + + + Search — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/branch/main/searchindex.js b/branch/main/searchindex.js new file mode 100644 index 00000000..f851ca39 --- /dev/null +++ b/branch/main/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["aliases", "archaeology", "basics", "branches", "browsing", "commits", "configuration", "conflicts", "customizing", "exercises", "guide", "index", "interrupted", "level", "local-workflow", "merging", "motivation", "recovering", "reference", "resources", "sharing", "staging-area", "under-the-hood", "what-to-avoid"], "filenames": ["aliases.md", "archaeology.md", "basics.md", "branches.md", "browsing.md", "commits.md", "configuration.md", "conflicts.md", "customizing.md", "exercises.md", "guide.md", "index.md", "interrupted.md", "level.md", "local-workflow.md", "merging.md", "motivation.md", "recovering.md", "reference.md", "resources.md", "sharing.md", "staging-area.md", "under-the-hood.md", "what-to-avoid.md"], "titles": ["Aliases and configuration", "Inspecting history", "Basics", "Branching and merging", "Copy and browse an existing project", "Committing changes", "Configuring Git command line and editor", "Conflict resolution", "Customizing Git", "List of exercises", "Instructor guide", "Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version", "Interrupted work", "Practical advice: how much Git is necessary?", "Cloning a Git repository and working locally", "Merging changes and contributing to the project", "Motivation", "Undoing and recovering", "Quick reference", "Other resources", "How to turn your project to a Git repo and share it", "Using the Git staging area", "Git under the hood", "What to avoid"], "terms": {"learn": [0, 2, 3, 12, 13, 14, 15, 16, 17, 19, 20, 21, 22], "most": [0, 1, 4, 5, 6, 7, 10, 11, 12, 14, 15, 17, 18, 21, 23], "common": [0, 4, 5, 10, 17, 23], "ar": [0, 1, 2, 3, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 20, 21, 22, 23], "you": [0, 2, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23], "get": [0, 2, 4, 5, 6, 7, 9, 10, 13, 14, 15, 16, 17, 18, 20, 21, 23], "tire": 0, "type": [0, 1, 3, 4, 7, 9, 10, 12, 14, 15, 17, 20, 21, 22], "so": [0, 1, 2, 3, 5, 9, 10, 12, 13, 14, 18, 20, 21, 22, 23], "much": [0, 4, 8, 11, 12, 15, 16], "In": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 14, 15, 16, 17, 18, 20, 21, 22, 23], "can": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23], "defin": [0, 1, 3, 4, 5, 6, 9, 14, 18, 21], "shortcut": [0, 3, 14, 18], "These": [0, 2, 4, 6, 10, 18, 23], "great": [0, 2, 13, 16, 21], "becaus": [0, 2, 5, 7, 11, 12, 15, 18, 23], "thei": [0, 2, 3, 4, 5, 9, 10, 13, 15, 17, 21, 22], "save": [0, 2, 6, 9, 12, 13, 16, 21, 22], "time": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 20, 21, 22], "But": [0, 1, 2, 3, 4, 6, 7, 9, 10, 12, 13, 14, 15, 16, 17, 20, 21, 23], "": [0, 1, 2, 3, 4, 5, 7, 9, 10, 13, 15, 16, 18, 20, 21], "easi": [0, 1, 2, 4, 5, 8, 9, 10, 16, 17, 18, 20], "forget": [0, 2, 3, 5, 9, 15, 17], "them": [0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 15, 16, 17, 21], "confus": [0, 2, 3, 10], "inconsist": 0, "your": [0, 1, 4, 6, 7, 8, 12, 13, 14, 16, 18, 21, 22, 23], "colleagu": [0, 7, 12, 16], "There": [0, 2, 3, 5, 6, 7, 9, 10, 12, 13, 15, 20, 23], "i": [0, 1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 15, 18, 23], "plenti": 0, "other": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 20, 21, 22], "make": [0, 1, 2, 3, 4, 7, 8, 10, 12, 13, 14, 15, 16, 17, 18, 20, 23], "nicer": 0, "offer": [0, 1, 4, 5, 9, 10, 11, 14, 15, 20], "wai": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 13, 14, 15, 17, 21, 23], "improv": [0, 2, 3, 8, 9, 13, 17, 18, 23], "usabl": 0, "ci": 0, "instead": [0, 1, 2, 4, 6, 7, 17, 20, 23], "commit": [0, 7, 10, 11, 12, 15, 18, 19, 20, 22, 23], "base": [0, 2, 9, 11, 13, 14, 15, 22], "simpl": [0, 4, 9, 10, 11, 13, 20], "string": [0, 1, 22], "replac": [0, 2, 5, 6, 9, 14, 20, 21], "either": [0, 2, 9, 12, 17, 18, 20], "specif": [0, 1, 2, 5, 9, 10, 15, 17, 18], "repositori": [0, 3, 5, 6, 7, 10, 11, 12, 13, 16, 17, 18, 21, 22, 23], "global": [0, 2, 3, 6, 7, 9, 14, 18], "help": [0, 2, 7, 9, 10, 13, 16, 20, 21, 23], "do": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 17, 20, 21, 22, 23], "thing": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 13, 14, 15, 16, 17, 18, 21, 23], "across": [0, 9, 15], "project": [0, 1, 2, 3, 5, 7, 8, 10, 14, 16, 19, 21, 23], "per": [0, 19], "also": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23], "creat": [0, 1, 6, 13, 16, 17, 18, 20, 21, 22], "store": [0, 2, 4, 9, 14, 20, 21, 22], "gitconfig": [0, 6, 10], "A": [0, 2, 3, 4, 5, 7, 9, 10, 13, 15, 17, 18, 19, 20, 21, 22], "veri": [0, 2, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 20, 21, 22], "which": [0, 1, 2, 3, 5, 6, 7, 9, 10, 12, 14, 15, 16, 17, 18, 20, 21, 22, 23], "we": [0, 1, 2, 3, 4, 5, 6, 7, 9, 12, 15, 17, 20, 21, 22, 23], "lot": [0, 2, 9, 12, 16, 17, 23], "our": [0, 2, 3, 4, 5, 6, 10, 11, 14, 15, 18, 20], "workshop": [0, 2, 5, 10, 15, 16], "config": [0, 2, 3, 6, 7, 9, 10, 14, 18, 22], "log": [0, 1, 3, 4, 5, 6, 9, 14, 15, 17, 18, 20, 21, 22], "all": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 20, 21, 22, 23], "decor": [0, 3, 4, 5, 6, 14, 18], "onelin": [0, 1, 2, 3, 4, 5, 6, 9, 14, 15, 17, 18], "cd": [0, 1, 2, 3, 4, 7, 9, 22], "your_git_repositori": 0, "It": [0, 1, 2, 4, 7, 8, 9, 10, 12, 13, 14, 15, 16, 18, 20, 21, 23], "possibl": [0, 1, 2, 8, 9, 13, 14, 15, 16], "call": [0, 1, 2, 3, 4, 5, 6, 7, 9, 14, 15, 18, 20], "exclam": 0, "mark": [0, 5, 7, 13], "charact": [0, 2, 3, 22], "thi": [0, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13, 14, 15, 16, 18, 20, 21, 22, 23], "here": [0, 1, 2, 3, 5, 6, 8, 9, 10, 15, 17, 20, 21], "local": [0, 1, 2, 3, 4, 6, 10, 11, 15, 17, 18, 20], "synchron": 0, "remot": [0, 3, 6, 7, 9, 10, 11, 18], "hi": [0, 6], "echo": 0, "hello": 0, "how": [0, 2, 3, 5, 6, 7, 8, 10, 12, 15, 16, 17, 21, 22], "mani": [0, 1, 2, 6, 9, 10, 13, 15, 20, 21, 23], "should": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 14, 15, 17, 20, 21, 23], "wait": [0, 23], "befor": [0, 1, 2, 3, 4, 5, 7, 9, 10, 12, 13, 14, 15, 17, 18, 21, 23], "believ": 0, "gener": [0, 2, 9, 10, 13, 18, 23], "two": [0, 2, 3, 4, 6, 7, 10, 12, 14, 15, 16, 17, 20, 22], "letter": [0, 3], "acronym": 0, "welcom": [0, 4, 10], "reus": [0, 9, 11, 20], "suggest": [0, 2, 18], "see": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 14, 15, 17, 18, 20, 21, 22, 23], "current": [0, 1, 3, 5, 7, 9, 11, 12, 14, 15, 17, 18, 20, 21], "ap": 0, "add": [0, 2, 3, 4, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18, 20, 21, 23], "patch": [0, 9, 12, 21], "br": 0, "branch": [0, 1, 2, 4, 10, 11, 18, 19, 20, 23], "v": [0, 5, 7, 9, 14, 15, 18, 20, 21], "cip": 0, "cl": 0, "clone": [0, 1, 3, 4, 6, 7, 10, 11, 12, 16, 18], "recurs": [0, 7, 22], "di": 0, "diff": [0, 5, 7, 10, 12, 18, 21], "dic": 0, "stage": [0, 2, 3, 7, 10, 11, 12, 14, 17, 18], "color": 0, "word": [0, 3, 4, 8, 9, 15, 16, 17], "diw": 0, "pager": [0, 8], "stat": [0, 2, 9], "fe": 0, "fetch": [0, 9, 14, 18], "rem": 0, "st": 0, "statu": [0, 1, 2, 7, 9, 10, 12, 14, 15, 17, 18, 21, 22], "su": 0, "submodul": 0, "updat": [0, 7, 10, 18, 23], "init": [0, 2, 6, 9, 10, 18, 20], "what": [0, 3, 4, 5, 7, 9, 10, 11, 12, 15, 17, 20, 21, 22], "select": [0, 1, 4, 6, 9, 14, 15, 17, 21], "part": [0, 2, 3, 5, 6, 7, 9, 15, 20], "individu": [0, 2, 18, 21], "interact": [0, 11, 14, 18], "obviou": [0, 23], "check": [0, 1, 2, 6, 7, 9, 10, 12, 15, 17, 20, 21, 22, 23], "option": [0, 4, 6, 14, 15, 17, 18, 20, 21], "clariti": [0, 6], "an": [0, 1, 2, 5, 6, 7, 10, 12, 14, 15, 16, 17, 18, 19, 20, 22, 23], "topic": [0, 18], "area": [0, 2, 10, 11, 12, 13, 18, 22], "last": [0, 1, 7, 9, 12, 14, 15, 17, 18, 21], "about": [0, 2, 3, 4, 5, 6, 7, 8, 9, 14, 15, 17, 20, 21, 22], "small": [0, 2, 13, 20, 21, 23], "chang": [0, 3, 6, 10, 11, 12, 13, 14, 18, 20, 21, 22, 23], "diffstat": 0, "file": [0, 1, 3, 4, 5, 6, 7, 9, 12, 14, 15, 16, 17, 18, 20, 21, 22, 23], "content": [0, 2, 7, 9], "show": [0, 1, 3, 4, 5, 6, 7, 10, 12, 14, 15, 16, 17, 18], "whole": [0, 2, 4, 10, 11], "some": [0, 1, 2, 3, 4, 5, 7, 10, 13, 15, 16, 17, 18, 21, 23], "u": [0, 1, 2, 3, 4, 5, 7, 9, 12, 15, 17, 20, 21, 22], "l": [0, 9, 20, 22], "set": [0, 2, 3, 6, 9, 10, 15, 16, 18, 20], "p": [0, 12, 13, 17, 21, 22], "singlekei": 0, "true": [0, 15, 23], "won": [0, 7], "t": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 14, 15, 16, 17, 20, 21, 22, 23], "explain": [0, 2, 7, 9, 10, 11, 21, 23], "bore": 0, "have": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 14, 15, 16, 17, 20, 21, 22, 23], "want": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 14, 15, 16, 17, 20, 21], "go": [0, 1, 2, 3, 4, 5, 7, 9, 10, 15, 16, 17, 18, 20, 21, 22], "deeper": 0, "try": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 15, 16, 17, 20], "figur": [0, 2, 7, 14], "out": [0, 2, 3, 4, 5, 7, 9, 10, 13, 14, 16, 18, 21], "might": [0, 3, 4, 6, 7, 9, 12, 13, 14, 15, 17, 20], "manual": [0, 3, 7, 9, 10, 22], "page": [0, 1, 2, 4, 5, 6, 9, 18, 20, 23], "cif": 0, "fixup": 0, "rb": 0, "rebas": [0, 10, 12, 17], "autosquash": 0, "rbi": 0, "autostash": 0, "rec": 0, "upstream": [0, 7, 9, 15, 18], "head": [0, 2, 3, 5, 7, 9, 14, 17, 18, 21, 22], "ignor": [0, 23], "o": 0, "exclud": 0, "standard": [0, 4, 10], "new": [0, 1, 2, 3, 4, 6, 7, 9, 10, 13, 14, 15, 17, 18, 20, 21, 22, 23], "newd": 0, "newdi": 0, "reca": 0, "n10": 0, "recd": 0, "besid": 0, "ones": [0, 15, 21], "core": [0, 2, 6, 20], "less": [0, 1, 3, 7, 9, 12], "r": [0, 16, 22], "excludesfil": 0, "gitignor": [0, 9, 20, 23], "merg": [0, 4, 5, 8, 10, 11, 12, 13, 18, 23], "conflictstyl": 0, "diff3": 0, "wordregex": 0, "za": 0, "z0": 0, "9_": 0, "space": [0, 1, 5], "mnemonicprefix": 0, "copi": [0, 2, 5, 10, 11, 12, 14, 18, 20], "past": [0, 4, 9, 14, 17, 20], "name": [0, 1, 2, 3, 4, 5, 9, 12, 14, 15, 18, 20, 21], "like": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 17, 18, 20, 21, 22], "github": [0, 2, 5, 7, 8, 9, 10, 11, 15, 16, 17, 18], "com": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 17, 20], "myusernam": 0, "url": [0, 1, 4, 5, 6, 9, 14], "insteadof": 0, "gh": 0, "usernam": [0, 4, 5, 6, 14], "ghu": 0, "Then": [0, 1, 3, 5, 7, 9, 14, 15, 17, 20, 22], "recip": [0, 3, 7, 9, 10, 14, 15, 17, 21], "automat": [0, 1, 2, 5, 7, 9, 14, 18, 23], "translat": [0, 1, 6], "prefix": 0, "match": [0, 4], "If": [0, 1, 2, 4, 5, 6, 9, 11, 13, 14, 15, 16, 17, 18, 20], "frustrat": [0, 15], "rememb": [0, 2, 3, 4, 6, 7, 9, 13, 14, 15, 17], "Be": [1, 3, 17, 20], "abl": [1, 2, 3, 6, 7, 9, 10, 11, 14, 15, 20], "why": [1, 2, 3, 9, 13, 22, 23], "wa": [1, 2, 3, 7, 9, 10, 13, 16, 17, 18, 23], "introduc": [1, 4, 9, 10, 16, 18], "quickli": 1, "behavior": [1, 2], "30": [1, 3, 10], "teach": [1, 2, 3, 7, 9, 11, 12, 13, 17, 21, 22], "along": [1, 3, 4, 7, 10, 12, 17, 21, 22], "As": [1, 2, 3, 9, 17, 18], "usual": [1, 4, 6, 14, 18], "power": [1, 9, 18, 20], "rel": [1, 2], "mai": [1, 2, 3, 5, 6, 7, 10, 13, 17, 23], "haven": [1, 2, 9, 10, 14, 15, 17, 23], "tri": [1, 9, 16, 18, 20], "yet": [1, 2, 5, 9, 10, 15, 17, 20], "d": [1, 3, 15], "recommend": [1, 2, 4, 5, 6, 10, 11, 14, 15], "give": [1, 2, 3, 4, 6, 7, 9, 10, 12, 15, 16, 21], "The": [1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 22, 23], "web": [1, 2, 6, 9, 11, 14, 16, 18, 20], "interfac": [1, 3, 5, 6, 9, 14, 20], "allow": [1, 8, 9, 11, 15], "done": [1, 2, 3, 4, 5, 7, 9, 10, 14, 15, 17, 20, 21, 23], "everyth": [1, 2, 7, 11, 12, 17, 21, 22], "easier": [1, 3, 5, 13, 14, 15, 23], "open": [1, 2, 4, 5, 7, 9, 14, 15, 16, 18, 20, 22], "termin": [1, 3, 4, 5, 6, 9, 11, 14, 16, 17, 20], "run": [1, 2, 3, 4, 7, 9, 10, 16, 17, 20, 21, 23], "first": [1, 2, 3, 4, 5, 7, 9, 10, 12, 13, 14, 15, 16, 17, 18, 20, 22, 23], "demonstr": [1, 3, 4, 5, 8, 9, 10, 11, 14, 16], "few": [1, 3, 4, 8, 9, 10, 12, 13, 15, 16, 17, 20, 22, 23], "real": [1, 4, 9, 12, 20], "life": 1, "exampl": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 20, 21], "http": [1, 2, 3, 4, 5, 7, 8, 9, 10, 13, 14, 16, 17, 20, 21], "networkx": [1, 9], "mention": [1, 2, 3, 9], "amaz": 1, "site": [1, 20], "program": [1, 2, 7, 18], "historian": 1, "later": [1, 2, 4, 5, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 23], "practic": [1, 2, 3, 7, 10, 11, 14, 15, 16, 19], "below": [1, 2, 3, 4, 5, 7, 9, 10, 12, 14, 15, 16, 17, 20], "readm": [1, 2, 3, 5, 9, 17, 20], "rst": 1, "visit": [1, 2, 9], "brows": [1, 2, 10, 11, 13, 15, 16], "githistori": 1, "xyz": 1, "blob": [1, 22], "main": [1, 2, 3, 4, 6, 7, 9, 12, 13, 14, 15, 17, 18, 20, 22], "left": [1, 2, 3, 4, 5, 7, 9, 12, 14], "right": [1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 14, 15, 20, 21, 22], "kei": [1, 6, 10, 21], "too": [1, 2, 3, 4, 10, 13, 23], "With": [1, 2, 3, 5, 9, 11, 12, 14, 16, 18], "grep": [1, 4, 8, 9, 18], "contain": [1, 2, 3, 9, 13, 14, 15, 17, 18, 20, 22], "regular": [1, 3], "express": 1, "where": [1, 2, 3, 4, 5, 6, 7, 9, 12, 13, 14, 15, 16, 17, 21, 23], "variabl": [1, 4], "error": [1, 9, 16, 20], "messag": [1, 3, 4, 5, 9, 10, 14, 17, 18, 22, 23], "print": [1, 3, 5, 9, 12, 21], "describ": [1, 4, 5, 15, 17, 23], "abov": [1, 2, 4, 5, 7, 9, 12, 14, 15, 16, 17, 20, 21], "fixm": 1, "while": [1, 3, 9, 12], "state": [1, 2, 3, 7, 8, 9, 10, 12, 17, 18, 21, 22], "through": [1, 2, 6, 10, 11, 21], "sometext": 1, "got": [1, 2, 5, 9, 17, 18, 21], "remov": [1, 2, 3, 7, 9, 15, 17, 18, 20, 21, 23], "same": [1, 2, 3, 5, 7, 9, 10, 12, 14, 15, 16, 17, 18, 20, 21], "q": [1, 2, 10, 21], "repo": [1, 4, 10, 11, 14, 17], "3anetworkx": 1, "2fnetworkx": 1, "from": [1, 2, 3, 4, 5, 6, 7, 9, 11, 13, 15, 16, 18, 20, 21, 22, 23], "window": [1, 2, 4, 6, 9], "enter": [1, 4, 5, 6, 9, 14], "magnifi": [1, 4], "glass": 1, "sidebar": [1, 4, 5, 14, 15], "equival": [1, 4], "seen": [1, 2, 9, 17], "one": [1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 13, 14, 15, 16, 18, 20, 21], "alreadi": [1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 14, 17, 20, 23], "know": [1, 2, 3, 4, 6, 7, 9, 10, 12, 13, 15, 16, 21], "its": [1, 6, 10, 20, 22], "hash": [1, 2, 3, 5, 9, 12, 14, 17, 18, 22], "For": [1, 2, 3, 5, 6, 9, 10, 14, 15, 17, 20, 22, 23], "instanc": [1, 3, 4, 7, 9, 14], "759d589bdfa61aff99e0535938f14f67b01c83f7": 1, "don": [1, 2, 3, 4, 5, 6, 7, 9, 14, 15, 16, 17, 20, 23], "built": 1, "everi": [1, 2, 4, 9, 10, 21], "singl": [1, 3, 4, 5, 9, 16, 17], "order": [1, 2, 9, 12, 21, 22], "extens": [1, 3, 4, 5, 14, 23], "timelin": [1, 4, 9], "view": [1, 3, 4, 5, 7, 8, 9, 10, 14, 15, 16], "under": [1, 2, 4, 5, 9, 11, 14, 20], "click": [1, 2, 4, 5, 9, 14, 15, 20], "detail": [1, 2, 3, 13, 18, 20], "who": [1, 6, 7, 9, 10, 11], "modifi": [1, 2, 7, 12, 14, 15, 21, 22], "precis": [1, 10, 15, 16], "each": [1, 2, 5, 6, 9, 10, 14, 21, 22], "incredibli": 1, "reproduc": [1, 10], "convert_matrix": 1, "py": [1, 9, 20], "longer": [1, 6, 13, 23], "than": [1, 2, 3, 4, 7, 9, 13, 16, 17, 20, 23], "screen": [1, 4, 14], "default": [1, 2, 4, 5, 9, 15, 18, 20], "scroll": [1, 15], "output": [1, 2, 4, 9, 14], "cycl": 1, "result": [1, 3, 7, 9, 10, 14, 16], "n": [1, 7, 9, 21], "next": [1, 2, 3, 4, 5, 9, 14, 15, 20, 21], "down": [1, 9, 15, 17], "quit": [1, 2, 9, 18, 20], "blame": [1, 4, 9, 10], "screenshot": [1, 2, 3, 9, 15, 16, 20], "seem": [1, 4, 5, 14], "need": [1, 2, 3, 4, 5, 6, 7, 9, 10, 13, 14, 15, 17, 20, 21, 22], "method": [1, 5, 6, 14], "now": [1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 13, 14, 15, 16, 17, 20, 21, 22], "trivial": 1, "affect": [1, 2, 10, 16, 17], "wrap": 1, "long": [1, 2, 3, 6, 7, 12, 14, 16, 17, 19, 21], "shorter": [1, 14], "auto": [1, 7, 9], "format": [1, 5], "tool": [1, 4, 7, 10, 21], "black": 1, "editor": [1, 2, 4, 7, 9, 11, 15, 16, 18, 20, 21, 22], "trail": 1, "whitespac": 1, "point": [1, 3, 5, 9, 14, 16, 17, 18, 20, 23], "mechan": [1, 10, 22], "old": [1, 9, 17], "switch": [1, 2, 3, 7, 9, 10, 12, 15, 17, 18, 22], "branchnam": [1, 3, 9, 17], "start": [1, 2, 3, 4, 5, 6, 7, 9, 13, 14, 15, 16, 20, 21, 22, 23], "onli": [1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 13, 14, 15, 17, 20, 21, 23], "comment": [1, 3, 15, 23], "older": [1, 3, 7, 9, 17, 20], "347e6292419b": 1, "347e6292419bd0e4bff077fe971f983932d7a0e9": 1, "navig": [1, 4, 9, 14], "back": [1, 2, 3, 4, 5, 9, 10, 12, 14, 17, 18, 20, 21, 22, 23], "after": [1, 2, 3, 4, 7, 9, 10, 12, 14, 15, 18, 20], "delet": [1, 7, 9, 17, 22], "On": [1, 2, 3, 7, 9, 13, 14, 15, 17, 22], "version": [1, 2, 3, 4, 5, 6, 7, 9, 10, 14, 15, 17, 18, 20, 21, 23], "23": [1, 9], "checkout": [1, 3, 7, 9, 17, 21], "b": [1, 2, 7, 9, 17, 18, 20, 21], "somehash": [1, 9], "347e629": 1, "onc": [1, 3, 5, 7, 9, 10, 13, 15, 17, 19, 20, 21, 22, 23], "sourc": [1, 4, 5, 9, 14, 15, 16, 20], "control": [1, 2, 3, 4, 5, 7, 9, 10, 14, 15, 17, 18, 20, 23], "menu": [1, 9], "identifi": [1, 2, 4, 5, 9, 14, 16, 18, 20], "sure": [1, 2, 3, 4, 9, 10, 13, 14, 15, 16, 17, 20, 21], "look": [1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 17, 21, 22], "let": [1, 2, 3, 5, 7, 9, 13, 14, 16, 17, 20, 21, 22, 23], "valu": [1, 9], "futur": [1, 2, 4, 9, 10, 13], "depend": [1, 4, 9, 14, 17, 18], "ok": [1, 9, 16, 17, 23], "complet": [1, 9, 12, 14, 17, 20, 23], "fulli": [1, 9, 13], "step": [1, 2, 3, 4, 5, 6, 10, 13, 14, 15, 20], "insid": [1, 2, 4, 6, 9, 14, 22], "anoth": [1, 2, 3, 4, 5, 10, 11, 14, 15, 18, 20, 21, 22], "outsid": [1, 9], "avoid": [1, 3, 9, 11, 15, 17], "fatal": [1, 9], "ani": [1, 2, 3, 4, 5, 7, 9, 13, 15, 16, 17, 18, 20, 23], "parent": [1, 3, 9, 22], "directori": [1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 14, 16, 18, 20, 21, 22, 23], "tell": [1, 2, 3, 7, 9], "problem": [1, 3, 4, 9, 10, 16, 18, 21, 23], "sinc": [1, 2, 3, 4, 7, 9, 10, 14, 15, 16, 17, 20, 21, 23], "noth": [1, 2, 3, 7, 9, 22], "directli": [1, 2, 4, 5, 9], "work": [1, 2, 5, 6, 7, 10, 13, 15, 16, 17, 18, 20, 21, 22, 23], "well": [1, 2, 3, 7, 9, 11, 21], "6": [1, 7, 9, 12, 20], "3": [1, 20, 21, 22], "tag": [1, 9, 13, 14, 18, 22], "releas": [1, 2, 5, 9, 13], "tree": [1, 2, 9, 10, 22], "logic": [1, 9, 21], "degree_correl": [1, 9], "ad": [1, 3, 4, 5, 7, 9, 14, 15, 23], "actual": [1, 4, 5, 7, 9, 14, 15, 18, 21], "bring": [1, 9, 15, 18], "provid": [1, 4, 9, 12, 13, 15, 22], "encourag": [1, 2, 3, 4, 5, 9, 15], "algorithm": [1, 3, 9], "threshold": [1, 2, 9], "rdi": [1, 9], "mayb": [1, 3, 9, 23], "number": [1, 7, 9, 11], "follow": [1, 2, 3, 4, 5, 6, 7, 9, 14, 16, 17, 20], "90544b4fa": [1, 9], "unless": [1, 2, 3, 6, 7, 9, 14, 20], "compact": [1, 9], "access": [1, 2, 4, 6, 9, 18, 20], "just": [1, 2, 3, 4, 6, 9, 11, 13, 14, 15, 20, 21], "1": [1, 22], "am": [1, 16], "strang": 1, "sometim": [1, 3, 6, 7, 13, 14, 15, 17, 18, 23], "realiz": [1, 3, 7, 10, 17], "500": [1, 9], "ago": [1, 16], "doe": [1, 2, 3, 5, 6, 7, 9, 12, 14, 17, 18, 22, 23], "could": [1, 2, 4, 5, 9, 12, 23], "probabl": [1, 2, 6, 9, 10, 12, 16, 20, 23], "arriv": [1, 2, 9], "similar": [1, 2, 4, 5, 9, 11, 17, 20], "good": [1, 2, 3, 4, 9, 10, 11, 12, 13, 16, 17, 19, 20, 22], "f0ea950": 1, "broken": [1, 10], "compil": [1, 2, 3, 21, 23], "test": [1, 6, 15, 16, 23], "decid": [1, 7, 9, 14, 15, 17, 21], "whether": [1, 7, 10, 14, 15], "And": [1, 2, 3, 7, 9, 10], "iter": 1, "until": [1, 3, 6, 9, 10, 17], "reset": [1, 7, 9, 10, 18, 21], "even": [1, 3, 5, 7, 8, 9, 10, 11, 14, 20, 23], "script": [1, 9, 16], "write": [1, 6, 9, 10, 12, 17, 20], "return": [1, 2, 6, 10, 12, 15], "zero": [1, 4], "non": 1, "success": [1, 2, 13, 19], "failur": [1, 16], "begin": [1, 9, 21], "coderefineri": [1, 3, 4, 5, 7, 9, 10, 11, 14, 15], "motiv": [1, 2, 10, 11, 13], "bug": [1, 3, 9, 10, 16], "difficult": [1, 2, 9, 15, 16, 23], "visual": [1, 3, 6, 7, 10, 11, 14], "offend": [1, 9], "often": [1, 2, 3, 4, 5, 7, 9, 10, 12, 13, 16, 18, 19, 21, 23], "more": [1, 3, 5, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 23], "half": [1, 2, 3, 5, 9, 17], "debug": [1, 3, 9, 12, 21], "background": [1, 9], "get_pi": [1, 9], "approxim": [1, 9], "pi": [1, 9], "term": [1, 2, 4, 9, 10, 19, 22], "nilakantha": [1, 9], "seri": [1, 9], "produc": [1, 9], "14": [1, 2, 9], "57": [1, 9], "python": [1, 2, 3, 9], "At": [1, 3, 4, 9], "within": [1, 2, 9, 15, 18], "correctli": [1, 9], "task": [1, 5, 9, 12], "comput": [1, 3, 4, 9, 14, 20], "spoiler": [1, 9], "alert": [1, 9], "found": [1, 3, 9, 10, 16], "bonu": [1, 9], "correct": [1, 2, 9, 17, 20], "hint": [1, 2, 4, 5, 9, 10, 15], "tail": [1, 9], "tild": [1, 9], "combin": [1, 7, 10, 13, 15, 23], "except": [1, 2], "grasp": 2, "structur": [2, 3, 6, 10, 14], "inspect": [2, 3, 4, 7, 11, 17, 18, 21, 22], "35": [2, 10], "min": [2, 3, 7, 10, 12, 13, 16, 17, 21, 22], "40": [2, 3, 22], "system": [2, 7, 10, 16, 18], "folder": [2, 4, 9, 17, 20, 22], "over": [2, 4, 5, 10, 13, 14, 15, 18, 21, 23], "entir": [2, 5, 7, 14, 18, 19], "assign": [2, 10], "kept": 2, "sub": [2, 5], "keep": [2, 3, 7, 10, 15, 18, 21], "move": [2, 3, 5, 7, 9, 10, 11, 14, 17, 18, 21], "somewher": [2, 6, 16], "els": [2, 3, 7, 12, 13, 15, 16, 23], "still": [2, 5, 6, 7, 9, 10, 12, 15, 20], "doesn": [2, 5, 9, 12, 17, 22], "anyth": [2, 6, 9, 10, 15], "ask": [2, 9, 12, 14, 15, 16, 17], "multipl": [2, 4, 5, 10, 13, 14, 21], "exist": [2, 5, 6, 7, 10, 14, 16, 17, 18, 20], "take": [2, 4, 7, 9, 17, 20, 21], "request": [2, 10, 13, 18, 23], "txt": [2, 3, 7, 9, 21], "anotherfil": 2, "focu": 2, "think": [2, 3, 7, 9, 10, 15], "outcom": 2, "edit": [2, 3, 5, 7, 9, 18], "again": [2, 3, 5, 7, 9, 10, 12, 13, 15, 17, 21], "sever": [2, 3, 5, 7, 9, 11, 12, 21, 22], "end": [2, 3, 4, 5, 9, 10, 13, 21, 23], "perform": 2, "focus": 2, "scene": 2, "press": 2, "shutter": 2, "instal": [2, 6, 7, 9, 11], "instruct": [2, 3, 5, 6, 7, 9, 11, 14, 17, 21], "email": [2, 16], "address": [2, 9, 20, 21], "yournam": [2, 6], "nano": [2, 6], "defaultbranch": [2, 6], "verifi": [2, 3, 6, 7, 9, 14, 20, 22], "list": [2, 3, 4, 6, 11, 12, 14, 16, 17, 22, 23], "learner": [2, 10, 11], "enough": [2, 4, 5, 7, 11, 13, 15, 16], "initi": [2, 9, 20], "delici": 2, "inspir": [2, 3, 5, 10, 13, 16], "smith": 2, "carpentri": 2, "mail": 2, "cook": 2, "everybodi": 2, "relat": [2, 7, 9, 21], "written": [2, 19], "e": [2, 3, 7, 9, 10, 17], "g": [2, 3, 7, 9, 10, 17], "languag": 2, "pleas": [2, 3, 5, 7, 9, 11, 13, 14, 15, 16, 20, 23], "lesson": [2, 3, 9, 11, 13, 15, 17, 18, 20, 21], "realli": [2, 3, 9, 10, 12, 13, 20, 23], "stuck": [2, 9, 10], "One": [2, 9, 10, 15, 16, 17, 18, 21], "principl": 2, "mkdir": 2, "That": 2, "empti": [2, 5, 9, 13, 20], "No": [2, 7, 9], "sens": [2, 5, 17], "inform": [2, 3, 4, 8, 9, 10, 15, 16, 17, 22], "dure": [2, 7, 9, 10, 13, 15, 23], "descript": [2, 9, 15, 20, 21, 22], "plu": [2, 9, 20], "symbol": [2, 4, 9, 20], "top": [2, 3, 4, 5, 7, 9, 12, 15, 16, 20, 21], "choos": [2, 9, 11, 14, 15, 20], "short": [2, 5, 9, 14, 20, 21], "final": [2, 5, 7, 9, 14, 20], "overview": [2, 5, 15], "md": [2, 3, 4, 5, 9, 14], "ingredi": [2, 3, 5, 7, 9, 17, 21], "avocado": [2, 3, 7, 9], "chili": [2, 3, 7, 9], "lime": [2, 3, 7, 9], "tsp": [2, 3, 7, 9], "salt": [2, 3, 5, 7, 9], "second": [2, 7, 13], "chop": 2, "onion": [2, 3, 5, 7, 9, 17], "squeez": [2, 9], "mix": [2, 5, 9, 21], "alwai": [2, 6, 10, 13, 14, 15, 16, 22], "safe": [2, 6, 7, 9, 13, 15, 17], "idea": [2, 3, 4, 9, 10, 13, 16, 17, 21, 22, 23], "when": [2, 3, 5, 10, 12, 13, 14, 15, 16, 17, 18, 21, 22, 23], "untrack": 2, "includ": [2, 9, 14, 17, 23], "present": [2, 10, 21, 22], "camera": 2, "consciou": 2, "decis": 2, "rm": [2, 9, 17, 23], "cach": 2, "unstag": [2, 7, 9, 18, 21], "readi": [2, 3, 15, 21, 22, 23], "m": [2, 3, 5, 9, 14, 20], "root": [2, 14], "f146d25": [2, 3, 9, 17], "insert": [2, 7], "mode": [2, 9, 10], "100644": [2, 7, 9], "queri": 2, "muscl": 2, "memori": 2, "third": 2, "flag": [2, 3, 9], "mean": [2, 3, 4, 5, 6, 7, 9, 10, 15, 17, 20], "versatil": [2, 3], "worri": [2, 22], "mind": [2, 3, 9, 12, 20], "read": [2, 6, 14], "doubt": [2, 7], "search": [2, 6, 9, 10, 16, 18], "onlin": [2, 9, 13, 16, 20], "find": [2, 3, 4, 5, 10, 14, 15, 16, 17, 18, 20, 22], "relev": [2, 9, 13], "thread": [2, 9, 20], "network": [2, 5, 9, 14, 15, 16], "connect": [2, 6, 10], "specifi": [2, 10, 14], "adjust": [2, 5, 13, 15], "howev": [2, 3, 16], "up": [2, 3, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17, 20, 22, 23], "three": [2, 3, 4, 5, 6, 9, 14, 15, 20, 21], "enjoi": [2, 3, 5, 9, 17], "index": [2, 4, 7, 9, 10, 12, 22], "4422a31": [2, 9], "ba8854f": [2, 9], "7811273": [2, 9], "2b11074": [2, 9], "separ": [2, 3, 5, 9, 11, 12, 21], "happen": [2, 3, 5, 7, 9, 10, 12, 17, 20, 22], "leav": [2, 7, 9, 10, 14, 16, 20], "associ": [2, 9], "made": [2, 3, 9, 17, 18, 21, 22], "chanc": [2, 7, 9, 10, 11, 16], "ve": [2, 6, 9, 14, 22], "convinc": [2, 9], "self": [2, 9], "were": [2, 3, 9, 10, 12, 15, 22], "justifi": [2, 9, 17], "close": [2, 7, 9, 20], "experi": [2, 3, 5, 9, 16, 17], "modif": [2, 5, 7, 9, 10, 12, 17, 18, 21], "pen": [2, 9], "By": [2, 4, 9, 10, 15], "preview": [2, 4, 9, 15], "goal": [2, 3, 9, 11, 22], "e7cf023efe382340e5284c278c6ae2c087dd3ff7": [2, 3], "author": [2, 3, 4, 6, 9, 13, 16, 20, 22], "radovan": [2, 5, 14], "bast": 2, "norepli": [2, 6], "date": [2, 7], "sun": 2, "sep": 2, "17": [2, 9, 16, 20], "19": [2, 16], "12": [2, 9, 10, 20], "47": 2, "2023": [2, 3, 11, 16], "0200": 2, "79161b6e67c62ad4688a58c1e54183334611a390": 2, "32": 2, "a3394e39535343c4dae3bb4f703741a31aa8b78a": 2, "18": 2, "369624674e63de48055a65bf63055bd59c985d22": 2, "46": 2, "58": 2, "f146d25b94569a15e94d7f0da6f15d7554f76c49": 2, "52": [2, 22], "arbitrari": [2, 9], "hash1": [2, 9], "hash2": [2, 9], "develop": [2, 3, 5, 6, 9, 10, 13, 15, 18], "uniqu": [2, 4, 5, 14, 18], "label": [2, 3, 9, 15, 17, 21], "code": [2, 3, 5, 7, 9, 10, 12, 13, 14, 15, 17, 18, 20, 21, 23], "integ": 2, "count": [2, 9, 20], "revers": 2, "chronolog": 2, "newest": [2, 18, 21], "7": [2, 9, 12, 20], "necessari": [2, 11], "nice": [2, 3, 4, 6, 9, 14, 21], "been": [2, 3, 6, 9, 10, 12, 14, 15, 23], "differ": [2, 3, 4, 5, 7, 9, 10, 15, 16, 18, 20, 21, 22, 23], "between": [2, 3, 5, 7, 9, 10, 12, 15, 18, 21], "side": [2, 4, 5, 8, 9, 16], "further": [2, 9], "difftool": [2, 9], "requir": [2, 3, 4, 5, 6, 7, 9, 14], "linux": [2, 9], "meld": [2, 9], "maco": [2, 9], "opendiff": [2, 9], "notic": [2, 3, 7, 9, 23], "deepen": [2, 9], "both": [2, 3, 4, 5, 7, 9, 10, 14, 17, 21], "manag": [2, 3, 6, 7, 9, 18], "troubl": [2, 9], "shoot": [2, 9], "better": [2, 4, 5, 12, 13, 16, 21, 23], "import": [2, 4, 5, 6, 10, 13, 15, 16, 21, 23], "increas": [2, 7, 13, 23], "alpha": [2, 13], "0": [2, 3, 4, 5, 9, 13, 20, 22], "enabl": [2, 10, 13], "123": [2, 13], "convent": [2, 3, 13], "summar": [2, 13], "paragraph": [2, 13], "free": [2, 13], "form": [2, 3, 5, 12, 13, 15, 16, 22], "someth": [2, 3, 5, 6, 7, 9, 10, 12, 13, 15, 17, 18, 23], "ha": [2, 3, 4, 5, 6, 9, 10, 13, 14, 15, 17, 18, 23], "cross": [2, 13], "refer": [2, 9, 10, 13, 15, 20, 21, 22, 23], "issu": [2, 7, 9, 10, 13, 18, 21], "bad": [2, 3, 7, 10, 12, 13, 16, 21], "fix": [2, 3, 5, 7, 9, 12, 13, 17, 21], "oop": [2, 13], "whatthecommit": [2, 13], "english": [2, 13], "understood": [2, 13], "15": [2, 10, 12, 13, 14, 15, 16, 20, 22], "year": [2, 10, 13, 16], "someon": [2, 7, 13, 16, 23], "Or": [2, 3, 7, 13, 14, 15, 16, 23], "me": [2, 3, 5, 13, 16], "50": [2, 10, 13], "peopl": [2, 4, 5, 7, 9, 10, 13, 15, 16, 17, 20, 23], "decad": [2, 13], "my": [2, 5, 8, 9, 13, 14, 16, 20], "favourit": [2, 13], "style": [2, 12, 13], "choic": [2, 6, 13, 21], "scipi": [2, 13], "numpi": [2, 13], "panda": [2, 13], "julia": [2, 13], "ggplot2": [2, 13], "flask": [2, 13], "design": [2, 4, 5, 13, 15, 18], "consid": [2, 13], "easili": [2, 4, 5, 6, 7, 10, 12, 13, 21], "changelog": [2, 13], "review": [2, 6, 13, 15, 16, 23], "especi": [2, 13, 23], "perfect": [2, 12, 13, 19, 23], "enemi": [2, 13], "binari": 2, "reason": [2, 4, 12, 13, 16, 23], "platform": [2, 11, 16, 18, 23], "thu": [2, 9, 15, 23], "contribut": [2, 3, 4, 6, 10, 11, 14, 16, 18, 23], "meaning": [2, 5, 14, 23], "although": [2, 23], "touch": [2, 9, 12, 17, 23], "pyc": 2, "__pycache__": 2, "taken": 2, "offici": 2, "document": [2, 3, 5, 9, 13, 16, 17], "archiv": 2, "anywher": 2, "oa": 2, "html": [2, 10], "foo": 2, "maintain": 2, "hand": 2, "build": [2, 4, 16], "shell": [2, 6, 10], "glob": 2, "syntax": [2, 8], "determin": 2, "pattern": [2, 5, 18], "lower": 2, "level": [2, 8, 22], "via": [2, 5, 9, 14, 20], "websit": [2, 9, 16, 20], "gui": 2, "desktop": 2, "sourcetre": 2, "parti": 2, "checkpoint": [2, 21], "undo": [2, 11, 13, 23], "uncommit": 2, "mv": 2, "renam": [2, 9, 20], "ideal": [2, 10], "larg": [2, 20, 23], "annex": 2, "would": [2, 3, 4, 7, 9, 10, 11, 13, 15, 17, 21], "myfil": [2, 9], "recent": [2, 9, 12, 18], "stori": [2, 3], "afraid": [2, 7, 10], "20": [3, 7, 10, 13], "previou": [3, 5, 11, 15, 16, 22], "section": [3, 6, 7, 9, 10, 14, 20], "track": [3, 4, 5, 9, 14, 15, 17, 18, 20, 23], "guacamol": [3, 5, 9], "git": [3, 4, 5, 10, 12, 15, 18, 19, 23], "had": [3, 14, 17], "come": [3, 4, 12, 14, 15, 18, 23], "linear": [3, 4, 9], "depict": 3, "littl": [3, 7, 9, 15], "box": [3, 7, 21], "abbrevi": 3, "posit": 3, "record": [3, 4, 5, 10, 18, 21, 22], "tape": 3, "sai": [3, 4, 5, 9, 15], "those": [3, 7, 9, 15, 20], "liter": [3, 17, 21], "isn": [3, 14, 17, 21], "placehold": [3, 9, 17, 20], "talk": [3, 7, 15], "imag": [3, 5, 16, 22], "us": [3, 5, 10, 11, 12, 14, 15, 16, 17, 20, 22, 23], "gopher": [3, 5, 16], "softwar": [3, 16], "least": [3, 9, 12, 17, 21], "expect": [3, 5, 7, 9, 14], "featur": [3, 7, 12, 13, 19, 21, 23], "concurr": 3, "unfinish": [3, 13, 20, 23], "line": [3, 5, 7, 10, 11, 12, 13, 15, 16, 18, 20, 21], "strength": 3, "permit": 3, "research": [3, 11], "isol": 3, "composit": 3, "master": [3, 5, 6, 9, 18, 20], "special": 3, "direct": [3, 10, 15, 22], "acycl": [3, 22], "graph": [3, 5, 6, 7, 9, 12, 16, 17, 18, 22], "arrow": [3, 9, 15, 20], "group": [3, 21, 23], "narr": 3, "strategi": [3, 10, 12], "sequenc": [3, 21], "extract": 3, "matrix": 3, "invers": 3, "without": [3, 4, 6, 7, 9, 10, 12, 14, 15, 16, 18, 20], "command": [3, 5, 7, 10, 11, 15, 17, 20], "alias": [3, 6, 11, 14, 18], "given": 3, "rest": 3, "ensur": 3, "collabor": [3, 4, 7, 9, 10, 11, 13, 15, 17, 20, 23], "histori": [3, 7, 11, 14, 16, 18, 20, 23], "e7cf023": [3, 9, 17], "79161b6": [3, 9, 17], "a3394e3": [3, 9, 17], "3696246": [3, 9, 17], "coupl": [3, 9, 14, 17, 22], "character": 3, "checksum": [3, 22], "pointer": [3, 18, 22], "afterward": 3, "togeth": [3, 4, 5, 7, 9, 15, 21, 23], "particip": [3, 10, 22], "episod": [3, 4, 5, 14, 15], "prefer": [3, 4, 6, 16], "browser": [3, 4, 5, 14, 16], "cilantro": [3, 4, 5, 7, 9], "text": [3, 7, 10, 15, 16, 18, 22], "case": [3, 4, 5, 7, 9, 10, 12, 14, 15, 16, 17, 20, 21], "2019": [3, 7, 16, 17], "clear": [3, 7, 10, 21], "tbsp": [3, 7], "reduc": [3, 5, 7, 9], "amount": [3, 5, 7, 9], "bit": [3, 7, 9, 12, 22], "bcb8b78": [3, 9], "f6ec7b7": [3, 9], "ahead": 3, "safer": [3, 9], "explicitli": [3, 9], "shown": [3, 4, 9, 15], "bf28166": [3, 9], "graphic": [3, 9, 10], "represent": [3, 9, 10], "situat": [3, 9, 17, 21], "b4af65b": [3, 9, 17], "comparison": [3, 9], "turn": [3, 10, 11, 14, 16], "appli": [3, 7, 9, 11], "skip": [3, 6, 7, 21], "origin": [3, 5, 6, 7, 9, 14, 18, 20], "helper": [3, 6, 7, 9], "un": [3, 7, 15], "wish": [3, 12, 17], "81fcc0c": 3, "intern": [3, 19], "attempt": 3, "incorpor": 3, "To": [3, 4, 7, 9, 10, 14, 20], "happi": [3, 7], "4e03d4b": [3, 7], "observ": [3, 7, 9, 14], "cat": [3, 7, 22], "overlap": 3, "user": [3, 4, 5, 6, 9, 13, 14, 15, 16, 20, 22, 23], "settl": 3, "conflict": [3, 8, 10, 11, 12, 23], "sticki": [3, 5, 15], "disappear": 3, "reintegr": 3, "insist": 3, "lost": [3, 17], "hard": [3, 4, 9, 10, 13, 15, 17, 18, 22], "advanc": [3, 4, 9, 12, 13, 15, 16], "absolut": 3, "postpon": [3, 7, 23], "month": [3, 7, 21, 23], "resolv": [3, 12, 17], "examin": [3, 9], "discuss": [3, 4, 9, 10, 11, 14, 15, 17, 18, 20], "ancestor": [3, 7, 9], "did": [3, 5, 7, 9, 14, 16, 21], "diverg": [3, 5, 9], "altern": [3, 4, 9, 14, 21], "replai": [3, 9], "explicit": [3, 9], "public": [3, 4, 9, 10, 15, 20], "alter": [3, 9], "contrast": 3, "ever": [3, 10, 21], "commemor": 3, "plaqu": 3, "particular": [3, 5, 10], "mileston": [3, 13], "semant": [3, 7], "v1": [3, 5], "64441c1934def7d91ff0b66af0795749d5f1954a": 3, "basic": [3, 5, 10, 11, 12, 15, 16, 23], "annot": [3, 4, 9, 10, 16, 18], "lightweight": [3, 22], "cryptograph": 3, "sign": [3, 5, 14], "gpg": 3, "timestamp": 3, "attach": [3, 5], "nobel": 3, "banquet": 3, "pro": [3, 19, 22], "book": [3, 4, 5, 9, 10, 14, 15, 19, 22], "chapter": 3, "subject": 3, "paus": 3, "moment": [3, 22], "recapitul": 3, "unmerg": [3, 7], "combo": [3, 9], "frequent": 3, "wild": [3, 23], "throw": [3, 17, 18], "awai": [3, 12, 17, 18, 22], "gone": [3, 9, 15, 16, 17], "off": [3, 9, 12], "job": [3, 9], "divis": 3, "unit": [3, 13], "understand": [4, 5, 7, 10, 15, 22], "piec": 4, "own": [4, 5, 6, 9, 11, 14, 15, 16, 17, 18, 20], "scratch": 4, "abstract": 4, "ll": [4, 5, 17], "cool": 4, "stuff": [4, 17, 21], "cours": [4, 10, 22], "big": [4, 23], "pictur": 4, "bunch": 4, "path": [4, 5, 7, 9, 12, 14, 15, 17, 20, 23], "dai": [4, 5, 13, 15, 16], "comfort": [4, 10, 11], "jupyt": 4, "rstudio": 4, "collect": [4, 18], "organ": [4, 21], "becom": [4, 10, 15, 17], "visibl": [4, 5], "stream": [4, 10], "button": [4, 5, 9, 14, 15, 20], "toward": [4, 9, 15], "shortli": 4, "redirect": [4, 9, 20], "your_user_nam": 4, "awar": [4, 5, 8, 14], "tab": [4, 5, 9, 14], "ye": [4, 7, 9, 12], "trust": 4, "somewhat": 4, "applic": 4, "bash": [4, 8, 10], "ssh": [4, 9, 14, 20], "setup": [4, 5, 14, 15, 18, 20], "team": [4, 14], "session": 4, "account": [4, 6, 9, 11, 20], "explor": [4, 22], "prepar": [4, 9, 10, 21], "question": [4, 9, 10, 16, 23], "insight": [4, 5, 9, 14], "filter": [4, 9], "licens": [4, 5, 9, 20, 22], "goe": [4, 5, 14, 15], "answer": [4, 5, 14, 15, 16], "aren": [4, 5, 15], "554c187": [4, 5, 18], "bottom": [4, 5, 9, 14, 15, 21], "saw": [4, 5], "hover": 4, "dot": [4, 5, 14, 15, 17], "person": [4, 7, 10, 13, 15, 18], "correspond": [4, 21], "alia": [4, 10, 14, 18], "configur": [4, 7, 9, 10, 11, 16, 18, 20], "filenam": [4, 5, 12], "accord": 4, "five": [4, 21], "2024": [4, 11], "03": [4, 21], "07": [4, 21], "occurr": 4, "function": [4, 5, 7, 10, 18], "class": 4, "context": [4, 8, 12, 13], "minut": 4, "keyword": 4, "continu": [4, 7, 9, 12, 15], "usag": 4, "c": [4, 21], "insensit": 4, "unfortun": 4, "histor": 4, "meant": [4, 7, 9, 15], "anyon": [4, 9, 17], "slightli": [4, 7, 9], "creativ": 4, "domain": 4, "condit": [4, 9, 17], "commun": [4, 7], "propos": [4, 15, 18], "owner": 4, "accept": [4, 13], "support": 5, "snapshot": [5, 14], "certain": [5, 7, 12, 14, 23], "note": [5, 6, 9, 23], "locat": [5, 9, 14, 21, 22], "templat": [5, 10], "markdown": 5, "matter": [5, 17], "verb": [5, 18], "upper": [5, 14], "nut": 5, "appear": [5, 7, 14], "brief": [5, 14], "pencil": 5, "icon": [5, 9, 20], "repeat": [5, 7, 9, 14, 21], "summari": 5, "shouldn": [5, 9, 15], "selector": [5, 14, 15], "normal": [5, 14], "prompt": [5, 6, 14], "didn": 5, "b4de93b": 5, "spring": 5, "poke": [5, 14, 22], "dc5d6f0": 5, "chocol": 5, "b4035e3": 5, "alex": [5, 14], "fruit": [5, 14], "salad": [5, 14], "89d5ef9": 5, "3bd2468": 5, "8bcb766": 5, "todo": 5, "b950c5c": 5, "capit": 5, "d18035e": 5, "7051cca": 5, "ae19e81": 5, "categori": 5, "a6fe629": 5, "30b89c4": 5, "fd12dc1": 5, "lasagna": [5, 14], "7753d43": 5, "vegetarian": 5, "aa0473": 5, "1e5a24a": 5, "5aa6687": 5, "oh": [5, 8, 16], "forgot": [5, 15, 17, 21], "cc84e4f": 5, "9500901": 5, "classic": [5, 6], "pumpkin": 5, "pie": 5, "yum": 5, "34ce939": 5, "draft": [5, 15], "pasta": 5, "far": [5, 10], "28e5f26": 5, "mushroom": 5, "soup": 5, "a550963": 5, "f2d6d58": 5, "1fde064": 5, "4c1873e": 5, "2992443": 5, "cc0": 5, "084a1ea": 5, "almost": [5, 7, 9, 10, 12], "switcher": 5, "version1": 5, "version2": 5, "around": [5, 9, 15], "addit": [5, 7, 9, 12, 20, 23], "metadata": 5, "purpos": [5, 15], "interchang": 5, "manuscript": [5, 16], "pre": [5, 7], "interfer": 5, "stick": [5, 11, 21], "cost": 5, "signific": 5, "disk": 5, "integr": 6, "environ": [6, 18], "home": [6, 21], "carri": 6, "your_github_usernam": 6, "nobodi": [6, 9, 16, 17], "theori": 6, "data": [6, 7, 9, 12, 15, 16, 20, 22], "registr": 6, "ident": 6, "place": [6, 12, 18, 21], "secur": 6, "protocol": 6, "credenti": 6, "extra": [6, 9, 12], "mac": 6, "successfulli": 6, "yourself": [6, 9, 14, 20, 23], "guid": [6, 11, 14, 19], "process": [6, 9, 18], "suffici": 7, "imagin": [7, 17], "somebodi": [7, 15, 16], "smooth": 7, "fast": 7, "forward": 7, "portion": [7, 15, 16, 17], "silent": 7, "overwrit": [7, 9, 20], "scari": 7, "luckili": 7, "rare": [7, 21], "meet": 7, "simpli": 7, "kind": [7, 16], "measur": 7, "declar": 7, "minor": 7, "revis": 7, "spell": 7, "rewrit": 7, "solv": [7, 9, 10, 21], "demo": 7, "decreas": 7, "dislik": [7, 9], "e83294b": 7, "6cacd50": 7, "4": [7, 20, 21, 22], "6484462": 7, "3caa632": 7, "fail": [7, 9], "marker": [7, 9, 15], "cc": [7, 22], "0000000": 7, "10": [7, 10, 12, 14, 15, 20, 21, 22], "care": [7, 17], "exactli": [7, 9, 10], "emac": 7, "plugin": 7, "fill": 7, "banch": [7, 9], "5": [7, 12, 16, 21, 22], "link": [7, 9, 18, 20, 22], "assum": [7, 9, 14, 15, 17], "anticip": [7, 9, 16, 21], "inde": [7, 9], "disagre": [7, 9], "stop": [7, 9, 23], "middl": [7, 9, 12, 21], "backup": [7, 9, 10, 14, 16, 20], "temporari": [7, 9, 12], "clean": [7, 9, 16, 22], "f": [7, 9], "keepbackup": [7, 9], "fals": [7, 9], "xour": 7, "xtheir": 7, "plan": [7, 13, 14], "put": [7, 9, 12, 21], "unrel": [7, 9, 12, 13, 21, 23], "live": [7, 15, 21], "layout": [7, 23], "caus": 7, "modular": 7, "risk": [7, 23], "technic": 7, "share": [7, 10, 14, 16, 17], "earli": [7, 10, 13, 23], "circumst": 7, "everyon": [7, 10, 15], "selfish": 7, "push": [7, 9, 10, 14, 15, 17, 18, 20], "best": [7, 19], "pull": [7, 10, 13, 14, 18, 20, 23], "handl": 7, "compar": [7, 10, 13, 15, 16, 21], "servic": [7, 11, 18, 20], "googl": 7, "drive": 7, "optim": [7, 10], "displai": 8, "contextu": 8, "jimeh": 8, "ohmyz": 8, "sh": 8, "zsh": 8, "fish": 8, "magicmonti": 8, "delta": [8, 9, 20], "highlight": 8, "mainli": 9, "instructor": [9, 11], "event": 9, "cover": [9, 15], "subset": 9, "interest": [9, 15], "sound": [9, 12, 16], "discov": [9, 16], "receiv": 9, "fork": [9, 14, 15, 18], "titl": [9, 15], "target": [9, 14, 15], "central": [9, 15], "mostli": [9, 15], "complex": [9, 15, 21], "workflow": [9, 11, 19], "toolbox": 9, "broke": [9, 16, 18], "myproject": [9, 16, 20], "repres": [9, 20], "gitlab": [9, 10, 11, 16, 18], "upload": [9, 20], "publish": [9, 10, 16, 19], "never": [9, 10, 12, 17, 20, 22, 23], "chose": [9, 20], "login": [9, 20], "oauth": [9, 20], "consist": [9, 18, 20], "rw": [9, 20, 22], "19k": [9, 20], "mar": [9, 20], "36": [9, 20], "21": [9, 16, 20, 22], "myscript": [9, 20], "28": [9, 20], "none": [9, 20], "green": [9, 15, 20], "red": [9, 20], "execut": [9, 20], "possibli": [9, 15, 17, 20], "enumer": [9, 20], "object": 9, "100": [9, 20], "compress": [9, 20], "08": [9, 10, 20], "kib": [9, 20], "mib": [9, 20], "total": [9, 20], "pack": [9, 20, 21], "reload": [9, 20], "troubleshoot": [9, 20], "explan": [9, 20], "ran": [9, 20], "recoveri": [9, 17, 20], "prevent": [9, 10, 20, 23], "accident": [9, 17, 20, 23], "forc": [9, 17, 20], "danger": [9, 13, 20], "brand": [9, 20], "fine": [9, 20], "abort": [9, 12, 17, 21], "unmodifi": [9, 21], "keystrok": [9, 21], "re": [9, 10, 18, 21], "benefici": [9, 21], "feel": [9, 10, 11, 14, 21], "regret": [9, 21], "newli": [9, 17], "incomplet": [9, 17], "typo": [9, 17], "unsatisfactori": [9, 17], "amend": [9, 17, 18], "d3fc63a": [9, 17], "e02efcd": [9, 17], "forev": [9, 17], "alright": [9, 17], "extraordinari": [9, 17], "sensit": [9, 17], "secret": [9, 17], "pop": [9, 12], "twice": [9, 12], "opposit": [9, 12, 17, 21], "deci": [9, 12], "ref": [9, 12, 22], "exercis": [10, 11, 22], "preserv": 10, "mirror": 10, "trigger": 10, "ce": 10, "09": [10, 16], "00": 10, "soft": [10, 18, 21], "icebreak": 10, "25": [10, 15, 17, 22], "break": [10, 13], "11": 10, "60": 10, "13": 10, "resolut": [10, 11, 15, 17], "feedback": [10, 15], "tomorrow": 10, "advic": [10, 11], "alon": [10, 21], "industri": 10, "high": [10, 11, 16, 23], "encount": 10, "disast": 10, "mistak": [10, 17], "roll": 10, "parallel": 10, "toe": 10, "exact": 10, "major": 10, "extent": 10, "lack": 10, "mental": 10, "model": [10, 16, 19, 22], "oper": 10, "newcom": 10, "valuabl": 10, "craft": [10, 21], "incorrect": 10, "emphas": 10, "effici": [10, 19], "avail": [10, 21], "bisect": [10, 18], "anybodi": 10, "rather": [10, 13, 21], "involv": 10, "wonder": 10, "whom": [10, 18], "behav": 10, "incorrectli": 10, "earlier": 10, "screencast": 10, "modul": [10, 11], "forgotten": 10, "expand": 10, "stash": [10, 13], "info": [10, 22], "anytim": 10, "etc": [10, 22], "cheat": 10, "sheet": 10, "www": 10, "ndpsoftwar": 10, "dir": 10, "diagram": 10, "student": 10, "sampl": 10, "infrequ": 10, "constantli": 10, "imposs": 10, "lose": [10, 12, 13, 18, 22], "highli": 10, "bashrc": 10, "februari": [11, 16], "march": 11, "rewrot": 11, "ground": [11, 21], "introductori": 11, "concept": [11, 18], "obsess": 11, "materi": 11, "bitbucket": [11, 16, 20], "transfer": 11, "implicitli": 11, "endors": 11, "compani": 11, "chosen": 11, "popular": [11, 16, 18, 20], "host": 11, "recov": [11, 13], "interrupt": 11, "hood": 11, "quick": [11, 23], "custom": 11, "resourc": 11, "pdf": 11, "panick": 12, "fresh": 12, "beauti": 12, "world": 12, "chaotic": [12, 23], "jackson": 12, "pollock": 12, "spree": 12, "27": 12, "everywher": [12, 23], "ruin": 12, "easiest": 12, "temporarili": 12, "drop": 12, "whichev": 12, "stack": [12, 17], "batch": 12, "resum": 12, "overlook": 12, "week": [12, 23], "2": [13, 18, 20, 22], "faster": 13, "converg": 13, "typic": 13, "untest": 13, "unsur": [13, 14], "protect": 13, "otherwis": 13, "split": [13, 18, 21, 23], "smaller": 13, "size": [13, 23], "huge": [13, 17, 23], "imperfect": 13, "simplifi": [13, 16], "repair": 13, "fit": 13, "grow": [13, 23], "beginn": 13, "input": 13, "introduct": [14, 15, 20], "download": 14, "full": 14, "activ": [14, 23], "conceptu": 14, "familiar": [14, 22], "yesterdai": 14, "authent": 14, "argument": 14, "anymor": [14, 15], "vari": 14, "somehow": [15, 21], "effect": 15, "equal": 15, "donat": 15, "send": [15, 16, 18], "permiss": [15, 18], "Not": [15, 23], "human": 15, "confid": 15, "watch": 15, "Being": 15, "basi": 15, "themselv": 15, "advoc": 16, "distribut": [16, 20], "recogn": 16, "hopefulli": [16, 22], "latest": [16, 17], "paper": 16, "laptop": 16, "thesi": 16, "interf": 16, "discard": [16, 21], "indic": 16, "src": 16, "util": 16, "time_iso8601": 16, "august": 16, "permalink": 16, "plain": 16, "suitabl": 16, "latex": 16, "quarto": 16, "zip": 16, "2020": [16, 21], "2021": 16, "myvers": 16, "newfeatur": 16, "despit": 16, "benefit": 16, "honest": 16, "worth": 16, "career": 16, "skill": 16, "worst": 16, "server": [16, 18, 20], "offlin": 16, "subvers": 16, "mercuri": 16, "pijul": 16, "undon": 17, "perman": [17, 18], "retriev": [17, 22], "unlik": 17, "xkcd": [17, 19], "comic": 17, "impli": [17, 21], "1597": 17, "mess": 17, "overflow": 17, "guru": 17, "sim": 17, "resouc": 17, "restor": [17, 18, 21], "remain": 17, "went": 17, "cherri": 17, "pick": [17, 21], "oldest": 17, "wrongli": 17, "recal": 18, "implement": [18, 21, 22], "noun": 18, "workspac": 18, "md5": 18, "sha1": 18, "roughli": 18, "hold": 18, "properti": 18, "itself": 18, "microsoft": 18, "partli": 18, "codium": 18, "revert": 18, "scott": 19, "chacon": 19, "ben": 19, "straub": 19, "peepcod": 19, "mid": 19, "finish": 20, "findabl": 20, "commerci": 20, "univers": 20, "privat": 20, "notabug": 20, "truli": 20, "condid": 20, "citabl": 20, "persist": 20, "pid": 20, "doi": 20, "publicli": 20, "zenodo": 20, "demystifi": 21, "came": [21, 23], "stand": 21, "hardli": 21, "advantag": 21, "disadvantag": 21, "b135ec8": 21, "6f0d49f": 21, "fee1807": 21, "6fe2f23": 21, "ab990f4": 21, "miscellan": 21, "bf39f9d": 21, "45831a5": 21, "bddb280": 21, "72d78e7": 21, "72e0211": 21, "61dd3a3": 21, "bugfix": 21, "49dc419": 21, "wip": 21, "progress": 21, "1949dc4": 21, "04": 21, "a361dd3": 21, "06": 21, "1172e02": 21, "e772d78": 21, "02": 21, "spread": 21, "simplest": 21, "y": 21, "blank": 21, "sort": 21, "shot": 21, "analogi": 21, "shop": 21, "receipt": 21, "wouldn": 21, "item": 21, "bathroom": 21, "kitchen": 21, "room": 21, "seal": 21, "dev": 21, "sublimegeek": 21, "im": 21, "1anh": 21, "bui": 21, "pai": 21, "ineffici": 21, "annoi": 21, "basket": 21, "conveyor": 21, "belt": 21, "importantli": 21, "flexibl": 21, "extrem": 22, "drwxr": 22, "xr": 22, "x": 22, "aug": 22, "51": 22, "499": 22, "commit_editmsg": 22, "92": 22, "73": 22, "hook": 22, "137": 22, "fact": 22, "previous": 22, "wrote": 22, "referenc": 22, "sha": 22, "hexadecim": 22, "BY": 22, "ca": 22, "digest": 22, "raw": 22, "lift": 22, "aha": 22, "underli": 22, "41": 22, "54": 22, "045e3db14740c60684d745e5fb891ae71e335611": 22, "replic": 22, "cp": 22, "gotcha": 23, "ugli": 23, "ish": 23, "harder": 23, "wors": 23, "meantim": 23, "largest": 23, "counterpoint": 23, "phase": 23, "ambiti": 23, "card": 23, "engin": 23, "safeguard": 23, "restrict": 23, "loop": 23, "significantli": 23, "subsequ": 23, "detect": 23, "autom": 23, "season": 23, "miss": 23}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"alias": 0, "configur": [0, 2, 6, 14], "object": [0, 1, 2, 3, 4, 5, 7, 12, 14, 15, 16, 17, 20, 21, 22], "exampl": 0, "alia": [0, 3, 6], "git": [0, 1, 2, 6, 7, 8, 9, 11, 13, 14, 16, 17, 20, 21, 22], "graph": [0, 4, 10, 14], "us": [0, 1, 2, 4, 6, 7, 8, 9, 13, 18, 21], "extern": 0, "command": [0, 1, 2, 4, 6, 9, 14, 18, 21], "food": 0, "thought": 0, "when": [0, 1, 4, 7, 9], "list": [0, 9], "instructor": [0, 1, 2, 3, 4, 7, 8, 10, 12, 13, 14, 15, 16, 17, 20, 21, 22], "advanc": [0, 2], "keypoint": [0, 2, 3, 7, 12, 13, 21], "inspect": [1, 9, 10], "histori": [1, 2, 4, 9, 10, 17, 21], "note": [1, 2, 3, 4, 7, 8, 12, 13, 14, 15, 16, 17, 20, 21, 22], "line": [1, 2, 4, 6, 9, 14], "github": [1, 3, 4, 6, 14, 20], "v": [1, 4, 6], "code": [1, 4, 6, 16], "our": [1, 7, 9, 17], "toolbox": 1, "warm": 1, "up": 1, "browser": [1, 2, 9], "search": [1, 4], "text": [1, 6], "pattern": 1, "repositori": [1, 2, 4, 9, 14, 15, 20], "individu": 1, "commit": [1, 2, 3, 4, 5, 6, 9, 13, 14, 17, 21], "annot": 1, "metadata": [1, 6], "discuss": [1, 2, 5, 7, 13, 16, 21, 22, 23], "past": 1, "exercis": [1, 2, 3, 4, 5, 7, 9, 12, 14, 15, 17, 20, 21], "explor": [1, 9], "basic": [1, 2, 4, 9, 22], "archaeologi": [1, 9], "20": [1, 5, 9, 15], "min": [1, 4, 5, 9, 14, 15, 20], "solut": [1, 2, 3, 4, 5, 7, 9, 12, 14, 15, 16, 17, 21], "find": [1, 9, 11], "out": [1, 15], "someth": 1, "broke": 1, "chang": [1, 2, 4, 5, 7, 9, 15, 16, 17], "bisect": [1, 9], "how": [1, 4, 9, 11, 13, 14, 20], "would": 1, "you": [1, 3, 4, 5, 7, 12], "solv": 1, "thi": [1, 9, 10, 17], "option": [1, 2, 3, 7, 9, 11, 12], "2": [1, 2, 3, 4, 5, 7, 9, 10, 12, 14, 15, 17, 21], "bad": [1, 9], "summari": [1, 2, 3, 4, 14, 15], "what": [2, 13, 14, 16, 23], "i": [2, 3, 13, 14, 16, 17, 20, 21, 22], "record": [2, 9], "snapshot": [2, 16], "question": 2, "more": [2, 4, 8], "particip": 2, "type": 2, "along": 2, "track": [2, 11, 16], "guacamol": [2, 4], "recip": [2, 4, 5], "creat": [2, 3, 4, 5, 7, 9, 10, 12, 14, 15], "ad": [2, 17], "file": 2, "1": [2, 3, 4, 5, 7, 9, 10, 12, 14, 15, 17, 21], "log": [2, 10], "compar": [2, 4, 5, 9, 14], "show": [2, 9], "3": [2, 3, 4, 5, 7, 9, 14, 15, 17], "visual": [2, 9, 17], "diff": [2, 8, 9], "tool": [2, 9, 16], "4": [2, 3, 4, 5, 9, 14, 15, 17], "write": [2, 13], "messag": [2, 6, 13], "ignor": 2, "path": 2, "gitignor": 2, "graphic": 2, "user": 2, "interfac": 2, "5": [2, 3, 4, 5, 9, 14, 15], "test": [2, 3, 9, 17], "your": [2, 3, 5, 9, 10, 11, 15, 17, 20], "understand": [2, 3, 9, 17], "branch": [3, 5, 6, 7, 9, 12, 13, 14, 15, 16, 17, 22], "merg": [3, 7, 9, 14, 15, 16, 17], "motiv": [3, 9, 16], "an": [3, 4, 9, 11, 21], "import": 3, "work": [3, 4, 9, 11, 12, 14], "It": [3, 17], "possibl": [3, 17], "directli": 3, "If": [3, 7], "got": [3, 7], "stuck": [3, 7], "abov": 3, "join": [3, 7], "later": [3, 7], "delet": [3, 15], "safe": 3, "perform": [3, 9, 21], "fast": [3, 9], "forward": [3, 9], "rebas": [3, 7, 9], "instead": [3, 9], "tag": [3, 5], "typic": [3, 16], "workflow": 3, "copi": [4, 9], "brows": [4, 5, 9, 14], "exist": [4, 9, 11], "project": [4, 9, 11, 13, 15, 20], "fork": [4, 5], "25": [4, 9, 14, 20], "walk": [4, 5, 14, 15], "through": [4, 5, 14, 15], "network": 4, "wa": 4, "last": 4, "modifi": [4, 5, 9, 11, 17], "mani": 4, "did": 4, "receiv": 4, "which": 4, "includ": 4, "ingredi": 4, "salt": 4, "instantan": 4, "6": [4, 5, 14, 15], "who": 4, "each": [4, 13], "7": [4, 5, 14, 15], "can": 4, "yourself": 4, "ar": [4, 5, 7, 14], "allow": 4, "share": [4, 9, 11, 20], "modif": 4, "8": [4, 5, 14], "issu": 4, "pull": [4, 9, 15, 17], "request": [4, 9, 15], "upstream": 4, "background": [5, 15], "practic": [5, 9, 13], "make": [5, 9, 21], "sure": 5, "add": 5, "new": 5, "switch": [5, 14], "main": 5, "just": 5, "made": 5, "two": [5, 9, 21], "arbitrari": 5, "renam": 5, "9": 5, "editor": [6, 14], "name": 6, "email": 6, "address": [6, 22], "default": 6, "authent": 6, "ssh": 6, "http": 6, "conflict": [7, 9, 15, 17], "resolut": [7, 9], "why": [7, 10, 11, 16], "thei": 7, "good": 7, "The": [7, 21], "human": 7, "side": 7, "prepar": 7, "previous": 7, "step": [7, 9, 21], "resolv": [7, 9, 15], "anoth": [7, 9, 16], "mergetool": [7, 9], "theirs": 7, "strategi": 7, "abort": 7, "avoid": [7, 23], "custom": 8, "shell": 8, "prompt": 8, "output": 8, "contribut": [9, 15], "clone": [9, 14], "local": [9, 14], "turn": [9, 20], "repo": [9, 20], "stage": [9, 13, 21], "area": [9, 21], "interact": [9, 21], "undo": [9, 17], "recov": [9, 17], "revert": [9, 17], "previou": [9, 17], "destroi": [9, 17], "experiment": [9, 17], "episod": [9, 11, 17], "interrupt": [9, 12], "stash": [9, 12], "some": [9, 12], "uncommit": [9, 12, 17], "guid": 10, "privaci": 10, "schedul": 10, "dai": 10, "we": [10, 11, 14, 16, 18], "teach": 10, "lesson": 10, "intend": 10, "learn": 10, "outcom": 10, "live": 10, "better": 10, "than": 10, "read": 10, "websit": 10, "materi": 10, "separ": 10, "window": 10, "cheatsheet": [10, 18], "board": 10, "draw": 10, "repeat": 10, "follow": 10, "point": 10, "start": [10, 11], "from": [10, 14, 17], "ident": 10, "environ": 10, "introduct": 11, "version": [11, 16], "control": [11, 16], "want": [11, 12], "go": 11, "back": [11, 16], "time": 11, "prerequisit": 11, "get": [11, 12], "studi": 11, "balanc": 11, "older": 11, "refer": [11, 18], "about": [11, 13, 16], "frequent": 12, "situat": 12, "store": 12, "variou": 12, "junk": 12, "don": 12, "t": 12, "need": [12, 16], "rid": 12, "advic": 13, "much": 13, "necessari": 13, "level": 13, "complex": 13, "larg": 13, "should": 13, "remot": [14, 20], "them": 14, "navig": 15, "begin": 15, "process": 15, "fill": 15, "verifi": 15, "origin": 15, "demonstr": [15, 22], "all": 16, "keep": 16, "do": 16, "featur": 16, "roll": 16, "collabor": 16, "reproduc": 16, "talk": 16, "like": 16, "difficulti": 16, "almost": 17, "alwai": 17, "nice": 17, "resourc": [17, 19], "simul": 17, "oper": 17, "recent": 17, "unstag": 17, "preserv": 17, "rewind": 17, "reset": 17, "wrong": 17, "after": 17, "quick": 18, "other": [18, 19], "glossari": 18, "put": 20, "softwar": 20, "gitlab": 20, "publish": 20, "tell": 21, "stori": 21, "under": 22, "hood": 22, "down": 22, "rabbit": 22, "hole": 22, "content": 22, "storag": 22, "system": 22, "experi": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Aliases and configuration": [[0, "aliases-and-configuration"]], "Objectives": [[0, "objectives-0"], [1, "objectives-0"], [2, "objectives-0"], [3, "objectives-0"], [4, "objectives-0"], [5, "objectives-0"], [7, "objectives-0"], [12, "objectives-0"], [14, "objectives-0"], [15, "objectives-0"], [16, "objectives-0"], [17, "objectives-0"], [20, "objectives-0"], [21, "objectives-0"], [22, "objectives-0"]], "Aliases": [[0, "id1"]], "Example alias: git graph": [[0, "example-alias-git-graph"]], "Using external commands": [[0, "using-external-commands"]], "Food for thought: When to alias?": [[0, "discussion-0"]], "List of aliases the instructors use": [[0, "list-of-aliases-the-instructors-use"]], "Advanced aliases": [[0, "advanced-aliases"]], "Advanced Git configuration": [[0, "advanced-git-configuration"]], "Keypoints": [[0, "keypoints-0"], [2, "keypoints-0"], [3, "keypoints-0"], [7, "keypoints-0"], [12, "keypoints-0"], [13, "keypoints-0"], [21, "keypoints-0"]], "Inspecting history": [[1, "inspecting-history"], [9, "inspecting-history"], [10, "inspecting-history"]], "Instructor note": [[1, "instructor-note-0"], [1, "instructor-note-1"], [2, "instructor-note-0"], [2, "instructor-note-1"], [2, "instructor-note-2"], [3, "instructor-note-0"], [3, "instructor-note-1"], [3, "instructor-note-2"], [4, "instructor-note-0"], [7, "instructor-note-0"], [7, "instructor-note-1"], [8, "instructor-note-0"], [12, "instructor-note-0"], [13, "instructor-note-0"], [14, "instructor-note-0"], [15, "instructor-note-0"], [16, "instructor-note-0"], [17, "instructor-note-0"], [20, "instructor-note-0"], [21, "instructor-note-0"], [21, "instructor-note-1"], [22, "instructor-note-0"]], "Command line, GitHub, and VS Code": [[1, "command-line-github-and-vs-code"]], "Our toolbox for history inspection": [[1, "our-toolbox-for-history-inspection"]], "Warm-up: \u201cGit History\u201d browser": [[1, "warm-up-git-history-browser"]], "Searching text patterns in the repository": [[1, "searching-text-patterns-in-the-repository"]], "Inspecting individual commits": [[1, "inspecting-individual-commits"]], "Line-by-line code annotation with metadata": [[1, "line-by-line-code-annotation-with-metadata"]], "Discussion": [[1, "discussion-0"], [2, "discussion-1"], [5, "discussion"], [7, "discussion-1"], [13, "discussion-0"], [16, "discussion-0"], [21, "discussion-0"], [21, "discussion-1"], [21, "discussion-2"], [22, "discussion-0"], [23, "discussion-0"]], "Inspecting code in the past": [[1, "inspecting-code-in-the-past"]], "Exercise": [[1, "exercise"], [4, "exercise"], [5, "exercise"], [9, "exercise-1"], [14, "exercise"], [15, "exercise"], [15, "exercise-1"], [20, "exercise"]], "Exercise: Explore basic archaeology commands (20 min)": [[1, "exercise-0"], [9, "exercise-0"]], "Solution": [[1, "solution-0"], [2, "solution-0"], [3, "solution-0"], [3, "solution-1"], [3, "solution-2"], [7, "solution-0"], [7, "solution-1"], [9, "solution-0"], [9, "solution-0"], [9, "solution-0"], [9, "solution-0"], [9, "solution-1"], [9, "solution-2"], [9, "solution-0"], [9, "solution-1"], [9, "solution-0"], [9, "solution-0"], [9, "solution-1"], [9, "solution-0"], [12, "solution-0"], [16, "solution-0"], [17, "solution-0"], [17, "solution-1"], [21, "solution-0"]], "Finding out when something broke/changed with git bisect": [[1, "finding-out-when-something-broke-changed-with-git-bisect"]], "How would you solve this?": [[1, "discussion-1"]], "Optional exercise: Git bisect": [[1, "optional-exercise-git-bisect"]], "(optional) History-2: Use git bisect to find the bad commit": [[1, "exercise-1"], [9, "exercise-1"]], "Summary": [[1, "summary"], [2, "summary"], [3, "summary"], [4, "summary"], [14, "summary"], [15, "summary"]], "Basics": [[2, "basics"], [9, "basics"]], "What is Git, and what is a Git repository?": [[2, "what-is-git-and-what-is-a-git-repository"]], "Recording a snapshot with Git": [[2, "recording-a-snapshot-with-git"]], "Question for the more advanced participants": [[2, "discussion-0"]], "Configuring Git command line": [[2, "configuring-git-command-line"]], "Type-along: Tracking a guacamole recipe with Git": [[2, "type-along-tracking-a-guacamole-recipe-with-git"]], "Creating a repository": [[2, "creating-a-repository"]], "Adding files and committing changes": [[2, "adding-files-and-committing-changes"]], "Exercise: Record changes": [[2, "exercise-record-changes"]], "Basic-1: Record changes": [[2, "exercise-0"], [9, "exercise-0"]], "Git history and log": [[2, "git-history-and-log"]], "Optional exercises: Comparing changes": [[2, "optional-exercises-comparing-changes"]], "(optional) Basic-2: Comparing and showing commits": [[2, "exercise-1"], [9, "exercise-1"]], "(optional) Basic-3: Visual diff tools": [[2, "exercise-2"], [9, "exercise-2"]], "(optional) Basic-4: Browser and command line": [[2, "exercise-3"], [9, "exercise-3"]], "Writing useful commit messages": [[2, "writing-useful-commit-messages"], [13, "writing-useful-commit-messages"]], "Ignoring files and paths with .gitignore": [[2, "ignoring-files-and-paths-with-gitignore"]], "Graphical user interfaces": [[2, "graphical-user-interfaces"]], "Basic-5: Test your understanding": [[2, "exercise-4"], [9, "exercise-4"]], "Branching and merging": [[3, "branching-and-merging"], [9, "branching-and-merging"]], "Motivation for branches": [[3, "motivation-for-branches"]], "An important alias": [[3, null]], "Creating and working with branches": [[3, "creating-and-working-with-branches"]], "It is possible to create and merge branches directly on GitHub": [[3, null]], "Exercise: Create and commit to branches": [[3, "exercise-create-and-commit-to-branches"]], "Branch-1: Create and commit to branches": [[3, "exercise-0"], [9, "exercise-0"]], "Exercise: Merging branches": [[3, "exercise-merging-branches"]], "Branch-2: Merge branches": [[3, "exercise-1"], [9, "exercise-1"]], "If you got stuck in the above exercises or joined later": [[3, null]], "Deleting branches safely": [[3, "deleting-branches-safely"]], "Optional exercises with branches": [[3, "optional-exercises-with-branches"]], "(optional) Branch-3: Perform a fast-forward merge": [[3, "exercise-2"], [9, "exercise-2"]], "(optional) Branch-4: Rebase a branch (instead of merge)": [[3, "exercise-3"], [9, "exercise-3"]], "Tags": [[3, "tags"]], "Typical workflows": [[3, "typical-workflows"]], "Branch-5: Test your understanding": [[3, "exercise-4"], [9, "exercise-4"]], "Copy and browse an existing project": [[4, "copy-and-browse-an-existing-project"], [9, "copy-and-browse-an-existing-project"]], "GitHub, VS Code, Command line, and more": [[4, "github-vs-code-command-line-and-more"]], "Creating a copy of the repository by \u201cforking\u201d": [[4, "creating-a-copy-of-the-repository-by-forking"]], "Exercise: Browsing an existing project (25 min)": [[4, "exercise-0"], [9, "exercise-0"]], "Solution and walk-through": [[4, "solution-and-walk-through"], [5, "solution-and-walk-through"], [14, "solution-and-walk-through"], [15, "solution-and-walk-through"]], "(1) Basic browsing": [[4, "basic-browsing"]], "(2) Compare commit history with network graph": [[4, "compare-commit-history-with-network-graph"]], "(3) When was a recipe last modified?": [[4, "when-was-a-recipe-last-modified"]], "(4) How many changes did the Guacamole recipe receive?": [[4, "how-many-changes-did-the-guacamole-recipe-receive"]], "(5) Which recipes include the ingredient \u201csalt\u201d": [[4, "which-recipes-include-the-ingredient-salt"]], "Searching in a forked repository will not work instantaneously!": [[4, null]], "(6) Who modified each line last and when?": [[4, "who-modified-each-line-last-and-when"]], "(7) Can you use these recipes yourself? Are you allowed to share modifications?": [[4, "can-you-use-these-recipes-yourself-are-you-allowed-to-share-modifications"]], "(8) Browse issues and pull requests in the upstream repository": [[4, "browse-issues-and-pull-requests-in-the-upstream-repository"]], "Committing changes": [[5, "committing-changes"], [9, "committing-changes"]], "Background": [[5, "background"], [15, "background"]], "Exercise: Practice creating commits and branches (20 min)": [[5, "exercise-0"], [9, "exercise-0"]], "(1) Make sure you are on your fork": [[5, "make-sure-you-are-on-your-fork"]], "(2) Create a branch and add a recipe to the branch": [[5, "create-a-branch-and-add-a-recipe-to-the-branch"]], "(3) Modify the recipe with a new commit": [[5, "modify-the-recipe-with-a-new-commit"]], "(4) Switch to the main branch and modify a recipe there": [[5, "switch-to-the-main-branch-and-modify-a-recipe-there"]], "(5) Browse the commits you just made": [[5, "browse-the-commits-you-just-made"]], "(6) Compare the branches": [[5, "compare-the-branches"]], "(7) Compare two arbitrary commits": [[5, "compare-two-arbitrary-commits"]], "(8) Renaming a branch": [[5, "renaming-a-branch"]], "(9) Creating a tag": [[5, "creating-a-tag"]], "Configuring Git command line and editor": [[6, "configuring-git-command-line-and-editor"]], "Name and email address for Git commit metadata": [[6, "name-and-email-address-for-git-commit-metadata"]], "Default branch name": [[6, "default-branch-name"]], "Useful alias for the command line": [[6, "useful-alias-for-the-command-line"]], "Default text editor for commit messages": [[6, "default-text-editor-for-commit-messages"]], "Authenticating to GitHub: SSH or HTTPS or VS Code?": [[6, "authenticating-to-github-ssh-or-https-or-vs-code"]], "Conflict resolution": [[7, "conflict-resolution"], [7, "id2"], [9, "conflict-resolution"]], "Conflicts in Git and why they are good": [[7, "conflicts-in-git-and-why-they-are-good"]], "The human side of conflicts": [[7, "discussion-0"]], "Preparing a conflict": [[7, "preparing-a-conflict"]], "If you got stuck previously or joined later": [[7, null]], "Merging conflicting changes": [[7, "merging-conflicting-changes"]], "Steps to resolve a conflict": [[7, null]], "Exercise: Create and resolve a conflict": [[7, "exercise-create-and-resolve-a-conflict"]], "Conflict-1: Create another conflict and resolve": [[7, "exercise-0"], [9, "exercise-0"]], "Optional exercises with conflict resolution": [[7, "optional-exercises-with-conflict-resolution"]], "(optional) Conflict-2: Resolve a conflict when rebasing a branch": [[7, "exercise-1"], [9, "exercise-1"]], "(optional) Conflict-3: Resolve a conflict using mergetool": [[7, "exercise-2"], [9, "exercise-2"]], "Using \u201cours\u201d or \u201ctheirs\u201d strategy": [[7, "using-ours-or-theirs-strategy"]], "Aborting a conflicting merge": [[7, "aborting-a-conflicting-merge"]], "Avoiding conflicts": [[7, "avoiding-conflicts"]], "Customizing Git": [[8, "customizing-git"]], "Shell prompt": [[8, "shell-prompt"]], "More useful \u201cdiff\u201d output": [[8, "more-useful-diff-output"]], "List of exercises": [[9, "list-of-exercises"]], "Motivation": [[9, "motivation"], [16, "motivation"]], "Merging changes and contributing to the project": [[9, "merging-changes-and-contributing-to-the-project"], [15, "merging-changes-and-contributing-to-the-project"]], "Exercise: Merging branches with pull requests (20 min)": [[9, "exercise-0"], [15, "exercise-0"]], "Cloning a Git repository and working locally": [[9, "cloning-a-git-repository-and-working-locally"], [14, "cloning-a-git-repository-and-working-locally"]], "Exercise: Cloning a Git repository and working locally (25 min)": [[9, "exercise-0"], [14, "exercise-0"]], "How to turn your project to a Git repo and share it": [[9, "how-to-turn-your-project-to-a-git-repo-and-share-it"], [20, "how-to-turn-your-project-to-a-git-repo-and-share-it"]], "Exercise: Turn your project to a Git repo and share it (25 min)": [[9, "exercise-0"], [20, "exercise-0"]], "Using the Git staging area": [[9, "using-the-git-staging-area"], [21, "using-the-git-staging-area"]], "Staging-1: Perform an interactive commit": [[9, "exercise-0"], [21, "exercise-0"]], "Staging-2: Use the staging area to make a commit in two steps": [[9, "exercise-1"], [21, "exercise-1"]], "Undoing and recovering": [[9, "undoing-and-recovering"], [17, "undoing-and-recovering"]], "Undoing-1: Revert a commit": [[9, "exercise-0"], [17, "exercise-0"]], "Undoing-2: Modify a previous commit": [[9, "exercise-1"], [17, "exercise-1"]], "Undoing-3: Destroy our experimentation in this episode": [[9, "exercise-2"], [17, "exercise-2"]], "Undoing-4: Test your understanding": [[9, "exercise-3"], [17, "exercise-3"]], "Interrupted work": [[9, "interrupted-work"], [12, "interrupted-work"]], "Interrupted-1: Stash some uncommitted work": [[9, "exercise-0"], [12, "exercise-0"]], "Instructor guide": [[10, "instructor-guide"]], "Privacy": [[10, "privacy"]], "Schedule Day 1": [[10, "schedule-day-1"]], "Schedule Day 2": [[10, "schedule-day-2"]], "Why we teach this lesson": [[10, "why-we-teach-this-lesson"]], "Intended learning outcomes": [[10, "intended-learning-outcomes"]], "Live better than reading the website material": [[10, "live-better-than-reading-the-website-material"]], "Log your history in a separate window": [[10, "log-your-history-in-a-separate-window"]], "Create a cheatsheet on the board": [[10, "create-a-cheatsheet-on-the-board"]], "Draw a graph on the board": [[10, "draw-a-graph-on-the-board"]], "Repeat the following points": [[10, "repeat-the-following-points"]], "Start from identical environment": [[10, "start-from-identical-environment"]], "Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version": [[11, "introduction-to-version-control-with-git-why-we-want-to-track-versions-and-how-to-go-back-in-time-to-a-working-version"]], "Prerequisites": [[11, "prerequisites-0"]], "Getting started": [[11, null]], "Modifying an existing project": [[11, null]], "Studying an existing project": [[11, null]], "Sharing your work": [[11, null]], "Finding the balance": [[11, null]], "Older episodes": [[11, null]], "Optional episodes": [[11, null]], "Reference": [[11, null]], "About": [[11, null]], "Frequent situation: interrupted work": [[12, "frequent-situation-interrupted-work"]], "Option 1: Stashing": [[12, "option-1-stashing"]], "Exercise: Stashing": [[12, "exercise-stashing"]], "Option 2: Create branches": [[12, "option-2-create-branches"]], "Storing various junk you don\u2019t need but don\u2019t want to get rid of": [[12, "storing-various-junk-you-don-t-need-but-don-t-want-to-get-rid-of"]], "Practical advice: how much Git is necessary?": [[13, "practical-advice-how-much-git-is-necessary"]], "What level of branching complexity is necessary for each project?": [[13, "what-level-of-branching-complexity-is-necessary-for-each-project"]], "How about staging and committing?": [[13, "how-about-staging-and-committing"]], "How large should a commit be?": [[13, "how-large-should-a-commit-be"]], "What is in a Git repository and what are we cloning?": [[14, "what-is-in-a-git-repository-and-what-are-we-cloning"]], "(1) Configure Git command line and editor": [[14, "configure-git-command-line-and-editor"]], "(2) Cloning a repository": [[14, "cloning-a-repository"]], "(3) Creating branches locally": [[14, "creating-branches-locally"]], "(4) Creating commits locally": [[14, "creating-commits-locally"]], "(5) Switching branches and creating commits": [[14, "switching-branches-and-creating-commits"]], "(6) Merging branches locally": [[14, "merging-branches-locally"]], "(7) How to compare the graph locally and on GitHub": [[14, "how-to-compare-the-graph-locally-and-on-github"]], "(8) Browsing remote branches and creating local branches from them": [[14, "browsing-remote-branches-and-creating-local-branches-from-them"]], "(1) Navigate to your branch": [[15, "navigate-to-your-branch"]], "(2) Begin the pull request process": [[15, "begin-the-pull-request-process"]], "(3) Fill out and verify the pull request": [[15, "fill-out-and-verify-the-pull-request"]], "(4) Create the pull request": [[15, "create-the-pull-request"]], "(5) Merge the pull request": [[15, "merge-the-pull-request"]], "(6) Delete merged branches": [[15, "delete-merged-branches"]], "(7) Contribute to the original repository with a pull request": [[15, "contribute-to-the-original-repository-with-a-pull-request"]], "Resolving a conflict (demonstration)": [[15, "resolving-a-conflict-demonstration"]], "Git is all about keeping track of changes": [[16, "git-is-all-about-keeping-track-of-changes"]], "Why do we need to keep track of versions?": [[16, "why-do-we-need-to-keep-track-of-versions"]], "Features: roll-back, branching, merging, collaboration": [[16, "features-roll-back-branching-merging-collaboration"]], "Reproducibility": [[16, "reproducibility"]], "Talking about code": [[16, "talking-about-code"]], "What we typically like to snapshot": [[16, "what-we-typically-like-to-snapshot"]], "Difficulties of version control": [[16, "difficulties-of-version-control"]], "Why Git and not another tool?": [[16, "why-git-and-not-another-tool"]], "It is almost always possible to recover": [[17, null]], "Nice resource to visually simulate Git operation": [[17, null]], "Undoing your recent, uncommitted and unstaged changes (preserves history)": [[17, "undoing-your-recent-uncommitted-and-unstaged-changes-preserves-history"]], "Reverting commits (preserves history)": [[17, "reverting-commits-preserves-history"]], "Exercise: Revert a commit": [[17, "exercise-revert-a-commit"]], "Adding to the previous commit (modifies history)": [[17, "adding-to-the-previous-commit-modifies-history"]], "Exercise: Modify a previous commit": [[17, "exercise-modify-a-previous-commit"]], "Rewinding branches (modifies history)": [[17, "rewinding-branches-modifies-history"]], "Exercise: Git reset": [[17, "exercise-git-reset"]], "Recovering from committing to the wrong branch": [[17, "recovering-from-committing-to-the-wrong-branch"]], "Recovering from merging/pulling into the wrong branch": [[17, "recovering-from-merging-pulling-into-the-wrong-branch"]], "Recovering from conflict after pulling changes": [[17, "recovering-from-conflict-after-pulling-changes"]], "Quick reference": [[18, "quick-reference"]], "Other cheatsheets": [[18, "other-cheatsheets"]], "Glossary": [[18, "glossary"]], "Commands we use": [[18, "commands-we-use"]], "Other resources": [[19, "other-resources"]], "Remote repositories": [[20, "remote-repositories"]], "Is putting software on GitHub/GitLab/\u2026 publishing?": [[20, "is-putting-software-on-github-gitlab-publishing"]], "Commit history is telling a story": [[21, "commit-history-is-telling-a-story"]], "Interactive commits": [[21, "interactive-commits"]], "Exercise: Interactive commits": [[21, "exercise-interactive-commits"]], "The staging area": [[21, "the-staging-area"]], "Staging area commands": [[21, "staging-area-commands"]], "Exercise: Using the staging area": [[21, "exercise-using-the-staging-area"]], "Git under the hood": [[22, "git-under-the-hood"]], "Down the rabbit hole": [[22, "down-the-rabbit-hole"]], "Git is basically a content-addressed storage system": [[22, "git-is-basically-a-content-addressed-storage-system"]], "Demonstration: experimenting with branches": [[22, "demonstration-experimenting-with-branches"]], "What to avoid": [[23, "what-to-avoid"]]}, "indexentries": {"github repository": [[18, "term-GitHub-repository"]], "head": [[18, "term-HEAD"]], "vs code": [[18, "term-VS-Code"]], "alias": [[18, "term-alias"]], "branch": [[18, "term-branch"]], "clone": [[18, "term-clone"]], "commit": [[18, "term-commit"]], "fork": [[18, "term-fork"]], "git": [[18, "term-git"]], "hash": [[18, "term-hash"]], "issue": [[18, "term-issue"]], "main": [[18, "term-main"]], "master": [[18, "term-master"]], "merge": [[18, "term-merge"]], "merging": [[18, "term-merging"]], "origin": [[18, "term-origin"]], "pull": [[18, "term-pull"]], "pull request": [[18, "term-pull-request"]], "push": [[18, "term-push"]], "remote": [[18, "term-remote"]], "repository": [[18, "term-repository"]], "staging area": [[18, "term-staging-area"]], "tag": [[18, "term-tag"]], "upstream": [[18, "term-upstream"]], "version control system": [[18, "term-version-control-system"]], "working directory": [[18, "term-working-directory"]], "workspace": [[18, "term-workspace"]]}}) \ No newline at end of file diff --git a/branch/main/sharing/index.html b/branch/main/sharing/index.html new file mode 100644 index 00000000..9ad1c053 --- /dev/null +++ b/branch/main/sharing/index.html @@ -0,0 +1,435 @@ + + + + + + + How to turn your project to a Git repo and share it — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • How to turn your project to a Git repo and share it
    • +
  • + Edit on GitHub +
    • +
+
+
+
+
+ +
+

How to turn your project to a Git repo and share it

+
+

Objectives

+
    +

  • Turn our own coding project (small or large, finished or unfinished) into a +Git repository.

    • +

  • Be able to share a repository on the web to have a backup or so that others +can reuse and collaborate or even just find it.

    • +
+
+
+

Instructor note

+
    +

  • 10 min introduction and setup

    • +

  • 25 min exercise

    • +

  • 15 min discussion

    • +
+
+
+

Exercise

+
+

Exercise: Turn your project to a Git repo and share it (25 min)

+
    +

  1. Create a new directory called myproject with one or few files in it. +This represents our own project. It is not yet a Git repository. You can try +that with your own project or use a simple placeholder example.

    2. +

  2. Turn this new directory into a Git repository.

    3. +

  3. Share this repository on GitHub (or GitLab, since it really works the same).

    4. +
+

We offer three different paths of how to do this exercise.

+
    +

  • Via GitHub web interface: easy and can be a good starting point if you are completely +new to Git.

    • +

  • VS Code is quite easy, since VS Code can offer to create the +GitHub repositories for you.

    • +

  • Command line: you need to create the +repository on GitHub and link it yourself.

    • +
+
+

Create an repository on GitHub

+

First log into GitHub, then follow the screenshots and descriptions below.

+
+Screenshot on GitHub before a new repository form is opened +
+

Click on the “plus” symbol on top right, then on “New repository”.

+
+
+

Then:

+
+Screenshot on GitHub just before a new repository is created +
+

Choose a repository name, add a short description, and in this case make sure to check “Add a +README file”. Finally “Create repository”.

+
+
+

Upload your files

+

Now that the repository is created, you can upload your files:

+
+Screenshot on GitHub just before uploading files +
+

Click on the “+” symbol and then on “Upload files”.

+
+
+
+
+
+
+

Remote repositories

+

In this exercise we have pushed our local repository to a remote repository. +We will learn how to work with remote repositories in detail in the +collaborative distributed version +control lesson. To store +your git data on another server, you use remotes. A remote is a repository +on its own, with its own branches. We can push changes to the remote and +pull from the remote.

+

You might use remotes to:

+
    +

  • Back up your own work or make your work findable.

    • +

  • To collaborate with other people.

    • +
+

There are different types of remotes:

+
    +

  • If you have a server you can SSH to, you can use that as a remote.

    • +

  • GitHub is a popular, closed-source commercial site.

    • +

  • GitLab is a popular, open-core +commercial site. Many universities have their own private GitLab servers +set up.

    • +

  • Bitbucket is yet another popular commercial site.

    • +

  • Another option is NotABug.

    • +

  • There are more …

    • +
+
+
+

Is putting software on GitHub/GitLab/… publishing?

+

It is a good first step but to make your code truly findable and +accessible, condider making your code citable and persistent: Get a +persistent identifier (PID) such as DOI in addition to sharing the code +publicly, by using services like Zenodo or similar +services.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/singlehtml/.buildinfo b/branch/main/singlehtml/.buildinfo new file mode 100644 index 00000000..d48d887f --- /dev/null +++ b/branch/main/singlehtml/.buildinfo @@ -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: e21ba9a26a1fa041e43d0d2e9e34e5b6 +tags: 33eac41acc08762151beb8f3b7b86c8f diff --git a/branch/main/singlehtml/.nojekyll b/branch/main/singlehtml/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/branch/main/singlehtml/_images/add-file.png b/branch/main/singlehtml/_images/add-file.png new file mode 100644 index 00000000..9683b2db Binary files /dev/null and b/branch/main/singlehtml/_images/add-file.png differ diff --git a/branch/main/singlehtml/_images/annotate.png b/branch/main/singlehtml/_images/annotate.png new file mode 100644 index 00000000..8021920a Binary files /dev/null and b/branch/main/singlehtml/_images/annotate.png differ diff --git a/branch/main/singlehtml/_images/annotate1.png b/branch/main/singlehtml/_images/annotate1.png new file mode 100644 index 00000000..93416b2a Binary files /dev/null and b/branch/main/singlehtml/_images/annotate1.png differ diff --git a/branch/main/singlehtml/_images/bare-repository.png b/branch/main/singlehtml/_images/bare-repository.png new file mode 100644 index 00000000..45286f93 Binary files /dev/null and b/branch/main/singlehtml/_images/bare-repository.png differ diff --git a/branch/main/singlehtml/_images/browse-files.png b/branch/main/singlehtml/_images/browse-files.png new file mode 100644 index 00000000..5fcc3528 Binary files /dev/null and b/branch/main/singlehtml/_images/browse-files.png differ diff --git a/branch/main/singlehtml/_images/cheat-sheet.jpg b/branch/main/singlehtml/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/branch/main/singlehtml/_images/cheat-sheet.jpg differ diff --git a/branch/main/singlehtml/_images/code-portion.png b/branch/main/singlehtml/_images/code-portion.png new file mode 100644 index 00000000..39356bd5 Binary files /dev/null and b/branch/main/singlehtml/_images/code-portion.png differ diff --git a/branch/main/singlehtml/_images/commit-and-tree.png b/branch/main/singlehtml/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/branch/main/singlehtml/_images/commit-and-tree.png differ diff --git a/branch/main/singlehtml/_images/commit-changes.png b/branch/main/singlehtml/_images/commit-changes.png new file mode 100644 index 00000000..4c0546c6 Binary files /dev/null and b/branch/main/singlehtml/_images/commit-changes.png differ diff --git a/branch/main/singlehtml/_images/commits-and-parents.png b/branch/main/singlehtml/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/branch/main/singlehtml/_images/commits-and-parents.png differ diff --git a/branch/main/singlehtml/_images/commits.png b/branch/main/singlehtml/_images/commits.png new file mode 100644 index 00000000..b154c666 Binary files /dev/null and b/branch/main/singlehtml/_images/commits.png differ diff --git a/branch/main/singlehtml/_images/create-repository-with-readme.png b/branch/main/singlehtml/_images/create-repository-with-readme.png new file mode 100644 index 00000000..24118344 Binary files /dev/null and b/branch/main/singlehtml/_images/create-repository-with-readme.png differ diff --git a/branch/main/singlehtml/_images/create-repository.png b/branch/main/singlehtml/_images/create-repository.png new file mode 100644 index 00000000..80fb99c2 Binary files /dev/null and b/branch/main/singlehtml/_images/create-repository.png differ diff --git a/branch/main/singlehtml/_images/edit-file.png b/branch/main/singlehtml/_images/edit-file.png new file mode 100644 index 00000000..f7527bd0 Binary files /dev/null and b/branch/main/singlehtml/_images/edit-file.png differ diff --git a/branch/main/singlehtml/_images/file-history.png b/branch/main/singlehtml/_images/file-history.png new file mode 100644 index 00000000..5e42fbe9 Binary files /dev/null and b/branch/main/singlehtml/_images/file-history.png differ diff --git a/branch/main/singlehtml/_images/fork.png b/branch/main/singlehtml/_images/fork.png new file mode 100644 index 00000000..0c992d3d Binary files /dev/null and b/branch/main/singlehtml/_images/fork.png differ diff --git a/branch/main/singlehtml/_images/forking.png b/branch/main/singlehtml/_images/forking.png new file mode 100644 index 00000000..73c4d71a Binary files /dev/null and b/branch/main/singlehtml/_images/forking.png differ diff --git a/branch/main/singlehtml/_images/git-annotate.png b/branch/main/singlehtml/_images/git-annotate.png new file mode 100644 index 00000000..60c6f7c2 Binary files /dev/null and b/branch/main/singlehtml/_images/git-annotate.png differ diff --git a/branch/main/singlehtml/_images/git-branch-1.svg b/branch/main/singlehtml/_images/git-branch-1.svg new file mode 100644 index 00000000..4b735e40 --- /dev/null +++ b/branch/main/singlehtml/_images/git-branch-1.svg @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + m2 + + + m3 + + + m1 + + + + + main + + + + + HEAD + + + diff --git a/branch/main/singlehtml/_images/git-branch-2.svg b/branch/main/singlehtml/_images/git-branch-2.svg new file mode 100644 index 00000000..dde628b6 --- /dev/null +++ b/branch/main/singlehtml/_images/git-branch-2.svg @@ -0,0 +1,443 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + l1 + + + e2 + + + e1 + + + m5 + + + m4 + + + m2 + + + m3 + + + m1 + + + + + less-salt + + + + + HEAD + + + + + experiment + + + + + main + + + diff --git a/branch/main/singlehtml/_images/git-branch-3.svg b/branch/main/singlehtml/_images/git-branch-3.svg new file mode 100644 index 00000000..19231579 --- /dev/null +++ b/branch/main/singlehtml/_images/git-branch-3.svg @@ -0,0 +1,475 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + e2 + + + m3 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + + + less-salt + + + + + experiment + + + diff --git a/branch/main/singlehtml/_images/git-collaborative.svg b/branch/main/singlehtml/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/branch/main/singlehtml/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/branch/main/singlehtml/_images/git-deleted-branches.svg b/branch/main/singlehtml/_images/git-deleted-branches.svg new file mode 100644 index 00000000..d54c0032 --- /dev/null +++ b/branch/main/singlehtml/_images/git-deleted-branches.svg @@ -0,0 +1,483 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + m5 + + + l1 + + + m4 + + + + + main + + + + + HEAD + + + diff --git a/branch/main/singlehtml/_images/git-log-github.png b/branch/main/singlehtml/_images/git-log-github.png new file mode 100644 index 00000000..db44d29b Binary files /dev/null and b/branch/main/singlehtml/_images/git-log-github.png differ diff --git a/branch/main/singlehtml/_images/git-log-terminal.png b/branch/main/singlehtml/_images/git-log-terminal.png new file mode 100644 index 00000000..56493e6e Binary files /dev/null and b/branch/main/singlehtml/_images/git-log-terminal.png differ diff --git a/branch/main/singlehtml/_images/git-merge-1.svg b/branch/main/singlehtml/_images/git-merge-1.svg new file mode 100644 index 00000000..005301ab --- /dev/null +++ b/branch/main/singlehtml/_images/git-merge-1.svg @@ -0,0 +1,515 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m1 + + + m2 + + + m5 + + + m6 + + + e1 + + + m3 + + + l1 + + + m7 + + + m4 + + + + + experiment + + + + + less-salt + + + + + main + + + + + HEAD + + + diff --git a/branch/main/singlehtml/_images/git-merge-2.svg b/branch/main/singlehtml/_images/git-merge-2.svg new file mode 100644 index 00000000..cb268ee7 --- /dev/null +++ b/branch/main/singlehtml/_images/git-merge-2.svg @@ -0,0 +1,555 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m7 + + + m8 + + + m6 + + + m1 + + + m2 + + + e1 + + + m3 + + + l1 + + + m5 + + + m4 + + + + + experiment + + + + + main + + + + + HEAD + + + + + less-salt + + + diff --git a/branch/main/singlehtml/_images/git-pre-ff.svg b/branch/main/singlehtml/_images/git-pre-ff.svg new file mode 100644 index 00000000..e4d8bc5b --- /dev/null +++ b/branch/main/singlehtml/_images/git-pre-ff.svg @@ -0,0 +1,615 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e1 + + + e2 + + + m7 + + + m8 + + + n3 + + + n1 + + + m5 + + + l1 + + + m6 + + + m4 + + + n2 + + + m2 + + + m3 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + main + + + diff --git a/branch/main/singlehtml/_images/git_stage_commit.svg b/branch/main/singlehtml/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/branch/main/singlehtml/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/main/singlehtml/_images/github-branches-overview.png b/branch/main/singlehtml/_images/github-branches-overview.png new file mode 100644 index 00000000..89e0058d Binary files /dev/null and b/branch/main/singlehtml/_images/github-branches-overview.png differ diff --git a/branch/main/singlehtml/_images/github-branches.png b/branch/main/singlehtml/_images/github-branches.png new file mode 100644 index 00000000..3a6a8ff9 Binary files /dev/null and b/branch/main/singlehtml/_images/github-branches.png differ diff --git a/branch/main/singlehtml/_images/github-comparing-changes.png b/branch/main/singlehtml/_images/github-comparing-changes.png new file mode 100644 index 00000000..735b990b Binary files /dev/null and b/branch/main/singlehtml/_images/github-comparing-changes.png differ diff --git a/branch/main/singlehtml/_images/github-contribute.png b/branch/main/singlehtml/_images/github-contribute.png new file mode 100644 index 00000000..a149e9f3 Binary files /dev/null and b/branch/main/singlehtml/_images/github-contribute.png differ diff --git a/branch/main/singlehtml/_images/github-create-branch.png b/branch/main/singlehtml/_images/github-create-branch.png new file mode 100644 index 00000000..e7958ff2 Binary files /dev/null and b/branch/main/singlehtml/_images/github-create-branch.png differ diff --git a/branch/main/singlehtml/_images/github-create-tag.png b/branch/main/singlehtml/_images/github-create-tag.png new file mode 100644 index 00000000..f08f5878 Binary files /dev/null and b/branch/main/singlehtml/_images/github-create-tag.png differ diff --git a/branch/main/singlehtml/_images/github-merged.png b/branch/main/singlehtml/_images/github-merged.png new file mode 100644 index 00000000..eea47d93 Binary files /dev/null and b/branch/main/singlehtml/_images/github-merged.png differ diff --git a/branch/main/singlehtml/_images/github-navigate-to-branch.png b/branch/main/singlehtml/_images/github-navigate-to-branch.png new file mode 100644 index 00000000..42b0f753 Binary files /dev/null and b/branch/main/singlehtml/_images/github-navigate-to-branch.png differ diff --git a/branch/main/singlehtml/_images/gophers.png b/branch/main/singlehtml/_images/gophers.png new file mode 100644 index 00000000..741406ba Binary files /dev/null and b/branch/main/singlehtml/_images/gophers.png differ diff --git a/branch/main/singlehtml/_images/history.png b/branch/main/singlehtml/_images/history.png new file mode 100644 index 00000000..6384e302 Binary files /dev/null and b/branch/main/singlehtml/_images/history.png differ diff --git a/branch/main/singlehtml/_images/history1.png b/branch/main/singlehtml/_images/history1.png new file mode 100644 index 00000000..06662c31 Binary files /dev/null and b/branch/main/singlehtml/_images/history1.png differ diff --git a/branch/main/singlehtml/_images/license.png b/branch/main/singlehtml/_images/license.png new file mode 100644 index 00000000..f4cadf0d Binary files /dev/null and b/branch/main/singlehtml/_images/license.png differ diff --git a/branch/main/singlehtml/_images/meld.png b/branch/main/singlehtml/_images/meld.png new file mode 100644 index 00000000..774f9cd1 Binary files /dev/null and b/branch/main/singlehtml/_images/meld.png differ diff --git a/branch/main/singlehtml/_images/mergetool.png b/branch/main/singlehtml/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/branch/main/singlehtml/_images/mergetool.png differ diff --git a/branch/main/singlehtml/_images/network.png b/branch/main/singlehtml/_images/network.png new file mode 100644 index 00000000..e0fcb2fb Binary files /dev/null and b/branch/main/singlehtml/_images/network.png differ diff --git a/branch/main/singlehtml/_images/new-repo-form.png b/branch/main/singlehtml/_images/new-repo-form.png new file mode 100644 index 00000000..b808ee0b Binary files /dev/null and b/branch/main/singlehtml/_images/new-repo-form.png differ diff --git a/branch/main/singlehtml/_images/new-repo-plus.png b/branch/main/singlehtml/_images/new-repo-plus.png new file mode 100644 index 00000000..e58ba5d8 Binary files /dev/null and b/branch/main/singlehtml/_images/new-repo-plus.png differ diff --git a/branch/main/singlehtml/_images/new-repository.png b/branch/main/singlehtml/_images/new-repository.png new file mode 100644 index 00000000..aff76772 Binary files /dev/null and b/branch/main/singlehtml/_images/new-repository.png differ diff --git a/branch/main/singlehtml/_images/pen-symbol.png b/branch/main/singlehtml/_images/pen-symbol.png new file mode 100644 index 00000000..044902a3 Binary files /dev/null and b/branch/main/singlehtml/_images/pen-symbol.png differ diff --git a/branch/main/singlehtml/_images/preview.png b/branch/main/singlehtml/_images/preview.png new file mode 100644 index 00000000..8a602b66 Binary files /dev/null and b/branch/main/singlehtml/_images/preview.png differ diff --git a/branch/main/singlehtml/_images/search.png b/branch/main/singlehtml/_images/search.png new file mode 100644 index 00000000..4462f71e Binary files /dev/null and b/branch/main/singlehtml/_images/search.png differ diff --git a/branch/main/singlehtml/_images/search1.png b/branch/main/singlehtml/_images/search1.png new file mode 100644 index 00000000..89c0e25a Binary files /dev/null and b/branch/main/singlehtml/_images/search1.png differ diff --git a/branch/main/singlehtml/_images/show.png b/branch/main/singlehtml/_images/show.png new file mode 100644 index 00000000..12d7915c Binary files /dev/null and b/branch/main/singlehtml/_images/show.png differ diff --git a/branch/main/singlehtml/_images/staging-basics.svg b/branch/main/singlehtml/_images/staging-basics.svg new file mode 100644 index 00000000..13df8bf5 --- /dev/null +++ b/branch/main/singlehtml/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + restore + add + commit + restore + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/branch/main/singlehtml/_images/stranger.jpg b/branch/main/singlehtml/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/branch/main/singlehtml/_images/stranger.jpg differ diff --git a/branch/main/singlehtml/_images/upload-files.png b/branch/main/singlehtml/_images/upload-files.png new file mode 100644 index 00000000..fd3ef8cc Binary files /dev/null and b/branch/main/singlehtml/_images/upload-files.png differ diff --git a/branch/main/singlehtml/_images/vscode-add-and-commit.png b/branch/main/singlehtml/_images/vscode-add-and-commit.png new file mode 100644 index 00000000..d9a09c46 Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-add-and-commit.png differ diff --git a/branch/main/singlehtml/_images/vscode-authorize.png b/branch/main/singlehtml/_images/vscode-authorize.png new file mode 100644 index 00000000..4d45dc2d Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-authorize.png differ diff --git a/branch/main/singlehtml/_images/vscode-change-branch.png b/branch/main/singlehtml/_images/vscode-change-branch.png new file mode 100644 index 00000000..c1a5f00a Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-change-branch.png differ diff --git a/branch/main/singlehtml/_images/vscode-create-branch.png b/branch/main/singlehtml/_images/vscode-create-branch.png new file mode 100644 index 00000000..71b275a9 Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-create-branch.png differ diff --git a/branch/main/singlehtml/_images/vscode-merging.png b/branch/main/singlehtml/_images/vscode-merging.png new file mode 100644 index 00000000..7e5880e7 Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-merging.png differ diff --git a/branch/main/singlehtml/_images/vscode-open-terminal.png b/branch/main/singlehtml/_images/vscode-open-terminal.png new file mode 100644 index 00000000..1be92267 Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-open-terminal.png differ diff --git a/branch/main/singlehtml/_images/vscode-publish-to-github1.png b/branch/main/singlehtml/_images/vscode-publish-to-github1.png new file mode 100644 index 00000000..883e756c Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-publish-to-github1.png differ diff --git a/branch/main/singlehtml/_images/vscode-publish-to-github2.png b/branch/main/singlehtml/_images/vscode-publish-to-github2.png new file mode 100644 index 00000000..d0055db4 Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-publish-to-github2.png differ diff --git a/branch/main/singlehtml/_images/vscode-publish-to-github3.png b/branch/main/singlehtml/_images/vscode-publish-to-github3.png new file mode 100644 index 00000000..0f68d0ee Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-publish-to-github3.png differ diff --git a/branch/main/singlehtml/_images/vscode-start.png b/branch/main/singlehtml/_images/vscode-start.png new file mode 100644 index 00000000..e7830807 Binary files /dev/null and b/branch/main/singlehtml/_images/vscode-start.png differ diff --git a/branch/main/singlehtml/_static/_sphinx_javascript_frameworks_compat.js b/branch/main/singlehtml/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/branch/main/singlehtml/_static/_sphinx_javascript_frameworks_compat.js @@ -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; +} diff --git a/branch/main/singlehtml/_static/basic.css b/branch/main/singlehtml/_static/basic.css new file mode 100644 index 00000000..30fee9d0 --- /dev/null +++ b/branch/main/singlehtml/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/branch/main/singlehtml/_static/check-solid.svg b/branch/main/singlehtml/_static/check-solid.svg new file mode 100644 index 00000000..92fad4b5 --- /dev/null +++ b/branch/main/singlehtml/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/main/singlehtml/_static/clipboard.min.js b/branch/main/singlehtml/_static/clipboard.min.js new file mode 100644 index 00000000..54b3c463 --- /dev/null +++ b/branch/main/singlehtml/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/branch/main/singlehtml/_static/copybutton.css b/branch/main/singlehtml/_static/copybutton.css new file mode 100644 index 00000000..40eafe5f --- /dev/null +++ b/branch/main/singlehtml/_static/copybutton.css @@ -0,0 +1,93 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +.highlight:hover button.copybtn { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/branch/main/singlehtml/_static/copybutton.js b/branch/main/singlehtml/_static/copybutton.js new file mode 100644 index 00000000..f3ecd034 --- /dev/null +++ b/branch/main/singlehtml/_static/copybutton.js @@ -0,0 +1,241 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copié dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for two seconds, then changes it back +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000) + setTimeout(() => el.classList.remove('success'), 2000) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, 2000) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos, .gp'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/branch/main/singlehtml/_static/copybutton_funcs.js b/branch/main/singlehtml/_static/copybutton_funcs.js new file mode 100644 index 00000000..dbe1aaad --- /dev/null +++ b/branch/main/singlehtml/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/branch/main/singlehtml/_static/css/badge_only.css b/branch/main/singlehtml/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/branch/main/singlehtml/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff2 b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff2 b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.eot b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.svg b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.ttf b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.woff b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.woff2 b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-bold-italic.woff b/branch/main/singlehtml/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-bold-italic.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-bold-italic.woff2 b/branch/main/singlehtml/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-bold.woff b/branch/main/singlehtml/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-bold.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-bold.woff2 b/branch/main/singlehtml/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-bold.woff2 differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-normal-italic.woff b/branch/main/singlehtml/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-normal-italic.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-normal-italic.woff2 b/branch/main/singlehtml/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-normal.woff b/branch/main/singlehtml/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-normal.woff differ diff --git a/branch/main/singlehtml/_static/css/fonts/lato-normal.woff2 b/branch/main/singlehtml/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/branch/main/singlehtml/_static/css/fonts/lato-normal.woff2 differ diff --git a/branch/main/singlehtml/_static/css/theme.css b/branch/main/singlehtml/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/branch/main/singlehtml/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/branch/main/singlehtml/_static/doctools.js b/branch/main/singlehtml/_static/doctools.js new file mode 100644 index 00000000..d06a71d7 --- /dev/null +++ b/branch/main/singlehtml/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/branch/main/singlehtml/_static/documentation_options.js b/branch/main/singlehtml/_static/documentation_options.js new file mode 100644 index 00000000..89003c67 --- /dev/null +++ b/branch/main/singlehtml/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'singlehtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/branch/main/singlehtml/_static/file.png b/branch/main/singlehtml/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/branch/main/singlehtml/_static/file.png differ diff --git a/branch/main/singlehtml/_static/jquery.js b/branch/main/singlehtml/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/branch/main/singlehtml/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/main/singlehtml/_static/js/html5shiv.min.js b/branch/main/singlehtml/_static/js/html5shiv.min.js new file mode 100644 index 00000000..cd1c674f --- /dev/null +++ b/branch/main/singlehtml/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/main/singlehtml/_static/js/theme.js b/branch/main/singlehtml/_static/js/theme.js new file mode 100644 index 00000000..1fddb6ee --- /dev/null +++ b/branch/main/singlehtml/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/branch/main/singlehtml/_static/minipres.js b/branch/main/singlehtml/_static/minipres.js new file mode 100644 index 00000000..ad11c871 --- /dev/null +++ b/branch/main/singlehtml/_static/minipres.js @@ -0,0 +1,223 @@ +// Add goTo method to elements +// http://stackoverflow.com/questions/4801655/how-to-go-to-a-specific-element-on-page +(function($) { + $.fn.goTo = function() { + $('html, body').animate({ + scrollTop: $(this).offset().top //+ 'px' + }, 'fast'); + return this; // for chaining... + } +})(jQuery); + +// NO good way to do this!. Copy a hack from here +// https://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript +// https://stackoverflow.com/a/2880929 +var urlParams; +(window.onpopstate = function () { + var match, + pl = /\+/g, // Regex for replacing addition symbol with a space + search = /([^&=]+)=?([^&]*)/g, + decode = function (s) { return decodeURIComponent(s.replace(pl, " ")); }, + query = window.location.search.substring(1); + urlParams = {}; + while (match = search.exec(query)) + urlParams[decode(match[1])] = decode(match[2]); +})(); + +// Select heading levels +var maxHeading = urlParams['h'] +if (maxHeading === undefined) maxHeading = 2 +var headingLevels = []; +for (h=2 ; h (sections.length-1) ) { + // if we would scroll past bottom, or above top, do nothing + return; + } + + console.log('xxxxxx'); + var targetSection = sections[targetPos]; + console.log(targetSection, typeof(targetSection)); + + // Return targetSection top and height + var secProperties = section_top_and_height(targetSection); + var top = secProperties['top']; + var height = secProperties['height'] + var win_height = window.innerHeight; + //console.info(top, height, win_height) + + var scroll_to = 0; + if (height >= win_height || height == 0) { + scroll_to = top; + } else { + scroll_to = top - (win_height-height)/3.; + } + //console.info(top, height, win_height, scroll_to) + + $('html, body').animate({ + scrollTop: scroll_to //+ 'px' + }, 'fast'); + +} + + +function minipres() { + /* Enable the minipres mode: + - call the hide() function + - set up the scrolling listener + */ + document.addEventListener('keydown', function (event) { + switch(event.which) { + case 37: // left + switch_slide(-1); + event.preventDefault(); + return false; + break; + //case 38: // up + case 39: // right + switch_slide(+1); + event.preventDefault(); + return false; + break; + //case 40: // down + default: + return; // exit this handler for other keys + } + }, true) + + hide() + + // Increase space between sections + //$("div .section").css('margin-bottom', '50%'); + $(sectionSelector).css('margin-top', '50%'); + + // Reduce size/color of other sections + if (hiddenSectionSelector.length > 0) { + var hideNodes = $(hiddenSectionSelector); + console.log(typeof hideNodes, hideNodes); + for (node in hideNodes) { + console.log("a", typeof node, node); + node = hideNodes[node]; // what's right way to iterate values? + console.log("b", typeof node, node); + if (node.parentNode && node.parentNode.className == "section") { + node = node.parentNode; + console.log("c", typeof node, node); + //node.css['transform'] = 'scale(.5)'; + //node.css['transform-origin'] = 'top center'; + $(node).css('color', 'lightgrey'); + //$(node).css('font-size', '20%'); + //$(node).css('visibility', 'collapse'); + //ntahousnatouhasno; + } + } + } +} + +function hide() { + /* Hide all non-essential elements on the page + */ + + // This is for sphinx_rst_theme and readthedocs + $(".wy-nav-side").remove(); + $(".wy-nav-content-wrap").css('margin-left', 0); + $('.rst-versions').remove(); // readthedocs version selector + + // Add other formats here. +} + + +var slideshow = minipres; + +if (window.location.search.match(/[?&](minipres|slideshow|pres)([=&]|$)/) ) { + //minipres() + window.addEventListener("load", minipres); +} else if (window.location.search.match(/[?&](plain)([=&]|$)/) ) { + window.addEventListener("load", hide); +} diff --git a/branch/main/singlehtml/_static/minus.png b/branch/main/singlehtml/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/branch/main/singlehtml/_static/minus.png differ diff --git a/branch/main/singlehtml/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css b/branch/main/singlehtml/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css new file mode 100644 index 00000000..33566310 --- /dev/null +++ b/branch/main/singlehtml/_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css @@ -0,0 +1,2342 @@ +/* Variables */ +:root { + --mystnb-source-bg-color: #f7f7f7; + --mystnb-stdout-bg-color: #fcfcfc; + --mystnb-stderr-bg-color: #fdd; + --mystnb-traceback-bg-color: #fcfcfc; + --mystnb-source-border-color: #ccc; + --mystnb-source-margin-color: green; + --mystnb-stdout-border-color: #f7f7f7; + --mystnb-stderr-border-color: #f7f7f7; + --mystnb-traceback-border-color: #ffd6d6; + --mystnb-hide-prompt-opacity: 70%; + --mystnb-source-border-radius: .4em; + --mystnb-source-border-width: 1px; +} + +/* Whole cell */ +div.container.cell { + padding-left: 0; + margin-bottom: 1em; +} + +/* Removing all background formatting so we can control at the div level */ +.cell_input div.highlight, +.cell_output pre, +.cell_input pre, +.cell_output .output { + border: none; + box-shadow: none; +} + +.cell_output .output pre, +.cell_input pre { + margin: 0px; +} + +/* Input cells */ +div.cell div.cell_input, +div.cell details.above-input>summary { + padding-left: 0em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + background-color: var(--mystnb-source-bg-color); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; + border-radius: var(--mystnb-source-border-radius); +} + +div.cell_input>div, +div.cell_output div.output>div.highlight { + margin: 0em !important; + border: none !important; +} + +/* All cell outputs */ +.cell_output { + padding-left: 1em; + padding-right: 0em; + margin-top: 1em; +} + +/* Text outputs from cells */ +.cell_output .output.text_plain, +.cell_output .output.traceback, +.cell_output .output.stream, +.cell_output .output.stderr { + margin-top: 1em; + margin-bottom: 0em; + box-shadow: none; +} + +.cell_output .output.text_plain, +.cell_output .output.stream { + background: var(--mystnb-stdout-bg-color); + border: 1px solid var(--mystnb-stdout-border-color); +} + +.cell_output .output.stderr { + background: var(--mystnb-stderr-bg-color); + border: 1px solid var(--mystnb-stderr-border-color); +} + +.cell_output .output.traceback { + background: var(--mystnb-traceback-bg-color); + border: 1px solid var(--mystnb-traceback-border-color); +} + +/* Collapsible cell content */ +div.cell details.above-input div.cell_input { + border-top-left-radius: 0; + border-top-right-radius: 0; + border-top: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; +} + +div.cell div.cell_input.above-output-prompt { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} + +div.cell details.above-input>summary { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + border-bottom: var(--mystnb-source-border-width) var(--mystnb-source-border-color) dashed; + padding-left: 1em; + margin-bottom: 0; +} + +div.cell details.above-output>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.below-input>summary { + background-color: var(--mystnb-source-bg-color); + padding-left: 1em; + padding-right: 0em; + border: var(--mystnb-source-border-width) var(--mystnb-source-border-color) solid; + border-top: none; + border-bottom-left-radius: var(--mystnb-source-border-radius); + border-bottom-right-radius: var(--mystnb-source-border-radius); + border-left-color: var(--mystnb-source-margin-color); + border-left-width: medium; +} + +div.cell details.hide>summary>span { + opacity: var(--mystnb-hide-prompt-opacity); +} + +div.cell details.hide[open]>summary>span.collapsed { + display: none; +} + +div.cell details.hide:not([open])>summary>span.expanded { + display: none; +} + +@keyframes collapsed-fade-in { + 0% { + opacity: 0; + } + + 100% { + opacity: 1; + } +} +div.cell details.hide[open]>summary~* { + -moz-animation: collapsed-fade-in 0.3s ease-in-out; + -webkit-animation: collapsed-fade-in 0.3s ease-in-out; + animation: collapsed-fade-in 0.3s ease-in-out; +} + +/* Math align to the left */ +.cell_output .MathJax_Display { + text-align: left !important; +} + +/* Pandas tables. Pulled from the Jupyter / nbsphinx CSS */ +div.cell_output table { + border: none; + border-collapse: collapse; + border-spacing: 0; + color: black; + font-size: 1em; + table-layout: fixed; +} + +div.cell_output thead { + border-bottom: 1px solid black; + vertical-align: bottom; +} + +div.cell_output tr, +div.cell_output th, +div.cell_output td { + text-align: right; + vertical-align: middle; + padding: 0.5em 0.5em; + line-height: normal; + white-space: normal; + max-width: none; + border: none; +} + +div.cell_output th { + font-weight: bold; +} + +div.cell_output tbody tr:nth-child(odd) { + background: #f5f5f5; +} + +div.cell_output tbody tr:hover { + background: rgba(66, 165, 245, 0.2); +} + +/** source code line numbers **/ +span.linenos { + opacity: 0.5; +} + +/* Inline text from `paste` operation */ + +span.pasted-text { + font-weight: bold; +} + +span.pasted-inline img { + max-height: 2em; +} + +tbody span.pasted-inline img { + max-height: none; +} + +/* Font colors for translated ANSI escape sequences +Color values are copied from Jupyter Notebook +https://github.com/jupyter/notebook/blob/52581f8eda9b319eb0390ac77fe5903c38f81e3e/notebook/static/notebook/less/ansicolors.less#L14-L21 +Background colors from +https://nbsphinx.readthedocs.io/en/latest/code-cells.html#ANSI-Colors +*/ +div.highlight .-Color-Bold { + font-weight: bold; +} + +div.highlight .-Color[class*=-Black] { + color: #3E424D +} + +div.highlight .-Color[class*=-Red] { + color: #E75C58 +} + +div.highlight .-Color[class*=-Green] { + color: #00A250 +} + +div.highlight .-Color[class*=-Yellow] { + color: #DDB62B +} + +div.highlight .-Color[class*=-Blue] { + color: #208FFB +} + +div.highlight .-Color[class*=-Magenta] { + color: #D160C4 +} + +div.highlight .-Color[class*=-Cyan] { + color: #60C6C8 +} + +div.highlight .-Color[class*=-White] { + color: #C5C1B4 +} + +div.highlight .-Color[class*=-BGBlack] { + background-color: #3E424D +} + +div.highlight .-Color[class*=-BGRed] { + background-color: #E75C58 +} + +div.highlight .-Color[class*=-BGGreen] { + background-color: #00A250 +} + +div.highlight .-Color[class*=-BGYellow] { + background-color: #DDB62B +} + +div.highlight .-Color[class*=-BGBlue] { + background-color: #208FFB +} + +div.highlight .-Color[class*=-BGMagenta] { + background-color: #D160C4 +} + +div.highlight .-Color[class*=-BGCyan] { + background-color: #60C6C8 +} + +div.highlight .-Color[class*=-BGWhite] { + background-color: #C5C1B4 +} + +/* Font colors for 8-bit ANSI */ + +div.highlight .-Color[class*=-C0] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC0] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C1] { + color: #800000 +} + +div.highlight .-Color[class*=-BGC1] { + background-color: #800000 +} + +div.highlight .-Color[class*=-C2] { + color: #008000 +} + +div.highlight .-Color[class*=-BGC2] { + background-color: #008000 +} + +div.highlight .-Color[class*=-C3] { + color: #808000 +} + +div.highlight .-Color[class*=-BGC3] { + background-color: #808000 +} + +div.highlight .-Color[class*=-C4] { + color: #000080 +} + +div.highlight .-Color[class*=-BGC4] { + background-color: #000080 +} + +div.highlight .-Color[class*=-C5] { + color: #800080 +} + +div.highlight .-Color[class*=-BGC5] { + background-color: #800080 +} + +div.highlight .-Color[class*=-C6] { + color: #008080 +} + +div.highlight .-Color[class*=-BGC6] { + background-color: #008080 +} + +div.highlight .-Color[class*=-C7] { + color: #C0C0C0 +} + +div.highlight .-Color[class*=-BGC7] { + background-color: #C0C0C0 +} + +div.highlight .-Color[class*=-C8] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC8] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C9] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC9] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C10] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC10] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C11] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC11] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C12] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC12] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C13] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC13] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C14] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC14] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C15] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC15] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C16] { + color: #000000 +} + +div.highlight .-Color[class*=-BGC16] { + background-color: #000000 +} + +div.highlight .-Color[class*=-C17] { + color: #00005F +} + +div.highlight .-Color[class*=-BGC17] { + background-color: #00005F +} + +div.highlight .-Color[class*=-C18] { + color: #000087 +} + +div.highlight .-Color[class*=-BGC18] { + background-color: #000087 +} + +div.highlight .-Color[class*=-C19] { + color: #0000AF +} + +div.highlight .-Color[class*=-BGC19] { + background-color: #0000AF +} + +div.highlight .-Color[class*=-C20] { + color: #0000D7 +} + +div.highlight .-Color[class*=-BGC20] { + background-color: #0000D7 +} + +div.highlight .-Color[class*=-C21] { + color: #0000FF +} + +div.highlight .-Color[class*=-BGC21] { + background-color: #0000FF +} + +div.highlight .-Color[class*=-C22] { + color: #005F00 +} + +div.highlight .-Color[class*=-BGC22] { + background-color: #005F00 +} + +div.highlight .-Color[class*=-C23] { + color: #005F5F +} + +div.highlight .-Color[class*=-BGC23] { + background-color: #005F5F +} + +div.highlight .-Color[class*=-C24] { + color: #005F87 +} + +div.highlight .-Color[class*=-BGC24] { + background-color: #005F87 +} + +div.highlight .-Color[class*=-C25] { + color: #005FAF +} + +div.highlight .-Color[class*=-BGC25] { + background-color: #005FAF +} + +div.highlight .-Color[class*=-C26] { + color: #005FD7 +} + +div.highlight .-Color[class*=-BGC26] { + background-color: #005FD7 +} + +div.highlight .-Color[class*=-C27] { + color: #005FFF +} + +div.highlight .-Color[class*=-BGC27] { + background-color: #005FFF +} + +div.highlight .-Color[class*=-C28] { + color: #008700 +} + +div.highlight .-Color[class*=-BGC28] { + background-color: #008700 +} + +div.highlight .-Color[class*=-C29] { + color: #00875F +} + +div.highlight .-Color[class*=-BGC29] { + background-color: #00875F +} + +div.highlight .-Color[class*=-C30] { + color: #008787 +} + +div.highlight .-Color[class*=-BGC30] { + background-color: #008787 +} + +div.highlight .-Color[class*=-C31] { + color: #0087AF +} + +div.highlight .-Color[class*=-BGC31] { + background-color: #0087AF +} + +div.highlight .-Color[class*=-C32] { + color: #0087D7 +} + +div.highlight .-Color[class*=-BGC32] { + background-color: #0087D7 +} + +div.highlight .-Color[class*=-C33] { + color: #0087FF +} + +div.highlight .-Color[class*=-BGC33] { + background-color: #0087FF +} + +div.highlight .-Color[class*=-C34] { + color: #00AF00 +} + +div.highlight .-Color[class*=-BGC34] { + background-color: #00AF00 +} + +div.highlight .-Color[class*=-C35] { + color: #00AF5F +} + +div.highlight .-Color[class*=-BGC35] { + background-color: #00AF5F +} + +div.highlight .-Color[class*=-C36] { + color: #00AF87 +} + +div.highlight .-Color[class*=-BGC36] { + background-color: #00AF87 +} + +div.highlight .-Color[class*=-C37] { + color: #00AFAF +} + +div.highlight .-Color[class*=-BGC37] { + background-color: #00AFAF +} + +div.highlight .-Color[class*=-C38] { + color: #00AFD7 +} + +div.highlight .-Color[class*=-BGC38] { + background-color: #00AFD7 +} + +div.highlight .-Color[class*=-C39] { + color: #00AFFF +} + +div.highlight .-Color[class*=-BGC39] { + background-color: #00AFFF +} + +div.highlight .-Color[class*=-C40] { + color: #00D700 +} + +div.highlight .-Color[class*=-BGC40] { + background-color: #00D700 +} + +div.highlight .-Color[class*=-C41] { + color: #00D75F +} + +div.highlight .-Color[class*=-BGC41] { + background-color: #00D75F +} + +div.highlight .-Color[class*=-C42] { + color: #00D787 +} + +div.highlight .-Color[class*=-BGC42] { + background-color: #00D787 +} + +div.highlight .-Color[class*=-C43] { + color: #00D7AF +} + +div.highlight .-Color[class*=-BGC43] { + background-color: #00D7AF +} + +div.highlight .-Color[class*=-C44] { + color: #00D7D7 +} + +div.highlight .-Color[class*=-BGC44] { + background-color: #00D7D7 +} + +div.highlight .-Color[class*=-C45] { + color: #00D7FF +} + +div.highlight .-Color[class*=-BGC45] { + background-color: #00D7FF +} + +div.highlight .-Color[class*=-C46] { + color: #00FF00 +} + +div.highlight .-Color[class*=-BGC46] { + background-color: #00FF00 +} + +div.highlight .-Color[class*=-C47] { + color: #00FF5F +} + +div.highlight .-Color[class*=-BGC47] { + background-color: #00FF5F +} + +div.highlight .-Color[class*=-C48] { + color: #00FF87 +} + +div.highlight .-Color[class*=-BGC48] { + background-color: #00FF87 +} + +div.highlight .-Color[class*=-C49] { + color: #00FFAF +} + +div.highlight .-Color[class*=-BGC49] { + background-color: #00FFAF +} + +div.highlight .-Color[class*=-C50] { + color: #00FFD7 +} + +div.highlight .-Color[class*=-BGC50] { + background-color: #00FFD7 +} + +div.highlight .-Color[class*=-C51] { + color: #00FFFF +} + +div.highlight .-Color[class*=-BGC51] { + background-color: #00FFFF +} + +div.highlight .-Color[class*=-C52] { + color: #5F0000 +} + +div.highlight .-Color[class*=-BGC52] { + background-color: #5F0000 +} + +div.highlight .-Color[class*=-C53] { + color: #5F005F +} + +div.highlight .-Color[class*=-BGC53] { + background-color: #5F005F +} + +div.highlight .-Color[class*=-C54] { + color: #5F0087 +} + +div.highlight .-Color[class*=-BGC54] { + background-color: #5F0087 +} + +div.highlight .-Color[class*=-C55] { + color: #5F00AF +} + +div.highlight .-Color[class*=-BGC55] { + background-color: #5F00AF +} + +div.highlight .-Color[class*=-C56] { + color: #5F00D7 +} + +div.highlight .-Color[class*=-BGC56] { + background-color: #5F00D7 +} + +div.highlight .-Color[class*=-C57] { + color: #5F00FF +} + +div.highlight .-Color[class*=-BGC57] { + background-color: #5F00FF +} + +div.highlight .-Color[class*=-C58] { + color: #5F5F00 +} + +div.highlight .-Color[class*=-BGC58] { + background-color: #5F5F00 +} + +div.highlight .-Color[class*=-C59] { + color: #5F5F5F +} + +div.highlight .-Color[class*=-BGC59] { + background-color: #5F5F5F +} + +div.highlight .-Color[class*=-C60] { + color: #5F5F87 +} + +div.highlight .-Color[class*=-BGC60] { + background-color: #5F5F87 +} + +div.highlight .-Color[class*=-C61] { + color: #5F5FAF +} + +div.highlight .-Color[class*=-BGC61] { + background-color: #5F5FAF +} + +div.highlight .-Color[class*=-C62] { + color: #5F5FD7 +} + +div.highlight .-Color[class*=-BGC62] { + background-color: #5F5FD7 +} + +div.highlight .-Color[class*=-C63] { + color: #5F5FFF +} + +div.highlight .-Color[class*=-BGC63] { + background-color: #5F5FFF +} + +div.highlight .-Color[class*=-C64] { + color: #5F8700 +} + +div.highlight .-Color[class*=-BGC64] { + background-color: #5F8700 +} + +div.highlight .-Color[class*=-C65] { + color: #5F875F +} + +div.highlight .-Color[class*=-BGC65] { + background-color: #5F875F +} + +div.highlight .-Color[class*=-C66] { + color: #5F8787 +} + +div.highlight .-Color[class*=-BGC66] { + background-color: #5F8787 +} + +div.highlight .-Color[class*=-C67] { + color: #5F87AF +} + +div.highlight .-Color[class*=-BGC67] { + background-color: #5F87AF +} + +div.highlight .-Color[class*=-C68] { + color: #5F87D7 +} + +div.highlight .-Color[class*=-BGC68] { + background-color: #5F87D7 +} + +div.highlight .-Color[class*=-C69] { + color: #5F87FF +} + +div.highlight .-Color[class*=-BGC69] { + background-color: #5F87FF +} + +div.highlight .-Color[class*=-C70] { + color: #5FAF00 +} + +div.highlight .-Color[class*=-BGC70] { + background-color: #5FAF00 +} + +div.highlight .-Color[class*=-C71] { + color: #5FAF5F +} + +div.highlight .-Color[class*=-BGC71] { + background-color: #5FAF5F +} + +div.highlight .-Color[class*=-C72] { + color: #5FAF87 +} + +div.highlight .-Color[class*=-BGC72] { + background-color: #5FAF87 +} + +div.highlight .-Color[class*=-C73] { + color: #5FAFAF +} + +div.highlight .-Color[class*=-BGC73] { + background-color: #5FAFAF +} + +div.highlight .-Color[class*=-C74] { + color: #5FAFD7 +} + +div.highlight .-Color[class*=-BGC74] { + background-color: #5FAFD7 +} + +div.highlight .-Color[class*=-C75] { + color: #5FAFFF +} + +div.highlight .-Color[class*=-BGC75] { + background-color: #5FAFFF +} + +div.highlight .-Color[class*=-C76] { + color: #5FD700 +} + +div.highlight .-Color[class*=-BGC76] { + background-color: #5FD700 +} + +div.highlight .-Color[class*=-C77] { + color: #5FD75F +} + +div.highlight .-Color[class*=-BGC77] { + background-color: #5FD75F +} + +div.highlight .-Color[class*=-C78] { + color: #5FD787 +} + +div.highlight .-Color[class*=-BGC78] { + background-color: #5FD787 +} + +div.highlight .-Color[class*=-C79] { + color: #5FD7AF +} + +div.highlight .-Color[class*=-BGC79] { + background-color: #5FD7AF +} + +div.highlight .-Color[class*=-C80] { + color: #5FD7D7 +} + +div.highlight .-Color[class*=-BGC80] { + background-color: #5FD7D7 +} + +div.highlight .-Color[class*=-C81] { + color: #5FD7FF +} + +div.highlight .-Color[class*=-BGC81] { + background-color: #5FD7FF +} + +div.highlight .-Color[class*=-C82] { + color: #5FFF00 +} + +div.highlight .-Color[class*=-BGC82] { + background-color: #5FFF00 +} + +div.highlight .-Color[class*=-C83] { + color: #5FFF5F +} + +div.highlight .-Color[class*=-BGC83] { + background-color: #5FFF5F +} + +div.highlight .-Color[class*=-C84] { + color: #5FFF87 +} + +div.highlight .-Color[class*=-BGC84] { + background-color: #5FFF87 +} + +div.highlight .-Color[class*=-C85] { + color: #5FFFAF +} + +div.highlight .-Color[class*=-BGC85] { + background-color: #5FFFAF +} + +div.highlight .-Color[class*=-C86] { + color: #5FFFD7 +} + +div.highlight .-Color[class*=-BGC86] { + background-color: #5FFFD7 +} + +div.highlight .-Color[class*=-C87] { + color: #5FFFFF +} + +div.highlight .-Color[class*=-BGC87] { + background-color: #5FFFFF +} + +div.highlight .-Color[class*=-C88] { + color: #870000 +} + +div.highlight .-Color[class*=-BGC88] { + background-color: #870000 +} + +div.highlight .-Color[class*=-C89] { + color: #87005F +} + +div.highlight .-Color[class*=-BGC89] { + background-color: #87005F +} + +div.highlight .-Color[class*=-C90] { + color: #870087 +} + +div.highlight .-Color[class*=-BGC90] { + background-color: #870087 +} + +div.highlight .-Color[class*=-C91] { + color: #8700AF +} + +div.highlight .-Color[class*=-BGC91] { + background-color: #8700AF +} + +div.highlight .-Color[class*=-C92] { + color: #8700D7 +} + +div.highlight .-Color[class*=-BGC92] { + background-color: #8700D7 +} + +div.highlight .-Color[class*=-C93] { + color: #8700FF +} + +div.highlight .-Color[class*=-BGC93] { + background-color: #8700FF +} + +div.highlight .-Color[class*=-C94] { + color: #875F00 +} + +div.highlight .-Color[class*=-BGC94] { + background-color: #875F00 +} + +div.highlight .-Color[class*=-C95] { + color: #875F5F +} + +div.highlight .-Color[class*=-BGC95] { + background-color: #875F5F +} + +div.highlight .-Color[class*=-C96] { + color: #875F87 +} + +div.highlight .-Color[class*=-BGC96] { + background-color: #875F87 +} + +div.highlight .-Color[class*=-C97] { + color: #875FAF +} + +div.highlight .-Color[class*=-BGC97] { + background-color: #875FAF +} + +div.highlight .-Color[class*=-C98] { + color: #875FD7 +} + +div.highlight .-Color[class*=-BGC98] { + background-color: #875FD7 +} + +div.highlight .-Color[class*=-C99] { + color: #875FFF +} + +div.highlight .-Color[class*=-BGC99] { + background-color: #875FFF +} + +div.highlight .-Color[class*=-C100] { + color: #878700 +} + +div.highlight .-Color[class*=-BGC100] { + background-color: #878700 +} + +div.highlight .-Color[class*=-C101] { + color: #87875F +} + +div.highlight .-Color[class*=-BGC101] { + background-color: #87875F +} + +div.highlight .-Color[class*=-C102] { + color: #878787 +} + +div.highlight .-Color[class*=-BGC102] { + background-color: #878787 +} + +div.highlight .-Color[class*=-C103] { + color: #8787AF +} + +div.highlight .-Color[class*=-BGC103] { + background-color: #8787AF +} + +div.highlight .-Color[class*=-C104] { + color: #8787D7 +} + +div.highlight .-Color[class*=-BGC104] { + background-color: #8787D7 +} + +div.highlight .-Color[class*=-C105] { + color: #8787FF +} + +div.highlight .-Color[class*=-BGC105] { + background-color: #8787FF +} + +div.highlight .-Color[class*=-C106] { + color: #87AF00 +} + +div.highlight .-Color[class*=-BGC106] { + background-color: #87AF00 +} + +div.highlight .-Color[class*=-C107] { + color: #87AF5F +} + +div.highlight .-Color[class*=-BGC107] { + background-color: #87AF5F +} + +div.highlight .-Color[class*=-C108] { + color: #87AF87 +} + +div.highlight .-Color[class*=-BGC108] { + background-color: #87AF87 +} + +div.highlight .-Color[class*=-C109] { + color: #87AFAF +} + +div.highlight .-Color[class*=-BGC109] { + background-color: #87AFAF +} + +div.highlight .-Color[class*=-C110] { + color: #87AFD7 +} + +div.highlight .-Color[class*=-BGC110] { + background-color: #87AFD7 +} + +div.highlight .-Color[class*=-C111] { + color: #87AFFF +} + +div.highlight .-Color[class*=-BGC111] { + background-color: #87AFFF +} + +div.highlight .-Color[class*=-C112] { + color: #87D700 +} + +div.highlight .-Color[class*=-BGC112] { + background-color: #87D700 +} + +div.highlight .-Color[class*=-C113] { + color: #87D75F +} + +div.highlight .-Color[class*=-BGC113] { + background-color: #87D75F +} + +div.highlight .-Color[class*=-C114] { + color: #87D787 +} + +div.highlight .-Color[class*=-BGC114] { + background-color: #87D787 +} + +div.highlight .-Color[class*=-C115] { + color: #87D7AF +} + +div.highlight .-Color[class*=-BGC115] { + background-color: #87D7AF +} + +div.highlight .-Color[class*=-C116] { + color: #87D7D7 +} + +div.highlight .-Color[class*=-BGC116] { + background-color: #87D7D7 +} + +div.highlight .-Color[class*=-C117] { + color: #87D7FF +} + +div.highlight .-Color[class*=-BGC117] { + background-color: #87D7FF +} + +div.highlight .-Color[class*=-C118] { + color: #87FF00 +} + +div.highlight .-Color[class*=-BGC118] { + background-color: #87FF00 +} + +div.highlight .-Color[class*=-C119] { + color: #87FF5F +} + +div.highlight .-Color[class*=-BGC119] { + background-color: #87FF5F +} + +div.highlight .-Color[class*=-C120] { + color: #87FF87 +} + +div.highlight .-Color[class*=-BGC120] { + background-color: #87FF87 +} + +div.highlight .-Color[class*=-C121] { + color: #87FFAF +} + +div.highlight .-Color[class*=-BGC121] { + background-color: #87FFAF +} + +div.highlight .-Color[class*=-C122] { + color: #87FFD7 +} + +div.highlight .-Color[class*=-BGC122] { + background-color: #87FFD7 +} + +div.highlight .-Color[class*=-C123] { + color: #87FFFF +} + +div.highlight .-Color[class*=-BGC123] { + background-color: #87FFFF +} + +div.highlight .-Color[class*=-C124] { + color: #AF0000 +} + +div.highlight .-Color[class*=-BGC124] { + background-color: #AF0000 +} + +div.highlight .-Color[class*=-C125] { + color: #AF005F +} + +div.highlight .-Color[class*=-BGC125] { + background-color: #AF005F +} + +div.highlight .-Color[class*=-C126] { + color: #AF0087 +} + +div.highlight .-Color[class*=-BGC126] { + background-color: #AF0087 +} + +div.highlight .-Color[class*=-C127] { + color: #AF00AF +} + +div.highlight .-Color[class*=-BGC127] { + background-color: #AF00AF +} + +div.highlight .-Color[class*=-C128] { + color: #AF00D7 +} + +div.highlight .-Color[class*=-BGC128] { + background-color: #AF00D7 +} + +div.highlight .-Color[class*=-C129] { + color: #AF00FF +} + +div.highlight .-Color[class*=-BGC129] { + background-color: #AF00FF +} + +div.highlight .-Color[class*=-C130] { + color: #AF5F00 +} + +div.highlight .-Color[class*=-BGC130] { + background-color: #AF5F00 +} + +div.highlight .-Color[class*=-C131] { + color: #AF5F5F +} + +div.highlight .-Color[class*=-BGC131] { + background-color: #AF5F5F +} + +div.highlight .-Color[class*=-C132] { + color: #AF5F87 +} + +div.highlight .-Color[class*=-BGC132] { + background-color: #AF5F87 +} + +div.highlight .-Color[class*=-C133] { + color: #AF5FAF +} + +div.highlight .-Color[class*=-BGC133] { + background-color: #AF5FAF +} + +div.highlight .-Color[class*=-C134] { + color: #AF5FD7 +} + +div.highlight .-Color[class*=-BGC134] { + background-color: #AF5FD7 +} + +div.highlight .-Color[class*=-C135] { + color: #AF5FFF +} + +div.highlight .-Color[class*=-BGC135] { + background-color: #AF5FFF +} + +div.highlight .-Color[class*=-C136] { + color: #AF8700 +} + +div.highlight .-Color[class*=-BGC136] { + background-color: #AF8700 +} + +div.highlight .-Color[class*=-C137] { + color: #AF875F +} + +div.highlight .-Color[class*=-BGC137] { + background-color: #AF875F +} + +div.highlight .-Color[class*=-C138] { + color: #AF8787 +} + +div.highlight .-Color[class*=-BGC138] { + background-color: #AF8787 +} + +div.highlight .-Color[class*=-C139] { + color: #AF87AF +} + +div.highlight .-Color[class*=-BGC139] { + background-color: #AF87AF +} + +div.highlight .-Color[class*=-C140] { + color: #AF87D7 +} + +div.highlight .-Color[class*=-BGC140] { + background-color: #AF87D7 +} + +div.highlight .-Color[class*=-C141] { + color: #AF87FF +} + +div.highlight .-Color[class*=-BGC141] { + background-color: #AF87FF +} + +div.highlight .-Color[class*=-C142] { + color: #AFAF00 +} + +div.highlight .-Color[class*=-BGC142] { + background-color: #AFAF00 +} + +div.highlight .-Color[class*=-C143] { + color: #AFAF5F +} + +div.highlight .-Color[class*=-BGC143] { + background-color: #AFAF5F +} + +div.highlight .-Color[class*=-C144] { + color: #AFAF87 +} + +div.highlight .-Color[class*=-BGC144] { + background-color: #AFAF87 +} + +div.highlight .-Color[class*=-C145] { + color: #AFAFAF +} + +div.highlight .-Color[class*=-BGC145] { + background-color: #AFAFAF +} + +div.highlight .-Color[class*=-C146] { + color: #AFAFD7 +} + +div.highlight .-Color[class*=-BGC146] { + background-color: #AFAFD7 +} + +div.highlight .-Color[class*=-C147] { + color: #AFAFFF +} + +div.highlight .-Color[class*=-BGC147] { + background-color: #AFAFFF +} + +div.highlight .-Color[class*=-C148] { + color: #AFD700 +} + +div.highlight .-Color[class*=-BGC148] { + background-color: #AFD700 +} + +div.highlight .-Color[class*=-C149] { + color: #AFD75F +} + +div.highlight .-Color[class*=-BGC149] { + background-color: #AFD75F +} + +div.highlight .-Color[class*=-C150] { + color: #AFD787 +} + +div.highlight .-Color[class*=-BGC150] { + background-color: #AFD787 +} + +div.highlight .-Color[class*=-C151] { + color: #AFD7AF +} + +div.highlight .-Color[class*=-BGC151] { + background-color: #AFD7AF +} + +div.highlight .-Color[class*=-C152] { + color: #AFD7D7 +} + +div.highlight .-Color[class*=-BGC152] { + background-color: #AFD7D7 +} + +div.highlight .-Color[class*=-C153] { + color: #AFD7FF +} + +div.highlight .-Color[class*=-BGC153] { + background-color: #AFD7FF +} + +div.highlight .-Color[class*=-C154] { + color: #AFFF00 +} + +div.highlight .-Color[class*=-BGC154] { + background-color: #AFFF00 +} + +div.highlight .-Color[class*=-C155] { + color: #AFFF5F +} + +div.highlight .-Color[class*=-BGC155] { + background-color: #AFFF5F +} + +div.highlight .-Color[class*=-C156] { + color: #AFFF87 +} + +div.highlight .-Color[class*=-BGC156] { + background-color: #AFFF87 +} + +div.highlight .-Color[class*=-C157] { + color: #AFFFAF +} + +div.highlight .-Color[class*=-BGC157] { + background-color: #AFFFAF +} + +div.highlight .-Color[class*=-C158] { + color: #AFFFD7 +} + +div.highlight .-Color[class*=-BGC158] { + background-color: #AFFFD7 +} + +div.highlight .-Color[class*=-C159] { + color: #AFFFFF +} + +div.highlight .-Color[class*=-BGC159] { + background-color: #AFFFFF +} + +div.highlight .-Color[class*=-C160] { + color: #D70000 +} + +div.highlight .-Color[class*=-BGC160] { + background-color: #D70000 +} + +div.highlight .-Color[class*=-C161] { + color: #D7005F +} + +div.highlight .-Color[class*=-BGC161] { + background-color: #D7005F +} + +div.highlight .-Color[class*=-C162] { + color: #D70087 +} + +div.highlight .-Color[class*=-BGC162] { + background-color: #D70087 +} + +div.highlight .-Color[class*=-C163] { + color: #D700AF +} + +div.highlight .-Color[class*=-BGC163] { + background-color: #D700AF +} + +div.highlight .-Color[class*=-C164] { + color: #D700D7 +} + +div.highlight .-Color[class*=-BGC164] { + background-color: #D700D7 +} + +div.highlight .-Color[class*=-C165] { + color: #D700FF +} + +div.highlight .-Color[class*=-BGC165] { + background-color: #D700FF +} + +div.highlight .-Color[class*=-C166] { + color: #D75F00 +} + +div.highlight .-Color[class*=-BGC166] { + background-color: #D75F00 +} + +div.highlight .-Color[class*=-C167] { + color: #D75F5F +} + +div.highlight .-Color[class*=-BGC167] { + background-color: #D75F5F +} + +div.highlight .-Color[class*=-C168] { + color: #D75F87 +} + +div.highlight .-Color[class*=-BGC168] { + background-color: #D75F87 +} + +div.highlight .-Color[class*=-C169] { + color: #D75FAF +} + +div.highlight .-Color[class*=-BGC169] { + background-color: #D75FAF +} + +div.highlight .-Color[class*=-C170] { + color: #D75FD7 +} + +div.highlight .-Color[class*=-BGC170] { + background-color: #D75FD7 +} + +div.highlight .-Color[class*=-C171] { + color: #D75FFF +} + +div.highlight .-Color[class*=-BGC171] { + background-color: #D75FFF +} + +div.highlight .-Color[class*=-C172] { + color: #D78700 +} + +div.highlight .-Color[class*=-BGC172] { + background-color: #D78700 +} + +div.highlight .-Color[class*=-C173] { + color: #D7875F +} + +div.highlight .-Color[class*=-BGC173] { + background-color: #D7875F +} + +div.highlight .-Color[class*=-C174] { + color: #D78787 +} + +div.highlight .-Color[class*=-BGC174] { + background-color: #D78787 +} + +div.highlight .-Color[class*=-C175] { + color: #D787AF +} + +div.highlight .-Color[class*=-BGC175] { + background-color: #D787AF +} + +div.highlight .-Color[class*=-C176] { + color: #D787D7 +} + +div.highlight .-Color[class*=-BGC176] { + background-color: #D787D7 +} + +div.highlight .-Color[class*=-C177] { + color: #D787FF +} + +div.highlight .-Color[class*=-BGC177] { + background-color: #D787FF +} + +div.highlight .-Color[class*=-C178] { + color: #D7AF00 +} + +div.highlight .-Color[class*=-BGC178] { + background-color: #D7AF00 +} + +div.highlight .-Color[class*=-C179] { + color: #D7AF5F +} + +div.highlight .-Color[class*=-BGC179] { + background-color: #D7AF5F +} + +div.highlight .-Color[class*=-C180] { + color: #D7AF87 +} + +div.highlight .-Color[class*=-BGC180] { + background-color: #D7AF87 +} + +div.highlight .-Color[class*=-C181] { + color: #D7AFAF +} + +div.highlight .-Color[class*=-BGC181] { + background-color: #D7AFAF +} + +div.highlight .-Color[class*=-C182] { + color: #D7AFD7 +} + +div.highlight .-Color[class*=-BGC182] { + background-color: #D7AFD7 +} + +div.highlight .-Color[class*=-C183] { + color: #D7AFFF +} + +div.highlight .-Color[class*=-BGC183] { + background-color: #D7AFFF +} + +div.highlight .-Color[class*=-C184] { + color: #D7D700 +} + +div.highlight .-Color[class*=-BGC184] { + background-color: #D7D700 +} + +div.highlight .-Color[class*=-C185] { + color: #D7D75F +} + +div.highlight .-Color[class*=-BGC185] { + background-color: #D7D75F +} + +div.highlight .-Color[class*=-C186] { + color: #D7D787 +} + +div.highlight .-Color[class*=-BGC186] { + background-color: #D7D787 +} + +div.highlight .-Color[class*=-C187] { + color: #D7D7AF +} + +div.highlight .-Color[class*=-BGC187] { + background-color: #D7D7AF +} + +div.highlight .-Color[class*=-C188] { + color: #D7D7D7 +} + +div.highlight .-Color[class*=-BGC188] { + background-color: #D7D7D7 +} + +div.highlight .-Color[class*=-C189] { + color: #D7D7FF +} + +div.highlight .-Color[class*=-BGC189] { + background-color: #D7D7FF +} + +div.highlight .-Color[class*=-C190] { + color: #D7FF00 +} + +div.highlight .-Color[class*=-BGC190] { + background-color: #D7FF00 +} + +div.highlight .-Color[class*=-C191] { + color: #D7FF5F +} + +div.highlight .-Color[class*=-BGC191] { + background-color: #D7FF5F +} + +div.highlight .-Color[class*=-C192] { + color: #D7FF87 +} + +div.highlight .-Color[class*=-BGC192] { + background-color: #D7FF87 +} + +div.highlight .-Color[class*=-C193] { + color: #D7FFAF +} + +div.highlight .-Color[class*=-BGC193] { + background-color: #D7FFAF +} + +div.highlight .-Color[class*=-C194] { + color: #D7FFD7 +} + +div.highlight .-Color[class*=-BGC194] { + background-color: #D7FFD7 +} + +div.highlight .-Color[class*=-C195] { + color: #D7FFFF +} + +div.highlight .-Color[class*=-BGC195] { + background-color: #D7FFFF +} + +div.highlight .-Color[class*=-C196] { + color: #FF0000 +} + +div.highlight .-Color[class*=-BGC196] { + background-color: #FF0000 +} + +div.highlight .-Color[class*=-C197] { + color: #FF005F +} + +div.highlight .-Color[class*=-BGC197] { + background-color: #FF005F +} + +div.highlight .-Color[class*=-C198] { + color: #FF0087 +} + +div.highlight .-Color[class*=-BGC198] { + background-color: #FF0087 +} + +div.highlight .-Color[class*=-C199] { + color: #FF00AF +} + +div.highlight .-Color[class*=-BGC199] { + background-color: #FF00AF +} + +div.highlight .-Color[class*=-C200] { + color: #FF00D7 +} + +div.highlight .-Color[class*=-BGC200] { + background-color: #FF00D7 +} + +div.highlight .-Color[class*=-C201] { + color: #FF00FF +} + +div.highlight .-Color[class*=-BGC201] { + background-color: #FF00FF +} + +div.highlight .-Color[class*=-C202] { + color: #FF5F00 +} + +div.highlight .-Color[class*=-BGC202] { + background-color: #FF5F00 +} + +div.highlight .-Color[class*=-C203] { + color: #FF5F5F +} + +div.highlight .-Color[class*=-BGC203] { + background-color: #FF5F5F +} + +div.highlight .-Color[class*=-C204] { + color: #FF5F87 +} + +div.highlight .-Color[class*=-BGC204] { + background-color: #FF5F87 +} + +div.highlight .-Color[class*=-C205] { + color: #FF5FAF +} + +div.highlight .-Color[class*=-BGC205] { + background-color: #FF5FAF +} + +div.highlight .-Color[class*=-C206] { + color: #FF5FD7 +} + +div.highlight .-Color[class*=-BGC206] { + background-color: #FF5FD7 +} + +div.highlight .-Color[class*=-C207] { + color: #FF5FFF +} + +div.highlight .-Color[class*=-BGC207] { + background-color: #FF5FFF +} + +div.highlight .-Color[class*=-C208] { + color: #FF8700 +} + +div.highlight .-Color[class*=-BGC208] { + background-color: #FF8700 +} + +div.highlight .-Color[class*=-C209] { + color: #FF875F +} + +div.highlight .-Color[class*=-BGC209] { + background-color: #FF875F +} + +div.highlight .-Color[class*=-C210] { + color: #FF8787 +} + +div.highlight .-Color[class*=-BGC210] { + background-color: #FF8787 +} + +div.highlight .-Color[class*=-C211] { + color: #FF87AF +} + +div.highlight .-Color[class*=-BGC211] { + background-color: #FF87AF +} + +div.highlight .-Color[class*=-C212] { + color: #FF87D7 +} + +div.highlight .-Color[class*=-BGC212] { + background-color: #FF87D7 +} + +div.highlight .-Color[class*=-C213] { + color: #FF87FF +} + +div.highlight .-Color[class*=-BGC213] { + background-color: #FF87FF +} + +div.highlight .-Color[class*=-C214] { + color: #FFAF00 +} + +div.highlight .-Color[class*=-BGC214] { + background-color: #FFAF00 +} + +div.highlight .-Color[class*=-C215] { + color: #FFAF5F +} + +div.highlight .-Color[class*=-BGC215] { + background-color: #FFAF5F +} + +div.highlight .-Color[class*=-C216] { + color: #FFAF87 +} + +div.highlight .-Color[class*=-BGC216] { + background-color: #FFAF87 +} + +div.highlight .-Color[class*=-C217] { + color: #FFAFAF +} + +div.highlight .-Color[class*=-BGC217] { + background-color: #FFAFAF +} + +div.highlight .-Color[class*=-C218] { + color: #FFAFD7 +} + +div.highlight .-Color[class*=-BGC218] { + background-color: #FFAFD7 +} + +div.highlight .-Color[class*=-C219] { + color: #FFAFFF +} + +div.highlight .-Color[class*=-BGC219] { + background-color: #FFAFFF +} + +div.highlight .-Color[class*=-C220] { + color: #FFD700 +} + +div.highlight .-Color[class*=-BGC220] { + background-color: #FFD700 +} + +div.highlight .-Color[class*=-C221] { + color: #FFD75F +} + +div.highlight .-Color[class*=-BGC221] { + background-color: #FFD75F +} + +div.highlight .-Color[class*=-C222] { + color: #FFD787 +} + +div.highlight .-Color[class*=-BGC222] { + background-color: #FFD787 +} + +div.highlight .-Color[class*=-C223] { + color: #FFD7AF +} + +div.highlight .-Color[class*=-BGC223] { + background-color: #FFD7AF +} + +div.highlight .-Color[class*=-C224] { + color: #FFD7D7 +} + +div.highlight .-Color[class*=-BGC224] { + background-color: #FFD7D7 +} + +div.highlight .-Color[class*=-C225] { + color: #FFD7FF +} + +div.highlight .-Color[class*=-BGC225] { + background-color: #FFD7FF +} + +div.highlight .-Color[class*=-C226] { + color: #FFFF00 +} + +div.highlight .-Color[class*=-BGC226] { + background-color: #FFFF00 +} + +div.highlight .-Color[class*=-C227] { + color: #FFFF5F +} + +div.highlight .-Color[class*=-BGC227] { + background-color: #FFFF5F +} + +div.highlight .-Color[class*=-C228] { + color: #FFFF87 +} + +div.highlight .-Color[class*=-BGC228] { + background-color: #FFFF87 +} + +div.highlight .-Color[class*=-C229] { + color: #FFFFAF +} + +div.highlight .-Color[class*=-BGC229] { + background-color: #FFFFAF +} + +div.highlight .-Color[class*=-C230] { + color: #FFFFD7 +} + +div.highlight .-Color[class*=-BGC230] { + background-color: #FFFFD7 +} + +div.highlight .-Color[class*=-C231] { + color: #FFFFFF +} + +div.highlight .-Color[class*=-BGC231] { + background-color: #FFFFFF +} + +div.highlight .-Color[class*=-C232] { + color: #080808 +} + +div.highlight .-Color[class*=-BGC232] { + background-color: #080808 +} + +div.highlight .-Color[class*=-C233] { + color: #121212 +} + +div.highlight .-Color[class*=-BGC233] { + background-color: #121212 +} + +div.highlight .-Color[class*=-C234] { + color: #1C1C1C +} + +div.highlight .-Color[class*=-BGC234] { + background-color: #1C1C1C +} + +div.highlight .-Color[class*=-C235] { + color: #262626 +} + +div.highlight .-Color[class*=-BGC235] { + background-color: #262626 +} + +div.highlight .-Color[class*=-C236] { + color: #303030 +} + +div.highlight .-Color[class*=-BGC236] { + background-color: #303030 +} + +div.highlight .-Color[class*=-C237] { + color: #3A3A3A +} + +div.highlight .-Color[class*=-BGC237] { + background-color: #3A3A3A +} + +div.highlight .-Color[class*=-C238] { + color: #444444 +} + +div.highlight .-Color[class*=-BGC238] { + background-color: #444444 +} + +div.highlight .-Color[class*=-C239] { + color: #4E4E4E +} + +div.highlight .-Color[class*=-BGC239] { + background-color: #4E4E4E +} + +div.highlight .-Color[class*=-C240] { + color: #585858 +} + +div.highlight .-Color[class*=-BGC240] { + background-color: #585858 +} + +div.highlight .-Color[class*=-C241] { + color: #626262 +} + +div.highlight .-Color[class*=-BGC241] { + background-color: #626262 +} + +div.highlight .-Color[class*=-C242] { + color: #6C6C6C +} + +div.highlight .-Color[class*=-BGC242] { + background-color: #6C6C6C +} + +div.highlight .-Color[class*=-C243] { + color: #767676 +} + +div.highlight .-Color[class*=-BGC243] { + background-color: #767676 +} + +div.highlight .-Color[class*=-C244] { + color: #808080 +} + +div.highlight .-Color[class*=-BGC244] { + background-color: #808080 +} + +div.highlight .-Color[class*=-C245] { + color: #8A8A8A +} + +div.highlight .-Color[class*=-BGC245] { + background-color: #8A8A8A +} + +div.highlight .-Color[class*=-C246] { + color: #949494 +} + +div.highlight .-Color[class*=-BGC246] { + background-color: #949494 +} + +div.highlight .-Color[class*=-C247] { + color: #9E9E9E +} + +div.highlight .-Color[class*=-BGC247] { + background-color: #9E9E9E +} + +div.highlight .-Color[class*=-C248] { + color: #A8A8A8 +} + +div.highlight .-Color[class*=-BGC248] { + background-color: #A8A8A8 +} + +div.highlight .-Color[class*=-C249] { + color: #B2B2B2 +} + +div.highlight .-Color[class*=-BGC249] { + background-color: #B2B2B2 +} + +div.highlight .-Color[class*=-C250] { + color: #BCBCBC +} + +div.highlight .-Color[class*=-BGC250] { + background-color: #BCBCBC +} + +div.highlight .-Color[class*=-C251] { + color: #C6C6C6 +} + +div.highlight .-Color[class*=-BGC251] { + background-color: #C6C6C6 +} + +div.highlight .-Color[class*=-C252] { + color: #D0D0D0 +} + +div.highlight .-Color[class*=-BGC252] { + background-color: #D0D0D0 +} + +div.highlight .-Color[class*=-C253] { + color: #DADADA +} + +div.highlight .-Color[class*=-BGC253] { + background-color: #DADADA +} + +div.highlight .-Color[class*=-C254] { + color: #E4E4E4 +} + +div.highlight .-Color[class*=-BGC254] { + background-color: #E4E4E4 +} + +div.highlight .-Color[class*=-C255] { + color: #EEEEEE +} + +div.highlight .-Color[class*=-BGC255] { + background-color: #EEEEEE +} diff --git a/branch/main/singlehtml/_static/plus.png b/branch/main/singlehtml/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/branch/main/singlehtml/_static/plus.png differ diff --git a/branch/main/singlehtml/_static/pygments.css b/branch/main/singlehtml/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/branch/main/singlehtml/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/branch/main/singlehtml/_static/searchtools.js b/branch/main/singlehtml/_static/searchtools.js new file mode 100644 index 00000000..7918c3fa --- /dev/null +++ b/branch/main/singlehtml/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/branch/main/singlehtml/_static/sphinx_highlight.js b/branch/main/singlehtml/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/branch/main/singlehtml/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.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: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/branch/main/singlehtml/_static/sphinx_lesson.css b/branch/main/singlehtml/_static/sphinx_lesson.css new file mode 100644 index 00000000..14b20c64 --- /dev/null +++ b/branch/main/singlehtml/_static/sphinx_lesson.css @@ -0,0 +1,51 @@ +/* sphinx_lesson.css */ + +body.wy-body-for-nav img.with-border { + border: 2px solid; +} + +.rst-content .admonition-no-content { + padding-bottom: 0px; +} + +.rst-content .demo > .admonition-title::before { + content: "\01F440"; /* Eyes */ } +.rst-content .type-along > .admonition-title::before { + content: "\02328\0FE0F"; /* Keyboard */ } +.rst-content .exercise > .admonition-title::before { + content: "\0270D\0FE0F"; /* Hand */ } +.rst-content .solution > .admonition-title::before { + content: "\02714\0FE0E"; /* Check mark */ } +.rst-content .homework > .admonition-title::before { + content: "\01F4DD"; /* Memo */ } +.rst-content .discussion > .admonition-title::before { + content: "\01F4AC"; /* Speech balloon */ } +.rst-content .questions > .admonition-title::before { + content: "\02753\0FE0E"; /* Question mark */ } +.rst-content .prerequisites > .admonition-title::before { + content: "\02699"; /* Gear */ } +.rst-content .seealso > .admonition-title::before { + content: "\027A1\0FE0E"; /* Question mark */ } + + +/* instructor-note */ +.rst-content .instructor-note { + background: #e7e7e7; +} +.rst-content .instructor-note > .admonition-title { + background: #6a6a6a; +} +.rst-content .instructor-note > .admonition-title::before { + content: ""; +} + + +/* sphinx_toggle_button, make the font white */ +.rst-content .toggle.admonition button.toggle-button { + color: white; +} + +/* sphinx-togglebutton, remove underflow when toggled to hidden mode */ +.rst-content .admonition.toggle-hidden { + padding-bottom: 0px; +} diff --git a/branch/main/singlehtml/_static/sphinx_rtd_theme_ext_color_contrast.css b/branch/main/singlehtml/_static/sphinx_rtd_theme_ext_color_contrast.css new file mode 100644 index 00000000..e68feb82 --- /dev/null +++ b/branch/main/singlehtml/_static/sphinx_rtd_theme_ext_color_contrast.css @@ -0,0 +1,47 @@ +/* The following are for web accessibility of sphinx_rtd_theme: they + * solve some of the most frequent contrast issues. Remove when this + * solved: + * https://github.com/readthedocs/sphinx_rtd_theme/issues/971 + */ +/* background: #fcfcfc, note boxes #E7F2FA */ +a { color: #2573A7; } /* original #2980B9, #1F5C84; */ +body { color: #242424; } /* original #404040, #383838 */ +.wy-side-nav-search>a, .wy-side-nav-search .wy-dropdown>a { + color: #ffffff; +} /* original #fcfcfc */ +footer { color: #737373; } /* original gray=#808080*/ +footer span.commit code, footer span.commit .rst-content tt, .rst-content footer span.commit tt { + color: #737373; +} /* original gray=#808080*/ +.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { + color: #AB2314; +} +/* Sidebar background */ +.wy-side-nav-search { background-color: #277CB4;} + +/* Same, but for pygments */ +.highlight .ch { color: #3E7A89; } /* #! line */ +.highlight .c1 { color: #3E7A89; } /* also comments */ +.highlight .nv { color: #AD3ECC; } /* variable */ +.highlight .gp { color: #B45608; } /* prompt character, $*/ +.highlight .si { color: #3975B1; } /* ${} variable text */ +.highlight .nc { color: #0C78A7; } + +/* Sphinx admonitions */ +/* warning */ +.wy-alert.wy-alert-warning .wy-alert-title, .rst-content .wy-alert-warning.note .wy-alert-title, .rst-content .attention .wy-alert-title, .rst-content .caution .wy-alert-title, .rst-content .wy-alert-warning.danger .wy-alert-title, .rst-content .wy-alert-warning.error .wy-alert-title, .rst-content .wy-alert-warning.hint .wy-alert-title, .rst-content .wy-alert-warning.important .wy-alert-title, .rst-content .wy-alert-warning.tip .wy-alert-title, .rst-content .warning .wy-alert-title, .rst-content .wy-alert-warning.seealso .wy-alert-title, .rst-content .admonition-todo .wy-alert-title, .rst-content .wy-alert-warning.admonition .wy-alert-title, .wy-alert.wy-alert-warning .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-warning .admonition-title, .rst-content .wy-alert-warning.note .admonition-title, .rst-content .attention .admonition-title, .rst-content .caution .admonition-title, .rst-content .wy-alert-warning.danger .admonition-title, .rst-content .wy-alert-warning.error .admonition-title, .rst-content .wy-alert-warning.hint .admonition-title, .rst-content .wy-alert-warning.important .admonition-title, .rst-content .wy-alert-warning.tip .admonition-title, .rst-content .warning .admonition-title, .rst-content .wy-alert-warning.seealso .admonition-title, .rst-content .admonition-todo .admonition-title, .rst-content .wy-alert-warning.admonition .admonition-title { + background: #B15E16; } +/* important */ +.wy-alert.wy-alert-success .wy-alert-title, .rst-content .wy-alert-success.note .wy-alert-title, .rst-content .wy-alert-success.attention .wy-alert-title, .rst-content .wy-alert-success.caution .wy-alert-title, .rst-content .wy-alert-success.danger .wy-alert-title, .rst-content .wy-alert-success.error .wy-alert-title, .rst-content .hint .wy-alert-title, .rst-content .important .wy-alert-title, .rst-content .tip .wy-alert-title, .rst-content .wy-alert-success.warning .wy-alert-title, .rst-content .wy-alert-success.seealso .wy-alert-title, .rst-content .wy-alert-success.admonition-todo .wy-alert-title, .rst-content .wy-alert-success.admonition .wy-alert-title, .wy-alert.wy-alert-success .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-success .admonition-title, .rst-content .wy-alert-success.note .admonition-title, .rst-content .wy-alert-success.attention .admonition-title, .rst-content .wy-alert-success.caution .admonition-title, .rst-content .wy-alert-success.danger .admonition-title, .rst-content .wy-alert-success.error .admonition-title, .rst-content .hint .admonition-title, .rst-content .important .admonition-title, .rst-content .tip .admonition-title, .rst-content .wy-alert-success.warning .admonition-title, .rst-content .wy-alert-success.seealso .admonition-title, .rst-content .wy-alert-success.admonition-todo .admonition-title, .rst-content .wy-alert-success.admonition .admonition-title { + background: #12826C; } +/* seealso, note, etc */ +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition .admonition-title { + background: #277CB4; } +/* error, danger */ +.rst-content .danger .admonition-title, .rst-content .danger .wy-alert-title, .rst-content .error .admonition-title, .rst-content .error .wy-alert-title, .rst-content .wy-alert-danger.admonition-todo .admonition-title, .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, .rst-content .wy-alert-danger.admonition .admonition-title, .rst-content .wy-alert-danger.admonition .wy-alert-title, .rst-content .wy-alert-danger.attention .admonition-title, .rst-content .wy-alert-danger.attention .wy-alert-title, .rst-content .wy-alert-danger.caution .admonition-title, .rst-content .wy-alert-danger.caution .wy-alert-title, .rst-content .wy-alert-danger.hint .admonition-title, .rst-content .wy-alert-danger.hint .wy-alert-title, .rst-content .wy-alert-danger.important .admonition-title, .rst-content .wy-alert-danger.important .wy-alert-title, .rst-content .wy-alert-danger.note .admonition-title, .rst-content .wy-alert-danger.note .wy-alert-title, .rst-content .wy-alert-danger.seealso .admonition-title, .rst-content .wy-alert-danger.seealso .wy-alert-title, .rst-content .wy-alert-danger.tip .admonition-title, .rst-content .wy-alert-danger.tip .wy-alert-title, .rst-content .wy-alert-danger.warning .admonition-title, .rst-content .wy-alert-danger.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-danger .admonition-title, .wy-alert.wy-alert-danger .rst-content .admonition-title, .wy-alert.wy-alert-danger .wy-alert-title { + background: #e31704; +} + +/* Generic admonition titles */ +.wy-alert-title, .rst-content .admonition-title { + background: #277CB4; } diff --git a/branch/main/singlehtml/_static/tabs.css b/branch/main/singlehtml/_static/tabs.css new file mode 100644 index 00000000..957ba60d --- /dev/null +++ b/branch/main/singlehtml/_static/tabs.css @@ -0,0 +1,89 @@ +.sphinx-tabs { + margin-bottom: 1rem; +} + +[role="tablist"] { + border-bottom: 1px solid #a0b3bf; +} + +.sphinx-tabs-tab { + position: relative; + font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif; + color: #1D5C87; + line-height: 24px; + margin: 0; + font-size: 16px; + font-weight: 400; + background-color: rgba(255, 255, 255, 0); + border-radius: 5px 5px 0 0; + border: 0; + padding: 1rem 1.5rem; + margin-bottom: 0; +} + +.sphinx-tabs-tab[aria-selected="true"] { + font-weight: 700; + border: 1px solid #a0b3bf; + border-bottom: 1px solid white; + margin: -1px; + background-color: white; +} + +.sphinx-tabs-tab:focus { + z-index: 1; + outline-offset: 1px; +} + +.sphinx-tabs-panel { + position: relative; + padding: 1rem; + border: 1px solid #a0b3bf; + margin: 0px -1px -1px -1px; + border-radius: 0 0 5px 5px; + border-top: 0; + background: white; +} + +.sphinx-tabs-panel.code-tab { + padding: 0.4rem; +} + +.sphinx-tab img { + margin-bottom: 24 px; +} + +/* Dark theme preference styling */ + +@media (prefers-color-scheme: dark) { + body[data-theme="auto"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); + } + + body[data-theme="auto"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); + } + + body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 1px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); + } +} + +/* Explicit dark theme styling */ + +body[data-theme="dark"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); +} + +body[data-theme="dark"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); +} + +body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 2px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); +} diff --git a/branch/main/singlehtml/_static/tabs.js b/branch/main/singlehtml/_static/tabs.js new file mode 100644 index 00000000..48dc303c --- /dev/null +++ b/branch/main/singlehtml/_static/tabs.js @@ -0,0 +1,145 @@ +try { + var session = window.sessionStorage || {}; +} catch (e) { + var session = {}; +} + +window.addEventListener("DOMContentLoaded", () => { + const allTabs = document.querySelectorAll('.sphinx-tabs-tab'); + const tabLists = document.querySelectorAll('[role="tablist"]'); + + allTabs.forEach(tab => { + tab.addEventListener("click", changeTabs); + }); + + tabLists.forEach(tabList => { + tabList.addEventListener("keydown", keyTabs); + }); + + // Restore group tab selection from session + const lastSelected = session.getItem('sphinx-tabs-last-selected'); + if (lastSelected != null) selectNamedTabs(lastSelected); +}); + +/** + * Key focus left and right between sibling elements using arrows + * @param {Node} e the element in focus when key was pressed + */ +function keyTabs(e) { + const tab = e.target; + let nextTab = null; + if (e.keyCode === 39 || e.keyCode === 37) { + tab.setAttribute("tabindex", -1); + // Move right + if (e.keyCode === 39) { + nextTab = tab.nextElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.firstElementChild; + } + // Move left + } else if (e.keyCode === 37) { + nextTab = tab.previousElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.lastElementChild; + } + } + } + + if (nextTab !== null) { + nextTab.setAttribute("tabindex", 0); + nextTab.focus(); + } +} + +/** + * Select or deselect clicked tab. If a group tab + * is selected, also select tab in other tabLists. + * @param {Node} e the element that was clicked + */ +function changeTabs(e) { + // Use this instead of the element that was clicked, in case it's a child + const notSelected = this.getAttribute("aria-selected") === "false"; + const positionBefore = this.parentNode.getBoundingClientRect().top; + const notClosable = !this.parentNode.classList.contains("closeable"); + + deselectTabList(this); + + if (notSelected || notClosable) { + selectTab(this); + const name = this.getAttribute("name"); + selectNamedTabs(name, this.id); + + if (this.classList.contains("group-tab")) { + // Persist during session + session.setItem('sphinx-tabs-last-selected', name); + } + } + + const positionAfter = this.parentNode.getBoundingClientRect().top; + const positionDelta = positionAfter - positionBefore; + // Scroll to offset content resizing + window.scrollTo(0, window.scrollY + positionDelta); +} + +/** + * Select tab and show associated panel. + * @param {Node} tab tab to select + */ +function selectTab(tab) { + tab.setAttribute("aria-selected", true); + + // Show the associated panel + document + .getElementById(tab.getAttribute("aria-controls")) + .removeAttribute("hidden"); +} + +/** + * Hide the panels associated with all tabs within the + * tablist containing this tab. + * @param {Node} tab a tab within the tablist to deselect + */ +function deselectTabList(tab) { + const parent = tab.parentNode; + const grandparent = parent.parentNode; + + Array.from(parent.children) + .forEach(t => t.setAttribute("aria-selected", false)); + + Array.from(grandparent.children) + .slice(1) // Skip tablist + .forEach(panel => panel.setAttribute("hidden", true)); +} + +/** + * Select grouped tabs with the same name, but no the tab + * with the given id. + * @param {Node} name name of grouped tab to be selected + * @param {Node} clickedId id of clicked tab + */ +function selectNamedTabs(name, clickedId=null) { + const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`); + const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode); + + tabLists + .forEach(tabList => { + // Don't want to change the tabList containing the clicked tab + const clickedTab = tabList.querySelector(`[id="${clickedId}"]`); + if (clickedTab === null ) { + // Select first tab with matching name + const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`); + deselectTabList(tab); + selectTab(tab); + } + }) +} + +if (typeof exports === 'undefined') { + exports = {}; +} + +exports.keyTabs = keyTabs; +exports.changeTabs = changeTabs; +exports.selectTab = selectTab; +exports.deselectTabList = deselectTabList; +exports.selectNamedTabs = selectNamedTabs; diff --git a/branch/main/singlehtml/_static/term_role_formatting.css b/branch/main/singlehtml/_static/term_role_formatting.css new file mode 100644 index 00000000..0b66095c --- /dev/null +++ b/branch/main/singlehtml/_static/term_role_formatting.css @@ -0,0 +1,4 @@ +/* Make terms bold */ +a.reference span.std-term { + font-weight: bold; +} diff --git a/branch/main/singlehtml/_static/togglebutton.css b/branch/main/singlehtml/_static/togglebutton.css new file mode 100644 index 00000000..54a67879 --- /dev/null +++ b/branch/main/singlehtml/_static/togglebutton.css @@ -0,0 +1,160 @@ +/** + * Admonition-based toggles + */ + +/* Visibility of the target */ +.admonition.toggle .admonition-title ~ * { + transition: opacity .3s, height .3s; +} + +/* Toggle buttons inside admonitions so we see the title */ +.admonition.toggle { + position: relative; +} + +/* Titles should cut off earlier to avoid overlapping w/ button */ +.admonition.toggle .admonition-title { + padding-right: 25%; + cursor: pointer; +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:hover { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 1%); +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:active { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 3%); +} + +/* Remove extra whitespace below the admonition title when hidden */ +.admonition.toggle-hidden { + padding-bottom: 0; +} + +.admonition.toggle-hidden .admonition-title { + margin-bottom: 0; +} + +/* hides all the content of a page until de-toggled */ +.admonition.toggle-hidden .admonition-title ~ * { + height: 0; + margin: 0; + opacity: 0; + visibility: hidden; +} + +/* General button style and position*/ +button.toggle-button { + /** + * Background and shape. By default there's no background + * but users can style as they wish + */ + background: none; + border: none; + outline: none; + + /* Positioning just inside the admonition title */ + position: absolute; + right: 0.5em; + padding: 0px; + border: none; + outline: none; +} + +/* Display the toggle hint on wide screens */ +@media (min-width: 768px) { + button.toggle-button.toggle-button-hidden:before { + content: attr(data-toggle-hint); /* This will be filled in by JS */ + font-size: .8em; + align-self: center; + } +} + +/* Icon behavior */ +.tb-icon { + transition: transform .2s ease-out; + height: 1.5em; + width: 1.5em; + stroke: currentColor; /* So that we inherit the color of other text */ +} + +/* The icon should point right when closed, down when open. */ +/* Open */ +.admonition.toggle button .tb-icon { + transform: rotate(90deg); +} + +/* Closed */ +.admonition.toggle button.toggle-button-hidden .tb-icon { + transform: rotate(0deg); +} + +/* With details toggles, we don't rotate the icon so it points right */ +details.toggle-details .tb-icon { + height: 1.4em; + width: 1.4em; + margin-top: 0.1em; /* To center the button vertically */ +} + + +/** + * Details-based toggles. + * In this case, we wrap elements with `.toggle` in a details block. + */ + +/* Details blocks */ +details.toggle-details { + margin: 1em 0; +} + + +details.toggle-details summary { + display: flex; + align-items: center; + cursor: pointer; + list-style: none; + border-radius: .2em; + border-left: 3px solid #1976d2; + background-color: rgb(204 204 204 / 10%); + padding: 0.2em 0.7em 0.3em 0.5em; /* Less padding on left because the SVG has left margin */ + font-size: 0.9em; +} + +details.toggle-details summary:hover { + background-color: rgb(204 204 204 / 20%); +} + +details.toggle-details summary:active { + background: rgb(204 204 204 / 28%); +} + +.toggle-details__summary-text { + margin-left: 0.2em; +} + +details.toggle-details[open] summary { + margin-bottom: .5em; +} + +details.toggle-details[open] summary .tb-icon { + transform: rotate(90deg); +} + +details.toggle-details[open] summary ~ * { + animation: toggle-fade-in .3s ease-out; +} + +@keyframes toggle-fade-in { + from {opacity: 0%;} + to {opacity: 100%;} +} + +/* Print rules - we hide all toggle button elements at print */ +@media print { + /* Always hide the summary so the button doesn't show up */ + details.toggle-details summary { + display: none; + } +} \ No newline at end of file diff --git a/branch/main/singlehtml/_static/togglebutton.js b/branch/main/singlehtml/_static/togglebutton.js new file mode 100644 index 00000000..215a7eef --- /dev/null +++ b/branch/main/singlehtml/_static/togglebutton.js @@ -0,0 +1,187 @@ +/** + * Add Toggle Buttons to elements + */ + +let toggleChevron = ` + + + +`; + +var initToggleItems = () => { + var itemsToToggle = document.querySelectorAll(togglebuttonSelector); + console.log(`[togglebutton]: Adding toggle buttons to ${itemsToToggle.length} items`) + // Add the button to each admonition and hook up a callback to toggle visibility + itemsToToggle.forEach((item, index) => { + if (item.classList.contains("admonition")) { + // If it's an admonition block, then we'll add a button inside + // Generate unique IDs for this item + var toggleID = `toggle-${index}`; + var buttonID = `button-${toggleID}`; + + item.setAttribute('id', toggleID); + if (!item.classList.contains("toggle")){ + item.classList.add("toggle"); + } + // This is the button that will be added to each item to trigger the toggle + var collapseButton = ` + `; + + title = item.querySelector(".admonition-title") + title.insertAdjacentHTML("beforeend", collapseButton); + thisButton = document.getElementById(buttonID); + + // Add click handlers for the button + admonition title (if admonition) + admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`) + if (admonitionTitle) { + // If an admonition, then make the whole title block clickable + admonitionTitle.addEventListener('click', toggleClickHandler); + admonitionTitle.dataset.target = toggleID + admonitionTitle.dataset.button = buttonID + } else { + // If not an admonition then we'll listen for the button click + thisButton.addEventListener('click', toggleClickHandler); + } + + // Now hide the item for this toggle button unless explicitly noted to show + if (!item.classList.contains("toggle-shown")) { + toggleHidden(thisButton); + } + } else { + // If not an admonition, wrap the block in a
block + // Define the structure of the details block and insert it as a sibling + var detailsBlock = ` +
+ + ${toggleChevron} + ${toggleHintShow} + +
`; + item.insertAdjacentHTML("beforebegin", detailsBlock); + + // Now move the toggle-able content inside of the details block + details = item.previousElementSibling + details.appendChild(item) + item.classList.add("toggle-details__container") + + // Set up a click trigger to change the text as needed + details.addEventListener('click', (click) => { + let parent = click.target.parentElement; + if (parent.tagName.toLowerCase() == "details") { + summary = parent.querySelector("summary"); + details = parent; + } else { + summary = parent; + details = parent.parentElement; + } + // Update the inner text for the proper hint + if (details.open) { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintShow; + } else { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintHide; + } + + }); + + // If we have a toggle-shown class, open details block should be open + if (item.classList.contains("toggle-shown")) { + details.click(); + } + } + }) +}; + +// This should simply add / remove the collapsed class and change the button text +var toggleHidden = (button) => { + target = button.dataset['target'] + var itemToToggle = document.getElementById(target); + if (itemToToggle.classList.contains("toggle-hidden")) { + itemToToggle.classList.remove("toggle-hidden"); + button.classList.remove("toggle-button-hidden"); + } else { + itemToToggle.classList.add("toggle-hidden"); + button.classList.add("toggle-button-hidden"); + } +} + +var toggleClickHandler = (click) => { + // Be cause the admonition title is clickable and extends to the whole admonition + // We only look for a click event on this title to trigger the toggle. + + if (click.target.classList.contains("admonition-title")) { + button = click.target.querySelector(".toggle-button"); + } else if (click.target.classList.contains("tb-icon")) { + // We've clicked the icon and need to search up one parent for the button + button = click.target.parentElement; + } else if (click.target.tagName == "polyline") { + // We've clicked the SVG elements inside the button, need to up 2 layers + button = click.target.parentElement.parentElement; + } else if (click.target.classList.contains("toggle-button")) { + // We've clicked the button itself and so don't need to do anything + button = click.target; + } else { + console.log(`[togglebutton]: Couldn't find button for ${click.target}`) + } + target = document.getElementById(button.dataset['button']); + toggleHidden(target); +} + +// If we want to blanket-add toggle classes to certain cells +var addToggleToSelector = () => { + const selector = ""; + if (selector.length > 0) { + document.querySelectorAll(selector).forEach((item) => { + item.classList.add("toggle"); + }) + } +} + +// Helper function to run when the DOM is finished +const sphinxToggleRunWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} +sphinxToggleRunWhenDOMLoaded(addToggleToSelector) +sphinxToggleRunWhenDOMLoaded(initToggleItems) + +/** Toggle details blocks to be open when printing */ +if (toggleOpenOnPrint == "true") { + window.addEventListener("beforeprint", () => { + // Open the details + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.dataset["togglestatus"] = el.open; + el.open = true; + }); + + // Open the admonitions + document.querySelectorAll(".admonition.toggle.toggle-hidden").forEach((el) => { + console.log(el); + el.querySelector("button.toggle-button").click(); + el.dataset["toggle_after_print"] = "true"; + }); + }); + window.addEventListener("afterprint", () => { + // Re-close the details that were closed + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.open = el.dataset["togglestatus"] == "true"; + delete el.dataset["togglestatus"]; + }); + + // Re-close the admonition toggle buttons + document.querySelectorAll(".admonition.toggle").forEach((el) => { + if (el.dataset["toggle_after_print"] == "true") { + el.querySelector("button.toggle-button").click(); + delete el.dataset["toggle_after_print"]; + } + }); + }); +} diff --git a/branch/main/singlehtml/index.html b/branch/main/singlehtml/index.html new file mode 100644 index 00000000..65e9282a --- /dev/null +++ b/branch/main/singlehtml/index.html @@ -0,0 +1,5700 @@ + + + + + + + Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Introduction to version control with Git documentation
    • +
  • + Edit on GitHub +
    • +
+
+
+
+
+ +
+

Introduction to version control with Git - Why we want to track versions and how to go back in time to a working version

+
+

Warning

+

In February and March 2024 we rewrote this lesson from the ground up. +If you are looking for the previous version, you can browse the +2023 version of this lesson.

+
+

This is the introductory lesson to version control using +Git.

+

We start with an existing repository on the web to visually explain the basic +concepts of version control. We later move to a local +repository. Our goal there is not only to be able to apply changes to an +existing repository but to also be able to turn own projects into Git +repositories and to share them with others.

+

In the separate collaborative Git +lesson, we teach more use +of remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with Git to +be able to work well.

+

The goals of the module as a whole are that the learner will feel comfortable +about committing changes, branching, and merging.

+
+

Prerequisites

+

We offer several options to go through the material: on the web, in an editor, +or in the terminal. +Please see the installation instructions.

+

We recommend to have a GitHub account. +Why GitHub? +Also GitLab and Bitbucket would +allow similar workflows and basically everything that we will discuss is +transferable. With this material and these exercises we do not implicitly +endorse the company GitHub. We have chosen to demonstrate +a number of concepts using examples with GitHub because +it is currently the most popular web platform for hosting Git repositories and +the chance is high that you will interact with +GitHub-based repositories even if you choose to host your +Git repository on another service.

+
+
+
+

Motivation

+
+

Objectives

+
    +

  • Make sure nobody leaves the workshop without starting to use some form of version control.

    • +

  • Discuss the reasons why we advocate distributed version control.

    • +
+
+
+

Instructor note

+
    +

  • 15 min discussion/demonstration

    • +
+
+
+

Git is all about keeping track of changes

+

We will learn how to keep track of changes first in the web browser. +Below are screenshots of tracked changes with Git +(from this example repository):

+
+Screenshot of a git log on GitHub +
+

Web browser, GitHub view

+
+
+

Later also using the terminal or the editor +(the same example repository):

+
+Screenshot of a git log in terminal +
+

The same as above, but the terminal view

+
+
+
+
+

Why do we need to keep track of versions?

+

Problem: If you have to identify and find your code from 17 days +ago, can you?

+

Version control is an answer to the following questions (do you recognize some +of them?):

+
    +

  • “It broke … hopefully I have a working version somewhere?”

    • +

  • “Can you please send me the latest version?”

    • +

  • “Where is the latest version?”

    • +

  • “Which version are you using?”

    • +

  • “Which version have the authors used in the paper I am trying to reproduce?”

    • +

  • “Found a bug! Since when was it there?”

    • +

  • “I am sure it used to work. When did it change?”

    • +

  • “My laptop is gone. Is my thesis now gone?”

    • +
+
+
+

Features: roll-back, branching, merging, collaboration

+

Problem: Your code worked two days ago, but is giving an error now. +You don’t know what you changed.

+

Problem: You and your colleague want to work on the same code at the +same time.

+
    +

  • Roll-back: you can always go back to a previous version and compare

    • +

  • Branching and merging:

    +
      +

    • Work on different ideas at the same time

      • +

    • Different people can work on the same code/project without interfering

      • +

    • You can experiment with an idea and discard it if it turns out to be a bad idea

      • +
    +
    • +
+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+ +
+
+

Reproducibility

+

Problem: Someone asks you about your results from 5 years ago. Can +you get the same results now?

+
    +

  • How do you indicate which version of your code you have used in your paper?

    • +

  • When you find a bug, how do you know when precisely this bug was introduced +(Are published results affected? Do you need to inform collaborators or users of your code?).

    • +
+

With version control we can “annotate” code +(browse this example online):

+
+Example of a git-annotated code with code and history side-by-side +
+

Example of a git-annotated code with code and history side-by-side.

+
+
+
+
+

Talking about code

+

Problem: You want to show someone a few lines from one of your projects.

+

Which of these two is more practical?

+
    +

  • “Clone the code, go to the file ‘src/util.rs’, and search for ‘time_iso8601’”. +Oh! But make sure you use the version from August 2023.”

    • +

  • Or I can send you a permalink:

    • +
+
+Screen-shot of a code portion +
+

Permalink that points to a code portion.

+
+
+
+
+

What we typically like to snapshot

+
    +

  • Software (this is how it started but Git/GitHub can track a lot more)

    • +

  • Scripts

    • +

  • Documents (plain text files much better suitable than Word documents)

    • +

  • Manuscripts (Git is great for collaborating/sharing LaTeX or Quarto manuscripts)

    • +

  • Configuration files

    • +

  • Website sources

    • +

  • Data

    • +
+
+

Discussion

+

In this example somebody tried to keep track of versions without a version +control system tool like Git. Discuss the following directory listing. What +possible problems do you anticipate with this kind of “version control”:

+
myproject-2019.zip
+myproject-2020-February.zip
+myproject-2021-August.zip
+myproject-2023-09-19-working.zip
+myproject-2023-09-21.zip
+myproject-2023-09-21-test.zip
+myproject-2023-09-21-myversion.zip
+myproject-2023-09-21-newfeature.zip
+...
+
+
+ +
+
+
+

Difficulties of version control

+

Despite the benefits, let’s be honest, there are some difficulties:

+
    +

  • One more thing to learn (it’s probably worth it and will save you more time in the long run; basic career skill).

    • +

  • Difficult if your collaborators don’t want to use it (in the worst case, you can version control on your side and email them versions).

    • +

  • Advanced things can be difficult, but basics are often enough (ask others for help when needed).

    • +
+
+
+

Why Git and not another tool?

+
    +

  • Easy to set up: no server needed.

    • +

  • Very popular: chances are high you will need to contribute to somebody else’s code which is tracked with Git.

    • +

  • Distributed: good backup, no single point of failure, you can track and +clean-up changes offline, simplifies collaboration model for open-source +projects.

    • +

  • Important platforms such as GitHub, GitLab, and Bitbucket +build on top of Git.

    • +
+

However, any version control is better than no version control and it is OK to +prefer a different tool than Git such as +Subversion, +Mercurial, Pijul, or others.

+
+
+
+

Configuring Git command line and editor

+

We have a longer version of this in the installation +instructions. +But for clarity, we will review the most important parts here.

+

You don’t need to set these if you work only through the GitHub web interface. +If you use VS Code or other editors or integrated development environments, +the editor might prompt you to set these up.

+

These configuration settings are saved in a file called .gitconfig in your +home directory. If this file exists, editors like VS Code will use this +configuration.

+

If you want to see your configuration settings, you can use the +command (--show-origin means it shows the file where each setting +is defined):

+
$ git config --list --show-origin
+
+
+
+

Name and email address for Git commit metadata

+

Git commits carry metadata about the author and two things you will always need +to define somewhere are:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+
+
+

For the email address we recommend to use the one you use for your GitHub account. +If you prefer to not use it, you can instead use +YOUR_GITHUB_USERNAME@users.noreply.github.com as the email address (replace YOUR_GITHUB_USERNAME). +This means that nobody can write to this email address, but GitHub will still +be able to connect your contributions with your GitHub account.

+

Note that these can, in theory, be anything: this is just data, not a +registration or identity requirement.

+
+
+

Default branch name

+

The default branch name in Git has been master for a long time, but it is +changing to main in many places. We recommend to set it to main for new +repositories that you create locally:

+
$ git config --global init.defaultbranch main
+
+
+
+
+

Useful alias for the command line

+

We recommend to define an alias in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+

We have an own section about aliases: Aliases and configuration.

+
+
+

Default text editor for commit messages

+

Git sometimes needs to start a text editor for you to enter messages (unless you create +commits from inside an editor or on the web). +This may have already been set to something (like VS Code), but if not +nano is usually a safe choice:

+
$ git config --global core.editor nano
+
+
+

The installation instructions text editor page gives ways +to set other editors, or do a web search for “git set editor to +[editor name]”.

+
+
+

Authenticating to GitHub: SSH or HTTPS or VS Code?

+

How does GitHub know who you are? There are three options:

+
    +

  • SSH is the classic method, using Secure Shell +Protocol remote connection +keys.

    • +

  • HTTPS works with the Git Credential Manager, which is an +extra add-on that works easily in Windows and Mac.

    • +

  • VS Code editor can authenticate with GitHub using its own +authentication method.

    • +
+

Read how to install them from the installation +instructions.

+

Test which one you should use:

+
+

Try this command:

+
$ ssh -T git@github.com
+
+
+

If it returns Hi USERNAME! You've successfully authenticated, ..., +then SSH is configured and the following steps will work with the SSH +cloning.

+

See our installation +instructions to +set up SSH access.

+

From now on, if you know that SSH works, you should always select +SSH as the clone URL from GitHub, or translate the URL to start with +the right thing yourself: git@github.com: (with the :).

+
+
+
+
+
+
+

Copy and browse an existing project

+

In this episode, we will look at an existing repository to +understand how all the pieces work together. Along the way, we will make a copy +(a fork) of the repository for us, which will be used for our +own changes in the next episode.

+
    +

  • We used to start by directly going and creating a repository from scratch. This +was abstract and hard to understand.

    • +

  • Instead, we’ll show you all the cool stuff in a Git repository +first, and then start adding files.

    • +

  • We use an example recipe book we created just for this course.

    • +

  • By the end of the course, you’ll know how to contribute your own +recipes to it.

    • +
+
+

Objectives

+
    +

  • See a real Git repository and understand what is inside of it.

    • +

  • Understand how version control allows advanced inspection of a +repository.

    • +

  • See how Git allows multiple people to collaborate easily.

    • +

  • See the big picture instead of remembering a bunch of commands.

    • +
+
+
+

GitHub, VS Code, Command line, and more

+

We offer three different paths of how to do this exercise:

+
    +

  • GitHub (this is the one we will demonstrate on day 1)

    • +

  • VS Code (if you prefer to follow along using an editor; we will +do this on day 2)

    • +

  • Command line (for people comfortable with the command line; you +will see more of this on day 2)

    • +
+

In the future we’ll add more paths, for example Jupyter and RStudio +(contributions welcome!).

+
+
+

Creating a copy of the repository by “forking”

+

A repository is a collection of files in one directory tracked +by git. A GitHub repository is GitHub’s copy, which adds +things like access control. Each GitHub repository is owned by a user +or organization, who controls what is in it.

+

First, we need to make our own copy of the exercise repository. This will +become important later, when we make our own changes.

+
    +

  1. Go to the repository view on GitHub:

    + +
    2. +

  2. First, on GitHub, click the button that says “Fork”. It is towards +the top-right of the screen:

    +
    +Screenshot on GitHub before clicking on "Fork" +
    +
    3. +

  3. You should shortly be redirected to your copy of the repository +YOUR_USER_NAME/recipe-book.

    4. +
+

At all times you should be aware of if you looking at your repository +or the CodeRefinery upstream repository.

+
    +

  • Your repository: https://github.com/USERNAME/recipe-book

    • +

  • CodeRefinery upstream repository: https://github.com/coderefinery/recipe-book

    • +
+
+

You only need to open your own view, as described above. The browser +URL should look like https://github.com/USER/recipe-book, where +USER is your GitHub username.

+
+
+
+

Exercise

+

Work on this by yourself or in your team.

+
+

Instructor note

+

Before starting the exercise session:

+
    +

  • Make sure you have shown how to fork the repository to own account +(above).

    • +
+
+
+

Exercise: Browsing an existing project (25 min)

+

Browse the recipe-book project (introduced above) and explore commits and branches. Take notes +and prepare questions. The hints are for the GitHub path in the +browser.

+
    +

  1. Browse the commit history: Are commit messages understandable? +(Hint: “Commit history”, the timeline symbol, above the file list)

    2. +

  2. Compare the commit history with the network graph (“Insights” -> “Network”). Can you find the branches?

    3. +

  3. How can you find out when a recipe was last modified?

    4. +

  4. How many changes did the Guacamole recipe receive (you find it under “sides”)? +Try to click on some of the commits to see what changed. +(Hint: “History” in the view of a single file)

    5. +

  5. Which recipes include the ingredient “salt”? +(Hint: the GitHub search. From the repository view, it should offer +the filter “repo:USER/recipe-book” by default. What if you +add a search term?)

    6. +

  6. In the Guacamole recipe, find out who modified each line last and when +(click on file, then click “Blame” button). Find out who added the cilantro +and in which commit. +(Hint: “Blame” view in the file view)

    7. +

  7. Can you use these recipes yourself? Are you allowed to share +modifications? +(Hint: look for a license file)

    8. +

  8. Browse issues and pull requests in the upstream repository (the +repository you forked from). Any idea what these might be good for? +(Hint: tabs in the repository view)

    9. +
+
+

The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren’t enough - this is by +design.

+
+
+

Solution and walk-through

+
+

(1) Basic browsing

+

The most basic thing to look at is the history of commits.

+
    +

  • This is visible from a button in the repository view. We see every +change, when, and who has committed.

    • +

  • Every change has a unique identifier, such as 554c187. This can +be used to identify both this change, and the whole project’s +version as of that change.

    • +

  • Clicking on a change in the view shows more.

    • +
+
+

Click on the timeline symbol in the repository view:

+
+Screenshot on GitHub of where to find the commit history +
+
+
+
+

(2) Compare commit history with network graph

+

The commit history we saw above looks linear: one commit after +another. But if we look at the network view, we see some branches and +merges. We’ll see how to do these later. This is another one of the +basic Git views.

+
+

In a new browser tab, open the “Insights” tab, and click on “Network”. +You can hover over the commit dots to see the person who committed and +how they correspond with the commits in the other view:

+
+Screenshot on GitHub of the network graph +
+
+
+
+

(3) When was a recipe last modified?

+

We see the history for the whole repository, but we can also see it +for a single file.

+
+

Navigate to the file view: Main page → sides directory → +guacamole.md. Click the “History” button near the top right:

+
+Screenshot on GitHub showing the history of a single file +
+
+
+
+

(4) How many changes did the Guacamole recipe receive?

+

According to the view above, it seems to have five changes (as of +2024-03-07). This could change later on.

+
+
+

(5) Which recipes include the ingredient “salt”

+

Version control makes it very easy to find all occurrences of a single +word. This is useful for things like finding where functions or +variables are defined or used.

+
+

We go to the main recipe book view. We click the Search magnifying +class at the very top, type “salt”, and click enter. We see every +instance, including the context.

+
+

Searching in a forked repository will not work instantaneously!

+

It usually takes a few minutes before one can search for keywords in a forked repository +since it first needs to build the search index the very first time we search. +Start it, continue with other steps, then come back to this.

+
+
+Screenshot on GitHub performing a search +
+
+
+
+

(6) Who modified each line last and when?

+

This is called the “annotate” or “blame” view. The name “blame” +is very unfortunate, but it is the standard term for historical reasons +for this functionality and it is not meant to blame anyone.

+
+

From a recipe view, change preview to “Blame” towards the top-left. +To get the actual commit, click on the commit message.

+
+Screenshot on GitHub showing the "Blame" view +
+
+
+
+

(7) Can you use these recipes yourself? Are you allowed to share modifications?

+
    +

  • Look at the file LICENSE.

    • +

  • It says it is “Creative Commons Zero 1.0”, which is equivalent to +public domain. You can use them without conditions.

    • +

  • Note the GitHub view of the file LICENSE gives a nice summary of what it +means. Try it out:

    +
    +Screenshot on GitHub summarizing license terms +
    +
    • +
+
+
+

(8) Browse issues and pull requests in the upstream repository

+

This can only be done through the GitHub view. Go to the main +repository coderefinery/recipe-book, (not your fork): +https://github.com/coderefinery/recipe-book. Issues +and Pull requests are different for each GitHub +copy.

+
    +

  • Click on the “Issues” tab. These are notes that people have added, +which allow discussion about the project. Often they are used to communicate +problems or ideas.

    • +

  • Click on the “Pull requests” tab. This allows anyone to propose +changes, but only the repository owners can accept.

    • +
+
+
+
+

Summary

+
    +

  • Git allowed us to understand this simple project much better than we +could, if it was just a few files on our own computer.

    • +

  • It was also very easy to share the project with the course.

    • +

  • By forking the repository, we created our own copy. This is +important for the next episode, where we will make changes to +our copy.

    • +
+
+
+
+

Committing changes

+

The first and most basic task to do in Git is record changes using +commits. In this part, we will record changes in two +ways: on a new branch (which supports multiple lines of work at once), and directly +on the “main” branch (which happens to be the default branch here).

+
+

Objectives

+
    +

  • Record new changes to our own copy of the project.

    • +

  • Understand adding changes in two separate branches.

    • +

  • See how to compare different versions.

    • +
+
+
+

Background

+
    +

  • In the previous episode we have browsed an existing repository and saw commits +and branches.

    • +

  • Each commit is a snapshot of the entire project at a certain +point in time and has a unique identifier (hash) .

    • +

  • A branch is a line of development, and the main branch or master branch +are often the default branch in Git.

    • +

  • A branch in Git is like a sticky note that is attached to a commit. When we add +new commits to a branch, the sticky note moves to the new commit.

    • +

  • Tags are a way to mark a specific commit as important, for example a release +version. They are also like a sticky note, but they don’t move when new +commits are added.

    • +
+
+Branching explained with a gopher +
+

What if two people, at the same time, make two different changes? Git +can merge them together easily. Image created using https://gopherize.me/ +(inspiration).

+
+
+
+
+

Exercise

+

We offer three different paths of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the GitHub +path only and recommend you do that. (You can get experience with +the other paths on day 2)

+
+

Exercise: Practice creating commits and branches (20 min)

+
    +

  1. Make sure that you now work on your fork of the recipe-book +repository (USER/recipe-book, not coderefinery/recipe-book)

    2. +

  2. First create a new branch and then add a recipe to the branch and commit the change.

    3. +

  3. In a new commit, modify the recipe you just added.

    4. +

  4. Switch to the main branch and modify a recipe there.

    5. +

  5. Browse the network and locate the commits that you just created (“Insights” -> “Network”).

    6. +

  6. Compare the branch that you created with the main branch. Can you find an easy way to see the differences?

    7. +

  7. Can you find a way to compare versions between two arbitrary commits in the repository?

    8. +

  8. Try to rename the branch that you created and then browse the network again.

    9. +

  9. Try to create a tag for one of the commits that you created (on GitHub, +create a “release”).

    10. +
+
+

The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren’t enough - this is by +design.

+
+
+

Solution and walk-through

+
+

(1) Make sure you are on your fork

+
+Screenshot on GitHub where we verify that we are on our fork. +
+

You want to see your username in the URL and you want to see the “forked from +…” part.

+
+
+
+
+

(2) Create a branch and add a recipe to the branch

+

A recipe template is below. This format is called “Markdown”, but it +doesn’t matter right now. You don’t have to use this particular template.

+
# Recipe name
+
+## Ingredients
+
+- Ingredient 1
+- Ingredient 2
+
+
+## Instructions
+
+- Step 1
+- Step 2
+
+
+

There is a main branch that is default. We want to create a +different branch for our new commit, because we will merge it later. +Commit is the verb to describe recording more changes, and also the +name of the thing you make. A commit is identified by something such as +554c187.

+
+
    +

  1. Where it says “main” at the top left, click, enter a new branch +name new-recipe, click on the offer to create the new branch +(“Create branch new-recipe from main”).

    +
    +Screenshot on GitHub where we create a new branch. +
    +
    2. +

  2. Change to some sub-directory, for example sides

    3. +

  3. Make sure you are still on the new-recipe branch (it should say +it at the top), and click “Add file” → “Create new file” from the +upper right.

    4. +

  4. Enter a filename where it says “Name your file…”, with a .md at +the end. Example: mixed-nuts.md.

    5. +

  5. Enter the recipe. You can use the template above.

    6. +

  6. Click “Commit changes”

    7. +

  7. Enter a commit message. Then click “Commit +changes”.

    8. +
+

You should appear back at the file browser view, and see your new +recipe there.

+
+
+
+

(3) Modify the recipe with a new commit

+
+

This is similar to before, but we click on the existing file to +modify.

+
    +

  1. Click on your new recipe, for example mixed-nuts.md.

    2. +

  2. Click the edit button, the pencil icon at top-right.

    3. +

  3. Follow the “Commit changes” instructions as in the previous step.

    4. +
+
+
+
+

(4) Switch to the main branch and modify a recipe there

+
+
    +

  1. Go back to the main repository page (your user’s page).

    2. +

  2. In the branch switch view (top left above the file view), switch to +main.

    3. +

  3. Modify another recipe that already exists, following the pattern +from above. Don’t modify the one you just created (but it shouldn’t +even be visible on the main branch).

    4. +
+
+
+
+

(5) Browse the commits you just made

+

Let’s look at what we did. Now, the main and new-recipe branches +have diverged: both have some modifications. Try to find the commits +you created.

+
+

Insights tab → Network view (just like we have done before).

+
+
+
+

(6) Compare the branches

+

Comparing changes is an important thing we need to do. When using the +GitHub view only, this may not be so common, but we’ll show it so that +it makes sense later on.

+
+

Next to the branch name switcher, click on “Branches” to get an overview.

+

Another way to compare branches or commits on GitHub is to adjust the following URL: +https://github.com/USER/recipe-book/compare/VERSION1..VERSION2

+

Replace USER with your username and VERSION1 and VERSION2 with a commit hash or branch name. +Please try it out.

+
+
+
+

(7) Compare two arbitrary commits

+

This is similar to above, but not only between branches.

+
+

Like above, one can compare commits on GitHub by adjusting the following URL: +https://github.com/USER/recipe-book/compare/VERSION1..VERSION2

+

Replace USER with your username and VERSION1 and VERSION2 with a commit hash or branch name. +Please try it out.

+
+
+
+

(8) Renaming a branch

+
+

Branch button → View all branches → three dots at right side → Rename branch.

+
+
+
+

(9) Creating a tag

+

Tags are a way to mark a specific commit as important, for example a release +version. They are also like a sticky note, but they don’t move when new +commits are added.

+
+

Click on the branch switcher, and then on “Tags”, then on “View all tags”, then +“Create a new release”:

+
+Screenshot on GitHub where we create a new tag. +
+

What GitHub calls releases are actually tags in Git with additional metadata. +For the purpose of this exercise we can use them interchangeably.

+
+
+
+
+

Discussion

+

In this part, we saw how we can make changes to our files. +With branches, we can +track several lines of work at once, and can compare +their differences.

+
    +

  • You could commit directly to main if there is only one single line +of work and it’s only you.

    • +

  • You could commit to branches if there are multiple lines of work at +once, and you don’t want them to interfere with each other.

    • +

  • Tags are useful to mark a specific commit as important, for example a +release version.

    • +

  • In Git, commits form a so-called “graph”. Branches are tags in Git function +like sticky notes that stick to specific commits. What this means for us is +that it does not cost any significant disk space to create new branches.

    • +
+
+
+
+

Merging changes and contributing to the project

+

Git allows us to have different development lines where we can try things out. +It also allows different people to work on the same project at the same. This +means that we have to somehow combine the changes later. In this part we will +practice this: merging.

+
+

Objectives

+
    +

  • Understand that on GitHub merging is done through a pull request. Think of it as a change proposal.

    • +

  • Create and merge a pull request within your own repository.

    • +

  • Understand (and optionally) do the same across repositories, to contribute to +the upstream public repository.

    • +
+
+
+

Instructor note

+
    +

  • 10 min introduction and setup

    • +

  • 25 min exercise

    • +

  • 15 min discussion

    • +
+
+
+

Background

+
    +

  • In the last episode, we added a new recipe on a branch. This allows +us to test it before it becomes “live”.

    • +

  • Now, we want to bring that change into the “main” branch.

    • +

  • We will find it’s not that hard! But you do have to keep track of the +steps and make sure that you work very precisely.

    • +
+
+
+

Exercise

+

In this exercise, we will show how we can propose changes and merge +changes within our own repository. Optionally, you can propose a recipe to +the upstream recipe book - which shows the true purpose of this. But +this is only a preview and we will practice collaboration much more in the +collaborative Git lesson.

+

We offer three different paths of how to do this exercise. For +the CodeRefinery workshop day 1, we use and demonstrate the GitHub +path only and recommend you do that. The exercise text below has +some GitHub-specific notes, but most is possibly with any path.

+
+

First, we make something called a pull request, which allows +review and commenting before the actual merge.

+
+

Exercise: Merging branches with pull requests (20 min)

+

We assume that in the previous exercise you have created a new branch +with a recipe. In our previous example, it is called new-recipe. +If not, create it first and add a recipe to your new branch, see +Committing changes.

+

We provide basic hints. You should refer to the solution as needed.

+
    +

  1. Navigate to your branch from the previous episode +(Hint: the same branch view we used last time).

    2. +

  2. Begin the pull request process. +(Hint: There is a “Contribute” button in the branch view).

    3. +

  3. Add or modify the pull request title and description, and verify the other data. +In the pull request verify the target repository and the target +branch. Make sure that you are merging within your own repository. +GitHub: By default, it will offer to make the change to the +upstream repository, coderefinery. You should change this, you +shouldn’t contribute your test recipe upstream yet. Where it says +base repository, select your own user’s repository.

    4. +

  4. Create the pull request by clicking “Create pull request”. Browse +the network view to see if anything has changed yet.

    5. +

  5. Merge the pull request, or if you are not on GitHub you can merge +the branch locally. Browse the network again. What has changed?

    6. +

  6. Find out which branches are merged and thus safe to delete. Then remove them +and verify that the commits are still there, only the branch labels are +gone. (Hint: you can delete branches that have been merged into main).

    7. +

  7. Optional: Try to create a new branch with a new change, then open a pull +request but towards the central repository. We will later merge few of +those. +(Hint: this is mostly the same as above, for the GitHub path. But, +you set the base repository as CodeRefinery. You might need to +compare across forks.)

    8. +
+
+
+

The solution below goes over most of the answers, and you are +encouraged to use it when the hints aren’t enough - this is by design.

+
+
+

Solution and walk-through

+ +
+

(2) Begin the pull request process

+

In GitHub, the pull request is the way we propose to merge two +branches together. We start the process of making one.

+
+
+Screenshot on GitHub where we get to the pull request process. +
+
+
+
+

(3) Fill out and verify the pull request

+

Check that the pull request is directed to the right repository and branch +and that it contains the changes that you meant to merge.

+
+

Things to check:

+
    +

  • Base repository: this should be your own

    • +

  • Title: make it descriptive

    • +

  • Description: make it informative

    • +

  • Scroll down to see commits: are these the ones you want to merge?

    • +

  • Scroll down to see the changes: are these the ones you want to merge?

    +
    +Screenshot on GitHub where we verify the changes we want to merge. +
    +

    This screenshot only shows the top part. If you scroll down, you +can see the commits and the changes. We recommend to do this before +clicking on “Create pull request”.

    +
    +
    +
    • +
+
+
+
+

(4) Create the pull request

+

We actually create the pull request. Don’t forget to navigate to the Network +view after opening the pull request. Note that the changes proposed in the +pull request are not yet merged.

+
+

Click on the green button “Create pull request”.

+

If you click on the little arrow next to “Create pull request”, you can also +see the option to “Create draft pull request”. This will be interesting later +when collaborating with others. It allows you to open a pull request that is +not ready to be merged yet, but you want to show it to others and get feedback.

+
+
+
+

(5) Merge the pull request

+

Now, we do the actual merging. We see some effects now.

+
+

Review it again (commits and changes), and then click “Merge pull request”.

+

After merging, verify the network view. Also navigate then to your “main” +branch and check that your new recipe is there.

+
+
+
+

(6) Delete merged branches

+

Before deleting branches, first check whether they are merged.

+

If you delete an un-merged branch, it will be difficult to find the commits +that were on that branch. If you delete a merged branch, the commits are now +also part of the branch where we have merged to.

+
+

One way to delete the branch is to click on the “Delete branch” button after the pull +request is merged:

+
+Screenshot on GitHub suggesting us to delete a branch after it has been merged. +
+

But what if we forgot? Then navigate to the branch view:

+
+Screenshot on GitHub where we navigate to the branches view. +
+

In the overview we can see that it has been merged and we can delete it:

+
+Screenshot on GitHub where we see an overview of branches and can delete them. +
+
+
+
+

(7) Contribute to the original repository with a pull request

+

Remember, this is an advanced step. If you do this, you are donating +a recipe to everyone.

+
+

Now that you know how to create branches and opening a pull request, try to +open a new pull request with a new change but this time the base repository +should be the upstream one.

+

In other words, you now send a pull request across repositories: from your fork +to the original repository.

+

Another thing that is different now is that you might not have permissions to +merge the pull request. We can then together review and browse the pull +request.

+
+
+
+
+

Resolving a conflict (demonstration)

+

A conflict is when Git asks humans to decide during a merge which of two +changes to keep if the same portion of a file has been changed in two different +ways on two different branches.

+

We will practice conflict resolution in the collaborative Git +lesson.

+

Here we will only demonstrate how to create a conflict and how to resolve it, +all on GitHub. Once we understand how this works, we will be more confident to +resolve conflicts also in the command line.

+

How to create a conflict (please try this in your own time and just watch now):

+
    +

  • Create a new branch from main and on it make a change to a file.

    • +

  • On main, make a different change to the same part of the same file.

    • +

  • Now try to merge the new branch to main. You will get a conflict.

    • +
+

How to resolve conflicts:

+
    +

  • On GitHub, you can resolve conflicts by clicking on the “Resolve conflicts” +button. This will open a text editor where you can choose which changes to +keep. +Make sure to remove the conflict markers. +After resolving the conflict, you can commit the changes and merge the +pull request.

    • +

  • Sometimes a conflict is between your change and somebody else’s change. In +that case, you might have to discuss with the other person which changes to +keep.

    • +
+

How to avoid conflicts:

+ +
+
+

Summary

+
    +

  • We learned how to merge two branches together.

    • +

  • When is this useful? This is not only useful to combine development lines in +your own work. Being able to merge branches also forms a basis for collaboration.

    • +

  • Branches which are merged to other branches are safe to delete, since we only +delete the “sticky note” next to a commit, not the commits themselves.

    • +
+
+
+
+

Cloning a Git repository and working locally

+

If you’ve been following the main path, you have just had interacted +with repositories on GitHub. This might not be what you usually +do, so now we move to working on your own computer.

+
+

Objectives

+
    +

  • We are able to clone a repository from the web and modify it locally.

    • +

  • We can do the same things we did before (commit, branch, merge), but locally.

    • +

  • We get a feeling for remote repositories (more later).

    • +
+
+
+

Instructor note

+
    +

  • 10 min introduction and setup

    • +

  • 25 min exercise

    • +

  • 15 min discussion

    • +
+
+
+

What is in a Git repository and what are we cloning?

+

Git repository:

+
    +

  • Contains all the files and directories of a project.

    • +

  • Contains the complete history of all changes (commits) to these files and directories.

    • +

  • Each commit is a snapshot of the entire project at a certain point in time and has a unique identifier (“hash”).

    • +

  • Sometimes it contains multiple branches and tags.

    • +

  • All the commits and history of a local repository are stored in a directory +called .git which is located at the root of the repository.

    • +
+

Cloning:

+
    +

  • Copying (downloading) the entire repository with all commits, branches, and tags to your computer.

    • +

  • It is a full backup of the repository, including all history.

    • +

  • You can then work on your local clone of the repository.

    • +

  • Changes on local clone will not automatically appear in the repository where +we cloned from. We have to actively “push” them there (we will practice this +in a later episode: How to turn your project to a Git repo and share it).

    • +
+
+
+

Exercise

+

Work on this by yourself or in your teams. Conceptually this episode should +seem familiar, from the browser-based exercises we did yesterday.

+

We offer the Command Line and VS Code paths for this exercise. +GitHub isn’t an option in this episode, since that is what we already +demonstrated in Committing changes and Merging changes and contributing to the project and since the point of this +episode is to work locally.

+

It is also possible to use the command line (terminal) from inside VS Code.

+
+

Exercise: Cloning a Git repository and working locally (25 min)

+
    +

  1. Configure Git command line and editor if you haven’t done that already.

    2. +

  2. Decide which repository you want to clone: your fork or the original repository? Both will work for this exercise. +Then, clone the recipe book.

    3. +

  3. Create a new branch.

    4. +

  4. Make a commit on your new branch.

    5. +

  5. Switch back to the main branch and create one or two commits there.

    6. +

  6. Merge the new branch into main.

    7. +

  7. Compare the graph locally and on GitHub and observe that the changes only exist locally on your computer.

    8. +

  8. Where are the remote branches? Practice how you can see all remote branches +also locally and how you can fetch them and make local changes to them.

    9. +
+
+

The solution below goes over most of the answer and should be used as +your guide (you can’t figure it out just from the exercise instructions).

+
+
+

Solution and walk-through

+
+

(1) Configure Git command line and editor

+

We have an own section for this: Configuring Git command line and editor.

+
+
+

(2) Cloning a repository

+

Now you need to decide which repository you want to clone. All of these options will work for this exercise +since we don’t plan to push changes back (for step 8 it might be easier to use the original repository):

+ +

The examples below assume you are cloning the original repository. If you are cloning your fork, you should +replace coderefinery with your GitHub username.

+
+

If you are unsure whether you are using SSH or HTTPS, please read Authenticating to GitHub: SSH or HTTPS or VS Code?.

+
+
$ git clone git@github.com:coderefinery/recipe-book.git
+
+
+
+

This creates a directory called “recipe-book” unless it already exists. You can also specify the target directory +on your computer (in this case “my-recipe-book”):

+
+
$ git clone git@github.com:coderefinery/recipe-book.git my-recipe-book
+
+
+
+
+
+
+

(3) Creating branches locally

+
+

Create a new branch called another-recipe from main and switch to it:

+
$ git switch --create another-recipe main
+
+
+

If you leave out the last argument, it will create a branch from the current +branch:

+
$ git switch --create another-recipe
+
+
+
+
+
+

(4) Creating commits locally

+
+

Create a new file. After we have created it, we can stage and commit +the change:

+
$ git add new-file.md
+$ git commit -m "Short summary of the change"
+
+
+

Make sure to replace “new-file.md” with the actual name of the file you created +and to replace “Short summary of the change” with a meaningful commit message.

+
+
+
+

(5) Switching branches and creating commits

+
+

First switch to the main branch:

+
$ git switch main
+
+
+

Then modify a file. Finally git add and then commit the change:

+
$ git commit -m "Short summary of the change"
+
+
+
+
+
+

(6) Merging branches locally

+
+

On the command line, when we merge, we always modify our current branch.

+

If you are not sure anymore what your current branch is, type:

+
$ git branch
+
+
+

Another way to find out where we are in Git:

+
$ git status
+
+
+

In this case we merge the another-recipe branch into our current branch:

+
$ git merge another-recipe
+
+
+
+
+
+

(7) How to compare the graph locally and on GitHub

+
+
$ git log --graph --oneline --decorate --all
+
+
+

We recommend to define an alias in Git, to be able to nicely visualize +branch structure in the terminal without having to remember a long Git command:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+

Then you can just type git graph from there on. We have an own section about +aliases: Aliases and configuration.

+

Compare this with the graph on GitHub: Insights tab → Network view (just like +we have done before).

+

The result is that we should not be able to see the new branch and the new +commits on GitHub.

+
+
+
+

(8) Browsing remote branches and creating local branches from them

+
+

With git branch you can list all local branches:

+
$ git branch
+
+  another-recipe
+* main
+
+
+

But where are the remote branches? We expect to see a couple of +them.

+

We can see them by asking for all branches (your output might vary depending on +where you cloned from):

+
$ git branch --all
+
+  another-recipe
+* main
+  remotes/origin/HEAD -> origin/main
+  remotes/origin/alex/fruit-salad
+  remotes/origin/main
+  remotes/origin/radovan/lasagna
+  remotes/origin/radovan/poke
+
+
+

You can create a local branch from a remote branch which will “track” the remote branch. +For instance, to create a local branch alex/fruit-salad from the remote branch origin/alex/fruit-salad +and switch to it, you can do:

+
$ git switch --create alex/fruit-salad origin/alex/fruit-salad
+
+
+

This shortcut will do the same thing:

+
$ git switch --track origin/alex/fruit-salad
+
+
+

Or even shorter:

+
$ git switch alex/fruit-salad
+
+
+

If you want to create a branch and not switch to it, you can use git branch.

+
$ git branch alex/fruit-salad
+
+
+
+
+
+
+

Summary

+
    +

  • When we clone a repository, we get a full backup of the repository, including +all history: all commits, branches, and tags.

    • +

  • Yesterday we learned about branches and commits, and now we created and used them locally.

    • +

  • Creating local branches and commits does not automatically modify the remote +repository. To “push” our local changes to the remote repository, we have to actively +“push” them there. We will practice this in a later episode: +How to turn your project to a Git repo and share it

    • +

  • Remote branches and local branches are not the same thing. If we want to +create local commits, we always need to create a local branch first. But the local branch can +“track” the remote branch and we can push and pull changes to and from the +remote branch.

    • +
+
+
+
+
+
+

Inspecting history

+
+

Objectives

+
    +

  • Be able find a line of code, find out why it was introduced and when.

    • +

  • Be able to quickly find the commit that changed a behavior.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Command line, GitHub, and VS Code

+

As usual, we offer ways to do this with the command line, VS Code, and +GitHub.

+
    +

  • Command line is most powerful and relatively easy with this. +You may also use it along with other things. If you haven’t tried +it yet, we’d recommend you to give it a try.

    • +

  • The GitHub web interface allows many things to be done, but not +everything.

    • +

  • VS Code allows some of these, but for some it’s easier to open +the VS Code terminal and run git there.

    • +
+
+
+

Our toolbox for history inspection

+
+

Instructor note

+

First the instructor demonstrates few commands on a real life example +repository https://github.com/networkx/networkx (mentioned in the amazing site The +Programming Historian). +Later we will practice these in an archaeology exercise (below).

+
+
+

Warm-up: “Git History” browser

+

As a warm-up we can try the “Git History” browser +on the README.rst file of the networkx repository:

+ +
+
+

Searching text patterns in the repository

+

With git grep you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or +some error message printed.

+
+

The Git command is as described above:

+
$ git grep TEXT
+$ git grep "some text with spaces"
+
+
+

In the networkx repository you can try:

+
$ git clone https://github.com/networkx/networkx
+$ cd networkx
+$ git grep -i fixme
+
+
+

While git grep searches the current state of the repository, +it is also possible to search through all changes with git log -S sometext +which can be useful to find where something got removed.

+
+
+
+

Inspecting individual commits

+
+

We have seen this one before already. Using git show we can inspect an individual commit if +we know its hash:

+
$ git show HASH
+
+
+

For instance:

+
$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7
+
+
+
+
+
+

Line-by-line code annotation with metadata

+

With git annotate you can see line by line who and when the line was +modified last. It also prints the precise hash of the last change which +modified each line. Incredibly useful for reproducibility.

+
+
$ git annotate FILE
+
+
+

Example:

+
$ git annotate networkx/convert_matrix.py
+
+
+

If you annotate in a terminal and the file is longer than the screen, Git by default uses the program less to +scroll the output. +Use /sometext <ENTER> to find “sometext” and you can cycle through the results with n (next) and N (last). +You can also use page up/down to scroll. You can quit with q.

+
+
+

Discussion

+

Discuss how these relatively trivial changes affect the annotation:

+
    +

  • Wrapping long lines of text/code into shorter lines

    • +

  • Auto-formatting tools such as black

    • +

  • Editors that automatically remove trailing whitespace

    • +
+
+
+
+

Inspecting code in the past

+
+

We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code:

+
$ git switch --create BRANCHNAME HASH
+
+
+

Example (lines starting with “#” are only comments):

+
$ # create branch called "older-code" from hash 347e6292419b
+$ git switch --create older-code 347e6292419bd0e4bff077fe971f983932d7a0e9
+
+$ # now you can navigate and inspect the code as it was back then
+$ # ...
+
+$ # after we are done we can switch back to "main"
+$ git switch main
+
+$ # if we like we can delete the "older-code" branch
+$ git branch -d older-code
+
+
+

On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

+
$ git checkout -b BRANCHNAME SOMEHASH
+
+
+
+
+
+
+

Exercise

+

This is described with the command line method, but by looking above +you can translate to the other options.

+
+

Exercise: Explore basic archaeology commands (20 min)

+

Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

+

Exercise steps:

+
    +

  • Make sure you are not inside another Git repository when running this +exercise. If you are, first step “outside” of it. +We want to avoid creating a Git repository inside another Git repository.

    +
    +

    You can check if you are inside a Git repository with:

    +
    $ git status
+
+fatal: not a git repository (or any of the parent directories): .git
+
    +
    +

    You want to see the above message which tells us that this is not a Git repository.

    +
    +
    • +

  • Clone this repository: +https://github.com/networkx/networkx.git.

    +
    +
    $ git clone https://github.com/networkx/networkx.git
+
    +
    +
    +
    • +

  • Then let us all make sure we are working on a well-defined version of the repository.

    +
    +

    Step into the new directory and create an exercise branch from the +networkx-2.6.3 tag/release:

    +
    $ cd networkx
+$ git switch --create exercise networkx-2.6.3
+
    +
    +

    On old Git versions which do not know the switch command (before 2.23), you +need to use this instead:

    +
    $ git checkout -b exercise networkx-2.6.3
+
    +
    +
    +
    • +
+

Then using the above toolbox try to:

+
    +

  1. Find the code line which contains "Logic error in degree_correlation".

    2. +

  2. Find out when this line was last modified or added. Find the actual commit which modified that line.

    3. +

  3. Inspect that commit with git show.

    4. +

  4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

    5. +

  5. How would you bring the code to the version of the code right before that line was last modified?

    6. +
+ +
+
+
+
+

Finding out when something broke/changed with git bisect

+

This only works with the command line.

+
+

“But I am sure it used to work! Strange.”

+
+

Sometimes you realize that something broke. +You know that it used to work. +You do not know when it broke.

+
+

How would you solve this?

+

Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now.

+
    +

  • How would you find the commit which changed it?

    • +

  • Why could it be useful to know the commit that changed it?

    • +
+
+

We will probably arrive at a solution which is similar to git bisect:

+
    +

  • First find out a commit in past when it worked.

    +
    $ git bisect start
+$ git bisect good f0ea950  # this is a commit that worked
+$ git bisect bad main      # last commit is broken
+
    +
    +
    • +

  • Now compile and/or run and/or test and decide whether “good” or “bad”.

    • +

  • This is how you can tell Git that this was a working commit:

    +
    $ git bisect good
+
    +
    +
    • +

  • And this is how you can tell Git that this was not a working commit:

    +
    $ git bisect bad
+
    +
    +
    • +

  • Then bisect/iterate your way until you find the commit that broke it.

    • +

  • If you want to go back to start, type git bisect reset.

    • +

  • This can even be automatized with git bisect run SCRIPT. +For this you write a script that returns zero/non-zero (success/failure).

    • +
+
+
+

Optional exercise: Git bisect

+

This only works with the command line.

+
+

(optional) History-2: Use git bisect to find the bad commit

+

In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

+

Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

+

Motivation

+

The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

+

Background

+

The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

+
$ python get_pi.py
+
+3.57
+
+
+

At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

+

Your task

+
    +

  • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

    • +

  • Once you have found the offending commit, also practice navigating to the last good commit.

    • +

  • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

    • +
+

Hints

+

Finding the first commit:

+
$ git log --oneline | tail -n 1
+
+
+

How to navigate to the parent of a commit with hash SOMEHASH:

+
$ git switch --create BRANCHNAME SOMEHASH~1
+
+
+

Instead of a tilde you can also use this:

+
$ git switch --create BRANCHNAME SOMEHASH^
+
+
+
+
+
+

Summary

+
    +

  • git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project on the command line.

    • +

  • git switch --create NAME HASH is the recommended mechanism to inspect old code on the command line.

    • +

  • Most of these commands can be used in the GitHub web interface (except git bisect).

    • +
+
+
+
+
+
+

How to turn your project to a Git repo and share it

+
+

Objectives

+
    +

  • Turn our own coding project (small or large, finished or unfinished) into a +Git repository.

    • +

  • Be able to share a repository on the web to have a backup or so that others +can reuse and collaborate or even just find it.

    • +
+
+
+

Instructor note

+
    +

  • 10 min introduction and setup

    • +

  • 25 min exercise

    • +

  • 15 min discussion

    • +
+
+
+

Exercise

+
+

Exercise: Turn your project to a Git repo and share it (25 min)

+
    +

  1. Create a new directory called myproject with one or few files in it. +This represents our own project. It is not yet a Git repository. You can try +that with your own project or use a simple placeholder example.

    2. +

  2. Turn this new directory into a Git repository.

    3. +

  3. Share this repository on GitHub (or GitLab, since it really works the same).

    4. +
+

We offer three different paths of how to do this exercise.

+
    +

  • Via GitHub web interface: easy and can be a good starting point if you are completely +new to Git.

    • +

  • VS Code is quite easy, since VS Code can offer to create the +GitHub repositories for you.

    • +

  • Command line: you need to create the +repository on GitHub and link it yourself.

    • +
+
+

Create an repository on GitHub

+

First log into GitHub, then follow the screenshots and descriptions below.

+
+Screenshot on GitHub before a new repository form is opened +
+

Click on the “plus” symbol on top right, then on “New repository”.

+
+
+

Then:

+
+Screenshot on GitHub just before a new repository is created +
+

Choose a repository name, add a short description, and in this case make sure to check “Add a +README file”. Finally “Create repository”.

+
+
+

Upload your files

+

Now that the repository is created, you can upload your files:

+
+Screenshot on GitHub just before uploading files +
+

Click on the “+” symbol and then on “Upload files”.

+
+
+
+
+
+
+

Remote repositories

+

In this exercise we have pushed our local repository to a remote repository. +We will learn how to work with remote repositories in detail in the +collaborative distributed version +control lesson. To store +your git data on another server, you use remotes. A remote is a repository +on its own, with its own branches. We can push changes to the remote and +pull from the remote.

+

You might use remotes to:

+
    +

  • Back up your own work or make your work findable.

    • +

  • To collaborate with other people.

    • +
+

There are different types of remotes:

+
    +

  • If you have a server you can SSH to, you can use that as a remote.

    • +

  • GitHub is a popular, closed-source commercial site.

    • +

  • GitLab is a popular, open-core +commercial site. Many universities have their own private GitLab servers +set up.

    • +

  • Bitbucket is yet another popular commercial site.

    • +

  • Another option is NotABug.

    • +

  • There are more …

    • +
+
+
+

Is putting software on GitHub/GitLab/… publishing?

+

It is a good first step but to make your code truly findable and +accessible, condider making your code citable and persistent: Get a +persistent identifier (PID) such as DOI in addition to sharing the code +publicly, by using services like Zenodo or similar +services.

+
+
+
+
+
+

Practical advice: how much Git is necessary?

+
+

Instructor note

+
    +

  • 20 min teaching/discussion

    • +
+
+
+

Writing useful commit messages

+

Useful commit messages summarize the change and provide context.

+

If you need a commit message that is longer than one line, +then the convention is: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+

Good example:

+
increase alpha to 2.0 for faster convergence
+
+the motivation for this change is
+to enable ...
+...
+(more context)
+...
+this is based on a discussion in #123
+
+
+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

What level of branching complexity is necessary for each project?

+

Simple personal projects:

+
    +

  • Typically start with just the main branch.

    • +

  • Use branches for unfinished/untested ideas.

    • +

  • Use branches when you are not sure about a change.

    • +

  • Use tags to mark important milestones.

    • +

  • If you are unsure what to do with unfinished and not working code, commit it +to a branch.

    • +
+

Projects with few persons: you accept things breaking sometimes

+
    +

  • It might be reasonable to commit to the main branch and feature branches.

    • +
+

Projects with few persons: changes are reviewed by others

+
    +

  • You create new feature branches for changes.

    • +

  • Changes are reviewed before they are merged to the main branch +(more about that in the collaborative Git lesson).

    • +

  • Consider to write-protect the main branch so that it can only be changed +with pull requests or merge requests.

    • +
+
+
+

How about staging and committing?

+
    +

  • Commit early and often: rather create too many commits than too few. +You can always combine commits later.

    • +

  • Once you commit, it is very, very hard to really lose your code.

    • +

  • Always fully commit (or stash) before you do dangerous things, so that you know you are safe. +Otherwise it can be hard to recover.

    • +

  • Later you can start using the staging area (where you first stage and then commit in a second step).

    • +

  • Later start using git add -p and/or git commit -p.

    • +
+
+
+

How large should a commit be?

+
    +

  • Better too small than too large (easier to combine than to split).

    • +

  • Often I make a commit at the end of the day (this is a unit I would not like to lose).

    • +

  • Smaller sized commits may be easier to review for others than huge commits.

    • +

  • Imperfect commits are better than no commits.

    • +

  • A commit should not contain unrelated changes to simplify review and possible +repair/adjustments/undo later (but again: imperfect commits are better than no commits).

    • +
+
+
+

Keypoints

+
    +

  • There is no one size fits all - start simple and grow your project.

    • +
+
+
+

Discussion

+

How do you [plan to] use Git?

+
    +

  • Advanced users or beginners, please provide your input in the online collaborative document.

    • +
+
+
+
+
+

What to avoid

+

The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas.

+

Postponing commits because the changes are “unfinished”/”ugly”: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all.

+

Not updating your branch before starting new work: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later. +So update your branch before adding new commits.

+

Commit unrelated changes together: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects.

+

Too ambitious branch which risks to never get completed: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere.

+

Committing generated files: Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files where +you can list which files and paths should be ignored by Git. You can also use +wild-cards to ignore files with a certain extension or files in a certain +directory.

+

Over-engineering the branch layout and safeguards in small projects: This +may prevent people from contributing (maybe even including yourself?). Add more +restrictions and safeguards only as the project and the group of collaborators +grows.

+

Commit messages that explain what has been changed but do not explain why it has been +changed: This is as useful as code comments which describe the “obvious” such +as “this is a loop” instead of explaining why something is done this way. +But don’t let perfect commit messages stop you from the most important point, committing often (first point).

+

Commit huge files: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent git rm does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request.

+
+

Discussion

+

Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements.

+
+
+
+
+
+

Basics

+
+

Objectives

+
    +

  • Learn to create Git repositories and make commits.

    • +

  • Get a grasp of the structure of a repository.

    • +

  • Learn how to inspect the project history.

    • +

  • Learn how to write useful commit log messages.

    • +
+
+
+

Instructor note

+
    +

  • 35 min teaching/type-along

    • +

  • 40 min exercise

    • +
+
+
+

What is Git, and what is a Git repository?

+
    +

  • Git is a version control system: can record/save snapshots and track the content of a folder as it changes over time.

    • +

  • Every time we commit a snapshot, Git records a snapshot of the entire project, saves it, and assigns it a version.

    • +

  • These snapshots are kept inside a sub-folder called .git.

    • +

  • If we remove .git, we remove the repository and history (but keep the working directory!).

    • +

  • The directory .git uses relative paths - you can move the whole repository somewhere else and it will still work.

    • +

  • Git doesn’t do anything unless you ask it to (it does not record anything automatically).

    • +

  • Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces).

    • +
+
+
+

Recording a snapshot with Git

+
    +

  • Git takes snapshots only if we request it.

    • +

  • We will record changes in two steps (we will later explain why this is a recommended practice).

    • +

  • Example (we don’t need to type yet):

    +
    $ git add FILE.txt
+$ git commit
+
+$ git add FILE.txt ANOTHERFILE.txt
+$ git commit
+
    +
    +
    • +

  • We first focus (git add, we “stage” the change), then record (git commit):

    • +
+
+Git staging +
+

Git staging and committing.

+
+
+
+

Question for the more advanced participants

+

What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? Think of focusing several scenes and pressing the +shutter at the end.

+
+
+
+

Configuring Git command line

+

Before we start using Git on the command line, we need to configure Git. +This is also part of the +installation instructions +but we need to make sure we all have +set name, email address, editor, and +default branch:

+
$ git config --global user.name "Your Name"
+$ git config --global user.email yourname@example.com
+$ git config --global core.editor nano
+$ git config --global init.defaultBranch main
+
+
+

Verify with:

+
$ git config --list
+
+
+
+

Instructor note

+

Instructors, give learners enough time to do the above configuration steps.

+
+
+
+

Type-along: Tracking a guacamole recipe with Git

+

We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole! (Inspiration for this example based on a +suggestion by B. Smith in a discussion in the Carpentries mailing list)

+

The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another specific language.

+
+

Instructor note

+

Instructors, please encourage now that participants type along.

+
+
+

Note

+

It is possible to go through this lesson in the command line or in the browser +(on GitHub).

+
    +

  • We recommend to start with the command line but later to also try in the browser.

    • +

  • If you get really stuck in the command line, try following in the browser and +later you can try to return to the command line.

    • +
+
+
+
+

Creating a repository

+

One of the basic principles of Git is that it is easy to create repositories:

+
+
$ mkdir recipe
+$ cd recipe
+$ git init -b main
+
+
+

That’s it! With git init -b main have now created an empty Git repository +where main is the default branch (more about branches later).

+

We will use git status a lot to check out what is going on:

+
$ git status
+
+On branch main
+
+No commits yet
+
+nothing to commit (create/copy files and use "git add" to track)
+
+
+

We will make sense of this information during this workshop.

+
+
+
+

Adding files and committing changes

+

Let us now create two files.

+

One file is called ingredients.txt and contains:

+
* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+
+
+

The second file is called instructions.txt and contains:

+
* chop avocados
+* chop onion
+* chop chili
+* squeeze lime
+* add salt
+* and mix well
+
+
+
+

As mentioned above, in Git you can always check the status of files in your repository using +git status. It is always a safe command to run and in general a good idea to +do when you are trying to figure out what to do next:

+
$ git status
+
+On branch main
+
+No commits yet
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    ingredients.txt
+    instructions.txt
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+

The two files are untracked in the repository (directory). You want to add the files (focus the camera) +to the list of files tracked by Git. Git does not track +any files automatically and you need make a conscious decision to add a file. Let’s do what +Git hints at, and add the files, one by one:

+
$ git add ingredients.txt
+$ git status
+
+On branch main
+
+No commits yet
+
+Changes to be committed:
+  (use "git rm --cached <file>..." to unstage)
+    new file:   ingredients.txt
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+    instructions.txt
+
+
+

Now this change is staged and ready to be committed. +Let us now commit the change to the repository:

+
$ git commit -m "adding ingredients"
+
+[main (root-commit) f146d25] adding ingredients
+ 1 file changed, 4 insertions(+)
+ create mode 100644 ingredients.txt
+
+
+

Right after we query the status to get this useful command into our muscle memory:

+
$ git status
+
+
+

Now stage and commit also the other file:

+
$ git add instructions.txt
+$ git commit -m "adding instructions"
+
+
+

We will add a third file to the repository, README.md, containing:

+
# recipe
+
+This is an exercise repository.
+
+
+

Now stage and commit also the README.md file:

+
$ git add README.md
+$ git commit -m "adding README"
+
+
+

What does the -m flag mean? Let us check the help page for that command:

+
$ git help commit
+
+
+

You should see a very long help page as the tool is very versatile (press q to quit). +Do not worry about this now but keep in mind that you can always read the help files +when in doubt. Searching online can also be useful, but choosing search terms +to find relevant information takes some practice and discussions in some +online threads may be confusing. +Note that help pages also work when you don’t have a network connection!

+
+
+
+

Exercise: Record changes

+
+

Basic-1: Record changes

+

Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt.

+
+

After modifying the files, do not stage the changes yet (do not git add +yet).

+

When you are done editing the files, try git diff:

+
$ git diff
+
+
+

You will see (can you identify in there the two added lines?):

+
diff --git a/ingredients.txt b/ingredients.txt
+index 4422a31..ba8854f 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -2,3 +2,4 @@
+ * 1 chili
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 7811273..2b11074 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -4,3 +4,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
+
+

Now first stage and commit each change separately (what happens when we leave out the -m flag?):

+
$ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
+
+

When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

+

When you are done committing the changes, experiment with these commands:

+
$ git log
+$ git log --stat
+$ git log --oneline
+
+
+
+
+
+
+

Git history and log

+
+

If you haven’t yet, please try now git log:

+
$ git log
+
+commit e7cf023efe382340e5284c278c6ae2c087dd3ff7 (HEAD -> main)
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:47 2023 +0200
+
+    don't forget to enjoy
+
+commit 79161b6e67c62ad4688a58c1e54183334611a390
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 19:12:32 2023 +0200
+
+    add half an onion
+
+commit a3394e39535343c4dae3bb4f703741a31aa8b78a
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:47:14 2023 +0200
+
+    adding README
+
+commit 369624674e63de48055a65bf63055bd59c985d22
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:46:58 2023 +0200
+
+    adding instructions
+
+commit f146d25b94569a15e94d7f0da6f15d7554f76c49
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Sun Sep 17 18:35:52 2023 +0200
+
+    adding ingredients
+
+
+
+
    +

  • We can browse the development and access each state that we have committed.

    • +

  • The long hashes uniquely label a state of the code.

    • +

  • They are not just integers counting 1, 2, 3, 4, … (why?).

    • +

  • Output is in reverse chronological order, i.e. newest commits on top.

    • +

  • We will use them when comparing versions and when going back in time.

    • +

  • git log --oneline only shows the first 7 characters of the commit hash and is good to get an overview.

    • +

  • If the first characters of the hash are unique it is not necessary to type the entire hash.

    • +

  • git log --stat is nice to show which files have been modified.

    • +
+
+
+

Optional exercises: Comparing changes

+
+

(optional) Basic-2: Comparing and showing commits

+
+
    +

  1. Have a look at specific commits with git show HASH.

    2. +

  2. Inspect differences between commit hashes with git diff HASH1 HASH2.

    3. +
+
+
+
+

(optional) Basic-3: Visual diff tools

+

This exercise is only relevant for the command line. In the browser, +the preview is already side-by-side and “visual”.

+
    +

  • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

    • +
+

On Windows or Linux:

+
$ git difftool --tool=meld HASH
+
+
+

On macOS:

+
$ git difftool --tool=opendiff HASH
+
+
+
+Git difftool using meld +
+

Git difftool using meld.

+
+
+

You probably want to use the same visual diff tool every time and +you can configure Git for that:

+
$ git config --global diff.tool meld
+
+
+
+
+

(optional) Basic-4: Browser and command line

+

You have noticed that it is possible to work either in the command +line or in the browser. It could help to deepen the understanding +trying to do the above steps in both.

+
    +

  • If you have managed to do the above in the command line, try now in the browser.

    • +

  • If you got stuck in the command line and move to the browser, try now to trouble-shoot the command line Git.

    • +
+
+
+
+

Writing useful commit messages

+

Using git log --oneline or browsing a repository on the web, we better +understand that the first line of the commit message is very important.

+

Good example:

+
increase threshold alpha to 2.0
+
+the motivation for this change is
+to enable ...
+...
+this is based on a discussion in #123
+
+
+

Convention: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

+
    +

  • Why something was changed is more important than what has changed.

    • +

  • Cross-reference to issues and discussions if possible/relevant.

    • +

  • Bad commit messages: “fix”, “oops”, “save work”

    • +

  • Bad examples: http://whatthecommit.com

    • +

  • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

    • +

  • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

    • +

  • Commits with multiple authors are possible.

    • +
+

Good references:

+ +
+

Note

+

A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

+

Some examples (but there are so many good examples):

+ +

When designing commit message styles consider also these:

+
    +

  • How will you easily generate a changelog or release notes?

    • +

  • During code review, you can help each other improving commit messages.

    • +
+
+

But remember: it is better to make any commit, than no commit. Especially in small projects. +Let not the perfect be the enemy of the good enough.

+
+
+

Ignoring files and paths with .gitignore

+
+

Discussion

+
    +

  • Should we add and track all files in a project?

    • +

  • How about generated files?

    • +

  • Why is it considered a bad idea to commit compiled binaries to version control?

    • +

  • What types of generated files do you know?

    • +
+
+

Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files. Example:

+
# ignore compiled python 2 files
+*.pyc
+# ignore compiled python 3 files
+__pycache__
+
+
+

An example taken from the official Git documentation:

+
# ignore objects and archives, anywhere in the tree.
+*.[oa]
+# ignore generated html files,
+*.html
+# except foo.html which is maintained by hand
+!foo.html
+# ignore everything under build directory
+build/
+
+
+
    +

  • .gitignore should be part of the repository because we want to make sure that all developers see the same behavior.

    • +

  • All files should be either tracked or ignored.

    • +

  • .gitignore uses something called a +shell glob syntax for +determining file patterns to ignore. You can read more about the syntax in the +documentation.

    • +

  • You can have .gitignore files in lower level directories and they affect the paths below.

    • +
+
+
+

Graphical user interfaces

+

We have seen how to make commits in the command line and via the GitHub website. +But it is also possible to work from within a Git graphical user interface (GUI):

+ +
+
+

Summary

+

Now we know how to save snapshots:

+
$ git add FILE(S)
+$ git commit
+
+
+

And this is what we do as we program.

+

Every state is then saved and later we will learn how to go back to these “checkpoints” +and how to undo things.

+
$ git init -b main  # initialize new repository (main is default branch)
+$ git add           # add files or stage file(s)
+$ git commit        # commit staged file(s)
+$ git status        # see what is going on
+$ git log           # see history
+$ git diff          # show unstaged/uncommitted modifications
+$ git show          # show the change for a specific commit
+$ git mv            # move/rename tracked files
+$ git rm            # remove tracked files
+
+
+

Git is not ideal for large binary files +(for this consider git-annex).

+
+

Basic-5: Test your understanding

+

Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

+
    +
  1. $ git commit -m "my recent changes"
+
    +
    +
    2. +
  2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    3. +
  3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
    +
    +
    4. +
  4. $ git commit -m myfile.txt "my recent changes"
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • It takes only one command to initialize a Git repository: git init -b main.

    • +

  • Commits should be used to tell a story.

    • +

  • Git uses the .git folder to store the snapshots.

    • +

  • Don’t be afraid to stage and commit often. Better too often than not often enough.

    • +
+
+
+
+
+

Branching and merging

+
+

Objectives

+
    +

  • Be able to create and merge branches.

    • +

  • Know the difference between a branch and a tag.

    • +
+
+
+

Instructor note

+
    +

  • 30 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Motivation for branches

+

In the previous section we tracked a guacamole recipe with Git.

+

Up until now our repository had only one branch with one commit coming +after the other:

+
+Linear Git repository +
+

Linear Git repository.

+
+
+
    +

  • Commits are depicted here as little boxes with abbreviated hashes.

    • +

  • Here the branch main points to a commit.

    • +

  • “HEAD” is the current position (remember the recording head of tape +recorders?). When we say HEAD, we mean those literal letters - +this isn’t a placeholder for something else.

    • +

  • When we talk about branches, we often mean all parent commits, not only the commit pointed to.

    • +
+

Now we want to do this:

+
+Branching explained with a gopher +
+

Image created using https://gopherize.me/ +(inspiration).

+
+
+

Software development is often not linear:

+
    +

  • We typically need at least one version of the code to “work” (to compile, to give expected results, …).

    • +

  • At the same time we work on new features, often several features concurrently. +Often they are unfinished.

    • +

  • We need to be able to separate different lines of work really well.

    • +
+

The strength of version control is that it permits the researcher to isolate +different tracks of work, which can later be merged to create a composite +version that contains all changes:

+
+Isolated tracks of work +
+

Isolated tracks of work.

+
+
+
    +

  • We see branching points and merging points.

    • +

  • Main line development is often called main or master.

    • +

  • Other than this convention there is nothing special about main or master, it is a branch like any other.

    • +

  • Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow).

    • +
+

A group of commits that create a single narrative are called a branch. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. “fast sequence extraction” or “Python interface” or “fixing bug in +matrix inversion algorithm”.

+
+

An important alias

+

We will now define an alias in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section). This is extensively used in the rest of this +and other lessons:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+
+
+
+
+

Instructor note

+

Instructors, please demonstrate how to set this alias and ensure that +all create it. This is very important for this lesson and +git-collaborative.

+
+

Let us inspect the project history using the git graph alias:

+
$ git graph
+
+* e7cf023 (HEAD -> main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • We have a couple commits and only +one development line (branch) and this branch is called main.

    • +

  • Commits are states characterized by a 40-character hash (checksum).

    • +

  • git graph print abbreviations of these checksums.

    • +

  • Branches are pointers that point to a commit.

    • +

  • Branch main points to a commit (in this example it is e7cf023efe382340e5284c278c6ae2c087dd3ff7 but on your computer +the hash will be different).

    • +

  • HEAD is another pointer, it points to where we are right now (currently main)

    • +
+

In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards.

+
+
+

Creating and working with branches

+
+

Instructor note

+

We do the following part together. Encourage participants to type along.

+
+
+

It is possible to create and merge branches directly on GitHub

+
    +

  • However, we do not have screenshots for that in this episode

    • +

  • But if you prefer to work in the browser, please try it

    • +

  • Please contribute screenshots to this lesson

    • +
+
+

Let’s create a branch called experiment where we add cilantro to ingredients.txt +(text after “#” are comments and not part of the command).

+
$ git branch experiment main  # creates branch "experiment" from "main"
+$ git switch experiment       # switch to branch "experiment"
+$ git branch                  # list all local branches and show on which branch we are
+
+
+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+
    +

  • Verify that you are on the experiment branch (note that git graph also +makes it clear what branch you are on: HEAD -> branchname):

    +
    $ git branch
+
+* experiment
+  main
+
    +
    +

    This command shows where we are, it does not create a branch.

    +
    • +

  • Then add 2 tbsp cilantro on top of the ingredients.txt:

    +
    * 2 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 2 tsp salt
+* 1/2 onion
+
    +
    +
    • +

  • Stage this and commit it with the message “let us try with some cilantro”.

    • +

  • Then reduce the amount of cilantro to 1 tbsp, stage and commit again with “maybe little bit less cilantro”.

    • +
+

We have created two new commits:

+
$ git graph
+
+* bcb8b78 (HEAD -> experiment) maybe little bit less cilantro
+* f6ec7b7 let us try with some cilantro
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
    +

  • The branch experiment is two commits ahead of main.

    • +

  • We commit our changes to this branch.

    • +
+
+
+

Exercise: Create and commit to branches

+
+

Branch-1: Create and commit to branches

+

In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging. The goal of the exercise is to end up with 3 branches.

+
    +

  • Change to the branch main.

    • +

  • Create another branch called less-salt.

    +
      +

    • Note! makes sure you are on main branch when you create the less-salt branch.

      • +

    • A safer way would be to explicitly mention to create from the main branch +as shown below:

      +
      $ git branch less-salt main
+
      +
      +
      • +
    +
    • +

  • Switch to the less-salt branch.

    • +

  • On the less-salt branch reduce the amount of salt.

    • +

  • Commit your changes to the less-salt branch.

    • +
+

Use the same commands as we used above.

+

We now have three branches (in this case HEAD points to less-salt):

+
$ git branch
+
+  experiment
+* less-salt
+  main
+
+$ git graph
+
+* bf28166 (HEAD -> less-salt) reduce amount of salt
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 (main) don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Here is a graphical representation of what we have created:

+
+_images/git-branch-2.svg
+
    +

  • Now switch to main.

    • +

  • In a new commit, improve the README.md file (we added the word “Guacamole”):

    +
    # Guacamole recipe
+
+This is an exercise repository.
+
    +
    +
    • +
+

Now you should have this situation:

+
$ git graph
+
+* b4af65b (HEAD -> main) improve the documentation
+| * bf28166 (less-salt) reduce amount of salt
+|/
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+
+_images/git-branch-3.svg
+

And for comparison this is how it looks on GitHub.

+
+
+
+

Exercise: Merging branches

+

It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge experiment into main.

+
+

Branch-2: Merge branches

+

Merge experiment and less-salt back into main following the lesson below +until the point where we start deleting branches.

+
+
+

If you got stuck in the above exercises or joined later

+

If you got stuck in the above exercises or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git switch experiment
+$ git switch less-salt
+$ git switch main
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

First we make sure we are on the branch we wish to merge into:

+
$ git branch
+
+  experiment
+  less-salt
+* main
+
+
+

Then we merge experiment into main:

+
$ git merge experiment
+
+
+
+_images/git-merge-1.svg
+

We can verify the result:

+
$ git graph
+
+*   81fcc0c (HEAD -> main) Merge branch 'experiment'
+|\
+| * bcb8b78 (experiment) maybe little bit less cilantro
+| * f6ec7b7 let us try with some cilantro
+* | b4af65b improve the documentation
+|/
+| * bf28166 (less-salt) reduce amount of salt
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents.

+

To view the branches that are merged into the current branch we can use the command:

+
$ git branch --merged
+
+  experiment
+* main
+
+
+

We are also happy with the work on the less-salt branch. Let us merge that +one, too, into main:

+
$ git branch  # make sure you are on main
+$ git merge less-salt
+
+
+
+Commit graph after merge
+

Commit graph after merge.

+
+
+

We can verify the result in the terminal:

+
$ git graph
+
+*   4e03d4b (HEAD -> main) Merge branch 'less-salt'
+|\
+| * bf28166 (less-salt) reduce amount of salt
+* |   81fcc0c Merge branch 'experiment'
+|\ \
+| * | bcb8b78 (experiment) maybe little bit less cilantro
+| * | f6ec7b7 let us try with some cilantro
+| |/
+* / b4af65b improve the documentation
+|/
+* e7cf023 don't forget to enjoy
+* 79161b6 add half an onion
+* a3394e3 adding README
+* 3696246 adding instructions
+* f146d25 adding ingredients
+
+
+

Observe how Git nicely merged the changed amount of salt and the new ingredient in the same file +without us merging it manually:

+
$ cat ingredients.txt
+
+* 1 tbsp cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually settle merge conflicts (we will do that later).

+
+
+

Deleting branches safely

+

Both feature branches are merged:

+
$ git branch --merged
+
+  experiment
+  less-salt
+* main
+
+
+

This means we can delete the branches:

+
$ git branch -d experiment
+$ git branch -d less-salt
+
+
+

This is the result:

+
+Commit graph after merged branches were deleted
+

Commit graph after merged branches were deleted.

+
+
+

We observe that when deleting branches, +only the pointers (“sticky notes”) disappeared, not the commits.

+

Git will not let you delete a branch which has not been reintegrated unless you +insist using git branch -D. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them.

+
+
+

Optional exercises with branches

+

The following exercises are more advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section.

+
+

(optional) Branch-3: Perform a fast-forward merge

+
    +

  1. Create a new branch from main and switch to it.

    2. +

  2. Create a couple of commits on the new branch (for instance edit README.md):

    +
    +_images/git-pre-ff.svg
    +
    3. +

  3. Now switch to main.

    4. +

  4. Merge the new branch to main.

    5. +

  5. Examine the result with git graph.

    6. +

  6. Have you expected the result? Discuss what you see.

    7. +
+ +
+
+

(optional) Branch-4: Rebase a branch (instead of merge)

+

As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

+
    +

  1. Create a new branch, and make a couple of commits on it.

    2. +

  2. Switch back to main, and make a couple of commits on it.

    3. +

  3. Inspect the situation with git graph.

    4. +

  4. Now rebase the new branch on top of main by first switching to the new branch, and then git rebase main.

    5. +

  5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

    6. +
+ +
+
+
+

Tags

+
    +

  • A tag is a pointer to a commit but in contrast to a branch it does not ever +move when creating new commits later.

    • +

  • It can be useful to think of branches as sticky notes and of tags as +commemorative plaques.

    • +

  • We use tags to record particular states or milestones of a project at a given +point in time, like for instance versions (have a look at semantic versioning, +v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a).

    • +

  • There are two basic types of tags: annotated and lightweight.

    • +

  • Use annotated tags since they contain the author and can be cryptographically signed using +GPG, timestamped, and a message attached.

    • +
+

Let’s add an annotated tag to our current state of the guacamole recipe:

+
$ git tag -a nobel-2023 -m "recipe I made for the 2023 Nobel banquet"
+
+
+

As you may have found out already, git show is a very versatile command. Try this:

+
$ git show nobel-2023
+
+
+

For more information about tags see for example +the Pro Git book chapter on the +subject.

+
+
+
+

Summary

+

Let us pause for a moment and recapitulate what we have just learned:

+
$ git branch               # see where we are
+$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+$ git merge NAME           # merge branch NAME (to current branch)
+$ git branch -d NAME       # delete branch NAME
+$ git branch -D NAME       # delete unmerged branch NAME
+
+
+

Since the following command combo is so frequent:

+
$ git branch NAME          # create branch NAME
+$ git switch NAME          # switch to branch NAME
+
+
+

There is a shortcut for it:

+
$ git switch --create NAME  # create branch NAME and switch to it
+
+
+
+

Typical workflows

+

With this there are two typical workflows:

+
$ git switch --create new-feature  # create branch, switch to it
+$ git commit                       # work, work, work, ..., and test
+$ git switch main                  # once feature is ready, switch to main
+$ git merge new-feature            # merge work to main
+$ git branch -d new-feature        # remove branch
+
+
+

Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging:

+
$ git switch --create wild-idea    # create branch, switch to it, work, work, work ...
+$ git switch main                  # realize it was a bad idea, back to main
+$ git branch -D wild-idea          # it is gone, off to a new idea
+
+
+
+
+

Branch-5: Test your understanding

+

Which of the following combos (one or more) creates a new branch and makes a commit to it?

+
    +
  1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    2. +
  2. $ git add file.txt
+$ git branch new-branch
+$ git switch new-branch
+$ git commit
+
    +
    +
    3. +
  3. $ git switch --create new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    4. +
  4. $ git switch new-branch
+$ git add file.txt
+$ git commit
+
    +
    +
    5. +
+ +
+
+

Keypoints

+
    +

  • A branch is a division unit of work, to be merged with other units of work.

    • +

  • A tag is a pointer to a moment in the history of a project.

    • +
+
+
+
+
+
+

Conflict resolution

+
+

Objectives

+
    +

  • Understand merge conflicts sufficiently well to be able to fix them.

    • +
+
+
+

Instructor note

+
    +

  • 20 min teaching/type-along

    • +

  • 20 min exercise

    • +
+
+
+

Conflicts in Git and why they are good

+

Imagine we start with the following text file:

+
1 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch A somebody modifies:

+
2 tbsp cilantro
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1/2 onion
+
+
+

On branch B somebody else modifies:

+
1/2 tbsp cilantro
+2 avocados
+1 chili
+1 lime
+1 tsp salt
+1 onion
+
+
+

When we try to merge Git will figure out that we 2 limes and an entire onion +but does not know whether to reduce or increase the amount of cilantro:

+
?????????????????
+2 avocados
+1 chili
+2 lime
+1 tsp salt
+1 onion
+
+
+

Git is very good at resolving modifications when merging branches and +in most cases a git merge runs smooth and automatic. +Then a merge commit appears (unless fast-forward; see Optional exercises with branches) without you even noticing.

+

But sometimes the same portion of the code/text is modified on two branches +in two different ways and Git issues a conflict. +Then you need to tell Git which version to keep (resolve it).

+

There are several ways to do that as we will see.

+

Please remember:

+
    +

  • It is good that Git conflicts exist: Git will not silently overwrite one of +two differing modifications.

    • +

  • Conflicts may look scary, but are not that bad after a little bit of +practice. Also they are luckily rare.

    • +

  • Don’t be afraid of Git because of conflicts. You may not meet some conflicts +using other systems because you simply can’t do the kinds of things you do +in Git.

    • +

  • You can take human measures to reduce them.

    • +
+
+
+

The human side of conflicts

+
    +

  • What does it mean if two people do the same thing in two different ways?

    • +

  • What if you work on the same file but do two different things in the different sections?

    • +

  • What if you do something, don’t tell someone from 6 months, and then try to combine it with other people’s work?

    • +

  • How are conflicts avoided in other work? (Only one person working at once? +Declaring what you are doing before you start, if there is any chance someone +else might do the same thing, helps.)

    • +

  • Minor conflicts (two people revise spelling) vs semantic (two people rewrite +a function to add two different new features). How did Git solve these in +branching/merging easily?

    • +
+
+

Now we can go to show how Git controls when there is actually a conflict.

+
+
+

Preparing a conflict

+
+

Instructor note

+

We do the following together as type-along/demo.

+
+
+

If you got stuck previously or joined later

+

If you got stuck previously or joined later, +you can apply the commands below. +But skip this box if you managed to create branches.

+
$ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe-before-merge.git
+$ cd recipe-before-merge
+
+$ git remote remove origin
+
+$ git graph
+
+
+

Or call a helper to un-stuck it for you.

+
+

We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together.

+
    +

  • Create two branches from main: one called like-cilantro, one called dislike-cilantro:

    +
    $ git branch like-cilantro main
+$ git branch dislike-cilantro main
+
    +
    +
    • +

  • On the two branches make different modifications to the amount of the same ingredient:

    • +

  • On the branch like-cilantro we have the following change:

    +
    $ git diff main like-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6cacd50 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +

  • And on the branch dislike-cilantro we have the following change:

    +
    $ git diff main dislike-cilantro
+
    +
    +
    diff --git a/ingredients.txt b/ingredients.txt
+index e83294b..6484462 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 1/2 tbsp cilantro
+ * 2 avocados
+ * 1 chili
+ * 1 lime
+
    +
    +
    • +
+
+
+

Merging conflicting changes

+

What do you expect will happen when we try to merge these two branches into +main?

+
+

Note

+

In case git switch does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git switch.

+
+

The first merge will work:

+
$ git switch main
+$ git status
+$ git merge like-cilantro
+
+Updating 4e03d4b..3caa632
+Fast-forward
+ ingredients.txt | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+

But the second will fail:

+
$ git merge dislike-cilantro
+
+Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+

Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit:

+
$ git status
+
+You have unmerged paths.
+  (fix conflicts and run "git commit")
+  (use "git merge --abort" to abort the merge)
+
+Unmerged paths:
+  (use "git add <file>..." to mark resolution)
+	both modified:   ingredients.txt
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+

Git won’t decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward.

+

Let us inspect the conflicting file:

+
$ cat ingredients.txt
+
+<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+* 2 avocados
+* 1 chili
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
+
+

Git inserted resolution markers (the <<<<<<<, >>>>>>>, and =======).

+

Try also git diff:

+
$ git diff
+
+
+
diff --cc ingredients.txt
+index 6cacd50,6484462..0000000
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@@ -1,4 -1,4 +1,10 @@@
+++<<<<<<< HEAD
+ +* 2 tbsp cilantro
+++=======
++ * 1/2 tbsp cilantro
+++>>>>>>> dislike-cilantro
+  * 2 avocados
+  * 1 chili
+  * 1 lime
+
+
+

git diff now only shows the conflicting part, nothing else.

+
+
+

Conflict resolution

+
<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 1/2 tbsp cilantro
+>>>>>>> dislike-cilantro
+
+
+

We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged.

+
+

Steps to resolve a conflict

+
    +

  • Check status with git status and git diff.

    • +

  • Decide what you keep (the one, the other, or both or something +else). Edit the file to do this.

    +
      +

    • Remove the resolution markers, if not already done.

      • +

    • The file(s) should now look exactly how you want them.

      • +
    +
    • +

  • Check status with git status and git diff.

    • +

  • Tell Git that you have resolved the conflict with git add ingredients.txt +(if you use the Emacs editor with a certain plugin the editor may stage the +change for you after you have removed the conflict markers).

    • +

  • Verify the result with git status.

    • +

  • Finally commit the merge with only git commit. Everything is pre-filled.

    • +
+
+
+
+

Exercise: Create and resolve a conflict

+
+

Conflict-1: Create another conflict and resolve

+

In this exercise, we repeat almost exactly what we did above with a +different ingredient.

+
    +

  1. Create two branches before making any modifications.

    2. +

  2. Again modify some ingredient on both branches.

    3. +

  3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

    4. +

  4. What happens if you apply the same modification on both branches?

    5. +

  5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into main you will not see a conflict. Can you +explain, why it is different this time?

    6. +
+ +
+
+
+

Optional exercises with conflict resolution

+
+

(optional) Conflict-2: Resolve a conflict when rebasing a branch

+
    +

  1. Create two branches where you anticipate a conflict.

    2. +

  2. Try to merge them and observe that indeed they conflict.

    3. +

  3. Abort the merge with git merge --abort.

    4. +

  4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

    5. +
+ +
+
+

(optional) Conflict-3: Resolve a conflict using mergetool

+
    +

  • Again create a conflict (for instance disagree on the number of avocados).

    • +

  • Stop at this stage:

    +
    Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +
    • +

  • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

    +
    $ git mergetool
+
    +
    +
    +Conflict resolution using mergetool +
    +
    • +

  • Your current branch is left, the branch you merge is right, result is in the middle.

    • +

  • After you are done, close and commit, git add is not needed when using git mergetool.

    • +
+

If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

+

To view what will be removed:

+
$ git clean -n
+
+
+

To remove:

+
$ git clean -f
+
+
+

To configure Git to avoid creating backups at all:

+
$ git config --global mergetool.keepBackup false
+
+
+
+
+
+
+

Using “ours” or “theirs” strategy

+
    +

  • Sometimes you know that you want to keep “ours” version (version on the branch you are on) +or “theirs” (version on the merged branch).

    • +

  • Then you do not have to resolve conflicts manually.

    • +

  • See merge strategies.

    • +
+

Example (merge and in doubt take the changes from current branch):

+
$ git merge -s recursive -Xours less-avocados
+
+
+

Or (merge and in doubt take the changes from less-avocados branch):

+
$ git merge -s recursive -Xtheirs less-avocados
+
+
+
+
+
+

Aborting a conflicting merge

+

Sometimes you get a merge conflict but realize that you can’t solve it without +talking to a colleague (who created the other change) first. What to do?

+

You can abort the merge and postponing conflict resolution by resetting the +repository to HEAD (last committed state):

+
$ git merge --abort
+
+
+

The repository looks then exactly as it was before the merge.

+
+
+
+

Avoiding conflicts

+
    +

  • Human measures

    +
      +

    • Think and plan to which branch you will commit to.

      • +

    • Do not put unrelated changes on the same branch.

      • +
    +
    • +

  • Collaboration measures

    +
      +

    • Open an issue and discuss with collaborators before starting a long-living +branch.

      • +
    +
    • +

  • Project layout measures

    +
      +

    • Modifying global data often causes conflicts.

      • +

    • Modular programming reduces this risk.

      • +
    +
    • +

  • Technical measures

    +
      +

    • Share your changes early and often - this is one of the happy, +rare circumstances when everyone doing the selfish thing (e.g. git push as +early as practical) results in best case for everyone!

      • +

    • Pull/rebase often to keep up to date with upstream.

      • +

    • Resolve conflicts early.

      • +
    +
    • +
+
+

Discussion

+

Discuss how Git handles conflicts compared to services like Google Drive.

+
+
+

Keypoints

+
    +

  • Conflicts often appear because of not enough communication or not optimal +branching strategy.

    • +
+
+
+
+
+
+
+

Using the Git staging area

+
+

Objectives

+
    +

  • Learn how to tell a story with your commit history.

    • +

  • Demystify the Git staging area.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 10 min exercise

    • +
+
+
+

Commit history is telling a story

+

Your current code is very important, but the history can be just +as important - it tells a story about how your code came to be.

+
    +

  • Each individual line of code rarely stands alone.

    • +

  • You often want to see all the related changes together.

    • +

  • But you also hardly ever do one thing at once.

    • +
+

Along with your code, Git creates a history for you, and if your +history is clear then you are a long way to organized code.

+
+

Discussion

+

Here are five types of history. What are the advantages and +disadvantages of each, when you look at it later?

+

Example 1:

+
b135ec8 add features A, B, and C
+
+
+

Example 2 (newest commit is on top):

+
6f0d49f implement feature C
+fee1807 implement feature B
+6fe2f23 implement feature A
+
+
+

Example 3:

+
ab990f4 saving three months of miscellaneous work I forgot to commit
+
+
+

Example 4 (newest commit is on top):

+
bf39f9d more work on feature B
+45831a5 removing debug prints for feature A and add new file
+bddb280 more work on feature B and make feature A compile again
+72d78e7 feature A did not work and started work on feature B
+b135ec8 now feature A should work
+72e0211 another fix to make it compile
+61dd3a3 forgot file and bugfix
+49dc419 wip (work in progress)
+
+
+

Example 5 (newest commit is on top):

+
1949dc4 Work of 2020-04-07
+a361dd3 Work of 2020-04-06
+1172e02 Work of 2020-04-03
+e772d78 Work of 2020-04-02
+
+
+

Discuss these examples. Can you anticipate problems?

+
+

We want to have nice commits. But we also want to “save often” +(checkpointing) - how can we have both?

+
    +

  • We will now learn to create nice commits using git commit --patch and/or the staging area.

    • +

  • Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits.

    • +

  • The staging area isn’t the only way to organize your history nicely, some alternatives are discussed at the end of the lesson.

    • +
+
+
+

Interactive commits

+
    +

  • The simplest ways to solve this is to do interactive commits: +the git commit --patch option (or git commit -p for short).

    • +

  • It will present you with every change you have made individually, +and you can decide which ones to commit right now.

    • +

  • Reference and key commands

    +
      +

    • git commit --patch to start the interactive commit

      • +

    • y to use the change

      • +

    • n to skip the change

      • +

    • s (split) if there are several changes grouped together, but +separated by a blank line, split them into separate choices.

      • +

    • q aborts everything.

      • +

    • ? for more options.

      • +
    +
    • +

  • The -p option is also available on commit, restore, checkout, reset, and add.

    • +
+
+
+

Exercise: Interactive commits

+
+

Staging-1: Perform an interactive commit

+

One option to help us create nice logical commits is to stage interactively +with git commit --patch:

+
    +

  1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

    2. +

  2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

    3. +

  3. Do it again for the other change.

    4. +

  4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

    5. +

  5. When would this be useful?

    6. +
+ +
+
+
+

The staging area

+
    +

  • The interactive commits above are great, but what if there are so +many changes that you can’t sort them out in one shot?

    • +

  • What if you make progress and want to record it somehow, but it’s +not ready to be committed?

    • +

  • The staging area is a place to record things before committing.

    • +
+
+

Instructor note

+

We give two examples and the instructor can pick one or both:

+
    +

  • Analogy using moving boxes

    • +

  • Analogy using shopping receipts

    • +
+
+
+

Discussion

+

Analogy using moving boxes

+
    +

  • You’re moving and you have a box to pack your things in.

    • +

  • You can put stuff into the box, but you can also take stuff out of the box.

    • +

  • You wouldn’t want to mix items from the bathroom, kitchen, and living room +into the same box.

    • +

  • The box corresponds to the staging area of Git, where you can craft your commits.

    • +

  • Committing is like sealing the box and sticking a label on it.

    • +

  • You wouldn’t want to label your box with “stuff”, but rather give a more +descriptive label.

    • +

  • See also https://dev.to/sublimegeek/git-staging-area-explained-like-im-five-1anh

    • +
+

Analogy using shopping receipts

+
    +

  • You need to go shopping and buy some stuff for work and for home. +You need two separate receipts.

    • +

  • Bad idea: go through the store get home stuff, pay, start at the +beginning and go through the store again. This is inefficient and +annoying.

    • +

  • What you actually do:

    +
      +

    • Go through the store and put everything you need in your shopping +basket.

      • +

    • Get to the check-out. Put your home stuff on the conveyor belt +(git add). Check both the belt (git diff --staged) and your +basket (git diff) to make sure you got all your home stuff.

      • +

    • Pay (git commit)

      • +

    • Repeat for work stuff.

      • +
    +
    • +
+

In order to keep organized, you have to use multiple locations to +stage things in sequence.

+
+
+
+

Staging area commands

+

The staging area is a middle ground between what you have done to your files +(the working directory) and what you have last committed (the HEAD commit). +Just like the name implies, it lets you prepare (stage) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since you can modify and stage several times before committing.

+

git add stages/prepares for the next commit:

+
                git add
+ [project*]  <------------  project*
+                               ^
+                               | modify with editor
+                               |
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git commit creates a new commit:

+
  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+  HEAD~2          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git reset --soft HEAD~1 (move HEAD back by one but keep changes and stage +them) would do the opposite of git commit. (in this case, HEAD +is literally this - not a replacement)

+

Going back to the last staged version:

+
              git restore
+ [project*]  ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Unstaging changes with git restore --staged:

+
          git restore --staged
+             ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Discarding unstaged changes:

+
                            project*
+                               |
+                               | git restore
+                               v
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Comparing:

+
                git diff
+ [project*]  <----------->  project*
+    ^                          ^
+    | git diff --staged        | git diff HEAD
+    v                          v
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+
+Staging basics +
+

The different states of the repository and the commands to move from one to +another.

+
+
+
+
+

Exercise: Using the staging area

+
+

Staging-2: Use the staging area to make a commit in two steps

+
    +

  1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

    2. +

  2. Use git add to stage one of the changes.

    3. +

  3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

    4. +

  4. Feel some regret and unstage the staged change.

    5. +
+
+
+

Discussion

+
    +

  • When is it better to “save” a change as commit, when is it better to “save” +it with git add?

    • +

  • Is it a problem to commit many small changes?

    • +
+
+
+

Keypoints

+
    +

  • The staging area helps us to create well-defined commits.

    • +
+
+
+
+
+

Undoing and recovering

+
+

Objectives

+
    +

  • Learn to undo changes safely

    • +

  • See when undone changes are permanently deleted and when they can be retrieved

    • +
+
+
+

Instructor note

+
    +

  • 25 min teaching/type-along

    • +

  • 25 min exercise

    • +
+
+

One of the main points of version control is that you can go back in +time to recover. Unlike this xkcd comic implies: https://xkcd.com/1597/

+

In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn’t a “commit” permanent?

+
    +

  • You can modify old commit history.

    • +

  • But if you have shared that history already, modifying it can make +a huge mess.

    • +
+
+

It is almost always possible to recover

+

As long as you commit something once (or at least git add it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru… until that guru becomes you.

+
+
+

Nice resource to visually simulate Git operation

+

git-sim +is a nice resouce to visually simulate Git operations listed in this episode +below, in your own repos with a single terminal command.

+
+
+
+

Undoing your recent, uncommitted and unstaged changes (preserves history)

+
+

Note

+

In case git restore does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git restore.

+
+

You do some work, and want to undo your uncommitted and unstaged modifications. +You can always do that with:

+
    +

  • git restore . (the dot means “here and in all folders below”)

    • +
+

You can also undo things selectively:

+
    +

  • git restore -p (decide which portions of changes to undo) or git restore PATH (decide which path/file)

    • +
+

If you have staged changes, you have at least two options to undo the staging:

+
    +

  • git restore --staged . followed by git status and git restore .

    • +

  • git reset --hard HEAD throws away everything that is not in last +commit (HEAD - this literal word, this isn’t a placeholder)

    • +
+
+
+
+

Reverting commits (preserves history)

+

Imagine we made a few commits. +We realize that the latest commit e02efcd was a mistake and we wish to undo it:

+
$ git log --oneline
+
+e02efcd (HEAD -> main) not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

A safe way to undo the commit is to revert the commit with git revert:

+
$ git revert e02efcd
+
+
+

This creates a new commit that does the opposite of the reverted commit. +The old commit remains in the history:

+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+

You can revert any commit, no matter how old it is. It doesn’t affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we’ll learn about later).

+
+

Exercise: Revert a commit

+
+

Undoing-1: Revert a commit

+
    +

  • Create a commit (commit A).

    • +

  • Revert the commit with git revert (commit B).

    • +

  • Inspect the history with git log --oneline.

    • +

  • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

    • +
+
+
+
+
+

Adding to the previous commit (modifies history)

+

Sometimes we commit but realize we forgot something. +We can amend to the last commit:

+
$ git commit --amend
+
+
+

This can also be used to modify the last commit message.

+

Note that this will change the commit hash. This command modifies the history. +This means that we avoid this command on commits that we have shared with others.

+
+

Exercise: Modify a previous commit

+
+

Undoing-2: Modify a previous commit

+
    +

  1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

    2. +

  2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

    3. +

  3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

    4. +
+ +
+
+
+
+

Rewinding branches (modifies history)

+

You can reset branch history to move your branch back to some +point in the past.

+
    +

  • git reset --hard HASH will force a branch label to any other point. All +other changes are lost (but it is possible to recover if you force reset by mistake).

    • +

  • Be careful if you do this - it can mess stuff up. Use git graph a +lot before and after.

    • +
+
+

Exercise: Git reset

+
+

Undoing-3: Destroy our experimentation in this episode

+

After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

+
    +

  • First, we will look at our history (git log/git graph) and +find the last commit HASH before our tests.

    • +

  • Then, we will git reset --hard HASH to that.

    • +

  • Then, git graph again to see what happened.

    • +
+
$ git log --oneline
+
+d3fc63a (HEAD -> main) Revert "not sure this is a good idea"
+e02efcd not sure this is a good idea
+b4af65b improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+$ git reset --hard b4af65b
+
+HEAD is now at b4af65b improve the documentation
+
+$ git log --oneline
+
+b4af65b (HEAD -> main) improve the documentation
+e7cf023 don't forget to enjoy
+79161b6 add half an onion
+a3394e3 adding README
+3696246 adding instructions
+f146d25 adding ingredients
+
+
+
+
+
+
+
+

Recovering from committing to the wrong branch

+

It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes.

+

Here we assume that we made a couple of commits but we realize they went to the +wrong branch.

+

Solution 1 using git cherry-pick:

+
    +

  1. Make sure that the correct branch exists and if not, create it. Make sure to +create it from the commit hash where you wish you had created it from: git branch BRANCHNAME HASH

    2. +

  2. Switch to the correct branch.

    3. +

  3. git cherry-pick HASH can be used to take a specific commit to the +current branch. Cherry-pick all commits that should have gone to the correct +branch, from oldest to most recent.

    4. +

  4. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    5. +
+

Solution 2 using git reset --hard (makes sense if the correct branch should +contain all commits of the accidentally modified branch):

+
    +

  1. Create the correct branch, pointing at the latest commit: git branch BRANCHNAME.

    2. +

  2. Check with git log or git graph that both branches point to the same, latest, commit.

    3. +

  3. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

    4. +
+
+
+

Recovering from merging/pulling into the wrong branch

+

git merge, git rebase, and git pull modify the current branch, never +the other branch. But sometimes we run this command on the wrong branch.

+
    +

  1. Check with git log the commit hash that you would like to rewind the +wrongly modified branch to.

    2. +

  2. Rewind the branch that accidentally got wrong commits with git reset --hard HASH (see also above).

    3. +
+
+
+

Recovering from conflict after pulling changes

+

Pulling changes with +git pull can create a conflict since git pull always also includes a git merge (more about this +in the collaborative Git lesson).

+

The recovery is same as described in Conflict resolution. Either +resolve conflicts or abort the merge with git merge --abort.

+
+
+

Undoing-4: Test your understanding

+
    +

  1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

    2. +

  2. Is it OK to modify commits that nobody has seen yet?

    3. +

  3. What situations would justify to modify the Git history and possibly remove commits?

    4. +
+ +
+
+
+
+

Interrupted work

+
+

Objectives

+
    +

  • Learn to switch context or abort work without panicking.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+

Keypoints

+
    +

  • There is almost never reason to clone a fresh copy to complete a task that +you have in mind.

    • +
+
+
+

Frequent situation: interrupted work

+

We all wish that we could write beautiful perfect code. But the real world is +much more chaotic:

+
    +

  • You are in the middle of a “Jackson-Pollock-style” debugging spree with 27 modified files +and debugging prints everywhere.

    • +

  • Your colleague comes in and wants you to fix/commit something right now.

    • +

  • What to do?

    • +
+

Git provides lots of ways to switch tasks without ruining everything.

+
+
+

Option 1: Stashing

+

The stash is the first and easiest place to temporarily “stash” +things.

+
    +

  • git stash will put working directory and staging area changes +away. Your code will be same as last commit.

    • +

  • git stash pop will return to the state you were before. Can give it a list.

    • +

  • git stash list will list the current stashes.

    • +

  • git stash save NAME is like the first, but will give it a name. +Useful if it might last a while.

    • +

  • git stash save [-p] [filename] will stash certain files files +and/or by patches.

    • +

  • git stash drop will drop the most recent stash (or whichever stash +you give).

    • +

  • The stashes form a stack, so you can stash several batches of modifications.

    • +
+
+

Exercise: Stashing

+
+

Interrupted-1: Stash some uncommitted work

+
    +

  1. Make a change.

    2. +

  2. Check status/diff, stash the change with git stash, check status/diff again.

    3. +

  3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

    4. +

  4. Pop off the stash you saved with git stash pop, and check status/diff.

    5. +

  5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

    6. +

  6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

    7. +

  7. Advanced: what does git graph show when you have something +stashed?

    8. +
+ +
+
+
+
+

Option 2: Create branches

+

You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch.

+

You basically know how to do this:

+
$ git switch --create temporary  # create a branch and switch to it
+$ git add PATHS                  # stage changes
+$ git commit                     # commit them
+$ git switch main                # back to main, continue your work there ...
+$ git switch temporary           # continue again on "temporary" where you left off
+
+
+

Later you can merge it to main or rebase it on top of main and resume work.

+
+
+

Storing various junk you don’t need but don’t want to get rid of

+

It happens often that you do something and don’t need it, but you don’t want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still.

+
+
+
+

Aliases and configuration

+
+

Objectives

+
    +

  • Learn to use aliases for most common commands.

    • +
+
+

Are you getting tired of typing so much? In Git you can define aliases (shortcuts):

+
    +

  • These are great because they can save you time typing.

    • +

  • But it’s easy to forget them, get confused, or be inconsistent with your colleagues.

    • +
+

There is plenty of other configuration for Git, that can make it nicer.

+
+

Aliases

+
    +

  • Aliases offer a way to improve the usability of Git: for +example git ci instead of git commit.

    • +

  • Aliases are based on simple string replacement in the command.

    • +

  • Aliases can either be specific to a repository or global.

    +
      +

    • Global aliases help you do the things you are used to across Git projects.

      • +

    • Per-project aliases can also be created.

      • +
    +
    • +

  • Global aliases are stored in ~/.gitconfig.

    • +
+
+
+

Example alias: git graph

+

A very useful shortcut which we use a lot in our workshops:

+
$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ cd your_git_repository
+$ git graph
+
+
+
+
+

Using external commands

+

It is possible to call external commands using the exclamation mark character “!”. +In this example here we create a local alias which is +stored in .git/config and not synchronized with remotes:

+
$ cd your_git_repository
+$ git config alias.hi '!echo hello'
+$ git hi
+
+
+
+

Food for thought: When to alias?

+
    +

  • How many times should you wait before aliasing a command?

    • +

  • Do you believe a list of generic two-letter acronyms for common commands will +save your time?

    • +
+
+
+
+

List of aliases the instructors use

+

You are welcome to reuse, suggest, improve. +You can see your current aliases in ~/.gitconfig.

+
$ git config --global alias.ap "add --patch"
+$ git config --global alias.br branch
+$ git config --global alias.ci "commit -v"
+$ git config --global alias.cip "commit --patch -v"
+$ git config --global alias.cl "clone --recursive"
+$ git config --global alias.di diff
+$ git config --global alias.dic "diff --staged --color-words"
+$ git config --global alias.diw "diff --color-words"
+$ git config --global alias.dis "!git --no-pager diff --stat"
+$ git config --global alias.fe fetch
+$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ git config --global alias.rem remote
+$ git config --global alias.st status
+$ git config --global alias.su "submodule update --init --recursive"
+
+
+

Here is what they do:

+
    +

  • ap: add, selecting parts individually, interactively.

    • +

  • br: branch (obvious)

    • +

  • ci: commit (check in), with -v option for clarity

    • +

  • cip: commit, selecting parts individually, interactively.

    • +

  • cl: clone, init submodules (submodules are an advanced topic)

    • +

  • di: diff (obvious)

    • +

  • dic: diff of staging area vs last commit (what is about to be committed)

    • +

  • diw: a word diff, color. Useful for small changes.

    • +

  • dis: a “diffstat”: what files are changed, not contents

    • +

  • fe: fetch (obvious)

    • +

  • graph: show whole git graph (so useful, some of us call it l)

    • +

  • rem: remote (obvious)

    • +

  • st: status (obvious)

    • +

  • su: submodule update (advanced)

    • +
+

A useful setting for the p aliases:

+
$ git config --global interactive.singlekey true
+
+
+
+
+

Advanced aliases

+

These are advanced aliases and configuration options. We won’t explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages!

+
$ git config --global alias.cif "commit -v -p --fixup"
+$ git config --global alias.rb "rebase --autosquash"
+$ git config --global alias.rbi "rebase --interactive --autosquash"
+$ git config --global alias.rbis "rebase --interactive --autosquash --autostash"
+$ git config --global alias.rbs "rebase --autosquash --autostash"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard"
+$ git config --global alias.new "log HEAD..HEAD@{upstream}"
+$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}"
+$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}"
+$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all"
+$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD"
+$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat"
+
+
+
+
+

Advanced Git configuration

+

Besides aliases, you can do plenty of other configuration of git. +Here are some of the most common ones:

+
$ git config --global interactive.singlekey true
+$ git config --global core.pager "less -RS"
+$ git config --global core.excludesfile ~/.gitignore
+$ git config --global merge.conflictstyle diff3
+$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]"
+$ git config --global diff.mnemonicPrefix true
+
+
+

Do you get tired of typing and copying and pasting your remote names +all the time, like git@github.com:myusername? You can create remote +aliases like this:

+
$ git config --global url.git@github.com:.insteadOf gh:
+$ git config --global url.git@github.com:/username/.insteadOf ghu:
+
+
+

Then, when you add a remote ghu:recipe, it will automatically be +translated to git@github.com:/username/recipe using a simple prefix +matching.

+
+

Keypoints

+
    +

  • If you are frustrated about remembering a command, you should create an alias.

    • +
+
+
+
+
+

Git under the hood

+
+

Objectives

+
    +

  • Verify that branches are pointers to commits and extremely lightweight.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+Git under the hood +
+
+

Down the rabbit hole

+

When working with Git, you will never need to go inside .git, but in this +exercise we will, in order to learn about how branches are implemented in Git.

+

For this exercise create a new repository and commit a couple of changes.

+

Now that we’ve made a couple of commits let us look at what is happening under +the hood.

+
$ cd .git
+$ ls -l
+
+drwxr-xr-x   - user 25 Aug 15:51 branches
+.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG
+.rw-r--r--  92 user 25 Aug 15:51 config
+.rw-r--r--  73 user 25 Aug 15:51 description
+.rw-r--r--  21 user 25 Aug 15:51 HEAD
+drwxr-xr-x   - user 25 Aug 15:51 hooks
+.rw-r--r-- 137 user 25 Aug 15:52 index
+drwxr-xr-x   - user 25 Aug 15:51 info
+drwxr-xr-x   - user 25 Aug 15:52 logs
+drwxr-xr-x   - user 25 Aug 15:52 objects
+drwxr-xr-x   - user 25 Aug 15:51 refs
+
+
+

Git stores everything under the .git folder in your repository. In fact, the +.git directory is the Git repository.

+

Previously when you wrote the commit messages using your text editor, they +were in fact saved to COMMIT_EDITMSG.

+

Each commit in Git is stored as a “blob”. This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file.

+

Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string).

+
+A commit inside Git +
+

States of a Git file. Image from the Pro Git book. License CC BY 3.0.

+
+
+

Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a directed acyclic +graph (do not worry +if the term is not familiar).

+
+A commit and its parents +
+

A commit and its parents. Image from the Pro Git book. License CC BY 3.0.

+
+
+

All branches and tags in Git are pointers to commits.

+
+
+

Git is basically a content-addressed storage system

+ +

Let us poke a bit into raw objects! Start with:

+
$ git cat-file -p HEAD
+
+
+

Then explore the tree object, then the file object, etc. recursively using the hashes you see.

+
+
+

Demonstration: experimenting with branches

+

Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an “Aha!” moment and provide us a +good understanding of the underlying model.

+

We are starting from the main branch and create an idea branch:

+
$ git status
+
+On branch main
+nothing to commit, working tree clean
+
+
+
$ git switch --create idea
+
+Switched to a new branch 'idea'
+
+
+
$ git branch
+
+* idea
+  main
+
+
+

Now let us go in:

+
$ cd .git
+$ cd refs/heads
+$ ls -l
+
+.rw-r--r-- 41 user 25 Aug 15:54 idea
+.rw-r--r-- 41 user 25 Aug 15:52 main
+
+
+

Let us check what the idea file looks like +(do not worry if the hash is different):

+
$ cat idea
+
+045e3db14740c60684d745e5fb891ae71e335611
+
+
+

Now let us replicate this file:

+
$ cp idea idea-2
+$ cp idea idea-3
+$ cp idea idea-4
+$ cp idea idea-5
+
+
+

Let us go up two levels and inspect the file HEAD:

+
$ cd ../..
+$ cat HEAD
+
+ref: refs/heads/idea
+
+
+

Let us open this file and change it to:

+
ref: refs/heads/idea-3
+
+
+

Now we are ready for the aha moment! +First let us go back to the working area:

+
$ cd ..
+
+
+

Now - on which branch are we?

+
$ git branch
+
+  idea
+  idea-2
+* idea-3
+  idea-4
+  idea-5
+  main
+
+
+
+

Discussion

+

Discuss the findings with other course participants.

+
+
+
+
+
+
+

Quick reference

+
+

Other cheatsheets

+ +
+
+

Glossary

+
+
alias

With aliases you can define your own shortcuts for Git commands.

+
+
version control system

A system that records changes to a file or set of files over time so that +you can recall specific versions later.

+
+
git

Implementation of a version control system. Currently the most popular one.

+
+
commit

As a verb, the process of recording more changes. +As a noun, the name of the record of changes. +A commit is identified by something such as 554c187.

+
+
working directory
workspace

the actual files you see and edit

+
+
staging area

Place files go after git add and before git commit

+
+
hash

Unique reference of any commit or state. Comes from hash +functions such as MD5 +or SHA1.

+
+
branch

One line of work. Different branches can exist at the same time +and split/merge. Committing on a branch updates that branch.

+
+
tag

Like a branch in that it points to a commit for reference. +It is designed to be permanent an not updated.

+
+
HEAD

Pointer to the most recent commit on the current branch.

+
+
remote

Roughly, another server that holds .git.

+
+
origin

Default name for a remote repository.

+
+
repository

One collection of files managed by Git. It contains entire history +of all files managed by git. GitHub has one repository as one +GitHub repository. VS Code has one repository as one directory you +can open. The command line has one repository as one directory.

+
+
clone

As a verb, the process of making a copy of a repository locally. +It brings in all history and all files. (As a noun, the copy that +was made when cloning).

+
+
GitHub repository

The files from the Git repository, but also other things from +GitHub such as access permissions, issues, and pull requests.

+
+
upstream

The original repository from which the code comes. If you +fork the repository, it is your upstream and it is easy to +send changes back to there.

+
+
fork

As a noun: a one person’s copy of a repository. +As a verb: making that copy. +As a verb on GitHub: Making a copy of a repository linked to the +original. It is easy to send changes to the original

+
+
issue

Within a web repository like GitHub, discussion of a topic, for +example a problem or improvement suggestion. These are a property +of the web platform and not of the Git program itself.

+
+
pull request

A GitHub concept: change proposal. A proposal to merge one branch +into another. Usually used to contribute code back to +upstream.

+
+
push

Moving changes from your local copy to another copy

+
+
pull

Getting changes from another copy to your own copy. git pull +does this fetch, and also tries to automatically merge.

+
+
master

Default name for main branch on Git. Depending on the configuration and service, +the default branch is sometimes main. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

+
+
main

Default name for main branch on GitLab and GitHub. +In this lesson we configure Git so that the default branch is +called main to be more consistent with GitHub and GitLab.

+
+
merge
merging

Bringing changes from one branch into another, either as a noun or +verb.

+
+
VS Code

A text editor and development environment by Microsoft. It’s quite +popular, partly because it is powerful and easy to use. VS +Codium is the same but without Microsoft +tracking.

+
+
+
+
+

Commands we use

+

Setup:

+
    +

  • git config: edit configuration options

    • +

  • git init -b main: create new repository with main as the default branch

    • +
+

See our status:

+
    +

  • git status: see status of files - use often!

    • +

  • git log: see history of commits and their messages, newest first

    • +

  • git graph: see a detailed graph of commits. Create this command +with git config --global alias.graph "log --all --graph --decorate --oneline"

    • +

  • git diff: show difference between working directory and last commit

    • +

  • git diff --staged: show difference between staging area and last commit

    • +

  • git show COMMIT: inspect individual commits

    • +
+

General work:

+
    +

  • git add FILE:

    +
      +

    • Add a new file

      • +

    • Add a file to staging

      • +
    +
    • +

  • git commit: record a version, add it to current branch

    • +

  • git commit --amend: amend our last commit

    • +

  • git branch: show which branch we’re on

    • +

  • git branch NAME: create a new branch called “name”

    • +

  • git restore FILE: restore last committed/staged version of FILE, losing unstaged changes

    • +

  • git switch --create BRANCH-NAME: create a new branch and switch to it

    • +

  • git revert HASH: create a new commit which reverts commit HASH

    • +

  • git reset --soft HASH: remove all commits after HASH, but keep their modifications as staged changes

    • +

  • git reset --hard HASH: remove all commits after HASH, permanently throwing away their changes

    • +

  • git merge BRANCH-NAME: merge branch BRANCH-NAME into current branch

    • +

  • git grep PATTERN: search for patterns in tracked files

    • +

  • git annotate FILE: find out when a specific line got introduced and by whom

    • +

  • git bisect: find a commit which broke some functionality

    • +
+
+
+
+

Customizing Git

+
+

Shell prompt

+
+

Instructor note

+

Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like.

+
+

You can make your shell display contextual information about +your Git state even at all times.

+

Here are few example projects that make this possible and easy:

+ +
+
+

More useful “diff” output

+

Delta is a syntax-highlighting pager for +git, diff, and grep output. You can customize how you want to highlight the +“diff” output. It allows side-by-side view, word-level diff highlighting, +improved merge conflict display, and much more.

+
+
+
+

Other resources

+ +
+
+

List of exercises

+

This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests.

+
+
+

Instructor guide

+
+

Exercise preparation: one day before the workshop

+ +
+
+

Privacy

+

When presenting the material in a streamed and recorded workshop, make sure to +only show the https://github.com/coderefinery/recipe-book-recorded +repository.

+
+
+

Schedule Day 1

+

Times here are in CE(S)T.

+ +
+
+

Schedule Day 2

+

Times here are in CE(S)T.

+ +
+
+

Why we teach this lesson

+

Everyone should be using a version control system for their work, even if they’re working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories.

+

Specific motivations:

+
    +

  • Code easily becomes a disaster without version control

    • +

  • Mistakes happen - Git offers roll-back functionality and easy backup mechanism

    • +

  • One often needs to work on multiple things in parallel - branches solve that problem

    • +

  • Git enables people to collaborate on code or text without stepping on each other’s toes

    • +

  • Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, +and if bugs are found one can find out exactly when it was introduced

    • +
+

Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices.

+
+
+

Intended learning outcomes

+

By the end of this lesson, learners should:

+
    +

  • realize that version control is very important and Git is a valuable tool to learn and use

    • +

  • understand that Git is configurable and know how to set basic configurations

    • +

  • be able to set up Git repositories and make commits

    • +

  • know how to write good commit messages

    • +

  • have an idea of how the staging area can be used to craft good commits

    • +

  • know how to create branches and switch between branches

    • +

  • have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way

    • +

  • know how to merge branches and understand what that means in terms of combining different modifications

    • +

  • realize that conflicts are generally a good thing since they prevent incorrect merges

    • +

  • be able to set up a repository on GitHub and connect it with local repository

    • +

  • push changes to a remote repository

    • +

  • know a few ways to search through a repository and its history

    • +
+
+
+

Inspecting history

+

Key lesson is how to find when something is broken or what commit has broken +the code.

+

It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that git annotate +and git show are available on GitHub and GitLab.

+

When discussing git annotate and git bisect the “when” is more important +than “who”. It is not to blame anybody but rather to find out whether published +results are affected.

+

Discuss how one would find out this information without version control.

+

Questions to involve participants:

+
    +

  • Have you ever found a bug in your code and wondered whether it has affected published results?

    • +

  • Have you ever wondered when, and by whom, a particular line of code was introduced?

    • +

  • Have you ever found out that a code behaves differently than it used to but you are not sure when +precisely this changed?

    • +
+

Confusion during git bisect exercise:

+

Learners may get stuck in the git bisect exercise if they incorrectly assign a commit +as bad or good. +To leave the bisect mode and return to the commit before git bisect start was issued, +one can do

+
$ git bisect reset
+
+
+

and start over if needed.

+
+

Live better than reading the website material

+

It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier.

+
+
+

Log your history in a separate window

+

The screencasting (shell window cheatsheet) hints have been moved to +the presenting +manual.

+
+
+

Create a cheatsheet on the board

+

For in-person workshops, create a “cheatsheet” on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven’t forgotten anything. Re-create and expand in future git lessons. +One strategy is:

+
    +

  • a common section for basic commands: init, config, clone, help, stash

    • +

  • info commands, can be run anytime: status, log, diff, graph

    • +

  • A section for all the commands that move code from different states: +add, commit, etc. See the visual cheat sheet below.

    • +
+

You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheat sheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it’s probably too confusing to use after this course. But, the idea +of commands moving from the “working dir”, “staging area”, “commits”, +etc is good.

+
+Example cheat sheet +
+

Example cheat sheet.

+
+
+

We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to.

+
+
+

Draw a graph on the board

+

Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run git graph, then do the command, +then look at git graph again.

+
+
+

Repeat the following points

+
    +

  • Always check git status, git diff, and git graph (our alias) before and +after every command until you get used to things. These give you a clear view +into what is going on, the key to knowing what you are doing. Even +after you are used to things… anytime you do something you do +infrequently, it’s good to check.

    • +

  • git graph is a direct representation of what we are drawing on the +board and should constantly be compared to it.

    • +

  • Once you git add something, it’s almost impossible to lose it. +This is used all the time, for example once you commit or even add +it is hard to lose. Commit before you merge or rebase. And so on.

    • +
+
+
+

Start from identical environment

+

You probably have a highly optimized bash and git environment - one +that is different from students. Move .gitconfig and .bashrc out +of the way before you start so that your environment is identical to +what students have.

+
+
+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/singlehtml/objects.inv b/branch/main/singlehtml/objects.inv new file mode 100644 index 00000000..66e23ea9 Binary files /dev/null and b/branch/main/singlehtml/objects.inv differ diff --git a/branch/main/staging-area/index.html b/branch/main/staging-area/index.html new file mode 100644 index 00000000..0eb66126 --- /dev/null +++ b/branch/main/staging-area/index.html @@ -0,0 +1,515 @@ + + + + + + + Using the Git staging area — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Using the Git staging area

+
+

Objectives

+
    +

  • Learn how to tell a story with your commit history.

    • +

  • Demystify the Git staging area.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 10 min exercise

    • +
+
+
+

Commit history is telling a story

+

Your current code is very important, but the history can be just +as important - it tells a story about how your code came to be.

+
    +

  • Each individual line of code rarely stands alone.

    • +

  • You often want to see all the related changes together.

    • +

  • But you also hardly ever do one thing at once.

    • +
+

Along with your code, Git creates a history for you, and if your +history is clear then you are a long way to organized code.

+
+

Discussion

+

Here are five types of history. What are the advantages and +disadvantages of each, when you look at it later?

+

Example 1:

+
b135ec8 add features A, B, and C
+
+
+

Example 2 (newest commit is on top):

+
6f0d49f implement feature C
+fee1807 implement feature B
+6fe2f23 implement feature A
+
+
+

Example 3:

+
ab990f4 saving three months of miscellaneous work I forgot to commit
+
+
+

Example 4 (newest commit is on top):

+
bf39f9d more work on feature B
+45831a5 removing debug prints for feature A and add new file
+bddb280 more work on feature B and make feature A compile again
+72d78e7 feature A did not work and started work on feature B
+b135ec8 now feature A should work
+72e0211 another fix to make it compile
+61dd3a3 forgot file and bugfix
+49dc419 wip (work in progress)
+
+
+

Example 5 (newest commit is on top):

+
1949dc4 Work of 2020-04-07
+a361dd3 Work of 2020-04-06
+1172e02 Work of 2020-04-03
+e772d78 Work of 2020-04-02
+
+
+

Discuss these examples. Can you anticipate problems?

+
+

We want to have nice commits. But we also want to “save often” +(checkpointing) - how can we have both?

+
    +

  • We will now learn to create nice commits using git commit --patch and/or the staging area.

    • +

  • Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits.

    • +

  • The staging area isn’t the only way to organize your history nicely, some alternatives are discussed at the end of the lesson.

    • +
+
+
+

Interactive commits

+
    +

  • The simplest ways to solve this is to do interactive commits: +the git commit --patch option (or git commit -p for short).

    • +

  • It will present you with every change you have made individually, +and you can decide which ones to commit right now.

    • +

  • Reference and key commands

    +
      +

    • git commit --patch to start the interactive commit

      • +

    • y to use the change

      • +

    • n to skip the change

      • +

    • s (split) if there are several changes grouped together, but +separated by a blank line, split them into separate choices.

      • +

    • q aborts everything.

      • +

    • ? for more options.

      • +
    +
    • +

  • The -p option is also available on commit, restore, checkout, reset, and add.

    • +
+
+
+

Exercise: Interactive commits

+
+

Staging-1: Perform an interactive commit

+

One option to help us create nice logical commits is to stage interactively +with git commit --patch:

+
    +

  1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

    2. +

  2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

    3. +

  3. Do it again for the other change.

    4. +

  4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

    5. +

  5. When would this be useful?

    6. +
+ +
+
+
+

The staging area

+
    +

  • The interactive commits above are great, but what if there are so +many changes that you can’t sort them out in one shot?

    • +

  • What if you make progress and want to record it somehow, but it’s +not ready to be committed?

    • +

  • The staging area is a place to record things before committing.

    • +
+
+

Instructor note

+

We give two examples and the instructor can pick one or both:

+
    +

  • Analogy using moving boxes

    • +

  • Analogy using shopping receipts

    • +
+
+
+

Discussion

+

Analogy using moving boxes

+
    +

  • You’re moving and you have a box to pack your things in.

    • +

  • You can put stuff into the box, but you can also take stuff out of the box.

    • +

  • You wouldn’t want to mix items from the bathroom, kitchen, and living room +into the same box.

    • +

  • The box corresponds to the staging area of Git, where you can craft your commits.

    • +

  • Committing is like sealing the box and sticking a label on it.

    • +

  • You wouldn’t want to label your box with “stuff”, but rather give a more +descriptive label.

    • +

  • See also https://dev.to/sublimegeek/git-staging-area-explained-like-im-five-1anh

    • +
+

Analogy using shopping receipts

+
    +

  • You need to go shopping and buy some stuff for work and for home. +You need two separate receipts.

    • +

  • Bad idea: go through the store get home stuff, pay, start at the +beginning and go through the store again. This is inefficient and +annoying.

    • +

  • What you actually do:

    +
      +

    • Go through the store and put everything you need in your shopping +basket.

      • +

    • Get to the check-out. Put your home stuff on the conveyor belt +(git add). Check both the belt (git diff --staged) and your +basket (git diff) to make sure you got all your home stuff.

      • +

    • Pay (git commit)

      • +

    • Repeat for work stuff.

      • +
    +
    • +
+

In order to keep organized, you have to use multiple locations to +stage things in sequence.

+
+
+
+

Staging area commands

+

The staging area is a middle ground between what you have done to your files +(the working directory) and what you have last committed (the HEAD commit). +Just like the name implies, it lets you prepare (stage) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since you can modify and stage several times before committing.

+

git add stages/prepares for the next commit:

+
                git add
+ [project*]  <------------  project*
+                               ^
+                               | modify with editor
+                               |
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git commit creates a new commit:

+
  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+  HEAD~2          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

git reset --soft HEAD~1 (move HEAD back by one but keep changes and stage +them) would do the opposite of git commit. (in this case, HEAD +is literally this - not a replacement)

+

Going back to the last staged version:

+
              git restore
+ [project*]  ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Unstaging changes with git restore --staged:

+
          git restore --staged
+             ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Discarding unstaged changes:

+
                            project*
+                               |
+                               | git restore
+                               v
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+

Comparing:

+
                git diff
+ [project*]  <----------->  project*
+    ^                          ^
+    | git diff --staged        | git diff HEAD
+    v                          v
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
+
+
+Staging basics +
+

The different states of the repository and the commands to move from one to +another.

+
+
+
+
+

Exercise: Using the staging area

+
+

Staging-2: Use the staging area to make a commit in two steps

+
    +

  1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

    2. +

  2. Use git add to stage one of the changes.

    3. +

  3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

    4. +

  4. Feel some regret and unstage the staged change.

    5. +
+
+
+

Discussion

+
    +

  • When is it better to “save” a change as commit, when is it better to “save” +it with git add?

    • +

  • Is it a problem to commit many small changes?

    • +
+
+
+

Keypoints

+
    +

  • The staging area helps us to create well-defined commits.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/under-the-hood/index.html b/branch/main/under-the-hood/index.html new file mode 100644 index 00000000..2c7f812b --- /dev/null +++ b/branch/main/under-the-hood/index.html @@ -0,0 +1,343 @@ + + + + + + + Git under the hood — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Git under the hood

+
+

Objectives

+
    +

  • Verify that branches are pointers to commits and extremely lightweight.

    • +
+
+
+

Instructor note

+
    +

  • 10 min teaching/type-along

    • +

  • 15 min exercise

    • +
+
+
+Git under the hood +
+
+

Down the rabbit hole

+

When working with Git, you will never need to go inside .git, but in this +exercise we will, in order to learn about how branches are implemented in Git.

+

For this exercise create a new repository and commit a couple of changes.

+

Now that we’ve made a couple of commits let us look at what is happening under +the hood.

+
$ cd .git
+$ ls -l
+
+drwxr-xr-x   - user 25 Aug 15:51 branches
+.rw-r--r-- 499 user 25 Aug 15:52 COMMIT_EDITMSG
+.rw-r--r--  92 user 25 Aug 15:51 config
+.rw-r--r--  73 user 25 Aug 15:51 description
+.rw-r--r--  21 user 25 Aug 15:51 HEAD
+drwxr-xr-x   - user 25 Aug 15:51 hooks
+.rw-r--r-- 137 user 25 Aug 15:52 index
+drwxr-xr-x   - user 25 Aug 15:51 info
+drwxr-xr-x   - user 25 Aug 15:52 logs
+drwxr-xr-x   - user 25 Aug 15:52 objects
+drwxr-xr-x   - user 25 Aug 15:51 refs
+
+
+

Git stores everything under the .git folder in your repository. In fact, the +.git directory is the Git repository.

+

Previously when you wrote the commit messages using your text editor, they +were in fact saved to COMMIT_EDITMSG.

+

Each commit in Git is stored as a “blob”. This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file.

+

Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string).

+
+A commit inside Git +
+

States of a Git file. Image from the Pro Git book. License CC BY 3.0.

+
+
+

Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a directed acyclic +graph (do not worry +if the term is not familiar).

+
+A commit and its parents +
+

A commit and its parents. Image from the Pro Git book. License CC BY 3.0.

+
+
+

All branches and tags in Git are pointers to commits.

+
+
+

Git is basically a content-addressed storage system

+ +

Let us poke a bit into raw objects! Start with:

+
$ git cat-file -p HEAD
+
+
+

Then explore the tree object, then the file object, etc. recursively using the hashes you see.

+
+
+

Demonstration: experimenting with branches

+

Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an “Aha!” moment and provide us a +good understanding of the underlying model.

+

We are starting from the main branch and create an idea branch:

+
$ git status
+
+On branch main
+nothing to commit, working tree clean
+
+
+
$ git switch --create idea
+
+Switched to a new branch 'idea'
+
+
+
$ git branch
+
+* idea
+  main
+
+
+

Now let us go in:

+
$ cd .git
+$ cd refs/heads
+$ ls -l
+
+.rw-r--r-- 41 user 25 Aug 15:54 idea
+.rw-r--r-- 41 user 25 Aug 15:52 main
+
+
+

Let us check what the idea file looks like +(do not worry if the hash is different):

+
$ cat idea
+
+045e3db14740c60684d745e5fb891ae71e335611
+
+
+

Now let us replicate this file:

+
$ cp idea idea-2
+$ cp idea idea-3
+$ cp idea idea-4
+$ cp idea idea-5
+
+
+

Let us go up two levels and inspect the file HEAD:

+
$ cd ../..
+$ cat HEAD
+
+ref: refs/heads/idea
+
+
+

Let us open this file and change it to:

+
ref: refs/heads/idea-3
+
+
+

Now we are ready for the aha moment! +First let us go back to the working area:

+
$ cd ..
+
+
+

Now - on which branch are we?

+
$ git branch
+
+  idea
+  idea-2
+* idea-3
+  idea-4
+  idea-5
+  main
+
+
+
+

Discussion

+

Discuss the findings with other course participants.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/main/what-to-avoid/index.html b/branch/main/what-to-avoid/index.html new file mode 100644 index 00000000..785f55ea --- /dev/null +++ b/branch/main/what-to-avoid/index.html @@ -0,0 +1,231 @@ + + + + + + + What to avoid — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

What to avoid

+

The idea for this page came up during a discussion: quick reference page of +things that you should not do with Git. Basically, a list of some common Git +gotchas.

+

Postponing commits because the changes are “unfinished”/”ugly”: It is +better to have many OK-ish commits than too few perfect commits. Too few +perfect commits are probably too large and make undoing more difficult. It is +also easier to combine too small commits than it is to split too large commits. +The longer you wait because of this, the harder it will be to +commit it at all.

+

Not updating your branch before starting new work: Few things are worse +than doing work and then noticing a lot of conflicts because +unrelated but conflicting work was done in the meantime or even before you started. Or noticing that someone +else has already done it. This problem is largest when you come back +to an active project weeks or months later. +So update your branch before adding new commits.

+

Commit unrelated changes together: Makes it difficult to undo changes since +it can undo also the unrelated change. +But, this is the counterpoint to the first point: In the end, it is probably better to make big +ugly commits than to never commit. This is especially true in in the chaotic early +phases of small projects.

+

Too ambitious branch which risks to never get completed: The branch will +never merge back and be so big and so ambitious with too many/big features that +the risk is high that once it is really ready, there are conflicts everywhere.

+

Committing generated files: Compiled and generated files are not +committed to version control. There are many reasons for this:

+
    +

  • These files can make it more difficult to run on different platforms.

    • +

  • These files are automatically generated and thus do not contribute in any meaningful way.

    • +

  • When tracking generated files you could see differences in the code although you haven’t touched the code.

    • +
+

For this we use .gitignore files where +you can list which files and paths should be ignored by Git. You can also use +wild-cards to ignore files with a certain extension or files in a certain +directory.

+

Over-engineering the branch layout and safeguards in small projects: This +may prevent people from contributing (maybe even including yourself?). Add more +restrictions and safeguards only as the project and the group of collaborators +grows.

+

Commit messages that explain what has been changed but do not explain why it has been +changed: This is as useful as code comments which describe the “obvious” such +as “this is a loop” instead of explaining why something is done this way. +But don’t let perfect commit messages stop you from the most important point, committing often (first point).

+

Commit huge files: Huge files get sometimes accidentally added and +committed which can significantly increase the repository size. Note that a +subsequent git rm does not remove the addition from the repository history. +Code review can help detecting accidental large file additions. +You can also add an automated test which checks for file sizes during a pull request or merge request.

+
+

Discussion

+

Question to all seasoned Git users: What are we missing on this page? Please +contribute improvements.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/.buildinfo b/branch/sphinx-book-theme-old-copybutton/.buildinfo new file mode 100644 index 00000000..f391f6fe --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/.buildinfo @@ -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: 566e1f45f64b701c94f54f123f87b9e6 +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/branch/sphinx-book-theme-old-copybutton/.nojekyll b/branch/sphinx-book-theme-old-copybutton/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/branch/sphinx-book-theme-old-copybutton/_images/cheat-sheet.jpg b/branch/sphinx-book-theme-old-copybutton/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/cheat-sheet.jpg differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/commit-and-tree.png b/branch/sphinx-book-theme-old-copybutton/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/commit-and-tree.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/commits-and-parents.png b/branch/sphinx-book-theme-old-copybutton/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/commits-and-parents.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/created.png b/branch/sphinx-book-theme-old-copybutton/_images/created.png new file mode 100644 index 00000000..1d657d77 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/created.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/creating.png b/branch/sphinx-book-theme-old-copybutton/_images/creating.png new file mode 100644 index 00000000..ff61a75a Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/creating.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-branch-1.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-branch-1.svg new file mode 100644 index 00000000..aaaa8a04 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-branch-1.svg @@ -0,0 +1,211 @@ + + + + + + + + + + + + + + + + + + + + m3 + + + m2 + + + m1 + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-branch-2.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-branch-2.svg new file mode 100644 index 00000000..af25bd2d --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-branch-2.svg @@ -0,0 +1,379 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + m3 + + + l1 + + + e1 + + + e2 + + + m2 + + + m1 + + + + + master + + + + + experiment + + + + + less-salt + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-branch-3.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-branch-3.svg new file mode 100644 index 00000000..ce525698 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-branch-3.svg @@ -0,0 +1,411 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + e2 + + + m3 + + + m4 + + + l1 + + + e1 + + + + + experiment + + + + + less-salt + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-collaborative.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-deleted-branches.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-deleted-branches.svg new file mode 100644 index 00000000..094c3a3d --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-deleted-branches.svg @@ -0,0 +1,419 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + l1 + + + m6 + + + e2 + + + m2 + + + m3 + + + e1 + + + m1 + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-merge-1.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-merge-1.svg new file mode 100644 index 00000000..f0ee336c --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-merge-1.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m4 + + + m5 + + + m3 + + + l1 + + + e2 + + + e1 + + + + + less-salt + + + + + master + + + + + HEAD + + + + + experiment + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-merge-2.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-merge-2.svg new file mode 100644 index 00000000..45af4301 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-merge-2.svg @@ -0,0 +1,491 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + l1 + + + m6 + + + e2 + + + m2 + + + m3 + + + e1 + + + m1 + + + + + experiment + + + + + less-salt + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git-pre-ff.svg b/branch/sphinx-book-theme-old-copybutton/_images/git-pre-ff.svg new file mode 100644 index 00000000..13010951 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git-pre-ff.svg @@ -0,0 +1,551 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m5 + + + n2 + + + n3 + + + m3 + + + l1 + + + e1 + + + n1 + + + m4 + + + m2 + + + m6 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + master + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/git_stage_commit.svg b/branch/sphinx-book-theme-old-copybutton/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/meld.png b/branch/sphinx-book-theme-old-copybutton/_images/meld.png new file mode 100644 index 00000000..fee5e33a Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/meld.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/mergetool.png b/branch/sphinx-book-theme-old-copybutton/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/mergetool.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/new-top-left.png b/branch/sphinx-book-theme-old-copybutton/_images/new-top-left.png new file mode 100644 index 00000000..80c5f16b Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/new-top-left.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/new-top-right.png b/branch/sphinx-book-theme-old-copybutton/_images/new-top-right.png new file mode 100644 index 00000000..6dabf482 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/new-top-right.png differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/octopus.jpeg b/branch/sphinx-book-theme-old-copybutton/_images/octopus.jpeg new file mode 100644 index 00000000..b26dc37e Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/octopus.jpeg differ diff --git a/branch/sphinx-book-theme-old-copybutton/_images/staging-basics.svg b/branch/sphinx-book-theme-old-copybutton/_images/staging-basics.svg new file mode 100644 index 00000000..6c7a2c3c --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + checkout + add + commit + checkout + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/branch/sphinx-book-theme-old-copybutton/_images/stranger.jpg b/branch/sphinx-book-theme-old-copybutton/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_images/stranger.jpg differ diff --git a/branch/sphinx-book-theme-old-copybutton/_sources/aliases.md.txt b/branch/sphinx-book-theme-old-copybutton/_sources/aliases.md.txt new file mode 100644 index 00000000..9d88c364 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_sources/aliases.md.txt @@ -0,0 +1,158 @@ +# Aliases and configuration + +```{objectives} +- Learn to use aliases for most common commands. +``` + +Are you getting tired of typing so much? In Git you can define aliases (shortcuts): +- These are great because they can save you time typing. +- But it's easy to forget them, get confused, or be inconsistent with your colleagues. + +There is plenty of other configuration for Git, that can make it nicer. + + +## Aliases + +- Aliases are a simple way to improve the usability of Git: for + example `git ci` instead of `git commit`. +- Aliases are based on simple string replacement in the command. +- Aliases can either be specific to a repository or global. + - Global aliases help you do the things you are used to across Git projects. + - Per-project aliases can also be created. +- Global aliases are stored in `~/.gitconfig`. + + +## Example alias: git graph + +A very useful shortcut which we use a lot in our workshops: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ cd your_git_repository +$ git graph +``` + + +## Using external commands + +It is possible to call external commands using the exclamation mark character "!". +In this case we create a local alias which is +stored in `.git/config` and not synchronized with remotes: + +```console +$ cd your_git_repository +$ git config alias.hi '!echo hello' +$ git hi +``` + +```{discussion} Food for thought: When to alias? +- How many times should you wait before aliasing a command? +- Do you believe a list of generic two-letter acronyms for common commands will + save your time? +``` + + +## List of aliases the instructors use + +You are welcome to reuse, suggest, improve. +You can see your current aliases in `~/.gitconfig`. + +```console +$ git config --global alias.ap "add --patch" +$ git config --global alias.br branch +$ git config --global alias.ci "commit -v" +$ git config --global alias.cip "commit --patch -v" +$ git config --global alias.cl "clone --recursive" +$ git config --global alias.co checkout +$ git config --global alias.cop "checkout --patch" +$ git config --global alias.di diff +$ git config --global alias.dic "diff --cached --color-words" +$ git config --global alias.diw "diff --color-words" +$ git config --global alias.dis "!git --no-pager diff --stat" +$ git config --global alias.fe fetch +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ git config --global alias.rem remote +$ git config --global alias.st status +$ git config --global alias.su "submodule update --init --recursive" +``` + +Here is what they do: +- `ap`: add, selecting parts individually, interactively. +- `br`: branch (obvious) +- `ci`: commit (check in), with `-v` option for clarity +- `cip`: commit, selecting parts individually, interactively. +- `cl`: clone, init submodules (submodules are an advanced topic) +- `co`: checkout (obvious) +- `cop`: checkout, selecting parts individually, interactively. +- `di`: diff (obvious) +- `dic`: diff of staging area vs last commit (what is about to be committed) +- `diw`: a word diff, color. Useful for small changes. +- `dis`: a "diffstat": what files are changed, not contents +- `fe`: fetch (obvious) +- `graph`: show whole git graph (so useful, some of us call it `l`) +- `rem`: remote (obvious) +- `st`: status (obvious) +- `su`: submodule update (advanced) + +A useful setting for the `p` aliases: +```console +$ git config --global interactive.singlekey true +``` + + +## Advanced aliases + +These are advanced aliases and configuration options. We won't explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages! + +```console +$ git config --global alias.cif "commit -v -p --fixup" +$ git config --global alias.rb "rebase --autosquash" +$ git config --global alias.rbi "rebase --interactive --autosquash" +$ git config --global alias.rbis "rebase --interactive --autosquash --autostash" +$ git config --global alias.rbs "rebase --autosquash --autostash" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard" +$ git config --global alias.new "log HEAD..HEAD@{upstream}" +$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}" +$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}" +$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all" +$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD" +$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat" +``` + +## Advanced Git configuration + +Besides aliases, you can do plenty of other configuration of `git`. +Here are some of the most common ones: + +```console +$ git config --global interactive.singlekey true +$ git config --global core.pager "less -RS" +$ git config --global core.excludesfile ~/.gitignore +$ git config --global merge.conflictstyle diff3 +$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]" +$ git config --global diff.mnemonicPrefix true +``` + +Do you get tired of typing and copying and pasting your remote names +all the time, like `git@github.com:myusername`? You can create remote +aliases like this: + +```console +$ git config --global url.git@github.com:.insteadOf gh: +$ git config --global url.git@github.com:/username/.insteadOf ghu: +``` + +Then, when you add a remote `ghu:recipe`, it will automatically be +translated to `git@github.com:/username/recipe` using a simple prefix +matching. + + +```{keypoints} +- If you are frustrated about remembering a command, you should create an alias. +``` diff --git a/branch/sphinx-book-theme-old-copybutton/_sources/archaeology.md.txt b/branch/sphinx-book-theme-old-copybutton/_sources/archaeology.md.txt new file mode 100644 index 00000000..a387a3e6 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_sources/archaeology.md.txt @@ -0,0 +1,357 @@ +# Inspecting history + +```{objectives} +- Quickly find a line of code, find out why it was introduced and when. +- Quickly find the commit that changed a behavior. +``` + +```{instructor-note} +- 15 min teaching/type-along +- 30 min exercise +``` + +````{prereq} Preparation +Please make sure that you do not clone repositories inside an already tracked folder: + +```console +$ git status +``` + +If you are inside an existing Git repository, step out of it. +You need to find a different location since we will clone a new repository. + +If you see this message, this is good in this case: + +```shell +fatal: not a git repository (or any of the parent directories): .git +``` +```` + + +## Our toolbox for history inspection + +```{instructor-note} +First the instructor demonstrates few commands on a real life example +repository (mentioned in the amazing site [The +Programming Historian](https://programminghistorian.org/)). +Later we will practice these in groups in an archaeology exercise (below). +After demonstrating the command line tools, the instructor can also demonstrate searching, "show" and "annotate" +in the GitHub browser for this example project. +``` + + +### Warm-up: ["Git History" browser](https://githistory.xyz/) + +As a warm-up we can try the ["Git History" browser](https://githistory.xyz/) +on the README.rst file of the [networkx](https://github.com/networkx/networkx) repository: + +- Visit and browse (use left/right keys). +- You can try this on some of your GitHub repositories, too! + + +### git grep: to search through the repository + +With `git grep` you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or some error message printed: + +```console +$ git grep sometext +$ git grep "some text with spaces" +``` + +In the [networkx](https://github.com/networkx/networkx) repository you can try: + +```console +$ git clone https://github.com/networkx/networkx +$ cd networkx +$ git grep -i fixme +``` + + +### git log -S: to search through the history of changes + +While `git grep` searches the **current state** of the repository, +it is also possible to search through all changes for "sometext": + +```console +$ git log -S sometext +``` + +In the [networkx](https://github.com/networkx/networkx) repository you can try: + +```console +$ git log -S test_weakly_connected_component +``` + + +### git show: to inspect commits + +We have seen this one before already. Using `git show` we can inspect an individual commit if +we know its hash: + +```console +$ git show somehash +``` + +For instance: + +```console +$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7 +``` + + +### git annotate: to annotate code with commit metadata + +Try it out on a file - with `git annotate` you can see line by line who and **when** the line was modified +last. It also prints the precise hash of the last change which modified each line. Incredibly useful +for reproducibility. + +```console +$ git annotate somefile +``` + +Example: + +```console +$ git annotate networkx/convert_matrix.py +``` + +If you annotate in a terminal and the file is longer than the screen, Git by default uses the program `less` to +scroll the output. +Use `/sometext` `` to find "sometext" and you can cycle through the results with `n` (next) and `N` (last). +You can also use page up/down to scroll. You can quit with `q`. + +```{discussion} +Discuss how these two affect the annotation: +- wrapping long lines of text/code into shorter lines +- autoformatting tools such as `black` +``` + + +### git checkout -b: to inspect code in the past + +We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code: + +```console +$ git checkout -b branchname somehash +``` + +Example (lines starting with "#" are only comments): + +```console +$ # create branch called "older-code" from hash 347e6292419b +$ git checkout -b older-code 347e6292419bd0e4bff077fe971f983932d7a0e9 + +$ # now you can navigate and inspect the code as it was back then +$ # ... + +$ # after we are done we can switch back to "main" +$ git checkout main + +$ # if we like we can delete the "older-code" branch +$ git branch -d older-code +``` + +On newer Git versions this is the preferred command: + +```console +$ git switch --create branchname somehash +``` + +(exercise-history)= + +## Exercise: Basic archaeology commands + +`````{exercise} History-1: Explore basic archaeology commands + Let us explore the value of these commands in an exercise. Future + exercises do not depend on this, so it is OK if you do not complete + it fully. + + **In-person workshops**: We recommend that you + do this exercise in groups of two and discuss with your neighbors. + + **Video workshops**: We will group you in breakout rooms of ~4 persons where you + can work and discuss together. A helper or instructor will pop in to help out. + In the group one participant can share their screen and others + in the group help out, discuss, and try to follow along. + Please write down questions in the collaborative notes. + After 15-20 minutes we will bring you back into the main room and discuss. + + Exercise steps: + - Clone this repository: + . + Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release: + ```console + $ git clone https://github.com/networkx/networkx.git + $ cd networkx + $ git checkout -b exercise networkx-2.6.3 + ``` + + Then using the above toolbox try to: + 1. Find the code line which contains `"Logic error in degree_correlation"`. + 2. Find out when this line was last modified or added. Find the actual commit which modified that line. + 3. Inspect that commit with `git show`. + 4. Create a branch pointing to the past when that commit was created to be + able to browse and use the code as it was back then. + 5. How would can you bring the code to the commit precisely before that line was last modified? + + ````{solution} + 1. We use `git grep`: + ```console + $ git grep "Logic error in degree_correlation" + ``` + This gives the output: + ``` + networkx/algorithms/threshold.py: print("Logic error in degree_correlation", i, rdi) + ``` + Maybe you also want to know the line number: + ```console + $ git grep -n "Logic error in degree_correlation" + ``` + 2. We use `git annotate`: + ```console + $ git annotate networkx/algorithms/threshold.py + ``` + Then search for "Logic error" by typing "/Logic error" followed by Enter. + The last commit that modified it was `90544b4fa` (unless that line changed since). + 3. We use `git show`: + ```console + $ git show 90544b4fa + ``` + 4. Create a branch pointing to that commit (here we called the branch "past-code"): + ```console + $ git branch past-code 90544b4fa + ``` + 5. This is a compact way to access the first parent of `90544b4fa` (here we + called the branch "just-before"): + ```console + $ git checkout -b just-before 90544b4fa~1 + ``` + ```` +````` + +--- + +## Finding out when something broke/changed with git bisect + +> *But I am sure it used to work! Strange.* + +- Sometimes you realize that something broke. +- You know that it used to work. +- You do not know when it broke. + +```{discussion} How would you solve this? +Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now. + +- How would you find the commit which changed it? +- Why could it be useful to know the commit that changed it? + +**Video workshops**: Write down ideas on how you would solve it in the collaborative +note and we will discuss various approaches. +``` + +We will probably arrive at a solution which is similar to `git bisect`: + +- First find out a commit in past when it worked. +- Then bisect your way until you find the commit that broke it. + +```console +$ git bisect start +$ git bisect good f0ea950 # this is a commit that worked +$ git bisect bad main # last commit is broken + +$ # now compile and/or run +$ # after that decide whether +$ git bisect good +$ # or +$ git bisect bad + +$ # now compile and/or run +$ # after that decide whether +$ git bisect good +$ # or +$ git bisect bad + +$ # iterate until commit is found +``` + +- This can even be automatized with `git bisect run +{% endmacro %} diff --git a/branch/sphinx-book-theme-old-copybutton/_static/scripts/pydata-sphinx-theme.js b/branch/sphinx-book-theme-old-copybutton/_static/scripts/pydata-sphinx-theme.js new file mode 100644 index 00000000..0e00c4ca --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/scripts/pydata-sphinx-theme.js @@ -0,0 +1,32 @@ +!function(t){var e={};function n(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return t[i].call(o.exports,o,o.exports,n),o.l=!0,o.exports}n.m=t,n.c=e,n.d=function(t,e,i){n.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:i})},n.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},n.t=function(t,e){if(1&e&&(t=n(t)),8&e)return t;if(4&e&&"object"==typeof t&&t&&t.__esModule)return t;var i=Object.create(null);if(n.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:t}),2&e&&"string"!=typeof t)for(var o in t)n.d(i,o,function(e){return t[e]}.bind(null,o));return i},n.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return n.d(e,"a",e),e},n.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},n.p="",n(n.s=2)}([function(t,e){t.exports=jQuery},function(t,e,n){"use strict";n.r(e),function(t){ +/**! + * @fileOverview Kickass library to create and place poppers near their reference elements. + * @version 1.16.1 + * @license + * Copyright (c) 2016 Federico Zivolo and contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +var n="undefined"!=typeof window&&"undefined"!=typeof document&&"undefined"!=typeof navigator,i=function(){for(var t=["Edge","Trident","Firefox"],e=0;e=0)return 1;return 0}();var o=n&&window.Promise?function(t){var e=!1;return function(){e||(e=!0,window.Promise.resolve().then((function(){e=!1,t()})))}}:function(t){var e=!1;return function(){e||(e=!0,setTimeout((function(){e=!1,t()}),i))}};function r(t){return t&&"[object Function]"==={}.toString.call(t)}function a(t,e){if(1!==t.nodeType)return[];var n=t.ownerDocument.defaultView.getComputedStyle(t,null);return e?n[e]:n}function s(t){return"HTML"===t.nodeName?t:t.parentNode||t.host}function l(t){if(!t)return document.body;switch(t.nodeName){case"HTML":case"BODY":return t.ownerDocument.body;case"#document":return t.body}var e=a(t),n=e.overflow,i=e.overflowX,o=e.overflowY;return/(auto|scroll|overlay)/.test(n+o+i)?t:l(s(t))}function u(t){return t&&t.referenceNode?t.referenceNode:t}var f=n&&!(!window.MSInputMethodContext||!document.documentMode),d=n&&/MSIE 10/.test(navigator.userAgent);function c(t){return 11===t?f:10===t?d:f||d}function h(t){if(!t)return document.documentElement;for(var e=c(10)?document.body:null,n=t.offsetParent||null;n===e&&t.nextElementSibling;)n=(t=t.nextElementSibling).offsetParent;var i=n&&n.nodeName;return i&&"BODY"!==i&&"HTML"!==i?-1!==["TH","TD","TABLE"].indexOf(n.nodeName)&&"static"===a(n,"position")?h(n):n:t?t.ownerDocument.documentElement:document.documentElement}function p(t){return null!==t.parentNode?p(t.parentNode):t}function m(t,e){if(!(t&&t.nodeType&&e&&e.nodeType))return document.documentElement;var n=t.compareDocumentPosition(e)&Node.DOCUMENT_POSITION_FOLLOWING,i=n?t:e,o=n?e:t,r=document.createRange();r.setStart(i,0),r.setEnd(o,0);var a,s,l=r.commonAncestorContainer;if(t!==l&&e!==l||i.contains(o))return"BODY"===(s=(a=l).nodeName)||"HTML"!==s&&h(a.firstElementChild)!==a?h(l):l;var u=p(t);return u.host?m(u.host,e):m(t,p(e).host)}function g(t){var e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"top",n="top"===e?"scrollTop":"scrollLeft",i=t.nodeName;if("BODY"===i||"HTML"===i){var o=t.ownerDocument.documentElement,r=t.ownerDocument.scrollingElement||o;return r[n]}return t[n]}function v(t,e){var n=arguments.length>2&&void 0!==arguments[2]&&arguments[2],i=g(e,"top"),o=g(e,"left"),r=n?-1:1;return t.top+=i*r,t.bottom+=i*r,t.left+=o*r,t.right+=o*r,t}function _(t,e){var n="x"===e?"Left":"Top",i="Left"===n?"Right":"Bottom";return parseFloat(t["border"+n+"Width"])+parseFloat(t["border"+i+"Width"])}function b(t,e,n,i){return Math.max(e["offset"+t],e["scroll"+t],n["client"+t],n["offset"+t],n["scroll"+t],c(10)?parseInt(n["offset"+t])+parseInt(i["margin"+("Height"===t?"Top":"Left")])+parseInt(i["margin"+("Height"===t?"Bottom":"Right")]):0)}function y(t){var e=t.body,n=t.documentElement,i=c(10)&&getComputedStyle(n);return{height:b("Height",e,n,i),width:b("Width",e,n,i)}}var w=function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")},E=function(){function t(t,e){for(var n=0;n2&&void 0!==arguments[2]&&arguments[2],i=c(10),o="HTML"===e.nodeName,r=N(t),s=N(e),u=l(t),f=a(e),d=parseFloat(f.borderTopWidth),h=parseFloat(f.borderLeftWidth);n&&o&&(s.top=Math.max(s.top,0),s.left=Math.max(s.left,0));var p=S({top:r.top-s.top-d,left:r.left-s.left-h,width:r.width,height:r.height});if(p.marginTop=0,p.marginLeft=0,!i&&o){var m=parseFloat(f.marginTop),g=parseFloat(f.marginLeft);p.top-=d-m,p.bottom-=d-m,p.left-=h-g,p.right-=h-g,p.marginTop=m,p.marginLeft=g}return(i&&!n?e.contains(u):e===u&&"BODY"!==u.nodeName)&&(p=v(p,e)),p}function k(t){var e=arguments.length>1&&void 0!==arguments[1]&&arguments[1],n=t.ownerDocument.documentElement,i=D(t,n),o=Math.max(n.clientWidth,window.innerWidth||0),r=Math.max(n.clientHeight,window.innerHeight||0),a=e?0:g(n),s=e?0:g(n,"left"),l={top:a-i.top+i.marginTop,left:s-i.left+i.marginLeft,width:o,height:r};return S(l)}function A(t){var e=t.nodeName;if("BODY"===e||"HTML"===e)return!1;if("fixed"===a(t,"position"))return!0;var n=s(t);return!!n&&A(n)}function I(t){if(!t||!t.parentElement||c())return document.documentElement;for(var e=t.parentElement;e&&"none"===a(e,"transform");)e=e.parentElement;return e||document.documentElement}function O(t,e,n,i){var o=arguments.length>4&&void 0!==arguments[4]&&arguments[4],r={top:0,left:0},a=o?I(t):m(t,u(e));if("viewport"===i)r=k(a,o);else{var f=void 0;"scrollParent"===i?"BODY"===(f=l(s(e))).nodeName&&(f=t.ownerDocument.documentElement):f="window"===i?t.ownerDocument.documentElement:i;var d=D(f,a,o);if("HTML"!==f.nodeName||A(a))r=d;else{var c=y(t.ownerDocument),h=c.height,p=c.width;r.top+=d.top-d.marginTop,r.bottom=h+d.top,r.left+=d.left-d.marginLeft,r.right=p+d.left}}var g="number"==typeof(n=n||0);return r.left+=g?n:n.left||0,r.top+=g?n:n.top||0,r.right-=g?n:n.right||0,r.bottom-=g?n:n.bottom||0,r}function x(t){return t.width*t.height}function j(t,e,n,i,o){var r=arguments.length>5&&void 0!==arguments[5]?arguments[5]:0;if(-1===t.indexOf("auto"))return t;var a=O(n,i,r,o),s={top:{width:a.width,height:e.top-a.top},right:{width:a.right-e.right,height:a.height},bottom:{width:a.width,height:a.bottom-e.bottom},left:{width:e.left-a.left,height:a.height}},l=Object.keys(s).map((function(t){return C({key:t},s[t],{area:x(s[t])})})).sort((function(t,e){return e.area-t.area})),u=l.filter((function(t){var e=t.width,i=t.height;return e>=n.clientWidth&&i>=n.clientHeight})),f=u.length>0?u[0].key:l[0].key,d=t.split("-")[1];return f+(d?"-"+d:"")}function L(t,e,n){var i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:null,o=i?I(e):m(e,u(n));return D(n,o,i)}function P(t){var e=t.ownerDocument.defaultView.getComputedStyle(t),n=parseFloat(e.marginTop||0)+parseFloat(e.marginBottom||0),i=parseFloat(e.marginLeft||0)+parseFloat(e.marginRight||0);return{width:t.offsetWidth+i,height:t.offsetHeight+n}}function F(t){var e={left:"right",right:"left",bottom:"top",top:"bottom"};return t.replace(/left|right|bottom|top/g,(function(t){return e[t]}))}function R(t,e,n){n=n.split("-")[0];var i=P(t),o={width:i.width,height:i.height},r=-1!==["right","left"].indexOf(n),a=r?"top":"left",s=r?"left":"top",l=r?"height":"width",u=r?"width":"height";return o[a]=e[a]+e[l]/2-i[l]/2,o[s]=n===s?e[s]-i[u]:e[F(s)],o}function M(t,e){return Array.prototype.find?t.find(e):t.filter(e)[0]}function B(t,e,n){return(void 0===n?t:t.slice(0,function(t,e,n){if(Array.prototype.findIndex)return t.findIndex((function(t){return t[e]===n}));var i=M(t,(function(t){return t[e]===n}));return t.indexOf(i)}(t,"name",n))).forEach((function(t){t.function&&console.warn("`modifier.function` is deprecated, use `modifier.fn`!");var n=t.function||t.fn;t.enabled&&r(n)&&(e.offsets.popper=S(e.offsets.popper),e.offsets.reference=S(e.offsets.reference),e=n(e,t))})),e}function H(){if(!this.state.isDestroyed){var t={instance:this,styles:{},arrowStyles:{},attributes:{},flipped:!1,offsets:{}};t.offsets.reference=L(this.state,this.popper,this.reference,this.options.positionFixed),t.placement=j(this.options.placement,t.offsets.reference,this.popper,this.reference,this.options.modifiers.flip.boundariesElement,this.options.modifiers.flip.padding),t.originalPlacement=t.placement,t.positionFixed=this.options.positionFixed,t.offsets.popper=R(this.popper,t.offsets.reference,t.placement),t.offsets.popper.position=this.options.positionFixed?"fixed":"absolute",t=B(this.modifiers,t),this.state.isCreated?this.options.onUpdate(t):(this.state.isCreated=!0,this.options.onCreate(t))}}function q(t,e){return t.some((function(t){var n=t.name;return t.enabled&&n===e}))}function Q(t){for(var e=[!1,"ms","Webkit","Moz","O"],n=t.charAt(0).toUpperCase()+t.slice(1),i=0;i1&&void 0!==arguments[1]&&arguments[1],n=Z.indexOf(t),i=Z.slice(n+1).concat(Z.slice(0,n));return e?i.reverse():i}var et="flip",nt="clockwise",it="counterclockwise";function ot(t,e,n,i){var o=[0,0],r=-1!==["right","left"].indexOf(i),a=t.split(/(\+|\-)/).map((function(t){return t.trim()})),s=a.indexOf(M(a,(function(t){return-1!==t.search(/,|\s/)})));a[s]&&-1===a[s].indexOf(",")&&console.warn("Offsets separated by white space(s) are deprecated, use a comma (,) instead.");var l=/\s*,\s*|\s+/,u=-1!==s?[a.slice(0,s).concat([a[s].split(l)[0]]),[a[s].split(l)[1]].concat(a.slice(s+1))]:[a];return(u=u.map((function(t,i){var o=(1===i?!r:r)?"height":"width",a=!1;return t.reduce((function(t,e){return""===t[t.length-1]&&-1!==["+","-"].indexOf(e)?(t[t.length-1]=e,a=!0,t):a?(t[t.length-1]+=e,a=!1,t):t.concat(e)}),[]).map((function(t){return function(t,e,n,i){var o=t.match(/((?:\-|\+)?\d*\.?\d*)(.*)/),r=+o[1],a=o[2];if(!r)return t;if(0===a.indexOf("%")){var s=void 0;switch(a){case"%p":s=n;break;case"%":case"%r":default:s=i}return S(s)[e]/100*r}if("vh"===a||"vw"===a){return("vh"===a?Math.max(document.documentElement.clientHeight,window.innerHeight||0):Math.max(document.documentElement.clientWidth,window.innerWidth||0))/100*r}return r}(t,o,e,n)}))}))).forEach((function(t,e){t.forEach((function(n,i){K(n)&&(o[e]+=n*("-"===t[i-1]?-1:1))}))})),o}var rt={placement:"bottom",positionFixed:!1,eventsEnabled:!0,removeOnDestroy:!1,onCreate:function(){},onUpdate:function(){},modifiers:{shift:{order:100,enabled:!0,fn:function(t){var e=t.placement,n=e.split("-")[0],i=e.split("-")[1];if(i){var o=t.offsets,r=o.reference,a=o.popper,s=-1!==["bottom","top"].indexOf(n),l=s?"left":"top",u=s?"width":"height",f={start:T({},l,r[l]),end:T({},l,r[l]+r[u]-a[u])};t.offsets.popper=C({},a,f[i])}return t}},offset:{order:200,enabled:!0,fn:function(t,e){var n=e.offset,i=t.placement,o=t.offsets,r=o.popper,a=o.reference,s=i.split("-")[0],l=void 0;return l=K(+n)?[+n,0]:ot(n,r,a,s),"left"===s?(r.top+=l[0],r.left-=l[1]):"right"===s?(r.top+=l[0],r.left+=l[1]):"top"===s?(r.left+=l[0],r.top-=l[1]):"bottom"===s&&(r.left+=l[0],r.top+=l[1]),t.popper=r,t},offset:0},preventOverflow:{order:300,enabled:!0,fn:function(t,e){var n=e.boundariesElement||h(t.instance.popper);t.instance.reference===n&&(n=h(n));var i=Q("transform"),o=t.instance.popper.style,r=o.top,a=o.left,s=o[i];o.top="",o.left="",o[i]="";var l=O(t.instance.popper,t.instance.reference,e.padding,n,t.positionFixed);o.top=r,o.left=a,o[i]=s,e.boundaries=l;var u=e.priority,f=t.offsets.popper,d={primary:function(t){var n=f[t];return f[t]l[t]&&!e.escapeWithReference&&(i=Math.min(f[n],l[t]-("right"===t?f.width:f.height))),T({},n,i)}};return u.forEach((function(t){var e=-1!==["left","top"].indexOf(t)?"primary":"secondary";f=C({},f,d[e](t))})),t.offsets.popper=f,t},priority:["left","right","top","bottom"],padding:5,boundariesElement:"scrollParent"},keepTogether:{order:400,enabled:!0,fn:function(t){var e=t.offsets,n=e.popper,i=e.reference,o=t.placement.split("-")[0],r=Math.floor,a=-1!==["top","bottom"].indexOf(o),s=a?"right":"bottom",l=a?"left":"top",u=a?"width":"height";return n[s]r(i[s])&&(t.offsets.popper[l]=r(i[s])),t}},arrow:{order:500,enabled:!0,fn:function(t,e){var n;if(!G(t.instance.modifiers,"arrow","keepTogether"))return t;var i=e.element;if("string"==typeof i){if(!(i=t.instance.popper.querySelector(i)))return t}else if(!t.instance.popper.contains(i))return console.warn("WARNING: `arrow.element` must be child of its popper element!"),t;var o=t.placement.split("-")[0],r=t.offsets,s=r.popper,l=r.reference,u=-1!==["left","right"].indexOf(o),f=u?"height":"width",d=u?"Top":"Left",c=d.toLowerCase(),h=u?"left":"top",p=u?"bottom":"right",m=P(i)[f];l[p]-ms[p]&&(t.offsets.popper[c]+=l[c]+m-s[p]),t.offsets.popper=S(t.offsets.popper);var g=l[c]+l[f]/2-m/2,v=a(t.instance.popper),_=parseFloat(v["margin"+d]),b=parseFloat(v["border"+d+"Width"]),y=g-t.offsets.popper[c]-_-b;return y=Math.max(Math.min(s[f]-m,y),0),t.arrowElement=i,t.offsets.arrow=(T(n={},c,Math.round(y)),T(n,h,""),n),t},element:"[x-arrow]"},flip:{order:600,enabled:!0,fn:function(t,e){if(q(t.instance.modifiers,"inner"))return t;if(t.flipped&&t.placement===t.originalPlacement)return t;var n=O(t.instance.popper,t.instance.reference,e.padding,e.boundariesElement,t.positionFixed),i=t.placement.split("-")[0],o=F(i),r=t.placement.split("-")[1]||"",a=[];switch(e.behavior){case et:a=[i,o];break;case nt:a=tt(i);break;case it:a=tt(i,!0);break;default:a=e.behavior}return a.forEach((function(s,l){if(i!==s||a.length===l+1)return t;i=t.placement.split("-")[0],o=F(i);var u=t.offsets.popper,f=t.offsets.reference,d=Math.floor,c="left"===i&&d(u.right)>d(f.left)||"right"===i&&d(u.left)d(f.top)||"bottom"===i&&d(u.top)d(n.right),m=d(u.top)d(n.bottom),v="left"===i&&h||"right"===i&&p||"top"===i&&m||"bottom"===i&&g,_=-1!==["top","bottom"].indexOf(i),b=!!e.flipVariations&&(_&&"start"===r&&h||_&&"end"===r&&p||!_&&"start"===r&&m||!_&&"end"===r&&g),y=!!e.flipVariationsByContent&&(_&&"start"===r&&p||_&&"end"===r&&h||!_&&"start"===r&&g||!_&&"end"===r&&m),w=b||y;(c||v||w)&&(t.flipped=!0,(c||v)&&(i=a[l+1]),w&&(r=function(t){return"end"===t?"start":"start"===t?"end":t}(r)),t.placement=i+(r?"-"+r:""),t.offsets.popper=C({},t.offsets.popper,R(t.instance.popper,t.offsets.reference,t.placement)),t=B(t.instance.modifiers,t,"flip"))})),t},behavior:"flip",padding:5,boundariesElement:"viewport",flipVariations:!1,flipVariationsByContent:!1},inner:{order:700,enabled:!1,fn:function(t){var e=t.placement,n=e.split("-")[0],i=t.offsets,o=i.popper,r=i.reference,a=-1!==["left","right"].indexOf(n),s=-1===["top","left"].indexOf(n);return o[a?"left":"top"]=r[n]-(s?o[a?"width":"height"]:0),t.placement=F(e),t.offsets.popper=S(o),t}},hide:{order:800,enabled:!0,fn:function(t){if(!G(t.instance.modifiers,"hide","preventOverflow"))return t;var e=t.offsets.reference,n=M(t.instance.modifiers,(function(t){return"preventOverflow"===t.name})).boundaries;if(e.bottomn.right||e.top>n.bottom||e.right2&&void 0!==arguments[2]?arguments[2]:{};w(this,t),this.scheduleUpdate=function(){return requestAnimationFrame(i.update)},this.update=o(this.update.bind(this)),this.options=C({},t.Defaults,a),this.state={isDestroyed:!1,isCreated:!1,scrollParents:[]},this.reference=e&&e.jquery?e[0]:e,this.popper=n&&n.jquery?n[0]:n,this.options.modifiers={},Object.keys(C({},t.Defaults.modifiers,a.modifiers)).forEach((function(e){i.options.modifiers[e]=C({},t.Defaults.modifiers[e]||{},a.modifiers?a.modifiers[e]:{})})),this.modifiers=Object.keys(this.options.modifiers).map((function(t){return C({name:t},i.options.modifiers[t])})).sort((function(t,e){return t.order-e.order})),this.modifiers.forEach((function(t){t.enabled&&r(t.onLoad)&&t.onLoad(i.reference,i.popper,i.options,t,i.state)})),this.update();var s=this.options.eventsEnabled;s&&this.enableEventListeners(),this.state.eventsEnabled=s}return E(t,[{key:"update",value:function(){return H.call(this)}},{key:"destroy",value:function(){return W.call(this)}},{key:"enableEventListeners",value:function(){return Y.call(this)}},{key:"disableEventListeners",value:function(){return z.call(this)}}]),t}();at.Utils=("undefined"!=typeof window?window:t).PopperUtils,at.placements=J,at.Defaults=rt,e.default=at}.call(this,n(4))},function(t,e,n){t.exports=n(5)},function(t,e,n){ +/*! + * Bootstrap v4.6.1 (https://getbootstrap.com/) + * Copyright 2011-2021 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors) + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + */ +!function(t,e,n){"use strict";function i(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}var o=i(e),r=i(n);function a(t,e){for(var n=0;n=4)throw new Error("Bootstrap's JavaScript requires at least jQuery v1.9.1 but less than v4.0.0")}};d.jQueryDetection(),o.default.fn.emulateTransitionEnd=f,o.default.event.special[d.TRANSITION_END]={bindType:"transitionend",delegateType:"transitionend",handle:function(t){if(o.default(t.target).is(this))return t.handleObj.handler.apply(this,arguments)}};var c=o.default.fn.alert,h=function(){function t(t){this._element=t}var e=t.prototype;return e.close=function(t){var e=this._element;t&&(e=this._getRootElement(t)),this._triggerCloseEvent(e).isDefaultPrevented()||this._removeElement(e)},e.dispose=function(){o.default.removeData(this._element,"bs.alert"),this._element=null},e._getRootElement=function(t){var e=d.getSelectorFromElement(t),n=!1;return e&&(n=document.querySelector(e)),n||(n=o.default(t).closest(".alert")[0]),n},e._triggerCloseEvent=function(t){var e=o.default.Event("close.bs.alert");return o.default(t).trigger(e),e},e._removeElement=function(t){var e=this;if(o.default(t).removeClass("show"),o.default(t).hasClass("fade")){var n=d.getTransitionDurationFromElement(t);o.default(t).one(d.TRANSITION_END,(function(n){return e._destroyElement(t,n)})).emulateTransitionEnd(n)}else this._destroyElement(t)},e._destroyElement=function(t){o.default(t).detach().trigger("closed.bs.alert").remove()},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data("bs.alert");i||(i=new t(this),n.data("bs.alert",i)),"close"===e&&i[e](this)}))},t._handleDismiss=function(t){return function(e){e&&e.preventDefault(),t.close(this)}},s(t,null,[{key:"VERSION",get:function(){return"4.6.1"}}]),t}();o.default(document).on("click.bs.alert.data-api",'[data-dismiss="alert"]',h._handleDismiss(new h)),o.default.fn.alert=h._jQueryInterface,o.default.fn.alert.Constructor=h,o.default.fn.alert.noConflict=function(){return o.default.fn.alert=c,h._jQueryInterface};var p=o.default.fn.button,m=function(){function t(t){this._element=t,this.shouldAvoidTriggerChange=!1}var e=t.prototype;return e.toggle=function(){var t=!0,e=!0,n=o.default(this._element).closest('[data-toggle="buttons"]')[0];if(n){var i=this._element.querySelector('input:not([type="hidden"])');if(i){if("radio"===i.type)if(i.checked&&this._element.classList.contains("active"))t=!1;else{var r=n.querySelector(".active");r&&o.default(r).removeClass("active")}t&&("checkbox"!==i.type&&"radio"!==i.type||(i.checked=!this._element.classList.contains("active")),this.shouldAvoidTriggerChange||o.default(i).trigger("change")),i.focus(),e=!1}}this._element.hasAttribute("disabled")||this._element.classList.contains("disabled")||(e&&this._element.setAttribute("aria-pressed",!this._element.classList.contains("active")),t&&o.default(this._element).toggleClass("active"))},e.dispose=function(){o.default.removeData(this._element,"bs.button"),this._element=null},t._jQueryInterface=function(e,n){return this.each((function(){var i=o.default(this),r=i.data("bs.button");r||(r=new t(this),i.data("bs.button",r)),r.shouldAvoidTriggerChange=n,"toggle"===e&&r[e]()}))},s(t,null,[{key:"VERSION",get:function(){return"4.6.1"}}]),t}();o.default(document).on("click.bs.button.data-api",'[data-toggle^="button"]',(function(t){var e=t.target,n=e;if(o.default(e).hasClass("btn")||(e=o.default(e).closest(".btn")[0]),!e||e.hasAttribute("disabled")||e.classList.contains("disabled"))t.preventDefault();else{var i=e.querySelector('input:not([type="hidden"])');if(i&&(i.hasAttribute("disabled")||i.classList.contains("disabled")))return void t.preventDefault();"INPUT"!==n.tagName&&"LABEL"===e.tagName||m._jQueryInterface.call(o.default(e),"toggle","INPUT"===n.tagName)}})).on("focus.bs.button.data-api blur.bs.button.data-api",'[data-toggle^="button"]',(function(t){var e=o.default(t.target).closest(".btn")[0];o.default(e).toggleClass("focus",/^focus(in)?$/.test(t.type))})),o.default(window).on("load.bs.button.data-api",(function(){for(var t=[].slice.call(document.querySelectorAll('[data-toggle="buttons"] .btn')),e=0,n=t.length;e0,this._pointerEvent=Boolean(window.PointerEvent||window.MSPointerEvent),this._addEventListeners()}var e=t.prototype;return e.next=function(){this._isSliding||this._slide("next")},e.nextWhenVisible=function(){var t=o.default(this._element);!document.hidden&&t.is(":visible")&&"hidden"!==t.css("visibility")&&this.next()},e.prev=function(){this._isSliding||this._slide("prev")},e.pause=function(t){t||(this._isPaused=!0),this._element.querySelector(".carousel-item-next, .carousel-item-prev")&&(d.triggerTransitionEnd(this._element),this.cycle(!0)),clearInterval(this._interval),this._interval=null},e.cycle=function(t){t||(this._isPaused=!1),this._interval&&(clearInterval(this._interval),this._interval=null),this._config.interval&&!this._isPaused&&(this._updateInterval(),this._interval=setInterval((document.visibilityState?this.nextWhenVisible:this.next).bind(this),this._config.interval))},e.to=function(t){var e=this;this._activeElement=this._element.querySelector(".active.carousel-item");var n=this._getItemIndex(this._activeElement);if(!(t>this._items.length-1||t<0))if(this._isSliding)o.default(this._element).one("slid.bs.carousel",(function(){return e.to(t)}));else{if(n===t)return this.pause(),void this.cycle();var i=t>n?"next":"prev";this._slide(i,this._items[t])}},e.dispose=function(){o.default(this._element).off(v),o.default.removeData(this._element,"bs.carousel"),this._items=null,this._config=null,this._element=null,this._interval=null,this._isPaused=null,this._isSliding=null,this._activeElement=null,this._indicatorsElement=null},e._getConfig=function(t){return t=l({},b,t),d.typeCheckConfig(g,t,y),t},e._handleSwipe=function(){var t=Math.abs(this.touchDeltaX);if(!(t<=40)){var e=t/this.touchDeltaX;this.touchDeltaX=0,e>0&&this.prev(),e<0&&this.next()}},e._addEventListeners=function(){var t=this;this._config.keyboard&&o.default(this._element).on("keydown.bs.carousel",(function(e){return t._keydown(e)})),"hover"===this._config.pause&&o.default(this._element).on("mouseenter.bs.carousel",(function(e){return t.pause(e)})).on("mouseleave.bs.carousel",(function(e){return t.cycle(e)})),this._config.touch&&this._addTouchEventListeners()},e._addTouchEventListeners=function(){var t=this;if(this._touchSupported){var e=function(e){t._pointerEvent&&w[e.originalEvent.pointerType.toUpperCase()]?t.touchStartX=e.originalEvent.clientX:t._pointerEvent||(t.touchStartX=e.originalEvent.touches[0].clientX)},n=function(e){t._pointerEvent&&w[e.originalEvent.pointerType.toUpperCase()]&&(t.touchDeltaX=e.originalEvent.clientX-t.touchStartX),t._handleSwipe(),"hover"===t._config.pause&&(t.pause(),t.touchTimeout&&clearTimeout(t.touchTimeout),t.touchTimeout=setTimeout((function(e){return t.cycle(e)}),500+t._config.interval))};o.default(this._element.querySelectorAll(".carousel-item img")).on("dragstart.bs.carousel",(function(t){return t.preventDefault()})),this._pointerEvent?(o.default(this._element).on("pointerdown.bs.carousel",(function(t){return e(t)})),o.default(this._element).on("pointerup.bs.carousel",(function(t){return n(t)})),this._element.classList.add("pointer-event")):(o.default(this._element).on("touchstart.bs.carousel",(function(t){return e(t)})),o.default(this._element).on("touchmove.bs.carousel",(function(e){return function(e){t.touchDeltaX=e.originalEvent.touches&&e.originalEvent.touches.length>1?0:e.originalEvent.touches[0].clientX-t.touchStartX}(e)})),o.default(this._element).on("touchend.bs.carousel",(function(t){return n(t)})))}},e._keydown=function(t){if(!/input|textarea/i.test(t.target.tagName))switch(t.which){case 37:t.preventDefault(),this.prev();break;case 39:t.preventDefault(),this.next()}},e._getItemIndex=function(t){return this._items=t&&t.parentNode?[].slice.call(t.parentNode.querySelectorAll(".carousel-item")):[],this._items.indexOf(t)},e._getItemByDirection=function(t,e){var n="next"===t,i="prev"===t,o=this._getItemIndex(e),r=this._items.length-1;if((i&&0===o||n&&o===r)&&!this._config.wrap)return e;var a=(o+("prev"===t?-1:1))%this._items.length;return-1===a?this._items[this._items.length-1]:this._items[a]},e._triggerSlideEvent=function(t,e){var n=this._getItemIndex(t),i=this._getItemIndex(this._element.querySelector(".active.carousel-item")),r=o.default.Event("slide.bs.carousel",{relatedTarget:t,direction:e,from:i,to:n});return o.default(this._element).trigger(r),r},e._setActiveIndicatorElement=function(t){if(this._indicatorsElement){var e=[].slice.call(this._indicatorsElement.querySelectorAll(".active"));o.default(e).removeClass("active");var n=this._indicatorsElement.children[this._getItemIndex(t)];n&&o.default(n).addClass("active")}},e._updateInterval=function(){var t=this._activeElement||this._element.querySelector(".active.carousel-item");if(t){var e=parseInt(t.getAttribute("data-interval"),10);e?(this._config.defaultInterval=this._config.defaultInterval||this._config.interval,this._config.interval=e):this._config.interval=this._config.defaultInterval||this._config.interval}},e._slide=function(t,e){var n,i,r,a=this,s=this._element.querySelector(".active.carousel-item"),l=this._getItemIndex(s),u=e||s&&this._getItemByDirection(t,s),f=this._getItemIndex(u),c=Boolean(this._interval);if("next"===t?(n="carousel-item-left",i="carousel-item-next",r="left"):(n="carousel-item-right",i="carousel-item-prev",r="right"),u&&o.default(u).hasClass("active"))this._isSliding=!1;else if(!this._triggerSlideEvent(u,r).isDefaultPrevented()&&s&&u){this._isSliding=!0,c&&this.pause(),this._setActiveIndicatorElement(u),this._activeElement=u;var h=o.default.Event("slid.bs.carousel",{relatedTarget:u,direction:r,from:l,to:f});if(o.default(this._element).hasClass("slide")){o.default(u).addClass(i),d.reflow(u),o.default(s).addClass(n),o.default(u).addClass(n);var p=d.getTransitionDurationFromElement(s);o.default(s).one(d.TRANSITION_END,(function(){o.default(u).removeClass(n+" "+i).addClass("active"),o.default(s).removeClass("active "+i+" "+n),a._isSliding=!1,setTimeout((function(){return o.default(a._element).trigger(h)}),0)})).emulateTransitionEnd(p)}else o.default(s).removeClass("active"),o.default(u).addClass("active"),this._isSliding=!1,o.default(this._element).trigger(h);c&&this.cycle()}},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this).data("bs.carousel"),i=l({},b,o.default(this).data());"object"==typeof e&&(i=l({},i,e));var r="string"==typeof e?e:i.slide;if(n||(n=new t(this,i),o.default(this).data("bs.carousel",n)),"number"==typeof e)n.to(e);else if("string"==typeof r){if(void 0===n[r])throw new TypeError('No method named "'+r+'"');n[r]()}else i.interval&&i.ride&&(n.pause(),n.cycle())}))},t._dataApiClickHandler=function(e){var n=d.getSelectorFromElement(this);if(n){var i=o.default(n)[0];if(i&&o.default(i).hasClass("carousel")){var r=l({},o.default(i).data(),o.default(this).data()),a=this.getAttribute("data-slide-to");a&&(r.interval=!1),t._jQueryInterface.call(o.default(i),r),a&&o.default(i).data("bs.carousel").to(a),e.preventDefault()}}},s(t,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"Default",get:function(){return b}}]),t}();o.default(document).on("click.bs.carousel.data-api","[data-slide], [data-slide-to]",E._dataApiClickHandler),o.default(window).on("load.bs.carousel.data-api",(function(){for(var t=[].slice.call(document.querySelectorAll('[data-ride="carousel"]')),e=0,n=t.length;e0&&(this._selector=a,this._triggerArray.push(r))}this._parent=this._config.parent?this._getParent():null,this._config.parent||this._addAriaAndCollapsedClass(this._element,this._triggerArray),this._config.toggle&&this.toggle()}var e=t.prototype;return e.toggle=function(){o.default(this._element).hasClass("show")?this.hide():this.show()},e.show=function(){var e,n,i=this;if(!(this._isTransitioning||o.default(this._element).hasClass("show")||(this._parent&&0===(e=[].slice.call(this._parent.querySelectorAll(".show, .collapsing")).filter((function(t){return"string"==typeof i._config.parent?t.getAttribute("data-parent")===i._config.parent:t.classList.contains("collapse")}))).length&&(e=null),e&&(n=o.default(e).not(this._selector).data("bs.collapse"))&&n._isTransitioning))){var r=o.default.Event("show.bs.collapse");if(o.default(this._element).trigger(r),!r.isDefaultPrevented()){e&&(t._jQueryInterface.call(o.default(e).not(this._selector),"hide"),n||o.default(e).data("bs.collapse",null));var a=this._getDimension();o.default(this._element).removeClass("collapse").addClass("collapsing"),this._element.style[a]=0,this._triggerArray.length&&o.default(this._triggerArray).removeClass("collapsed").attr("aria-expanded",!0),this.setTransitioning(!0);var s="scroll"+(a[0].toUpperCase()+a.slice(1)),l=d.getTransitionDurationFromElement(this._element);o.default(this._element).one(d.TRANSITION_END,(function(){o.default(i._element).removeClass("collapsing").addClass("collapse show"),i._element.style[a]="",i.setTransitioning(!1),o.default(i._element).trigger("shown.bs.collapse")})).emulateTransitionEnd(l),this._element.style[a]=this._element[s]+"px"}}},e.hide=function(){var t=this;if(!this._isTransitioning&&o.default(this._element).hasClass("show")){var e=o.default.Event("hide.bs.collapse");if(o.default(this._element).trigger(e),!e.isDefaultPrevented()){var n=this._getDimension();this._element.style[n]=this._element.getBoundingClientRect()[n]+"px",d.reflow(this._element),o.default(this._element).addClass("collapsing").removeClass("collapse show");var i=this._triggerArray.length;if(i>0)for(var r=0;r0},e._getOffset=function(){var t=this,e={};return"function"==typeof this._config.offset?e.fn=function(e){return e.offsets=l({},e.offsets,t._config.offset(e.offsets,t._element)),e}:e.offset=this._config.offset,e},e._getPopperConfig=function(){var t={placement:this._getPlacement(),modifiers:{offset:this._getOffset(),flip:{enabled:this._config.flip},preventOverflow:{boundariesElement:this._config.boundary}}};return"static"===this._config.display&&(t.modifiers.applyStyle={enabled:!1}),l({},t,this._config.popperConfig)},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this).data("bs.dropdown");if(n||(n=new t(this,"object"==typeof e?e:null),o.default(this).data("bs.dropdown",n)),"string"==typeof e){if(void 0===n[e])throw new TypeError('No method named "'+e+'"');n[e]()}}))},t._clearMenus=function(e){if(!e||3!==e.which&&("keyup"!==e.type||9===e.which))for(var n=[].slice.call(document.querySelectorAll('[data-toggle="dropdown"]')),i=0,r=n.length;i0&&a--,40===e.which&&adocument.documentElement.clientHeight;n||(this._element.style.overflowY="hidden"),this._element.classList.add("modal-static");var i=d.getTransitionDurationFromElement(this._dialog);o.default(this._element).off(d.TRANSITION_END),o.default(this._element).one(d.TRANSITION_END,(function(){t._element.classList.remove("modal-static"),n||o.default(t._element).one(d.TRANSITION_END,(function(){t._element.style.overflowY=""})).emulateTransitionEnd(t._element,i)})).emulateTransitionEnd(i),this._element.focus()}},e._showElement=function(t){var e=this,n=o.default(this._element).hasClass("fade"),i=this._dialog?this._dialog.querySelector(".modal-body"):null;this._element.parentNode&&this._element.parentNode.nodeType===Node.ELEMENT_NODE||document.body.appendChild(this._element),this._element.style.display="block",this._element.removeAttribute("aria-hidden"),this._element.setAttribute("aria-modal",!0),this._element.setAttribute("role","dialog"),o.default(this._dialog).hasClass("modal-dialog-scrollable")&&i?i.scrollTop=0:this._element.scrollTop=0,n&&d.reflow(this._element),o.default(this._element).addClass("show"),this._config.focus&&this._enforceFocus();var r=o.default.Event("shown.bs.modal",{relatedTarget:t}),a=function(){e._config.focus&&e._element.focus(),e._isTransitioning=!1,o.default(e._element).trigger(r)};if(n){var s=d.getTransitionDurationFromElement(this._dialog);o.default(this._dialog).one(d.TRANSITION_END,a).emulateTransitionEnd(s)}else a()},e._enforceFocus=function(){var t=this;o.default(document).off("focusin.bs.modal").on("focusin.bs.modal",(function(e){document!==e.target&&t._element!==e.target&&0===o.default(t._element).has(e.target).length&&t._element.focus()}))},e._setEscapeEvent=function(){var t=this;this._isShown?o.default(this._element).on("keydown.dismiss.bs.modal",(function(e){t._config.keyboard&&27===e.which?(e.preventDefault(),t.hide()):t._config.keyboard||27!==e.which||t._triggerBackdropTransition()})):this._isShown||o.default(this._element).off("keydown.dismiss.bs.modal")},e._setResizeEvent=function(){var t=this;this._isShown?o.default(window).on("resize.bs.modal",(function(e){return t.handleUpdate(e)})):o.default(window).off("resize.bs.modal")},e._hideModal=function(){var t=this;this._element.style.display="none",this._element.setAttribute("aria-hidden",!0),this._element.removeAttribute("aria-modal"),this._element.removeAttribute("role"),this._isTransitioning=!1,this._showBackdrop((function(){o.default(document.body).removeClass("modal-open"),t._resetAdjustments(),t._resetScrollbar(),o.default(t._element).trigger("hidden.bs.modal")}))},e._removeBackdrop=function(){this._backdrop&&(o.default(this._backdrop).remove(),this._backdrop=null)},e._showBackdrop=function(t){var e=this,n=o.default(this._element).hasClass("fade")?"fade":"";if(this._isShown&&this._config.backdrop){if(this._backdrop=document.createElement("div"),this._backdrop.className="modal-backdrop",n&&this._backdrop.classList.add(n),o.default(this._backdrop).appendTo(document.body),o.default(this._element).on("click.dismiss.bs.modal",(function(t){e._ignoreBackdropClick?e._ignoreBackdropClick=!1:t.target===t.currentTarget&&("static"===e._config.backdrop?e._triggerBackdropTransition():e.hide())})),n&&d.reflow(this._backdrop),o.default(this._backdrop).addClass("show"),!t)return;if(!n)return void t();var i=d.getTransitionDurationFromElement(this._backdrop);o.default(this._backdrop).one(d.TRANSITION_END,t).emulateTransitionEnd(i)}else if(!this._isShown&&this._backdrop){o.default(this._backdrop).removeClass("show");var r=function(){e._removeBackdrop(),t&&t()};if(o.default(this._element).hasClass("fade")){var a=d.getTransitionDurationFromElement(this._backdrop);o.default(this._backdrop).one(d.TRANSITION_END,r).emulateTransitionEnd(a)}else r()}else t&&t()},e._adjustDialog=function(){var t=this._element.scrollHeight>document.documentElement.clientHeight;!this._isBodyOverflowing&&t&&(this._element.style.paddingLeft=this._scrollbarWidth+"px"),this._isBodyOverflowing&&!t&&(this._element.style.paddingRight=this._scrollbarWidth+"px")},e._resetAdjustments=function(){this._element.style.paddingLeft="",this._element.style.paddingRight=""},e._checkScrollbar=function(){var t=document.body.getBoundingClientRect();this._isBodyOverflowing=Math.round(t.left+t.right)
',trigger:"hover focus",title:"",delay:0,html:!1,selector:!1,placement:"top",offset:0,container:!1,fallbackPlacement:"flip",boundary:"scrollParent",customClass:"",sanitize:!0,sanitizeFn:null,whiteList:B,popperConfig:null},X={animation:"boolean",template:"string",title:"(string|element|function)",trigger:"string",delay:"(number|object)",html:"boolean",selector:"(string|boolean)",placement:"(string|function)",offset:"(number|string|function)",container:"(string|element|boolean)",fallbackPlacement:"(string|array)",boundary:"(string|element)",customClass:"(string|function)",sanitize:"boolean",sanitizeFn:"(null|function)",whiteList:"object",popperConfig:"(null|object)"},$={HIDE:"hide.bs.tooltip",HIDDEN:"hidden.bs.tooltip",SHOW:"show.bs.tooltip",SHOWN:"shown.bs.tooltip",INSERTED:"inserted.bs.tooltip",CLICK:"click.bs.tooltip",FOCUSIN:"focusin.bs.tooltip",FOCUSOUT:"focusout.bs.tooltip",MOUSEENTER:"mouseenter.bs.tooltip",MOUSELEAVE:"mouseleave.bs.tooltip"},G=function(){function t(t,e){if(void 0===r.default)throw new TypeError("Bootstrap's tooltips require Popper (https://popper.js.org)");this._isEnabled=!0,this._timeout=0,this._hoverState="",this._activeTrigger={},this._popper=null,this.element=t,this.config=this._getConfig(e),this.tip=null,this._setListeners()}var e=t.prototype;return e.enable=function(){this._isEnabled=!0},e.disable=function(){this._isEnabled=!1},e.toggleEnabled=function(){this._isEnabled=!this._isEnabled},e.toggle=function(t){if(this._isEnabled)if(t){var e=this.constructor.DATA_KEY,n=o.default(t.currentTarget).data(e);n||(n=new this.constructor(t.currentTarget,this._getDelegateConfig()),o.default(t.currentTarget).data(e,n)),n._activeTrigger.click=!n._activeTrigger.click,n._isWithActiveTrigger()?n._enter(null,n):n._leave(null,n)}else{if(o.default(this.getTipElement()).hasClass("show"))return void this._leave(null,this);this._enter(null,this)}},e.dispose=function(){clearTimeout(this._timeout),o.default.removeData(this.element,this.constructor.DATA_KEY),o.default(this.element).off(this.constructor.EVENT_KEY),o.default(this.element).closest(".modal").off("hide.bs.modal",this._hideModalHandler),this.tip&&o.default(this.tip).remove(),this._isEnabled=null,this._timeout=null,this._hoverState=null,this._activeTrigger=null,this._popper&&this._popper.destroy(),this._popper=null,this.element=null,this.config=null,this.tip=null},e.show=function(){var t=this;if("none"===o.default(this.element).css("display"))throw new Error("Please use show on visible elements");var e=o.default.Event(this.constructor.Event.SHOW);if(this.isWithContent()&&this._isEnabled){o.default(this.element).trigger(e);var n=d.findShadowRoot(this.element),i=o.default.contains(null!==n?n:this.element.ownerDocument.documentElement,this.element);if(e.isDefaultPrevented()||!i)return;var a=this.getTipElement(),s=d.getUID(this.constructor.NAME);a.setAttribute("id",s),this.element.setAttribute("aria-describedby",s),this.setContent(),this.config.animation&&o.default(a).addClass("fade");var l="function"==typeof this.config.placement?this.config.placement.call(this,a,this.element):this.config.placement,u=this._getAttachment(l);this.addAttachmentClass(u);var f=this._getContainer();o.default(a).data(this.constructor.DATA_KEY,this),o.default.contains(this.element.ownerDocument.documentElement,this.tip)||o.default(a).appendTo(f),o.default(this.element).trigger(this.constructor.Event.INSERTED),this._popper=new r.default(this.element,a,this._getPopperConfig(u)),o.default(a).addClass("show"),o.default(a).addClass(this.config.customClass),"ontouchstart"in document.documentElement&&o.default(document.body).children().on("mouseover",null,o.default.noop);var c=function(){t.config.animation&&t._fixTransition();var e=t._hoverState;t._hoverState=null,o.default(t.element).trigger(t.constructor.Event.SHOWN),"out"===e&&t._leave(null,t)};if(o.default(this.tip).hasClass("fade")){var h=d.getTransitionDurationFromElement(this.tip);o.default(this.tip).one(d.TRANSITION_END,c).emulateTransitionEnd(h)}else c()}},e.hide=function(t){var e=this,n=this.getTipElement(),i=o.default.Event(this.constructor.Event.HIDE),r=function(){"show"!==e._hoverState&&n.parentNode&&n.parentNode.removeChild(n),e._cleanTipClass(),e.element.removeAttribute("aria-describedby"),o.default(e.element).trigger(e.constructor.Event.HIDDEN),null!==e._popper&&e._popper.destroy(),t&&t()};if(o.default(this.element).trigger(i),!i.isDefaultPrevented()){if(o.default(n).removeClass("show"),"ontouchstart"in document.documentElement&&o.default(document.body).children().off("mouseover",null,o.default.noop),this._activeTrigger.click=!1,this._activeTrigger.focus=!1,this._activeTrigger.hover=!1,o.default(this.tip).hasClass("fade")){var a=d.getTransitionDurationFromElement(n);o.default(n).one(d.TRANSITION_END,r).emulateTransitionEnd(a)}else r();this._hoverState=""}},e.update=function(){null!==this._popper&&this._popper.scheduleUpdate()},e.isWithContent=function(){return Boolean(this.getTitle())},e.addAttachmentClass=function(t){o.default(this.getTipElement()).addClass("bs-tooltip-"+t)},e.getTipElement=function(){return this.tip=this.tip||o.default(this.config.template)[0],this.tip},e.setContent=function(){var t=this.getTipElement();this.setElementContent(o.default(t.querySelectorAll(".tooltip-inner")),this.getTitle()),o.default(t).removeClass("fade show")},e.setElementContent=function(t,e){"object"!=typeof e||!e.nodeType&&!e.jquery?this.config.html?(this.config.sanitize&&(e=Q(e,this.config.whiteList,this.config.sanitizeFn)),t.html(e)):t.text(e):this.config.html?o.default(e).parent().is(t)||t.empty().append(e):t.text(o.default(e).text())},e.getTitle=function(){var t=this.element.getAttribute("data-original-title");return t||(t="function"==typeof this.config.title?this.config.title.call(this.element):this.config.title),t},e._getPopperConfig=function(t){var e=this;return l({},{placement:t,modifiers:{offset:this._getOffset(),flip:{behavior:this.config.fallbackPlacement},arrow:{element:".arrow"},preventOverflow:{boundariesElement:this.config.boundary}},onCreate:function(t){t.originalPlacement!==t.placement&&e._handlePopperPlacementChange(t)},onUpdate:function(t){return e._handlePopperPlacementChange(t)}},this.config.popperConfig)},e._getOffset=function(){var t=this,e={};return"function"==typeof this.config.offset?e.fn=function(e){return e.offsets=l({},e.offsets,t.config.offset(e.offsets,t.element)),e}:e.offset=this.config.offset,e},e._getContainer=function(){return!1===this.config.container?document.body:d.isElement(this.config.container)?o.default(this.config.container):o.default(document).find(this.config.container)},e._getAttachment=function(t){return z[t.toUpperCase()]},e._setListeners=function(){var t=this;this.config.trigger.split(" ").forEach((function(e){if("click"===e)o.default(t.element).on(t.constructor.Event.CLICK,t.config.selector,(function(e){return t.toggle(e)}));else if("manual"!==e){var n="hover"===e?t.constructor.Event.MOUSEENTER:t.constructor.Event.FOCUSIN,i="hover"===e?t.constructor.Event.MOUSELEAVE:t.constructor.Event.FOCUSOUT;o.default(t.element).on(n,t.config.selector,(function(e){return t._enter(e)})).on(i,t.config.selector,(function(e){return t._leave(e)}))}})),this._hideModalHandler=function(){t.element&&t.hide()},o.default(this.element).closest(".modal").on("hide.bs.modal",this._hideModalHandler),this.config.selector?this.config=l({},this.config,{trigger:"manual",selector:""}):this._fixTitle()},e._fixTitle=function(){var t=typeof this.element.getAttribute("data-original-title");(this.element.getAttribute("title")||"string"!==t)&&(this.element.setAttribute("data-original-title",this.element.getAttribute("title")||""),this.element.setAttribute("title",""))},e._enter=function(t,e){var n=this.constructor.DATA_KEY;(e=e||o.default(t.currentTarget).data(n))||(e=new this.constructor(t.currentTarget,this._getDelegateConfig()),o.default(t.currentTarget).data(n,e)),t&&(e._activeTrigger["focusin"===t.type?"focus":"hover"]=!0),o.default(e.getTipElement()).hasClass("show")||"show"===e._hoverState?e._hoverState="show":(clearTimeout(e._timeout),e._hoverState="show",e.config.delay&&e.config.delay.show?e._timeout=setTimeout((function(){"show"===e._hoverState&&e.show()}),e.config.delay.show):e.show())},e._leave=function(t,e){var n=this.constructor.DATA_KEY;(e=e||o.default(t.currentTarget).data(n))||(e=new this.constructor(t.currentTarget,this._getDelegateConfig()),o.default(t.currentTarget).data(n,e)),t&&(e._activeTrigger["focusout"===t.type?"focus":"hover"]=!1),e._isWithActiveTrigger()||(clearTimeout(e._timeout),e._hoverState="out",e.config.delay&&e.config.delay.hide?e._timeout=setTimeout((function(){"out"===e._hoverState&&e.hide()}),e.config.delay.hide):e.hide())},e._isWithActiveTrigger=function(){for(var t in this._activeTrigger)if(this._activeTrigger[t])return!0;return!1},e._getConfig=function(t){var e=o.default(this.element).data();return Object.keys(e).forEach((function(t){-1!==Y.indexOf(t)&&delete e[t]})),"number"==typeof(t=l({},this.constructor.Default,e,"object"==typeof t&&t?t:{})).delay&&(t.delay={show:t.delay,hide:t.delay}),"number"==typeof t.title&&(t.title=t.title.toString()),"number"==typeof t.content&&(t.content=t.content.toString()),d.typeCheckConfig(W,t,this.constructor.DefaultType),t.sanitize&&(t.template=Q(t.template,t.whiteList,t.sanitizeFn)),t},e._getDelegateConfig=function(){var t={};if(this.config)for(var e in this.config)this.constructor.Default[e]!==this.config[e]&&(t[e]=this.config[e]);return t},e._cleanTipClass=function(){var t=o.default(this.getTipElement()),e=t.attr("class").match(V);null!==e&&e.length&&t.removeClass(e.join(""))},e._handlePopperPlacementChange=function(t){this.tip=t.instance.popper,this._cleanTipClass(),this.addAttachmentClass(this._getAttachment(t.placement))},e._fixTransition=function(){var t=this.getTipElement(),e=this.config.animation;null===t.getAttribute("x-placement")&&(o.default(t).removeClass("fade"),this.config.animation=!1,this.hide(),this.show(),this.config.animation=e)},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data("bs.tooltip"),r="object"==typeof e&&e;if((i||!/dispose|hide/.test(e))&&(i||(i=new t(this,r),n.data("bs.tooltip",i)),"string"==typeof e)){if(void 0===i[e])throw new TypeError('No method named "'+e+'"');i[e]()}}))},s(t,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"Default",get:function(){return K}},{key:"NAME",get:function(){return W}},{key:"DATA_KEY",get:function(){return"bs.tooltip"}},{key:"Event",get:function(){return $}},{key:"EVENT_KEY",get:function(){return".bs.tooltip"}},{key:"DefaultType",get:function(){return X}}]),t}();o.default.fn[W]=G._jQueryInterface,o.default.fn[W].Constructor=G,o.default.fn[W].noConflict=function(){return o.default.fn[W]=U,G._jQueryInterface};var J="popover",Z=o.default.fn[J],tt=new RegExp("(^|\\s)bs-popover\\S+","g"),et=l({},G.Default,{placement:"right",trigger:"click",content:"",template:''}),nt=l({},G.DefaultType,{content:"(string|element|function)"}),it={HIDE:"hide.bs.popover",HIDDEN:"hidden.bs.popover",SHOW:"show.bs.popover",SHOWN:"shown.bs.popover",INSERTED:"inserted.bs.popover",CLICK:"click.bs.popover",FOCUSIN:"focusin.bs.popover",FOCUSOUT:"focusout.bs.popover",MOUSEENTER:"mouseenter.bs.popover",MOUSELEAVE:"mouseleave.bs.popover"},ot=function(t){var e,n;function i(){return t.apply(this,arguments)||this}n=t,(e=i).prototype=Object.create(n.prototype),e.prototype.constructor=e,u(e,n);var r=i.prototype;return r.isWithContent=function(){return this.getTitle()||this._getContent()},r.addAttachmentClass=function(t){o.default(this.getTipElement()).addClass("bs-popover-"+t)},r.getTipElement=function(){return this.tip=this.tip||o.default(this.config.template)[0],this.tip},r.setContent=function(){var t=o.default(this.getTipElement());this.setElementContent(t.find(".popover-header"),this.getTitle());var e=this._getContent();"function"==typeof e&&(e=e.call(this.element)),this.setElementContent(t.find(".popover-body"),e),t.removeClass("fade show")},r._getContent=function(){return this.element.getAttribute("data-content")||this.config.content},r._cleanTipClass=function(){var t=o.default(this.getTipElement()),e=t.attr("class").match(tt);null!==e&&e.length>0&&t.removeClass(e.join(""))},i._jQueryInterface=function(t){return this.each((function(){var e=o.default(this).data("bs.popover"),n="object"==typeof t?t:null;if((e||!/dispose|hide/.test(t))&&(e||(e=new i(this,n),o.default(this).data("bs.popover",e)),"string"==typeof t)){if(void 0===e[t])throw new TypeError('No method named "'+t+'"');e[t]()}}))},s(i,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"Default",get:function(){return et}},{key:"NAME",get:function(){return J}},{key:"DATA_KEY",get:function(){return"bs.popover"}},{key:"Event",get:function(){return it}},{key:"EVENT_KEY",get:function(){return".bs.popover"}},{key:"DefaultType",get:function(){return nt}}]),i}(G);o.default.fn[J]=ot._jQueryInterface,o.default.fn[J].Constructor=ot,o.default.fn[J].noConflict=function(){return o.default.fn[J]=Z,ot._jQueryInterface};var rt="scrollspy",at=o.default.fn[rt],st={offset:10,method:"auto",target:""},lt={offset:"number",method:"string",target:"(string|element)"},ut=function(){function t(t,e){var n=this;this._element=t,this._scrollElement="BODY"===t.tagName?window:t,this._config=this._getConfig(e),this._selector=this._config.target+" .nav-link,"+this._config.target+" .list-group-item,"+this._config.target+" .dropdown-item",this._offsets=[],this._targets=[],this._activeTarget=null,this._scrollHeight=0,o.default(this._scrollElement).on("scroll.bs.scrollspy",(function(t){return n._process(t)})),this.refresh(),this._process()}var e=t.prototype;return e.refresh=function(){var t=this,e=this._scrollElement===this._scrollElement.window?"offset":"position",n="auto"===this._config.method?e:this._config.method,i="position"===n?this._getScrollTop():0;this._offsets=[],this._targets=[],this._scrollHeight=this._getScrollHeight(),[].slice.call(document.querySelectorAll(this._selector)).map((function(t){var e,r=d.getSelectorFromElement(t);if(r&&(e=document.querySelector(r)),e){var a=e.getBoundingClientRect();if(a.width||a.height)return[o.default(e)[n]().top+i,r]}return null})).filter((function(t){return t})).sort((function(t,e){return t[0]-e[0]})).forEach((function(e){t._offsets.push(e[0]),t._targets.push(e[1])}))},e.dispose=function(){o.default.removeData(this._element,"bs.scrollspy"),o.default(this._scrollElement).off(".bs.scrollspy"),this._element=null,this._scrollElement=null,this._config=null,this._selector=null,this._offsets=null,this._targets=null,this._activeTarget=null,this._scrollHeight=null},e._getConfig=function(t){if("string"!=typeof(t=l({},st,"object"==typeof t&&t?t:{})).target&&d.isElement(t.target)){var e=o.default(t.target).attr("id");e||(e=d.getUID(rt),o.default(t.target).attr("id",e)),t.target="#"+e}return d.typeCheckConfig(rt,t,lt),t},e._getScrollTop=function(){return this._scrollElement===window?this._scrollElement.pageYOffset:this._scrollElement.scrollTop},e._getScrollHeight=function(){return this._scrollElement.scrollHeight||Math.max(document.body.scrollHeight,document.documentElement.scrollHeight)},e._getOffsetHeight=function(){return this._scrollElement===window?window.innerHeight:this._scrollElement.getBoundingClientRect().height},e._process=function(){var t=this._getScrollTop()+this._config.offset,e=this._getScrollHeight(),n=this._config.offset+e-this._getOffsetHeight();if(this._scrollHeight!==e&&this.refresh(),t>=n){var i=this._targets[this._targets.length-1];this._activeTarget!==i&&this._activate(i)}else{if(this._activeTarget&&t0)return this._activeTarget=null,void this._clear();for(var o=this._offsets.length;o--;)this._activeTarget!==this._targets[o]&&t>=this._offsets[o]&&(void 0===this._offsets[o+1]||t li > .active":".active";n=(n=o.default.makeArray(o.default(i).find(a)))[n.length-1]}var s=o.default.Event("hide.bs.tab",{relatedTarget:this._element}),l=o.default.Event("show.bs.tab",{relatedTarget:n});if(n&&o.default(n).trigger(s),o.default(this._element).trigger(l),!l.isDefaultPrevented()&&!s.isDefaultPrevented()){r&&(e=document.querySelector(r)),this._activate(this._element,i);var u=function(){var e=o.default.Event("hidden.bs.tab",{relatedTarget:t._element}),i=o.default.Event("shown.bs.tab",{relatedTarget:n});o.default(n).trigger(e),o.default(t._element).trigger(i)};e?this._activate(e,e.parentNode,u):u()}}},e.dispose=function(){o.default.removeData(this._element,"bs.tab"),this._element=null},e._activate=function(t,e,n){var i=this,r=(!e||"UL"!==e.nodeName&&"OL"!==e.nodeName?o.default(e).children(".active"):o.default(e).find("> li > .active"))[0],a=n&&r&&o.default(r).hasClass("fade"),s=function(){return i._transitionComplete(t,r,n)};if(r&&a){var l=d.getTransitionDurationFromElement(r);o.default(r).removeClass("show").one(d.TRANSITION_END,s).emulateTransitionEnd(l)}else s()},e._transitionComplete=function(t,e,n){if(e){o.default(e).removeClass("active");var i=o.default(e.parentNode).find("> .dropdown-menu .active")[0];i&&o.default(i).removeClass("active"),"tab"===e.getAttribute("role")&&e.setAttribute("aria-selected",!1)}o.default(t).addClass("active"),"tab"===t.getAttribute("role")&&t.setAttribute("aria-selected",!0),d.reflow(t),t.classList.contains("fade")&&t.classList.add("show");var r=t.parentNode;if(r&&"LI"===r.nodeName&&(r=r.parentNode),r&&o.default(r).hasClass("dropdown-menu")){var a=o.default(t).closest(".dropdown")[0];if(a){var s=[].slice.call(a.querySelectorAll(".dropdown-toggle"));o.default(s).addClass("active")}t.setAttribute("aria-expanded",!0)}n&&n()},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data("bs.tab");if(i||(i=new t(this),n.data("bs.tab",i)),"string"==typeof e){if(void 0===i[e])throw new TypeError('No method named "'+e+'"');i[e]()}}))},s(t,null,[{key:"VERSION",get:function(){return"4.6.1"}}]),t}();o.default(document).on("click.bs.tab.data-api",'[data-toggle="tab"], [data-toggle="pill"], [data-toggle="list"]',(function(t){t.preventDefault(),dt._jQueryInterface.call(o.default(this),"show")})),o.default.fn.tab=dt._jQueryInterface,o.default.fn.tab.Constructor=dt,o.default.fn.tab.noConflict=function(){return o.default.fn.tab=ft,dt._jQueryInterface};var ct="toast",ht=o.default.fn[ct],pt={animation:!0,autohide:!0,delay:500},mt={animation:"boolean",autohide:"boolean",delay:"number"},gt=function(){function t(t,e){this._element=t,this._config=this._getConfig(e),this._timeout=null,this._setListeners()}var e=t.prototype;return e.show=function(){var t=this,e=o.default.Event("show.bs.toast");if(o.default(this._element).trigger(e),!e.isDefaultPrevented()){this._clearTimeout(),this._config.animation&&this._element.classList.add("fade");var n=function(){t._element.classList.remove("showing"),t._element.classList.add("show"),o.default(t._element).trigger("shown.bs.toast"),t._config.autohide&&(t._timeout=setTimeout((function(){t.hide()}),t._config.delay))};if(this._element.classList.remove("hide"),d.reflow(this._element),this._element.classList.add("showing"),this._config.animation){var i=d.getTransitionDurationFromElement(this._element);o.default(this._element).one(d.TRANSITION_END,n).emulateTransitionEnd(i)}else n()}},e.hide=function(){if(this._element.classList.contains("show")){var t=o.default.Event("hide.bs.toast");o.default(this._element).trigger(t),t.isDefaultPrevented()||this._close()}},e.dispose=function(){this._clearTimeout(),this._element.classList.contains("show")&&this._element.classList.remove("show"),o.default(this._element).off("click.dismiss.bs.toast"),o.default.removeData(this._element,"bs.toast"),this._element=null,this._config=null},e._getConfig=function(t){return t=l({},pt,o.default(this._element).data(),"object"==typeof t&&t?t:{}),d.typeCheckConfig(ct,t,this.constructor.DefaultType),t},e._setListeners=function(){var t=this;o.default(this._element).on("click.dismiss.bs.toast",'[data-dismiss="toast"]',(function(){return t.hide()}))},e._close=function(){var t=this,e=function(){t._element.classList.add("hide"),o.default(t._element).trigger("hidden.bs.toast")};if(this._element.classList.remove("show"),this._config.animation){var n=d.getTransitionDurationFromElement(this._element);o.default(this._element).one(d.TRANSITION_END,e).emulateTransitionEnd(n)}else e()},e._clearTimeout=function(){clearTimeout(this._timeout),this._timeout=null},t._jQueryInterface=function(e){return this.each((function(){var n=o.default(this),i=n.data("bs.toast");if(i||(i=new t(this,"object"==typeof e&&e),n.data("bs.toast",i)),"string"==typeof e){if(void 0===i[e])throw new TypeError('No method named "'+e+'"');i[e](this)}}))},s(t,null,[{key:"VERSION",get:function(){return"4.6.1"}},{key:"DefaultType",get:function(){return mt}},{key:"Default",get:function(){return pt}}]),t}();o.default.fn[ct]=gt._jQueryInterface,o.default.fn[ct].Constructor=gt,o.default.fn[ct].noConflict=function(){return o.default.fn[ct]=ht,gt._jQueryInterface},t.Alert=h,t.Button=m,t.Carousel=E,t.Collapse=D,t.Dropdown=j,t.Modal=R,t.Popover=ot,t.Scrollspy=ut,t.Tab=dt,t.Toast=gt,t.Tooltip=G,t.Util=d,Object.defineProperty(t,"__esModule",{value:!0})}(e,n(0),n(1))},function(t,e){var n;n=function(){return this}();try{n=n||new Function("return this")()}catch(t){"object"==typeof window&&(n=window)}t.exports=n},function(t,e,n){"use strict";n.r(e);n(0),n(3),n.p;$((function(){var t=document.querySelector("div.bd-sidebar");let e=parseInt(sessionStorage.getItem("sidebar-scroll-top"),10);if(isNaN(e)){var n=document.getElementById("bd-docs-nav").querySelectorAll(".active");if(n.length>0){var i=n[n.length-1],o=i.getBoundingClientRect().y-t.getBoundingClientRect().y;if(i.getBoundingClientRect().y>.5*window.innerHeight){let e=.25;t.scrollTop=o-t.clientHeight*e,console.log("[PST]: Scrolled sidebar using last active link...")}}}else t.scrollTop=e,console.log("[PST]: Scrolled sidebar using stored browser position...");window.addEventListener("beforeunload",()=>{sessionStorage.setItem("sidebar-scroll-top",t.scrollTop)})})),$((function(){$(window).on("activate.bs.scrollspy",(function(){document.querySelectorAll("#bd-toc-nav a").forEach(t=>{t.parentElement.classList.remove("active")});document.querySelectorAll("#bd-toc-nav a.active").forEach(t=>{t.parentElement.classList.add("active")})}))}))}]); \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/scripts/sphinx-book-theme.js b/branch/sphinx-book-theme-old-copybutton/_static/scripts/sphinx-book-theme.js new file mode 100644 index 00000000..a8a305eb --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/scripts/sphinx-book-theme.js @@ -0,0 +1,2 @@ +!function(e){var t={};function n(o){if(t[o])return t[o].exports;var r=t[o]={i:o,l:!1,exports:{}};return e[o].call(r.exports,r,r.exports,n),r.l=!0,r.exports}n.m=e,n.c=t,n.d=function(e,t,o){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:o})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var o=Object.create(null);if(n.r(o),Object.defineProperty(o,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var r in e)n.d(o,r,function(t){return e[t]}.bind(null,r));return o},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=0)}([function(e,t,n){e.exports=n(1)},function(e,t,n){"use strict";n.r(t);n.p;var o=e=>{"loading"!=document.readyState?e():document.addEventListener?document.addEventListener("DOMContentLoaded",e):document.attachEvent("onreadystatechange",(function(){"complete"==document.readyState&&e()}))};window.initThebeSBT=()=>{var e=$("div.section h1")[0];$(e).next().hasClass("thebe-launch-button")||$("").insertAfter($(e)),initThebe()},window.printPdf=e=>{let t=$(e).attr("aria-describedby"),n=$("#"+t).detach();window.print(),$("body").append(n)},window.toggleFullScreen=()=>{var e=document.fullscreenElement&&null!==document.fullscreenElement||document.webkitFullscreenElement&&null!==document.webkitFullscreenElement;let t=document.documentElement;e?(console.log("[SBT]: Exiting full screen"),document.exitFullscreen?document.exitFullscreen():document.webkitExitFullscreen&&document.webkitExitFullscreen()):(console.log("[SBT]: Entering full screen"),t.requestFullscreen?t.requestFullscreen():t.webkitRequestFullscreen&&t.webkitRequestFullscreen())},o(()=>{$(document).ready((function(){$('[data-toggle="tooltip"]').tooltip({trigger:"hover",delay:{show:500,hide:100}})}))}),o(()=>{var e=document.getElementById("site-navigation"),t=e.querySelectorAll(".active"),n=t[t.length-1];void 0!==n&&n.offsetTop>.5*$(window).height()&&(e.scrollTop=n.offsetTop-.2*$(window).height())}),o(()=>{var e=[];let t=new IntersectionObserver((t,n)=>{t.forEach(t=>{if(t.isIntersecting)e.push(t.target);else for(let n=0;n0?$("div.bd-toc").removeClass("show"):$("div.bd-toc").addClass("show")});let n=[];["marginnote","sidenote","margin","margin-caption","full-width","sidebar","popout"].forEach(e=>{n.push("."+e,".tag_"+e,"."+e.replace("-","_"),".tag_"+e.replace("-","_"))}),document.querySelectorAll(n.join(", ")).forEach(e=>{t.observe(e)}),new IntersectionObserver((e,t)=>{e[0].boundingClientRect.y<0?document.body.classList.add("scrolled"):document.body.classList.remove("scrolled")}).observe(document.querySelector(".sbt-scroll-pixel-helper"))}),o((function(){new MutationObserver((e,t)=>{e.forEach(e=>{0!==e.addedNodes.length&&void 0!==e.addedNodes[0].data&&-1!=e.addedNodes[0].data.search("Inserted RTD Footer")&&e.addedNodes.forEach(e=>{document.getElementById("rtd-footer-container").append(e)})})}).observe(document.body,{childList:!0})}))}]); +//# sourceMappingURL=sphinx-book-theme.js.map \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/scripts/sphinx-book-theme.js.map b/branch/sphinx-book-theme-old-copybutton/_static/scripts/sphinx-book-theme.js.map new file mode 100644 index 00000000..dccd768e --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/scripts/sphinx-book-theme.js.map @@ -0,0 +1 @@ +{"version":3,"sources":["webpack:///webpack/bootstrap","webpack:///./src/sphinx_book_theme/assets/styles/index.scss","webpack:///./src/sphinx_book_theme/assets/scripts/index.js"],"names":["installedModules","__webpack_require__","moduleId","exports","module","i","l","modules","call","m","c","d","name","getter","o","Object","defineProperty","enumerable","get","r","Symbol","toStringTag","value","t","mode","__esModule","ns","create","key","bind","n","object","property","prototype","hasOwnProperty","p","s","sbRunWhenDOMLoaded","cb","document","readyState","addEventListener","attachEvent","window","initThebeSBT","title","$","next","hasClass","insertAfter","initThebe","printPdf","el","tooltipID","attr","tooltipTextDiv","detach","print","append","toggleFullScreen","isInFullScreen","fullscreenElement","webkitFullscreenElement","docElm","documentElement","console","log","exitFullscreen","webkitExitFullscreen","requestFullscreen","webkitRequestFullscreen","ready","tooltip","trigger","delay","show","hide","navbar","getElementById","active_pages","querySelectorAll","active_page","length","undefined","offsetTop","height","scrollTop","onScreenItems","tocObserver","IntersectionObserver","entries","observer","forEach","entry","isIntersecting","push","target","ii","splice","removeClass","addClass","marginSelector","replace","join","observe","boundingClientRect","y","body","classList","add","remove","querySelector","MutationObserver","mutationList","mutation","addedNodes","data","search","node","childList"],"mappings":"aACE,IAAIA,EAAmB,GAGvB,SAASC,EAAoBC,GAG5B,GAAGF,EAAiBE,GACnB,OAAOF,EAAiBE,GAAUC,QAGnC,IAAIC,EAASJ,EAAiBE,GAAY,CACzCG,EAAGH,EACHI,GAAG,EACHH,QAAS,IAUV,OANAI,EAAQL,GAAUM,KAAKJ,EAAOD,QAASC,EAAQA,EAAOD,QAASF,GAG/DG,EAAOE,GAAI,EAGJF,EAAOD,QAKfF,EAAoBQ,EAAIF,EAGxBN,EAAoBS,EAAIV,EAGxBC,EAAoBU,EAAI,SAASR,EAASS,EAAMC,GAC3CZ,EAAoBa,EAAEX,EAASS,IAClCG,OAAOC,eAAeb,EAASS,EAAM,CAAEK,YAAY,EAAMC,IAAKL,KAKhEZ,EAAoBkB,EAAI,SAAShB,GACX,oBAAXiB,QAA0BA,OAAOC,aAC1CN,OAAOC,eAAeb,EAASiB,OAAOC,YAAa,CAAEC,MAAO,WAE7DP,OAAOC,eAAeb,EAAS,aAAc,CAAEmB,OAAO,KAQvDrB,EAAoBsB,EAAI,SAASD,EAAOE,GAEvC,GADU,EAAPA,IAAUF,EAAQrB,EAAoBqB,IAC/B,EAAPE,EAAU,OAAOF,EACpB,GAAW,EAAPE,GAA8B,iBAAVF,GAAsBA,GAASA,EAAMG,WAAY,OAAOH,EAChF,IAAII,EAAKX,OAAOY,OAAO,MAGvB,GAFA1B,EAAoBkB,EAAEO,GACtBX,OAAOC,eAAeU,EAAI,UAAW,CAAET,YAAY,EAAMK,MAAOA,IACtD,EAAPE,GAA4B,iBAATF,EAAmB,IAAI,IAAIM,KAAON,EAAOrB,EAAoBU,EAAEe,EAAIE,EAAK,SAASA,GAAO,OAAON,EAAMM,IAAQC,KAAK,KAAMD,IAC9I,OAAOF,GAIRzB,EAAoB6B,EAAI,SAAS1B,GAChC,IAAIS,EAAST,GAAUA,EAAOqB,WAC7B,WAAwB,OAAOrB,EAAgB,SAC/C,WAA8B,OAAOA,GAEtC,OADAH,EAAoBU,EAAEE,EAAQ,IAAKA,GAC5BA,GAIRZ,EAAoBa,EAAI,SAASiB,EAAQC,GAAY,OAAOjB,OAAOkB,UAAUC,eAAe1B,KAAKuB,EAAQC,IAGzG/B,EAAoBkC,EAAI,GAIjBlC,EAAoBA,EAAoBmC,EAAI,G,sEClFtC,QCSXC,EAAsBC,IACG,WAAvBC,SAASC,WACXF,IACSC,SAASE,iBAClBF,SAASE,iBAAiB,mBAAoBH,GAE9CC,SAASG,YAAY,sBAAsB,WACd,YAAvBH,SAASC,YAA0BF,QAyM7CK,OAAOC,aAjDY,KACjB,IAAIC,EAAQC,EAAE,kBAAkB,GAC3BA,EAAED,GAAOE,OAAOC,SAAS,wBAC5BF,EAAE,iDAAiDG,YAAYH,EAAED,IAEnEK,aA6CFP,OAAOQ,SAhJSC,IAGd,IAAIC,EAAYP,EAAEM,GAAIE,KAAK,oBACvBC,EAAiBT,EAAE,IAAMO,GAAWG,SACxCb,OAAOc,QACPX,EAAE,QAAQY,OAAOH,IA2InBZ,OAAOgB,iBA/LgB,KACrB,IAAIC,EACDrB,SAASsB,mBAAoD,OAA/BtB,SAASsB,mBACvCtB,SAASuB,yBAC6B,OAArCvB,SAASuB,wBACb,IAAIC,EAASxB,SAASyB,gBACjBJ,GAQHK,QAAQC,IAAI,8BACR3B,SAAS4B,eACX5B,SAAS4B,iBACA5B,SAAS6B,sBAClB7B,SAAS6B,yBAXXH,QAAQC,IAAI,+BACRH,EAAOM,kBACTN,EAAOM,oBACEN,EAAOO,yBAChBP,EAAOO,4BAyLbjC,EA7CmB,KACjBS,EAAEP,UAAUgC,OAAM,WAChBzB,EAAE,2BAA2B0B,QAAQ,CACnCC,QAAS,QACTC,MAAO,CAAEC,KAAM,IAAKC,KAAM,YA0ChCvC,EAxKqB,KACnB,IAAIwC,EAAStC,SAASuC,eAAe,mBACjCC,EAAeF,EAAOG,iBAAiB,WACvCC,EAAcF,EAAaA,EAAaG,OAAS,QAGnCC,IAAhBF,GACAA,EAAYG,UAAiC,GAArBtC,EAAEH,QAAQ0C,WAElCR,EAAOS,UAAYL,EAAYG,UAAiC,GAArBtC,EAAEH,QAAQ0C,YAgKzDhD,EAjIkB,KAChB,IAAIkD,EAAgB,GACpB,IAkCIC,EAAc,IAAIC,qBAlCA,CAACC,EAASC,KAE9BD,EAAQE,QAASC,IACf,GAAIA,EAAMC,eAERP,EAAcQ,KAAKF,EAAMG,aAGzB,IAAK,IAAIC,EAAK,EAAGA,EAAKV,EAAcL,OAAQe,IAC1C,GAAIV,EAAcU,KAAQJ,EAAMG,OAAQ,CACtCT,EAAcW,OAAOD,EAAI,GACzB,SAOJV,EAAcL,OAAS,EACzBpC,EAAE,cAAcqD,YAAY,QAE5BrD,EAAE,cAAcsD,SAAS,UAwB7B,IAAIC,EAAiB,GATG,CACtB,aACA,WACA,SACA,iBACA,aACA,UACA,UAGcT,QAASK,IAEvBI,EAAeN,KAEX,IAAIE,EACJ,QAAQA,EACR,IAAIA,EAAGK,QAAQ,IAAK,KACpB,QAAQL,EAAGK,QAAQ,IAAK,QAI9B/D,SAASyC,iBAAiBqB,EAAeE,KAAK,OAAOX,QAASK,IAC5DT,EAAYgB,QAAQP,KAID,IAAIR,qBAtCO,CAACC,EAASC,KAEpCD,EAAQ,GAAGe,mBAAmBC,EAAI,EACpCnE,SAASoE,KAAKC,UAAUC,IAAI,YAE5BtE,SAASoE,KAAKC,UAAUE,OAAO,cAkCpBN,QAAQjE,SAASwE,cAAc,+BAiEhD1E,GApCA,WAkBmB,IAAI2E,iBAjBG,CAACC,EAActB,KACrCsB,EAAarB,QAASsB,IAEe,IAA/BA,EAASC,WAAWjC,aAGYC,IAAhC+B,EAASC,WAAW,GAAGC,OAGuC,GAA9DF,EAASC,WAAW,GAAGC,KAAKC,OAAO,wBACrCH,EAASC,WAAWvB,QAAS0B,IAC3B/E,SAASuC,eAAe,wBAAwBpB,OAAO4D,SAQtDd,QAAQjE,SAASoE,KADX,CAAEY,WAAW","file":"scripts/sphinx-book-theme.js","sourcesContent":[" \t// The module cache\n \tvar installedModules = {};\n\n \t// The require function\n \tfunction __webpack_require__(moduleId) {\n\n \t\t// Check if module is in cache\n \t\tif(installedModules[moduleId]) {\n \t\t\treturn installedModules[moduleId].exports;\n \t\t}\n \t\t// Create a new module (and put it into the cache)\n \t\tvar module = installedModules[moduleId] = {\n \t\t\ti: moduleId,\n \t\t\tl: false,\n \t\t\texports: {}\n \t\t};\n\n \t\t// Execute the module function\n \t\tmodules[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n \t\t// Flag the module as loaded\n \t\tmodule.l = true;\n\n \t\t// Return the exports of the module\n \t\treturn module.exports;\n \t}\n\n\n \t// expose the modules object (__webpack_modules__)\n \t__webpack_require__.m = modules;\n\n \t// expose the module cache\n \t__webpack_require__.c = installedModules;\n\n \t// define getter function for harmony exports\n \t__webpack_require__.d = function(exports, name, getter) {\n \t\tif(!__webpack_require__.o(exports, name)) {\n \t\t\tObject.defineProperty(exports, name, { enumerable: true, get: getter });\n \t\t}\n \t};\n\n \t// define __esModule on exports\n \t__webpack_require__.r = function(exports) {\n \t\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n \t\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n \t\t}\n \t\tObject.defineProperty(exports, '__esModule', { value: true });\n \t};\n\n \t// create a fake namespace object\n \t// mode & 1: value is a module id, require it\n \t// mode & 2: merge all properties of value into the ns\n \t// mode & 4: return value when already ns object\n \t// mode & 8|1: behave like require\n \t__webpack_require__.t = function(value, mode) {\n \t\tif(mode & 1) value = __webpack_require__(value);\n \t\tif(mode & 8) return value;\n \t\tif((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;\n \t\tvar ns = Object.create(null);\n \t\t__webpack_require__.r(ns);\n \t\tObject.defineProperty(ns, 'default', { enumerable: true, value: value });\n \t\tif(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));\n \t\treturn ns;\n \t};\n\n \t// getDefaultExport function for compatibility with non-harmony modules\n \t__webpack_require__.n = function(module) {\n \t\tvar getter = module && module.__esModule ?\n \t\t\tfunction getDefault() { return module['default']; } :\n \t\t\tfunction getModuleExports() { return module; };\n \t\t__webpack_require__.d(getter, 'a', getter);\n \t\treturn getter;\n \t};\n\n \t// Object.prototype.hasOwnProperty.call\n \t__webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };\n\n \t// __webpack_public_path__\n \t__webpack_require__.p = \"\";\n\n\n \t// Load entry module and return exports\n \treturn __webpack_require__(__webpack_require__.s = 0);\n","export default __webpack_public_path__ + \"styles/sphinx-book-theme.css\";","// Import CSS variables\n// ref: https://css-tricks.com/getting-javascript-to-talk-to-css-and-sass/\nimport \"../styles/index.scss\";\n\n/**\n * A helper function to load scripts when the DOM is loaded.\n * This waits for everything to be on the page first before running, since\n * some functionality doesn't behave properly until everything is ready.\n */\nvar sbRunWhenDOMLoaded = (cb) => {\n if (document.readyState != \"loading\") {\n cb();\n } else if (document.addEventListener) {\n document.addEventListener(\"DOMContentLoaded\", cb);\n } else {\n document.attachEvent(\"onreadystatechange\", function () {\n if (document.readyState == \"complete\") cb();\n });\n }\n};\n\n/**\n * Toggle full-screen with button\n *\n * There are some browser-specific hacks in here:\n * - Safari requires a `webkit` prefix, so this uses conditionals to check for that\n * ref: https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API\n */\nvar toggleFullScreen = () => {\n var isInFullScreen =\n (document.fullscreenElement && document.fullscreenElement !== null) ||\n (document.webkitFullscreenElement &&\n document.webkitFullscreenElement !== null);\n let docElm = document.documentElement;\n if (!isInFullScreen) {\n console.log(\"[SBT]: Entering full screen\");\n if (docElm.requestFullscreen) {\n docElm.requestFullscreen();\n } else if (docElm.webkitRequestFullscreen) {\n docElm.webkitRequestFullscreen();\n }\n } else {\n console.log(\"[SBT]: Exiting full screen\");\n if (document.exitFullscreen) {\n document.exitFullscreen();\n } else if (document.webkitExitFullscreen) {\n document.webkitExitFullscreen();\n }\n }\n};\n\n/**\n * Sidebar scroll on load.\n *\n * Detect the active page in the sidebar, and scroll so that it is centered on\n * the screen.\n */\nvar scrollToActive = () => {\n var navbar = document.getElementById(\"site-navigation\");\n var active_pages = navbar.querySelectorAll(\".active\");\n var active_page = active_pages[active_pages.length - 1];\n // Only scroll the navbar if the active link is lower than 50% of the page\n if (\n active_page !== undefined &&\n active_page.offsetTop > $(window).height() * 0.5\n ) {\n navbar.scrollTop = active_page.offsetTop - $(window).height() * 0.2;\n }\n};\n\n/**\n * Called when the \"print to PDF\" button is clicked.\n * This is a hack to prevent tooltips from showing up in the printed PDF.\n */\nvar printPdf = (el) => {\n // Detach the tooltip text from DOM to hide in PDF\n // and then reattach it for HTML\n let tooltipID = $(el).attr(\"aria-describedby\");\n let tooltipTextDiv = $(\"#\" + tooltipID).detach();\n window.print();\n $(\"body\").append(tooltipTextDiv);\n};\n\n/**\n * Manage scrolling behavior. This is primarily two things:\n *\n * 1. Hide the Table of Contents any time sidebar content is on the screen.\n *\n * This will be triggered any time a sidebar item enters or exits the screen.\n * It adds/removes items from an array if they have entered the screen, and\n * removes them when they exit the screen. It hides the TOC if anything is\n * on-screen.\n *\n * ref: https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API\n *\n * 2. Add a `scrolled` class to to trigger CSS changes.\n */\nvar initTocHide = () => {\n var onScreenItems = [];\n let hideTocCallback = (entries, observer) => {\n // Check whether any sidebar item is displayed\n entries.forEach((entry) => {\n if (entry.isIntersecting) {\n // If an element just came on screen, add it our list\n onScreenItems.push(entry.target);\n } else {\n // Otherwise, if it's in our list then remove it\n for (let ii = 0; ii < onScreenItems.length; ii++) {\n if (onScreenItems[ii] === entry.target) {\n onScreenItems.splice(ii, 1);\n break;\n }\n }\n }\n });\n\n // Hide the TOC if any margin content is displayed on the screen\n if (onScreenItems.length > 0) {\n $(\"div.bd-toc\").removeClass(\"show\");\n } else {\n $(\"div.bd-toc\").addClass(\"show\");\n }\n };\n let manageScrolledClassOnBody = (entries, observer) => {\n // The pixel is at the top, so if we're < 0 that it means we've scrolled\n if (entries[0].boundingClientRect.y < 0) {\n document.body.classList.add(\"scrolled\");\n } else {\n document.body.classList.remove(\"scrolled\");\n }\n };\n\n // Set up the intersection observer to watch all margin content\n let tocObserver = new IntersectionObserver(hideTocCallback);\n // TODO: deprecate popout after v0.5.0\n const selectorClasses = [\n \"marginnote\",\n \"sidenote\",\n \"margin\",\n \"margin-caption\",\n \"full-width\",\n \"sidebar\",\n \"popout\",\n ];\n let marginSelector = [];\n selectorClasses.forEach((ii) => {\n // Use three permutations of each class name because `tag_` and `_` used to be supported\n marginSelector.push(\n ...[\n `.${ii}`,\n `.tag_${ii}`,\n `.${ii.replace(\"-\", \"_\")}`,\n `.tag_${ii.replace(\"-\", \"_\")}`,\n ]\n );\n });\n document.querySelectorAll(marginSelector.join(\", \")).forEach((ii) => {\n tocObserver.observe(ii);\n });\n\n // Set up the observer to check if we've scrolled from top of page\n let scrollObserver = new IntersectionObserver(manageScrolledClassOnBody);\n scrollObserver.observe(document.querySelector(\".sbt-scroll-pixel-helper\"));\n};\n\n/**\n * Activate Thebe with a custom button click.\n */\nvar initThebeSBT = () => {\n var title = $(\"div.section h1\")[0];\n if (!$(title).next().hasClass(\"thebe-launch-button\")) {\n $(\"\").insertAfter($(title));\n }\n initThebe();\n};\n\n/**\n * Use Bootstrap helper function to enable tooltips.\n */\nvar initTooltips = () => {\n $(document).ready(function () {\n $('[data-toggle=\"tooltip\"]').tooltip({\n trigger: \"hover\",\n delay: { show: 500, hide: 100 },\n });\n });\n};\n\n/**\n * MutationObserver to move the ReadTheDocs button\n */\nfunction initRTDObserver() {\n const mutatedCallback = (mutationList, observer) => {\n mutationList.forEach((mutation) => {\n // Check whether the mutation is for RTD, which will have a specific structure\n if (mutation.addedNodes.length === 0) {\n return;\n }\n if (mutation.addedNodes[0].data === undefined) {\n return;\n }\n if (mutation.addedNodes[0].data.search(\"Inserted RTD Footer\") != -1) {\n mutation.addedNodes.forEach((node) => {\n document.getElementById(\"rtd-footer-container\").append(node);\n });\n }\n });\n };\n\n const observer = new MutationObserver(mutatedCallback);\n const config = { childList: true };\n observer.observe(document.body, config);\n}\n\n/**\n * Set up callback functions for UI click actions\n */\nwindow.initThebeSBT = initThebeSBT;\nwindow.printPdf = printPdf;\nwindow.toggleFullScreen = toggleFullScreen;\n\n/**\n * Set up functions to load when the DOM is ready\n */\nsbRunWhenDOMLoaded(initTooltips);\nsbRunWhenDOMLoaded(scrollToActive);\nsbRunWhenDOMLoaded(initTocHide);\nsbRunWhenDOMLoaded(initRTDObserver);\n"],"sourceRoot":""} \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/searchtools.js b/branch/sphinx-book-theme-old-copybutton/_static/searchtools.js new file mode 100644 index 00000000..0a44e858 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/searchtools.js @@ -0,0 +1,525 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +if (!Scorer) { + /** + * Simple result scoring code. + */ + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [filename, title, anchor, descr, score] + // and returns the new score. + /* + score: function(result) { + return result[4]; + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: {0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5}, // used to be unimportantResults + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2 + }; +} + +if (!splitQuery) { + function splitQuery(query) { + return query.split(/\s+/); + } +} + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + htmlToText : function(htmlString) { + var virtualDocument = document.implementation.createHTMLDocument('virtual'); + var htmlElement = $(htmlString, virtualDocument); + htmlElement.find('.headerlink').remove(); + docContent = htmlElement.find('[role=main]')[0]; + if(docContent === undefined) { + console.warn("Content block not found. Sphinx search tries to obtain it " + + "via '[role=main]'. Could you check your theme or template."); + return ""; + } + return docContent.textContent || docContent.innerText; + }, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, + dataType: "script", cache: true, + complete: function(jqxhr, textstatus) { + if (textstatus != "success") { + document.getElementById("searchindexloader").src = url; + } + }}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + var i; + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + } + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

' + _('Searching') + '

').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

 

').appendTo(this.out); + this.output = $('
    ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query : function(query) { + var i; + + // stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = splitQuery(query); + var objectterms = []; + for (i = 0; i < tmp.length; i++) { + if (tmp[i] !== "") { + objectterms.push(tmp[i].toLowerCase()); + } + + if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") { + // skip this "word" + continue; + } + // stem the word + var word = stemmer.stemWord(tmp[i].toLowerCase()); + var toAppend; + // select the correct list + if (word[0] == '-') { + toAppend = excluded; + word = word.substr(1); + } + else { + toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$u.contains(toAppend, word)) + toAppend.push(word); + } + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + // console.debug('SEARCH: searching for:'); + // console.info('required: ', searchterms); + // console.info('excluded: ', excluded); + + // prepare search + var terms = this._index.terms; + var titleterms = this._index.titleterms; + + // array of [filename, title, anchor, descr, score] + var results = []; + $('#search-progress').empty(); + + // lookup as object + for (i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0, i), + objectterms.slice(i+1, objectterms.length)); + results = results.concat(this.performObjectSearch(objectterms[i], others)); + } + + // lookup as search terms in fulltext + results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + for (i = 0; i < results.length; i++) + results[i][4] = Scorer.score(results[i]); + } + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort(function(a, b) { + var left = a[4]; + var right = b[4]; + if (left > right) { + return 1; + } else if (left < right) { + return -1; + } else { + // same score: sort alphabetically + left = a[1].toLowerCase(); + right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + } + }); + + // for debugging + //Search.lastresults = results.slice(); // a copy + //console.info('search results:', Search.lastresults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
  • '); + var requestUrl = ""; + var linkUrl = ""; + if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') { + // dirhtml builder + var dirname = item[0] + '/'; + if (dirname.match(/\/index\/$/)) { + dirname = dirname.substring(0, dirname.length-6); + } else if (dirname == 'index/') { + dirname = ''; + } + requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname; + linkUrl = requestUrl; + + } else { + // normal html builders + requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; + linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; + } + listItem.append($('').attr('href', + linkUrl + + highlightstring + item[2]).html(item[1])); + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + setTimeout(function() { + displayNextItem(); + }, 5); + } else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) { + $.ajax({url: requestUrl, + dataType: "text", + complete: function(jqxhr, textstatus) { + var data = jqxhr.responseText; + if (data !== '' && data !== undefined) { + var summary = Search.makeSearchSummary(data, searchterms, hlterms); + if (summary) { + listItem.append(summary); + } + } + Search.output.append(listItem); + setTimeout(function() { + displayNextItem(); + }, 5); + }}); + } else { + // just display title + Search.output.append(listItem); + setTimeout(function() { + displayNextItem(); + }, 5); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + }, + + /** + * search for object names + */ + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var docnames = this._index.docnames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var i; + var results = []; + + for (var prefix in objects) { + for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) { + var match = objects[prefix][iMatch]; + var name = match[4]; + var fullname = (prefix ? prefix + '.' : '') + name; + var fullnameLower = fullname.toLowerCase() + if (fullnameLower.indexOf(object) > -1) { + var score = 0; + var parts = fullnameLower.split('.'); + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower == object || parts[parts.length - 1] == object) { + score += Scorer.objNameMatch; + // matches in last name + } else if (parts[parts.length - 1].indexOf(object) > -1) { + score += Scorer.objPartialMatch; + } + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + + var anchor = match[3]; + if (anchor === '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) { + score += Scorer.objPrio[match[2]]; + } else { + score += Scorer.objPrioDefault; + } + results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]); + } + } + } + + return results; + }, + + /** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions + */ + escapeRegExp : function(string) { + return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch : function(searchterms, excluded, terms, titleterms) { + var docnames = this._index.docnames; + var filenames = this._index.filenames; + var titles = this._index.titles; + + var i, j, file; + var fileMap = {}; + var scoreMap = {}; + var results = []; + + // perform the search on the required terms + for (i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + var files = []; + var _o = [ + {files: terms[word], score: Scorer.term}, + {files: titleterms[word], score: Scorer.title} + ]; + // add support for partial matches + if (word.length > 2) { + var word_regex = this.escapeRegExp(word); + for (var w in terms) { + if (w.match(word_regex) && !terms[word]) { + _o.push({files: terms[w], score: Scorer.partialTerm}) + } + } + for (var w in titleterms) { + if (w.match(word_regex) && !titleterms[word]) { + _o.push({files: titleterms[w], score: Scorer.partialTitle}) + } + } + } + + // no match but word was a required one + if ($u.every(_o, function(o){return o.files === undefined;})) { + break; + } + // found search word in contents + $u.each(_o, function(o) { + var _files = o.files; + if (_files === undefined) + return + + if (_files.length === undefined) + _files = [_files]; + files = files.concat(_files); + + // set score for the word in each file to Scorer.term + for (j = 0; j < _files.length; j++) { + file = _files[j]; + if (!(file in scoreMap)) + scoreMap[file] = {}; + scoreMap[file][word] = o.score; + } + }); + + // create the mapping + for (j = 0; j < files.length; j++) { + file = files[j]; + if (file in fileMap && fileMap[file].indexOf(word) === -1) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (file in fileMap) { + var valid = true; + + // check if all requirements are matched + var filteredTermCount = // as search terms with length < 3 are discarded: ignore + searchterms.filter(function(term){return term.length > 2}).length + if ( + fileMap[file].length != searchterms.length && + fileMap[file].length != filteredTermCount + ) continue; + + // ensure that none of the excluded terms is in the search result + for (i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + titleterms[excluded[i]] == file || + $u.contains(terms[excluded[i]] || [], file) || + $u.contains(titleterms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it to the result list + if (valid) { + // select one (max) score for the file. + // for better ranking, we should calculate ranking by using words statistics like basic tf-idf... + var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]})); + results.push([docnames[file], titles[file], '', null, score, filenames[file]]); + } + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurrence, the + * latter for highlighting it. + */ + makeSearchSummary : function(htmlText, keywords, hlwords) { + var text = Search.htmlToText(htmlText); + if (text == "") { + return null; + } + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('

    ').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlighted'); + }); + return rv; + } +}; + +$(document).ready(function() { + Search.init(); +}); diff --git a/branch/sphinx-book-theme-old-copybutton/_static/sphinx_lesson.css b/branch/sphinx-book-theme-old-copybutton/_static/sphinx_lesson.css new file mode 100644 index 00000000..14b20c64 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/sphinx_lesson.css @@ -0,0 +1,51 @@ +/* sphinx_lesson.css */ + +body.wy-body-for-nav img.with-border { + border: 2px solid; +} + +.rst-content .admonition-no-content { + padding-bottom: 0px; +} + +.rst-content .demo > .admonition-title::before { + content: "\01F440"; /* Eyes */ } +.rst-content .type-along > .admonition-title::before { + content: "\02328\0FE0F"; /* Keyboard */ } +.rst-content .exercise > .admonition-title::before { + content: "\0270D\0FE0F"; /* Hand */ } +.rst-content .solution > .admonition-title::before { + content: "\02714\0FE0E"; /* Check mark */ } +.rst-content .homework > .admonition-title::before { + content: "\01F4DD"; /* Memo */ } +.rst-content .discussion > .admonition-title::before { + content: "\01F4AC"; /* Speech balloon */ } +.rst-content .questions > .admonition-title::before { + content: "\02753\0FE0E"; /* Question mark */ } +.rst-content .prerequisites > .admonition-title::before { + content: "\02699"; /* Gear */ } +.rst-content .seealso > .admonition-title::before { + content: "\027A1\0FE0E"; /* Question mark */ } + + +/* instructor-note */ +.rst-content .instructor-note { + background: #e7e7e7; +} +.rst-content .instructor-note > .admonition-title { + background: #6a6a6a; +} +.rst-content .instructor-note > .admonition-title::before { + content: ""; +} + + +/* sphinx_toggle_button, make the font white */ +.rst-content .toggle.admonition button.toggle-button { + color: white; +} + +/* sphinx-togglebutton, remove underflow when toggled to hidden mode */ +.rst-content .admonition.toggle-hidden { + padding-bottom: 0px; +} diff --git a/branch/sphinx-book-theme-old-copybutton/_static/sphinx_rtd_theme_ext_color_contrast.css b/branch/sphinx-book-theme-old-copybutton/_static/sphinx_rtd_theme_ext_color_contrast.css new file mode 100644 index 00000000..e68feb82 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/sphinx_rtd_theme_ext_color_contrast.css @@ -0,0 +1,47 @@ +/* The following are for web accessibility of sphinx_rtd_theme: they + * solve some of the most frequent contrast issues. Remove when this + * solved: + * https://github.com/readthedocs/sphinx_rtd_theme/issues/971 + */ +/* background: #fcfcfc, note boxes #E7F2FA */ +a { color: #2573A7; } /* original #2980B9, #1F5C84; */ +body { color: #242424; } /* original #404040, #383838 */ +.wy-side-nav-search>a, .wy-side-nav-search .wy-dropdown>a { + color: #ffffff; +} /* original #fcfcfc */ +footer { color: #737373; } /* original gray=#808080*/ +footer span.commit code, footer span.commit .rst-content tt, .rst-content footer span.commit tt { + color: #737373; +} /* original gray=#808080*/ +.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal { + color: #AB2314; +} +/* Sidebar background */ +.wy-side-nav-search { background-color: #277CB4;} + +/* Same, but for pygments */ +.highlight .ch { color: #3E7A89; } /* #! line */ +.highlight .c1 { color: #3E7A89; } /* also comments */ +.highlight .nv { color: #AD3ECC; } /* variable */ +.highlight .gp { color: #B45608; } /* prompt character, $*/ +.highlight .si { color: #3975B1; } /* ${} variable text */ +.highlight .nc { color: #0C78A7; } + +/* Sphinx admonitions */ +/* warning */ +.wy-alert.wy-alert-warning .wy-alert-title, .rst-content .wy-alert-warning.note .wy-alert-title, .rst-content .attention .wy-alert-title, .rst-content .caution .wy-alert-title, .rst-content .wy-alert-warning.danger .wy-alert-title, .rst-content .wy-alert-warning.error .wy-alert-title, .rst-content .wy-alert-warning.hint .wy-alert-title, .rst-content .wy-alert-warning.important .wy-alert-title, .rst-content .wy-alert-warning.tip .wy-alert-title, .rst-content .warning .wy-alert-title, .rst-content .wy-alert-warning.seealso .wy-alert-title, .rst-content .admonition-todo .wy-alert-title, .rst-content .wy-alert-warning.admonition .wy-alert-title, .wy-alert.wy-alert-warning .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-warning .admonition-title, .rst-content .wy-alert-warning.note .admonition-title, .rst-content .attention .admonition-title, .rst-content .caution .admonition-title, .rst-content .wy-alert-warning.danger .admonition-title, .rst-content .wy-alert-warning.error .admonition-title, .rst-content .wy-alert-warning.hint .admonition-title, .rst-content .wy-alert-warning.important .admonition-title, .rst-content .wy-alert-warning.tip .admonition-title, .rst-content .warning .admonition-title, .rst-content .wy-alert-warning.seealso .admonition-title, .rst-content .admonition-todo .admonition-title, .rst-content .wy-alert-warning.admonition .admonition-title { + background: #B15E16; } +/* important */ +.wy-alert.wy-alert-success .wy-alert-title, .rst-content .wy-alert-success.note .wy-alert-title, .rst-content .wy-alert-success.attention .wy-alert-title, .rst-content .wy-alert-success.caution .wy-alert-title, .rst-content .wy-alert-success.danger .wy-alert-title, .rst-content .wy-alert-success.error .wy-alert-title, .rst-content .hint .wy-alert-title, .rst-content .important .wy-alert-title, .rst-content .tip .wy-alert-title, .rst-content .wy-alert-success.warning .wy-alert-title, .rst-content .wy-alert-success.seealso .wy-alert-title, .rst-content .wy-alert-success.admonition-todo .wy-alert-title, .rst-content .wy-alert-success.admonition .wy-alert-title, .wy-alert.wy-alert-success .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-success .admonition-title, .rst-content .wy-alert-success.note .admonition-title, .rst-content .wy-alert-success.attention .admonition-title, .rst-content .wy-alert-success.caution .admonition-title, .rst-content .wy-alert-success.danger .admonition-title, .rst-content .wy-alert-success.error .admonition-title, .rst-content .hint .admonition-title, .rst-content .important .admonition-title, .rst-content .tip .admonition-title, .rst-content .wy-alert-success.warning .admonition-title, .rst-content .wy-alert-success.seealso .admonition-title, .rst-content .wy-alert-success.admonition-todo .admonition-title, .rst-content .wy-alert-success.admonition .admonition-title { + background: #12826C; } +/* seealso, note, etc */ +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition .admonition-title { + background: #277CB4; } +/* error, danger */ +.rst-content .danger .admonition-title, .rst-content .danger .wy-alert-title, .rst-content .error .admonition-title, .rst-content .error .wy-alert-title, .rst-content .wy-alert-danger.admonition-todo .admonition-title, .rst-content .wy-alert-danger.admonition-todo .wy-alert-title, .rst-content .wy-alert-danger.admonition .admonition-title, .rst-content .wy-alert-danger.admonition .wy-alert-title, .rst-content .wy-alert-danger.attention .admonition-title, .rst-content .wy-alert-danger.attention .wy-alert-title, .rst-content .wy-alert-danger.caution .admonition-title, .rst-content .wy-alert-danger.caution .wy-alert-title, .rst-content .wy-alert-danger.hint .admonition-title, .rst-content .wy-alert-danger.hint .wy-alert-title, .rst-content .wy-alert-danger.important .admonition-title, .rst-content .wy-alert-danger.important .wy-alert-title, .rst-content .wy-alert-danger.note .admonition-title, .rst-content .wy-alert-danger.note .wy-alert-title, .rst-content .wy-alert-danger.seealso .admonition-title, .rst-content .wy-alert-danger.seealso .wy-alert-title, .rst-content .wy-alert-danger.tip .admonition-title, .rst-content .wy-alert-danger.tip .wy-alert-title, .rst-content .wy-alert-danger.warning .admonition-title, .rst-content .wy-alert-danger.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-danger .admonition-title, .wy-alert.wy-alert-danger .rst-content .admonition-title, .wy-alert.wy-alert-danger .wy-alert-title { + background: #e31704; +} + +/* Generic admonition titles */ +.wy-alert-title, .rst-content .admonition-title { + background: #277CB4; } diff --git a/branch/sphinx-book-theme-old-copybutton/_static/styles/pydata-sphinx-theme.css b/branch/sphinx-book-theme-old-copybutton/_static/styles/pydata-sphinx-theme.css new file mode 100644 index 00000000..cad32211 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/styles/pydata-sphinx-theme.css @@ -0,0 +1,6 @@ +/*! + * Bootstrap v4.6.1 (https://getbootstrap.com/) + * Copyright 2011-2021 The Bootstrap Authors + * Copyright 2011-2021 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + */:root{--blue:#007bff;--indigo:#6610f2;--purple:#6f42c1;--pink:#e83e8c;--red:#dc3545;--orange:#fd7e14;--yellow:#ffc107;--green:#28a745;--teal:#20c997;--cyan:#17a2b8;--white:#fff;--gray:#6c757d;--gray-dark:#343a40;--primary:#007bff;--secondary:#6c757d;--success:#28a745;--info:#17a2b8;--warning:#ffc107;--danger:#dc3545;--light:#f8f9fa;--dark:#343a40;--breakpoint-xs:0;--breakpoint-sm:540px;--breakpoint-md:720px;--breakpoint-lg:960px;--breakpoint-xl:1200px;--font-family-sans-serif:-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";--font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace}*,:after,:before{box-sizing:border-box}html{font-family:sans-serif;line-height:1.15;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:rgba(0,0,0,0)}article,aside,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}body{margin:0;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,Liberation Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;font-size:1rem;line-height:1.5;color:#212529;text-align:left}[tabindex="-1"]:focus:not(:focus-visible){outline:0!important}hr{box-sizing:content-box;height:0;overflow:visible}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem}p{margin-top:0;margin-bottom:1rem}abbr[data-original-title],abbr[title]{text-decoration:underline;text-decoration:underline dotted;cursor:help;border-bottom:0;text-decoration-skip-ink:none}address{font-style:normal;line-height:inherit}address,dl,ol,ul{margin-bottom:1rem}dl,ol,ul{margin-top:0}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#007bff;background-color:transparent}a:hover{color:#0056b3}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:1em}pre{margin-top:0;margin-bottom:1rem;overflow:auto;-ms-overflow-style:scrollbar}figure{margin:0 0 1rem}img{border-style:none}img,svg{vertical-align:middle}svg{overflow:hidden}table{border-collapse:collapse}caption{padding-top:.75rem;padding-bottom:.75rem;color:#6c757d;text-align:left;caption-side:bottom}th{text-align:inherit;text-align:-webkit-match-parent}label{display:inline-block;margin-bottom:.5rem}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,input{overflow:visible}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{padding:0;border-style:none}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0}textarea{overflow:auto;resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;max-width:100%;padding:0;margin-bottom:.5rem;font-size:1.5rem;line-height:inherit;color:inherit;white-space:normal}progress{vertical-align:baseline}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:none}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}summary{display:list-item;cursor:pointer}template{display:none}[hidden]{display:none!important}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{margin-bottom:.5rem;font-weight:500;line-height:1.2}.h1,h1{font-size:2.5rem}.h2,h2{font-size:2rem}.h3,h3{font-size:1.75rem}.h4,h4{font-size:1.5rem}.h5,h5{font-size:1.25rem}.h6,h6{font-size:1rem}.lead{font-size:1.25rem;font-weight:300}.display-1{font-size:6rem}.display-1,.display-2{font-weight:300;line-height:1.2}.display-2{font-size:5.5rem}.display-3{font-size:4.5rem}.display-3,.display-4{font-weight:300;line-height:1.2}.display-4{font-size:3.5rem}hr{margin-top:1rem;margin-bottom:1rem;border-top:1px solid rgba(0,0,0,.1)}.small,small{font-size:80%;font-weight:400}.mark,mark{padding:.2em;background-color:#fcf8e3}.list-inline,.list-unstyled{padding-left:0;list-style:none}.list-inline-item{display:inline-block}.list-inline-item:not(:last-child){margin-right:.5rem}.initialism{font-size:90%;text-transform:uppercase}.blockquote{margin-bottom:1rem;font-size:1.25rem}.blockquote-footer{display:block;font-size:80%;color:#6c757d}.blockquote-footer:before{content:"\2014\00A0"}.img-fluid,.img-thumbnail{max-width:100%;height:auto}.img-thumbnail{padding:.25rem;background-color:#fff;border:1px solid #dee2e6;border-radius:.25rem}.figure{display:inline-block}.figure-img{margin-bottom:.5rem;line-height:1}.figure-caption{font-size:90%;color:#6c757d}code{font-size:87.5%;color:#e83e8c;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:87.5%;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:100%;font-weight:700}pre{display:block;font-size:87.5%;color:#212529}pre code{font-size:inherit;color:inherit;word-break:normal}.pre-scrollable{max-height:340px;overflow-y:scroll}.container,.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{width:100%;padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width:540px){.container,.container-sm{max-width:540px}}@media (min-width:720px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width:960px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width:1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1400px}}.row{display:flex;flex-wrap:wrap;margin-right:-15px;margin-left:-15px}.no-gutters{margin-right:0;margin-left:0}.no-gutters>.col,.no-gutters>[class*=col-]{padding-right:0;padding-left:0}.col,.col-1,.col-2,.col-3,.col-4,.col-5,.col-6,.col-7,.col-8,.col-9,.col-10,.col-11,.col-12,.col-auto,.col-lg,.col-lg-1,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-auto,.col-md,.col-md-1,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-10,.col-md-11,.col-md-12,.col-md-auto,.col-sm,.col-sm-1,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-auto{position:relative;width:100%;padding-right:15px;padding-left:15px}.col{flex-basis:0;flex-grow:1;max-width:100%}.row-cols-1>*{flex:0 0 100%;max-width:100%}.row-cols-2>*{flex:0 0 50%;max-width:50%}.row-cols-3>*{flex:0 0 33.33333%;max-width:33.33333%}.row-cols-4>*{flex:0 0 25%;max-width:25%}.row-cols-5>*{flex:0 0 20%;max-width:20%}.row-cols-6>*{flex:0 0 16.66667%;max-width:16.66667%}.col-auto{flex:0 0 auto;width:auto;max-width:100%}.col-1{flex:0 0 8.33333%;max-width:8.33333%}.col-2{flex:0 0 16.66667%;max-width:16.66667%}.col-3{flex:0 0 25%;max-width:25%}.col-4{flex:0 0 33.33333%;max-width:33.33333%}.col-5{flex:0 0 41.66667%;max-width:41.66667%}.col-6{flex:0 0 50%;max-width:50%}.col-7{flex:0 0 58.33333%;max-width:58.33333%}.col-8{flex:0 0 66.66667%;max-width:66.66667%}.col-9{flex:0 0 75%;max-width:75%}.col-10{flex:0 0 83.33333%;max-width:83.33333%}.col-11{flex:0 0 91.66667%;max-width:91.66667%}.col-12{flex:0 0 100%;max-width:100%}.order-first{order:-1}.order-last{order:13}.order-0{order:0}.order-1{order:1}.order-2{order:2}.order-3{order:3}.order-4{order:4}.order-5{order:5}.order-6{order:6}.order-7{order:7}.order-8{order:8}.order-9{order:9}.order-10{order:10}.order-11{order:11}.order-12{order:12}.offset-1{margin-left:8.33333%}.offset-2{margin-left:16.66667%}.offset-3{margin-left:25%}.offset-4{margin-left:33.33333%}.offset-5{margin-left:41.66667%}.offset-6{margin-left:50%}.offset-7{margin-left:58.33333%}.offset-8{margin-left:66.66667%}.offset-9{margin-left:75%}.offset-10{margin-left:83.33333%}.offset-11{margin-left:91.66667%}@media (min-width:540px){.col-sm{flex-basis:0;flex-grow:1;max-width:100%}.row-cols-sm-1>*{flex:0 0 100%;max-width:100%}.row-cols-sm-2>*{flex:0 0 50%;max-width:50%}.row-cols-sm-3>*{flex:0 0 33.33333%;max-width:33.33333%}.row-cols-sm-4>*{flex:0 0 25%;max-width:25%}.row-cols-sm-5>*{flex:0 0 20%;max-width:20%}.row-cols-sm-6>*{flex:0 0 16.66667%;max-width:16.66667%}.col-sm-auto{flex:0 0 auto;width:auto;max-width:100%}.col-sm-1{flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{flex:0 0 25%;max-width:25%}.col-sm-4{flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{flex:0 0 50%;max-width:50%}.col-sm-7{flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{flex:0 0 75%;max-width:75%}.col-sm-10{flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{flex:0 0 100%;max-width:100%}.order-sm-first{order:-1}.order-sm-last{order:13}.order-sm-0{order:0}.order-sm-1{order:1}.order-sm-2{order:2}.order-sm-3{order:3}.order-sm-4{order:4}.order-sm-5{order:5}.order-sm-6{order:6}.order-sm-7{order:7}.order-sm-8{order:8}.order-sm-9{order:9}.order-sm-10{order:10}.order-sm-11{order:11}.order-sm-12{order:12}.offset-sm-0{margin-left:0}.offset-sm-1{margin-left:8.33333%}.offset-sm-2{margin-left:16.66667%}.offset-sm-3{margin-left:25%}.offset-sm-4{margin-left:33.33333%}.offset-sm-5{margin-left:41.66667%}.offset-sm-6{margin-left:50%}.offset-sm-7{margin-left:58.33333%}.offset-sm-8{margin-left:66.66667%}.offset-sm-9{margin-left:75%}.offset-sm-10{margin-left:83.33333%}.offset-sm-11{margin-left:91.66667%}}@media (min-width:720px){.col-md{flex-basis:0;flex-grow:1;max-width:100%}.row-cols-md-1>*{flex:0 0 100%;max-width:100%}.row-cols-md-2>*{flex:0 0 50%;max-width:50%}.row-cols-md-3>*{flex:0 0 33.33333%;max-width:33.33333%}.row-cols-md-4>*{flex:0 0 25%;max-width:25%}.row-cols-md-5>*{flex:0 0 20%;max-width:20%}.row-cols-md-6>*{flex:0 0 16.66667%;max-width:16.66667%}.col-md-auto{flex:0 0 auto;width:auto;max-width:100%}.col-md-1{flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{flex:0 0 25%;max-width:25%}.col-md-4{flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{flex:0 0 50%;max-width:50%}.col-md-7{flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{flex:0 0 75%;max-width:75%}.col-md-10{flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{flex:0 0 100%;max-width:100%}.order-md-first{order:-1}.order-md-last{order:13}.order-md-0{order:0}.order-md-1{order:1}.order-md-2{order:2}.order-md-3{order:3}.order-md-4{order:4}.order-md-5{order:5}.order-md-6{order:6}.order-md-7{order:7}.order-md-8{order:8}.order-md-9{order:9}.order-md-10{order:10}.order-md-11{order:11}.order-md-12{order:12}.offset-md-0{margin-left:0}.offset-md-1{margin-left:8.33333%}.offset-md-2{margin-left:16.66667%}.offset-md-3{margin-left:25%}.offset-md-4{margin-left:33.33333%}.offset-md-5{margin-left:41.66667%}.offset-md-6{margin-left:50%}.offset-md-7{margin-left:58.33333%}.offset-md-8{margin-left:66.66667%}.offset-md-9{margin-left:75%}.offset-md-10{margin-left:83.33333%}.offset-md-11{margin-left:91.66667%}}@media (min-width:960px){.col-lg{flex-basis:0;flex-grow:1;max-width:100%}.row-cols-lg-1>*{flex:0 0 100%;max-width:100%}.row-cols-lg-2>*{flex:0 0 50%;max-width:50%}.row-cols-lg-3>*{flex:0 0 33.33333%;max-width:33.33333%}.row-cols-lg-4>*{flex:0 0 25%;max-width:25%}.row-cols-lg-5>*{flex:0 0 20%;max-width:20%}.row-cols-lg-6>*{flex:0 0 16.66667%;max-width:16.66667%}.col-lg-auto{flex:0 0 auto;width:auto;max-width:100%}.col-lg-1{flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{flex:0 0 25%;max-width:25%}.col-lg-4{flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{flex:0 0 50%;max-width:50%}.col-lg-7{flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{flex:0 0 75%;max-width:75%}.col-lg-10{flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{flex:0 0 100%;max-width:100%}.order-lg-first{order:-1}.order-lg-last{order:13}.order-lg-0{order:0}.order-lg-1{order:1}.order-lg-2{order:2}.order-lg-3{order:3}.order-lg-4{order:4}.order-lg-5{order:5}.order-lg-6{order:6}.order-lg-7{order:7}.order-lg-8{order:8}.order-lg-9{order:9}.order-lg-10{order:10}.order-lg-11{order:11}.order-lg-12{order:12}.offset-lg-0{margin-left:0}.offset-lg-1{margin-left:8.33333%}.offset-lg-2{margin-left:16.66667%}.offset-lg-3{margin-left:25%}.offset-lg-4{margin-left:33.33333%}.offset-lg-5{margin-left:41.66667%}.offset-lg-6{margin-left:50%}.offset-lg-7{margin-left:58.33333%}.offset-lg-8{margin-left:66.66667%}.offset-lg-9{margin-left:75%}.offset-lg-10{margin-left:83.33333%}.offset-lg-11{margin-left:91.66667%}}@media (min-width:1200px){.col-xl{flex-basis:0;flex-grow:1;max-width:100%}.row-cols-xl-1>*{flex:0 0 100%;max-width:100%}.row-cols-xl-2>*{flex:0 0 50%;max-width:50%}.row-cols-xl-3>*{flex:0 0 33.33333%;max-width:33.33333%}.row-cols-xl-4>*{flex:0 0 25%;max-width:25%}.row-cols-xl-5>*{flex:0 0 20%;max-width:20%}.row-cols-xl-6>*{flex:0 0 16.66667%;max-width:16.66667%}.col-xl-auto{flex:0 0 auto;width:auto;max-width:100%}.col-xl-1{flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{flex:0 0 25%;max-width:25%}.col-xl-4{flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{flex:0 0 50%;max-width:50%}.col-xl-7{flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{flex:0 0 75%;max-width:75%}.col-xl-10{flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{flex:0 0 100%;max-width:100%}.order-xl-first{order:-1}.order-xl-last{order:13}.order-xl-0{order:0}.order-xl-1{order:1}.order-xl-2{order:2}.order-xl-3{order:3}.order-xl-4{order:4}.order-xl-5{order:5}.order-xl-6{order:6}.order-xl-7{order:7}.order-xl-8{order:8}.order-xl-9{order:9}.order-xl-10{order:10}.order-xl-11{order:11}.order-xl-12{order:12}.offset-xl-0{margin-left:0}.offset-xl-1{margin-left:8.33333%}.offset-xl-2{margin-left:16.66667%}.offset-xl-3{margin-left:25%}.offset-xl-4{margin-left:33.33333%}.offset-xl-5{margin-left:41.66667%}.offset-xl-6{margin-left:50%}.offset-xl-7{margin-left:58.33333%}.offset-xl-8{margin-left:66.66667%}.offset-xl-9{margin-left:75%}.offset-xl-10{margin-left:83.33333%}.offset-xl-11{margin-left:91.66667%}}.table{width:100%;margin-bottom:1rem;color:#212529}.table td,.table th{padding:.75rem;vertical-align:top;border-top:1px solid #dee2e6}.table thead th{vertical-align:bottom;border-bottom:2px solid #dee2e6}.table tbody+tbody{border-top:2px solid #dee2e6}.table-sm td,.table-sm th{padding:.3rem}.table-bordered,.table-bordered td,.table-bordered th{border:1px solid #dee2e6}.table-bordered thead td,.table-bordered thead th{border-bottom-width:2px}.table-borderless tbody+tbody,.table-borderless td,.table-borderless th,.table-borderless thead th{border:0}.table-striped tbody tr:nth-of-type(odd){background-color:rgba(0,0,0,.05)}.table-hover tbody tr:hover{color:#212529;background-color:rgba(0,0,0,.075)}.table-primary,.table-primary>td,.table-primary>th{background-color:#b8daff}.table-primary tbody+tbody,.table-primary td,.table-primary th,.table-primary thead th{border-color:#7abaff}.table-hover .table-primary:hover,.table-hover .table-primary:hover>td,.table-hover .table-primary:hover>th{background-color:#9fcdff}.table-secondary,.table-secondary>td,.table-secondary>th{background-color:#d6d8db}.table-secondary tbody+tbody,.table-secondary td,.table-secondary th,.table-secondary thead th{border-color:#b3b7bb}.table-hover .table-secondary:hover,.table-hover .table-secondary:hover>td,.table-hover .table-secondary:hover>th{background-color:#c8cbcf}.table-success,.table-success>td,.table-success>th{background-color:#c3e6cb}.table-success tbody+tbody,.table-success td,.table-success th,.table-success thead th{border-color:#8fd19e}.table-hover .table-success:hover,.table-hover .table-success:hover>td,.table-hover .table-success:hover>th{background-color:#b1dfbb}.table-info,.table-info>td,.table-info>th{background-color:#bee5eb}.table-info tbody+tbody,.table-info td,.table-info th,.table-info thead th{border-color:#86cfda}.table-hover .table-info:hover,.table-hover .table-info:hover>td,.table-hover .table-info:hover>th{background-color:#abdde5}.table-warning,.table-warning>td,.table-warning>th{background-color:#ffeeba}.table-warning tbody+tbody,.table-warning td,.table-warning th,.table-warning thead th{border-color:#ffdf7e}.table-hover .table-warning:hover,.table-hover .table-warning:hover>td,.table-hover .table-warning:hover>th{background-color:#ffe8a1}.table-danger,.table-danger>td,.table-danger>th{background-color:#f5c6cb}.table-danger tbody+tbody,.table-danger td,.table-danger th,.table-danger thead th{border-color:#ed969e}.table-hover .table-danger:hover,.table-hover .table-danger:hover>td,.table-hover .table-danger:hover>th{background-color:#f1b0b7}.table-light,.table-light>td,.table-light>th{background-color:#fdfdfe}.table-light tbody+tbody,.table-light td,.table-light th,.table-light thead th{border-color:#fbfcfc}.table-hover .table-light:hover,.table-hover .table-light:hover>td,.table-hover .table-light:hover>th{background-color:#ececf6}.table-dark,.table-dark>td,.table-dark>th{background-color:#c6c8ca}.table-dark tbody+tbody,.table-dark td,.table-dark th,.table-dark thead th{border-color:#95999c}.table-hover .table-dark:hover,.table-hover .table-dark:hover>td,.table-hover .table-dark:hover>th{background-color:#b9bbbe}.table-active,.table-active>td,.table-active>th,.table-hover .table-active:hover,.table-hover .table-active:hover>td,.table-hover .table-active:hover>th{background-color:rgba(0,0,0,.075)}.table .thead-dark th{color:#fff;background-color:#343a40;border-color:#454d55}.table .thead-light th{color:#495057;background-color:#e9ecef;border-color:#dee2e6}.table-dark{color:#fff;background-color:#343a40}.table-dark td,.table-dark th,.table-dark thead th{border-color:#454d55}.table-dark.table-bordered{border:0}.table-dark.table-striped tbody tr:nth-of-type(odd){background-color:hsla(0,0%,100%,.05)}.table-dark.table-hover tbody tr:hover{color:#fff;background-color:hsla(0,0%,100%,.075)}@media (max-width:539.98px){.table-responsive-sm{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-sm>.table-bordered{border:0}}@media (max-width:719.98px){.table-responsive-md{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-md>.table-bordered{border:0}}@media (max-width:959.98px){.table-responsive-lg{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-lg>.table-bordered{border:0}}@media (max-width:1199.98px){.table-responsive-xl{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive-xl>.table-bordered{border:0}}.table-responsive{display:block;width:100%;overflow-x:auto;-webkit-overflow-scrolling:touch}.table-responsive>.table-bordered{border:0}.form-control{display:block;width:100%;height:calc(1.5em + .75rem + 2px);padding:.375rem .75rem;font-size:1rem;font-weight:400;line-height:1.5;color:#495057;background-color:#fff;background-clip:padding-box;border:1px solid #ced4da;border-radius:.25rem;transition:border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.form-control{transition:none}}.form-control::-ms-expand{background-color:transparent;border:0}.form-control:focus{color:#495057;background-color:#fff;border-color:#80bdff;outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.form-control::placeholder{color:#6c757d;opacity:1}.form-control:disabled,.form-control[readonly]{background-color:#e9ecef;opacity:1}input[type=date].form-control,input[type=datetime-local].form-control,input[type=month].form-control,input[type=time].form-control{appearance:none}select.form-control:-moz-focusring{color:transparent;text-shadow:0 0 0 #495057}select.form-control:focus::-ms-value{color:#495057;background-color:#fff}.form-control-file,.form-control-range{display:block;width:100%}.col-form-label{padding-top:calc(.375rem + 1px);padding-bottom:calc(.375rem + 1px);margin-bottom:0;font-size:inherit;line-height:1.5}.col-form-label-lg{padding-top:calc(.5rem + 1px);padding-bottom:calc(.5rem + 1px);font-size:1.25rem;line-height:1.5}.col-form-label-sm{padding-top:calc(.25rem + 1px);padding-bottom:calc(.25rem + 1px);font-size:.875rem;line-height:1.5}.form-control-plaintext{display:block;width:100%;padding:.375rem 0;margin-bottom:0;font-size:1rem;line-height:1.5;color:#212529;background-color:transparent;border:solid transparent;border-width:1px 0}.form-control-plaintext.form-control-lg,.form-control-plaintext.form-control-sm{padding-right:0;padding-left:0}.form-control-sm{height:calc(1.5em + .5rem + 2px);padding:.25rem .5rem;font-size:.875rem;line-height:1.5;border-radius:.2rem}.form-control-lg{height:calc(1.5em + 1rem + 2px);padding:.5rem 1rem;font-size:1.25rem;line-height:1.5;border-radius:.3rem}select.form-control[multiple],select.form-control[size],textarea.form-control{height:auto}.form-group{margin-bottom:1rem}.form-text{display:block;margin-top:.25rem}.form-row{display:flex;flex-wrap:wrap;margin-right:-5px;margin-left:-5px}.form-row>.col,.form-row>[class*=col-]{padding-right:5px;padding-left:5px}.form-check{position:relative;display:block;padding-left:1.25rem}.form-check-input{position:absolute;margin-top:.3rem;margin-left:-1.25rem}.form-check-input:disabled~.form-check-label,.form-check-input[disabled]~.form-check-label{color:#6c757d}.form-check-label{margin-bottom:0}.form-check-inline{display:inline-flex;align-items:center;padding-left:0;margin-right:.75rem}.form-check-inline .form-check-input{position:static;margin-top:0;margin-right:.3125rem;margin-left:0}.valid-feedback{display:none;width:100%;margin-top:.25rem;font-size:80%;color:#28a745}.valid-tooltip{position:absolute;top:100%;left:0;z-index:5;display:none;max-width:100%;padding:.25rem .5rem;margin-top:.1rem;font-size:.875rem;line-height:1.5;color:#fff;background-color:rgba(40,167,69,.9);border-radius:.25rem}.form-row>.col>.valid-tooltip,.form-row>[class*=col-]>.valid-tooltip{left:5px}.is-valid~.valid-feedback,.is-valid~.valid-tooltip,.was-validated :valid~.valid-feedback,.was-validated :valid~.valid-tooltip{display:block}.form-control.is-valid,.was-validated .form-control:valid{border-color:#28a745;padding-right:calc(1.5em + .75rem)!important;background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8'%3E%3Cpath fill='%2328a745' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3E%3C/svg%3E");background-repeat:no-repeat;background-position:right calc(.375em + .1875rem) center;background-size:calc(.75em + .375rem) calc(.75em + .375rem)}.form-control.is-valid:focus,.was-validated .form-control:valid:focus{border-color:#28a745;box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.was-validated select.form-control:valid,select.form-control.is-valid{padding-right:3rem!important;background-position:right 1.5rem center}.was-validated textarea.form-control:valid,textarea.form-control.is-valid{padding-right:calc(1.5em + .75rem);background-position:top calc(.375em + .1875rem) right calc(.375em + .1875rem)}.custom-select.is-valid,.was-validated .custom-select:valid{border-color:#28a745;padding-right:calc(.75em + 2.3125rem)!important;background:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='4' height='5'%3E%3Cpath fill='%23343a40' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") right .75rem center/8px 10px no-repeat,#fff url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8'%3E%3Cpath fill='%2328a745' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3E%3C/svg%3E") center right 1.75rem/calc(.75em + .375rem) calc(.75em + .375rem) no-repeat}.custom-select.is-valid:focus,.was-validated .custom-select:valid:focus{border-color:#28a745;box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.form-check-input.is-valid~.form-check-label,.was-validated .form-check-input:valid~.form-check-label{color:#28a745}.form-check-input.is-valid~.valid-feedback,.form-check-input.is-valid~.valid-tooltip,.was-validated .form-check-input:valid~.valid-feedback,.was-validated .form-check-input:valid~.valid-tooltip{display:block}.custom-control-input.is-valid~.custom-control-label,.was-validated .custom-control-input:valid~.custom-control-label{color:#28a745}.custom-control-input.is-valid~.custom-control-label:before,.was-validated .custom-control-input:valid~.custom-control-label:before{border-color:#28a745}.custom-control-input.is-valid:checked~.custom-control-label:before,.was-validated .custom-control-input:valid:checked~.custom-control-label:before{border-color:#34ce57;background-color:#34ce57}.custom-control-input.is-valid:focus~.custom-control-label:before,.was-validated .custom-control-input:valid:focus~.custom-control-label:before{box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.custom-control-input.is-valid:focus:not(:checked)~.custom-control-label:before,.custom-file-input.is-valid~.custom-file-label,.was-validated .custom-control-input:valid:focus:not(:checked)~.custom-control-label:before,.was-validated .custom-file-input:valid~.custom-file-label{border-color:#28a745}.custom-file-input.is-valid:focus~.custom-file-label,.was-validated .custom-file-input:valid:focus~.custom-file-label{border-color:#28a745;box-shadow:0 0 0 .2rem rgba(40,167,69,.25)}.invalid-feedback{display:none;width:100%;margin-top:.25rem;font-size:80%;color:#dc3545}.invalid-tooltip{position:absolute;top:100%;left:0;z-index:5;display:none;max-width:100%;padding:.25rem .5rem;margin-top:.1rem;font-size:.875rem;line-height:1.5;color:#fff;background-color:rgba(220,53,69,.9);border-radius:.25rem}.form-row>.col>.invalid-tooltip,.form-row>[class*=col-]>.invalid-tooltip{left:5px}.is-invalid~.invalid-feedback,.is-invalid~.invalid-tooltip,.was-validated :invalid~.invalid-feedback,.was-validated :invalid~.invalid-tooltip{display:block}.form-control.is-invalid,.was-validated .form-control:invalid{border-color:#dc3545;padding-right:calc(1.5em + .75rem)!important;background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23dc3545'%3E%3Ccircle cx='6' cy='6' r='4.5'/%3E%3Cpath stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/%3E%3Ccircle cx='6' cy='8.2' r='.6' fill='%23dc3545' stroke='none'/%3E%3C/svg%3E");background-repeat:no-repeat;background-position:right calc(.375em + .1875rem) center;background-size:calc(.75em + .375rem) calc(.75em + .375rem)}.form-control.is-invalid:focus,.was-validated .form-control:invalid:focus{border-color:#dc3545;box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.was-validated select.form-control:invalid,select.form-control.is-invalid{padding-right:3rem!important;background-position:right 1.5rem center}.was-validated textarea.form-control:invalid,textarea.form-control.is-invalid{padding-right:calc(1.5em + .75rem);background-position:top calc(.375em + .1875rem) right calc(.375em + .1875rem)}.custom-select.is-invalid,.was-validated .custom-select:invalid{border-color:#dc3545;padding-right:calc(.75em + 2.3125rem)!important;background:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='4' height='5'%3E%3Cpath fill='%23343a40' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") right .75rem center/8px 10px no-repeat,#fff url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23dc3545'%3E%3Ccircle cx='6' cy='6' r='4.5'/%3E%3Cpath stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/%3E%3Ccircle cx='6' cy='8.2' r='.6' fill='%23dc3545' stroke='none'/%3E%3C/svg%3E") center right 1.75rem/calc(.75em + .375rem) calc(.75em + .375rem) no-repeat}.custom-select.is-invalid:focus,.was-validated .custom-select:invalid:focus{border-color:#dc3545;box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.form-check-input.is-invalid~.form-check-label,.was-validated .form-check-input:invalid~.form-check-label{color:#dc3545}.form-check-input.is-invalid~.invalid-feedback,.form-check-input.is-invalid~.invalid-tooltip,.was-validated .form-check-input:invalid~.invalid-feedback,.was-validated .form-check-input:invalid~.invalid-tooltip{display:block}.custom-control-input.is-invalid~.custom-control-label,.was-validated .custom-control-input:invalid~.custom-control-label{color:#dc3545}.custom-control-input.is-invalid~.custom-control-label:before,.was-validated .custom-control-input:invalid~.custom-control-label:before{border-color:#dc3545}.custom-control-input.is-invalid:checked~.custom-control-label:before,.was-validated .custom-control-input:invalid:checked~.custom-control-label:before{border-color:#e4606d;background-color:#e4606d}.custom-control-input.is-invalid:focus~.custom-control-label:before,.was-validated .custom-control-input:invalid:focus~.custom-control-label:before{box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.custom-control-input.is-invalid:focus:not(:checked)~.custom-control-label:before,.custom-file-input.is-invalid~.custom-file-label,.was-validated .custom-control-input:invalid:focus:not(:checked)~.custom-control-label:before,.was-validated .custom-file-input:invalid~.custom-file-label{border-color:#dc3545}.custom-file-input.is-invalid:focus~.custom-file-label,.was-validated .custom-file-input:invalid:focus~.custom-file-label{border-color:#dc3545;box-shadow:0 0 0 .2rem rgba(220,53,69,.25)}.form-inline{display:flex;flex-flow:row wrap;align-items:center}.form-inline .form-check{width:100%}@media (min-width:540px){.form-inline label{justify-content:center}.form-inline .form-group,.form-inline label{display:flex;align-items:center;margin-bottom:0}.form-inline .form-group{flex:0 0 auto;flex-flow:row wrap}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-plaintext{display:inline-block}.form-inline .custom-select,.form-inline .input-group{width:auto}.form-inline .form-check{display:flex;align-items:center;justify-content:center;width:auto;padding-left:0}.form-inline .form-check-input{position:relative;flex-shrink:0;margin-top:0;margin-right:.25rem;margin-left:0}.form-inline .custom-control{align-items:center;justify-content:center}.form-inline .custom-control-label{margin-bottom:0}}.btn{display:inline-block;font-weight:400;color:#212529;text-align:center;vertical-align:middle;user-select:none;background-color:transparent;border:1px solid transparent;padding:.375rem .75rem;font-size:1rem;line-height:1.5;border-radius:.25rem;transition:color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.btn{transition:none}}.btn:hover{color:#212529;text-decoration:none}.btn.focus,.btn:focus{outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.btn.disabled,.btn:disabled{opacity:.65}.btn:not(:disabled):not(.disabled){cursor:pointer}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{color:#fff;background-color:#007bff;border-color:#007bff}.btn-primary.focus,.btn-primary:focus,.btn-primary:hover{color:#fff;background-color:#0069d9;border-color:#0062cc}.btn-primary.focus,.btn-primary:focus{box-shadow:0 0 0 .2rem rgba(38,143,255,.5)}.btn-primary.disabled,.btn-primary:disabled{color:#fff;background-color:#007bff;border-color:#007bff}.btn-primary:not(:disabled):not(.disabled).active,.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{color:#fff;background-color:#0062cc;border-color:#005cbf}.btn-primary:not(:disabled):not(.disabled).active:focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(38,143,255,.5)}.btn-secondary{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-secondary.focus,.btn-secondary:focus,.btn-secondary:hover{color:#fff;background-color:#5a6268;border-color:#545b62}.btn-secondary.focus,.btn-secondary:focus{box-shadow:0 0 0 .2rem rgba(130,138,145,.5)}.btn-secondary.disabled,.btn-secondary:disabled{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-secondary:not(:disabled):not(.disabled).active,.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{color:#fff;background-color:#545b62;border-color:#4e555b}.btn-secondary:not(:disabled):not(.disabled).active:focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(130,138,145,.5)}.btn-success{color:#fff;background-color:#28a745;border-color:#28a745}.btn-success.focus,.btn-success:focus,.btn-success:hover{color:#fff;background-color:#218838;border-color:#1e7e34}.btn-success.focus,.btn-success:focus{box-shadow:0 0 0 .2rem rgba(72,180,97,.5)}.btn-success.disabled,.btn-success:disabled{color:#fff;background-color:#28a745;border-color:#28a745}.btn-success:not(:disabled):not(.disabled).active,.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{color:#fff;background-color:#1e7e34;border-color:#1c7430}.btn-success:not(:disabled):not(.disabled).active:focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(72,180,97,.5)}.btn-info{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-info.focus,.btn-info:focus,.btn-info:hover{color:#fff;background-color:#138496;border-color:#117a8b}.btn-info.focus,.btn-info:focus{box-shadow:0 0 0 .2rem rgba(58,176,195,.5)}.btn-info.disabled,.btn-info:disabled{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-info:not(:disabled):not(.disabled).active,.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{color:#fff;background-color:#117a8b;border-color:#10707f}.btn-info:not(:disabled):not(.disabled).active:focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(58,176,195,.5)}.btn-warning{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-warning.focus,.btn-warning:focus,.btn-warning:hover{color:#212529;background-color:#e0a800;border-color:#d39e00}.btn-warning.focus,.btn-warning:focus{box-shadow:0 0 0 .2rem rgba(222,170,12,.5)}.btn-warning.disabled,.btn-warning:disabled{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-warning:not(:disabled):not(.disabled).active,.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{color:#212529;background-color:#d39e00;border-color:#c69500}.btn-warning:not(:disabled):not(.disabled).active:focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(222,170,12,.5)}.btn-danger{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-danger.focus,.btn-danger:focus,.btn-danger:hover{color:#fff;background-color:#c82333;border-color:#bd2130}.btn-danger.focus,.btn-danger:focus{box-shadow:0 0 0 .2rem rgba(225,83,97,.5)}.btn-danger.disabled,.btn-danger:disabled{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-danger:not(:disabled):not(.disabled).active,.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{color:#fff;background-color:#bd2130;border-color:#b21f2d}.btn-danger:not(:disabled):not(.disabled).active:focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(225,83,97,.5)}.btn-light{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-light.focus,.btn-light:focus,.btn-light:hover{color:#212529;background-color:#e2e6ea;border-color:#dae0e5}.btn-light.focus,.btn-light:focus{box-shadow:0 0 0 .2rem rgba(216,217,219,.5)}.btn-light.disabled,.btn-light:disabled{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-light:not(:disabled):not(.disabled).active,.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{color:#212529;background-color:#dae0e5;border-color:#d3d9df}.btn-light:not(:disabled):not(.disabled).active:focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(216,217,219,.5)}.btn-dark{color:#fff;background-color:#343a40;border-color:#343a40}.btn-dark.focus,.btn-dark:focus,.btn-dark:hover{color:#fff;background-color:#23272b;border-color:#1d2124}.btn-dark.focus,.btn-dark:focus{box-shadow:0 0 0 .2rem rgba(82,88,93,.5)}.btn-dark.disabled,.btn-dark:disabled{color:#fff;background-color:#343a40;border-color:#343a40}.btn-dark:not(:disabled):not(.disabled).active,.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{color:#fff;background-color:#1d2124;border-color:#171a1d}.btn-dark:not(:disabled):not(.disabled).active:focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(82,88,93,.5)}.btn-outline-primary{color:#007bff;border-color:#007bff}.btn-outline-primary:hover{color:#fff;background-color:#007bff;border-color:#007bff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{color:#007bff;background-color:transparent}.btn-outline-primary:not(:disabled):not(.disabled).active,.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{color:#fff;background-color:#007bff;border-color:#007bff}.btn-outline-primary:not(:disabled):not(.disabled).active:focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,.5)}.btn-outline-secondary{color:#6c757d;border-color:#6c757d}.btn-outline-secondary:hover{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{color:#6c757d;background-color:transparent}.btn-outline-secondary:not(:disabled):not(.disabled).active,.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{color:#fff;background-color:#6c757d;border-color:#6c757d}.btn-outline-secondary:not(:disabled):not(.disabled).active:focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,.5)}.btn-outline-success{color:#28a745;border-color:#28a745}.btn-outline-success:hover{color:#fff;background-color:#28a745;border-color:#28a745}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{color:#28a745;background-color:transparent}.btn-outline-success:not(:disabled):not(.disabled).active,.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{color:#fff;background-color:#28a745;border-color:#28a745}.btn-outline-success:not(:disabled):not(.disabled).active:focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,.5)}.btn-outline-info{color:#17a2b8;border-color:#17a2b8}.btn-outline-info:hover{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{color:#17a2b8;background-color:transparent}.btn-outline-info:not(:disabled):not(.disabled).active,.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{color:#fff;background-color:#17a2b8;border-color:#17a2b8}.btn-outline-info:not(:disabled):not(.disabled).active:focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,.5)}.btn-outline-warning{color:#ffc107;border-color:#ffc107}.btn-outline-warning:hover{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{color:#ffc107;background-color:transparent}.btn-outline-warning:not(:disabled):not(.disabled).active,.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{color:#212529;background-color:#ffc107;border-color:#ffc107}.btn-outline-warning:not(:disabled):not(.disabled).active:focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,.5)}.btn-outline-danger{color:#dc3545;border-color:#dc3545}.btn-outline-danger:hover{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{color:#dc3545;background-color:transparent}.btn-outline-danger:not(:disabled):not(.disabled).active,.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{color:#fff;background-color:#dc3545;border-color:#dc3545}.btn-outline-danger:not(:disabled):not(.disabled).active:focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,.5)}.btn-outline-light{color:#f8f9fa;border-color:#f8f9fa}.btn-outline-light:hover{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{color:#f8f9fa;background-color:transparent}.btn-outline-light:not(:disabled):not(.disabled).active,.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{color:#212529;background-color:#f8f9fa;border-color:#f8f9fa}.btn-outline-light:not(:disabled):not(.disabled).active:focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,.5)}.btn-outline-dark{color:#343a40;border-color:#343a40}.btn-outline-dark:hover{color:#fff;background-color:#343a40;border-color:#343a40}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{color:#343a40;background-color:transparent}.btn-outline-dark:not(:disabled):not(.disabled).active,.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{color:#fff;background-color:#343a40;border-color:#343a40}.btn-outline-dark:not(:disabled):not(.disabled).active:focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,.5)}.btn-link{font-weight:400;color:#007bff;text-decoration:none}.btn-link:hover{color:#0056b3}.btn-link.focus,.btn-link:focus,.btn-link:hover{text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{padding:.5rem 1rem;font-size:1.25rem;line-height:1.5;border-radius:.3rem}.btn-group-sm>.btn,.btn-sm{padding:.25rem .5rem;font-size:.875rem;line-height:1.5;border-radius:.2rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input[type=button].btn-block,input[type=reset].btn-block,input[type=submit].btn-block{width:100%}.fade{transition:opacity .15s linear}@media (prefers-reduced-motion:reduce){.fade{transition:none}}.fade:not(.show){opacity:0}.collapse:not(.show){display:none}.collapsing{position:relative;height:0;overflow:hidden;transition:height .35s ease}@media (prefers-reduced-motion:reduce){.collapsing{transition:none}}.dropdown,.dropleft,.dropright,.dropup{position:relative}.dropdown-toggle{white-space:nowrap}.dropdown-toggle:after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";border-top:.3em solid;border-right:.3em solid transparent;border-bottom:0;border-left:.3em solid transparent}.dropdown-toggle:empty:after{margin-left:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:10rem;padding:.5rem 0;margin:.125rem 0 0;font-size:1rem;color:#212529;text-align:left;list-style:none;background-color:#fff;background-clip:padding-box;border:1px solid rgba(0,0,0,.15);border-radius:.25rem}.dropdown-menu-left{right:auto;left:0}.dropdown-menu-right{right:0;left:auto}@media (min-width:540px){.dropdown-menu-sm-left{right:auto;left:0}.dropdown-menu-sm-right{right:0;left:auto}}@media (min-width:720px){.dropdown-menu-md-left{right:auto;left:0}.dropdown-menu-md-right{right:0;left:auto}}@media (min-width:960px){.dropdown-menu-lg-left{right:auto;left:0}.dropdown-menu-lg-right{right:0;left:auto}}@media (min-width:1200px){.dropdown-menu-xl-left{right:auto;left:0}.dropdown-menu-xl-right{right:0;left:auto}}.dropup .dropdown-menu{top:auto;bottom:100%;margin-top:0;margin-bottom:.125rem}.dropup .dropdown-toggle:after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";border-top:0;border-right:.3em solid transparent;border-bottom:.3em solid;border-left:.3em solid transparent}.dropup .dropdown-toggle:empty:after{margin-left:0}.dropright .dropdown-menu{top:0;right:auto;left:100%;margin-top:0;margin-left:.125rem}.dropright .dropdown-toggle:after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";border-top:.3em solid transparent;border-right:0;border-bottom:.3em solid transparent;border-left:.3em solid}.dropright .dropdown-toggle:empty:after{margin-left:0}.dropright .dropdown-toggle:after{vertical-align:0}.dropleft .dropdown-menu{top:0;right:100%;left:auto;margin-top:0;margin-right:.125rem}.dropleft .dropdown-toggle:after{display:inline-block;margin-left:.255em;vertical-align:.255em;content:"";display:none}.dropleft .dropdown-toggle:before{display:inline-block;margin-right:.255em;vertical-align:.255em;content:"";border-top:.3em solid transparent;border-right:.3em solid;border-bottom:.3em solid transparent}.dropleft .dropdown-toggle:empty:after{margin-left:0}.dropleft .dropdown-toggle:before{vertical-align:0}.dropdown-menu[x-placement^=bottom],.dropdown-menu[x-placement^=left],.dropdown-menu[x-placement^=right],.dropdown-menu[x-placement^=top]{right:auto;bottom:auto}.dropdown-divider{height:0;margin:.5rem 0;overflow:hidden;border-top:1px solid #e9ecef}.dropdown-item{display:block;width:100%;padding:.25rem 1.5rem;clear:both;font-weight:400;color:#212529;text-align:inherit;white-space:nowrap;background-color:transparent;border:0}.dropdown-item:focus,.dropdown-item:hover{color:#16181b;text-decoration:none;background-color:#e9ecef}.dropdown-item.active,.dropdown-item:active{color:#fff;text-decoration:none;background-color:#007bff}.dropdown-item.disabled,.dropdown-item:disabled{color:#adb5bd;pointer-events:none;background-color:transparent}.dropdown-menu.show{display:block}.dropdown-header{display:block;padding:.5rem 1.5rem;margin-bottom:0;font-size:.875rem;color:#6c757d;white-space:nowrap}.dropdown-item-text{display:block;padding:.25rem 1.5rem;color:#212529}.btn-group,.btn-group-vertical{position:relative;display:inline-flex;vertical-align:middle}.btn-group-vertical>.btn,.btn-group>.btn{position:relative;flex:1 1 auto}.btn-group-vertical>.btn.active,.btn-group-vertical>.btn:active,.btn-group-vertical>.btn:focus,.btn-group-vertical>.btn:hover,.btn-group>.btn.active,.btn-group>.btn:active,.btn-group>.btn:focus,.btn-group>.btn:hover{z-index:1}.btn-toolbar{display:flex;flex-wrap:wrap;justify-content:flex-start}.btn-toolbar .input-group{width:auto}.btn-group>.btn-group:not(:first-child),.btn-group>.btn:not(:first-child){margin-left:-1px}.btn-group>.btn-group:not(:last-child)>.btn,.btn-group>.btn:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:not(:first-child)>.btn,.btn-group>.btn:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.dropdown-toggle-split{padding-right:.5625rem;padding-left:.5625rem}.dropdown-toggle-split:after,.dropright .dropdown-toggle-split:after,.dropup .dropdown-toggle-split:after{margin-left:0}.dropleft .dropdown-toggle-split:before{margin-right:0}.btn-group-sm>.btn+.dropdown-toggle-split,.btn-sm+.dropdown-toggle-split{padding-right:.375rem;padding-left:.375rem}.btn-group-lg>.btn+.dropdown-toggle-split,.btn-lg+.dropdown-toggle-split{padding-right:.75rem;padding-left:.75rem}.btn-group-vertical{flex-direction:column;align-items:flex-start;justify-content:center}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group{width:100%}.btn-group-vertical>.btn-group:not(:first-child),.btn-group-vertical>.btn:not(:first-child){margin-top:-1px}.btn-group-vertical>.btn-group:not(:last-child)>.btn,.btn-group-vertical>.btn:not(:last-child):not(.dropdown-toggle){border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:not(:first-child)>.btn,.btn-group-vertical>.btn:not(:first-child){border-top-left-radius:0;border-top-right-radius:0}.btn-group-toggle>.btn,.btn-group-toggle>.btn-group>.btn{margin-bottom:0}.btn-group-toggle>.btn-group>.btn input[type=checkbox],.btn-group-toggle>.btn-group>.btn input[type=radio],.btn-group-toggle>.btn input[type=checkbox],.btn-group-toggle>.btn input[type=radio]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;display:flex;flex-wrap:wrap;align-items:stretch;width:100%}.input-group>.custom-file,.input-group>.custom-select,.input-group>.form-control,.input-group>.form-control-plaintext{position:relative;flex:1 1 auto;width:1%;min-width:0;margin-bottom:0}.input-group>.custom-file+.custom-file,.input-group>.custom-file+.custom-select,.input-group>.custom-file+.form-control,.input-group>.custom-select+.custom-file,.input-group>.custom-select+.custom-select,.input-group>.custom-select+.form-control,.input-group>.form-control+.custom-file,.input-group>.form-control+.custom-select,.input-group>.form-control+.form-control,.input-group>.form-control-plaintext+.custom-file,.input-group>.form-control-plaintext+.custom-select,.input-group>.form-control-plaintext+.form-control{margin-left:-1px}.input-group>.custom-file .custom-file-input:focus~.custom-file-label,.input-group>.custom-select:focus,.input-group>.form-control:focus{z-index:3}.input-group>.custom-file .custom-file-input:focus{z-index:4}.input-group>.custom-select:not(:first-child),.input-group>.form-control:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.input-group>.custom-file{display:flex;align-items:center}.input-group>.custom-file:not(:last-child) .custom-file-label,.input-group>.custom-file:not(:last-child) .custom-file-label:after{border-top-right-radius:0;border-bottom-right-radius:0}.input-group>.custom-file:not(:first-child) .custom-file-label{border-top-left-radius:0;border-bottom-left-radius:0}.input-group.has-validation>.custom-file:nth-last-child(n+3) .custom-file-label,.input-group.has-validation>.custom-file:nth-last-child(n+3) .custom-file-label:after,.input-group.has-validation>.custom-select:nth-last-child(n+3),.input-group.has-validation>.form-control:nth-last-child(n+3),.input-group:not(.has-validation)>.custom-file:not(:last-child) .custom-file-label,.input-group:not(.has-validation)>.custom-file:not(:last-child) .custom-file-label:after,.input-group:not(.has-validation)>.custom-select:not(:last-child),.input-group:not(.has-validation)>.form-control:not(:last-child){border-top-right-radius:0;border-bottom-right-radius:0}.input-group-append,.input-group-prepend{display:flex}.input-group-append .btn,.input-group-prepend .btn{position:relative;z-index:2}.input-group-append .btn:focus,.input-group-prepend .btn:focus{z-index:3}.input-group-append .btn+.btn,.input-group-append .btn+.input-group-text,.input-group-append .input-group-text+.btn,.input-group-append .input-group-text+.input-group-text,.input-group-prepend .btn+.btn,.input-group-prepend .btn+.input-group-text,.input-group-prepend .input-group-text+.btn,.input-group-prepend .input-group-text+.input-group-text{margin-left:-1px}.input-group-prepend{margin-right:-1px}.input-group-append{margin-left:-1px}.input-group-text{display:flex;align-items:center;padding:.375rem .75rem;margin-bottom:0;font-size:1rem;font-weight:400;line-height:1.5;color:#495057;text-align:center;white-space:nowrap;background-color:#e9ecef;border:1px solid #ced4da;border-radius:.25rem}.input-group-text input[type=checkbox],.input-group-text input[type=radio]{margin-top:0}.input-group-lg>.custom-select,.input-group-lg>.form-control:not(textarea){height:calc(1.5em + 1rem + 2px)}.input-group-lg>.custom-select,.input-group-lg>.form-control,.input-group-lg>.input-group-append>.btn,.input-group-lg>.input-group-append>.input-group-text,.input-group-lg>.input-group-prepend>.btn,.input-group-lg>.input-group-prepend>.input-group-text{padding:.5rem 1rem;font-size:1.25rem;line-height:1.5;border-radius:.3rem}.input-group-sm>.custom-select,.input-group-sm>.form-control:not(textarea){height:calc(1.5em + .5rem + 2px)}.input-group-sm>.custom-select,.input-group-sm>.form-control,.input-group-sm>.input-group-append>.btn,.input-group-sm>.input-group-append>.input-group-text,.input-group-sm>.input-group-prepend>.btn,.input-group-sm>.input-group-prepend>.input-group-text{padding:.25rem .5rem;font-size:.875rem;line-height:1.5;border-radius:.2rem}.input-group-lg>.custom-select,.input-group-sm>.custom-select{padding-right:1.75rem}.input-group.has-validation>.input-group-append:nth-last-child(n+3)>.btn,.input-group.has-validation>.input-group-append:nth-last-child(n+3)>.input-group-text,.input-group:not(.has-validation)>.input-group-append:not(:last-child)>.btn,.input-group:not(.has-validation)>.input-group-append:not(:last-child)>.input-group-text,.input-group>.input-group-append:last-child>.btn:not(:last-child):not(.dropdown-toggle),.input-group>.input-group-append:last-child>.input-group-text:not(:last-child),.input-group>.input-group-prepend>.btn,.input-group>.input-group-prepend>.input-group-text{border-top-right-radius:0;border-bottom-right-radius:0}.input-group>.input-group-append>.btn,.input-group>.input-group-append>.input-group-text,.input-group>.input-group-prepend:first-child>.btn:not(:first-child),.input-group>.input-group-prepend:first-child>.input-group-text:not(:first-child),.input-group>.input-group-prepend:not(:first-child)>.btn,.input-group>.input-group-prepend:not(:first-child)>.input-group-text{border-top-left-radius:0;border-bottom-left-radius:0}.custom-control{position:relative;z-index:1;display:block;min-height:1.5rem;padding-left:1.5rem;color-adjust:exact}.custom-control-inline{display:inline-flex;margin-right:1rem}.custom-control-input{position:absolute;left:0;z-index:-1;width:1rem;height:1.25rem;opacity:0}.custom-control-input:checked~.custom-control-label:before{color:#fff;border-color:#007bff;background-color:#007bff}.custom-control-input:focus~.custom-control-label:before{box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.custom-control-input:focus:not(:checked)~.custom-control-label:before{border-color:#80bdff}.custom-control-input:not(:disabled):active~.custom-control-label:before{color:#fff;background-color:#b3d7ff;border-color:#b3d7ff}.custom-control-input:disabled~.custom-control-label,.custom-control-input[disabled]~.custom-control-label{color:#6c757d}.custom-control-input:disabled~.custom-control-label:before,.custom-control-input[disabled]~.custom-control-label:before{background-color:#e9ecef}.custom-control-label{position:relative;margin-bottom:0;vertical-align:top}.custom-control-label:before{pointer-events:none;background-color:#fff;border:1px solid #adb5bd}.custom-control-label:after,.custom-control-label:before{position:absolute;top:.25rem;left:-1.5rem;display:block;width:1rem;height:1rem;content:""}.custom-control-label:after{background:50%/50% 50% no-repeat}.custom-checkbox .custom-control-label:before{border-radius:.25rem}.custom-checkbox .custom-control-input:checked~.custom-control-label:after{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8'%3E%3Cpath fill='%23fff' d='M6.564.75l-3.59 3.612-1.538-1.55L0 4.26l2.974 2.99L8 2.193z'/%3E%3C/svg%3E")}.custom-checkbox .custom-control-input:indeterminate~.custom-control-label:before{border-color:#007bff;background-color:#007bff}.custom-checkbox .custom-control-input:indeterminate~.custom-control-label:after{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='4' height='4'%3E%3Cpath stroke='%23fff' d='M0 2h4'/%3E%3C/svg%3E")}.custom-checkbox .custom-control-input:disabled:checked~.custom-control-label:before{background-color:rgba(0,123,255,.5)}.custom-checkbox .custom-control-input:disabled:indeterminate~.custom-control-label:before{background-color:rgba(0,123,255,.5)}.custom-radio .custom-control-label:before{border-radius:50%}.custom-radio .custom-control-input:checked~.custom-control-label:after{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' viewBox='-4 -4 8 8'%3E%3Ccircle r='3' fill='%23fff'/%3E%3C/svg%3E")}.custom-radio .custom-control-input:disabled:checked~.custom-control-label:before{background-color:rgba(0,123,255,.5)}.custom-switch{padding-left:2.25rem}.custom-switch .custom-control-label:before{left:-2.25rem;width:1.75rem;pointer-events:all;border-radius:.5rem}.custom-switch .custom-control-label:after{top:calc(.25rem + 2px);left:calc(-2.25rem + 2px);width:calc(1rem - 4px);height:calc(1rem - 4px);background-color:#adb5bd;border-radius:.5rem;transition:transform .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.custom-switch .custom-control-label:after{transition:none}}.custom-switch .custom-control-input:checked~.custom-control-label:after{background-color:#fff;transform:translateX(.75rem)}.custom-switch .custom-control-input:disabled:checked~.custom-control-label:before{background-color:rgba(0,123,255,.5)}.custom-select{display:inline-block;width:100%;height:calc(1.5em + .75rem + 2px);padding:.375rem 1.75rem .375rem .75rem;font-size:1rem;font-weight:400;line-height:1.5;color:#495057;vertical-align:middle;background:#fff url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='4' height='5'%3E%3Cpath fill='%23343a40' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") right .75rem center/8px 10px no-repeat;border:1px solid #ced4da;border-radius:.25rem;appearance:none}.custom-select:focus{border-color:#80bdff;outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.custom-select:focus::-ms-value{color:#495057;background-color:#fff}.custom-select[multiple],.custom-select[size]:not([size="1"]){height:auto;padding-right:.75rem;background-image:none}.custom-select:disabled{color:#6c757d;background-color:#e9ecef}.custom-select::-ms-expand{display:none}.custom-select:-moz-focusring{color:transparent;text-shadow:0 0 0 #495057}.custom-select-sm{height:calc(1.5em + .5rem + 2px);padding-top:.25rem;padding-bottom:.25rem;padding-left:.5rem;font-size:.875rem}.custom-select-lg{height:calc(1.5em + 1rem + 2px);padding-top:.5rem;padding-bottom:.5rem;padding-left:1rem;font-size:1.25rem}.custom-file{display:inline-block;margin-bottom:0}.custom-file,.custom-file-input{position:relative;width:100%;height:calc(1.5em + .75rem + 2px)}.custom-file-input{z-index:2;margin:0;overflow:hidden;opacity:0}.custom-file-input:focus~.custom-file-label{border-color:#80bdff;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.custom-file-input:disabled~.custom-file-label,.custom-file-input[disabled]~.custom-file-label{background-color:#e9ecef}.custom-file-input:lang(en)~.custom-file-label:after{content:"Browse"}.custom-file-input~.custom-file-label[data-browse]:after{content:attr(data-browse)}.custom-file-label{left:0;z-index:1;height:calc(1.5em + .75rem + 2px);overflow:hidden;font-weight:400;background-color:#fff;border:1px solid #ced4da;border-radius:.25rem}.custom-file-label,.custom-file-label:after{position:absolute;top:0;right:0;padding:.375rem .75rem;line-height:1.5;color:#495057}.custom-file-label:after{bottom:0;z-index:3;display:block;height:calc(1.5em + .75rem);content:"Browse";background-color:#e9ecef;border-left:inherit;border-radius:0 .25rem .25rem 0}.custom-range{width:100%;height:1.4rem;padding:0;background-color:transparent;appearance:none}.custom-range:focus{outline:0}.custom-range:focus::-webkit-slider-thumb{box-shadow:0 0 0 1px #fff,0 0 0 .2rem rgba(0,123,255,.25)}.custom-range:focus::-moz-range-thumb{box-shadow:0 0 0 1px #fff,0 0 0 .2rem rgba(0,123,255,.25)}.custom-range:focus::-ms-thumb{box-shadow:0 0 0 1px #fff,0 0 0 .2rem rgba(0,123,255,.25)}.custom-range::-moz-focus-outer{border:0}.custom-range::-webkit-slider-thumb{width:1rem;height:1rem;margin-top:-.25rem;background-color:#007bff;border:0;border-radius:1rem;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;appearance:none}@media (prefers-reduced-motion:reduce){.custom-range::-webkit-slider-thumb{transition:none}}.custom-range::-webkit-slider-thumb:active{background-color:#b3d7ff}.custom-range::-webkit-slider-runnable-track{width:100%;height:.5rem;color:transparent;cursor:pointer;background-color:#dee2e6;border-color:transparent;border-radius:1rem}.custom-range::-moz-range-thumb{width:1rem;height:1rem;background-color:#007bff;border:0;border-radius:1rem;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;appearance:none}@media (prefers-reduced-motion:reduce){.custom-range::-moz-range-thumb{transition:none}}.custom-range::-moz-range-thumb:active{background-color:#b3d7ff}.custom-range::-moz-range-track{width:100%;height:.5rem;color:transparent;cursor:pointer;background-color:#dee2e6;border-color:transparent;border-radius:1rem}.custom-range::-ms-thumb{width:1rem;height:1rem;margin-top:0;margin-right:.2rem;margin-left:.2rem;background-color:#007bff;border:0;border-radius:1rem;transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;appearance:none}@media (prefers-reduced-motion:reduce){.custom-range::-ms-thumb{transition:none}}.custom-range::-ms-thumb:active{background-color:#b3d7ff}.custom-range::-ms-track{width:100%;height:.5rem;color:transparent;cursor:pointer;background-color:transparent;border-color:transparent;border-width:.5rem}.custom-range::-ms-fill-lower,.custom-range::-ms-fill-upper{background-color:#dee2e6;border-radius:1rem}.custom-range::-ms-fill-upper{margin-right:15px}.custom-range:disabled::-webkit-slider-thumb{background-color:#adb5bd}.custom-range:disabled::-webkit-slider-runnable-track{cursor:default}.custom-range:disabled::-moz-range-thumb{background-color:#adb5bd}.custom-range:disabled::-moz-range-track{cursor:default}.custom-range:disabled::-ms-thumb{background-color:#adb5bd}.custom-control-label:before,.custom-file-label,.custom-select{transition:background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.custom-control-label:before,.custom-file-label,.custom-select{transition:none}}.nav{display:flex;flex-wrap:wrap;padding-left:0;margin-bottom:0;list-style:none}.nav-link{display:block;padding:.5rem 1rem}.nav-link:focus,.nav-link:hover{text-decoration:none}.nav-link.disabled{color:#6c757d;pointer-events:none;cursor:default}.nav-tabs{border-bottom:1px solid #dee2e6}.nav-tabs .nav-link{margin-bottom:-1px;border:1px solid transparent;border-top-left-radius:.25rem;border-top-right-radius:.25rem}.nav-tabs .nav-link:focus,.nav-tabs .nav-link:hover{border-color:#e9ecef #e9ecef #dee2e6}.nav-tabs .nav-link.disabled{color:#6c757d;background-color:transparent;border-color:transparent}.nav-tabs .nav-item.show .nav-link,.nav-tabs .nav-link.active{color:#495057;background-color:#fff;border-color:#dee2e6 #dee2e6 #fff}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-left-radius:0;border-top-right-radius:0}.nav-pills .nav-link{border-radius:.25rem}.nav-pills .nav-link.active,.nav-pills .show>.nav-link{color:#fff;background-color:#007bff}.nav-fill .nav-item,.nav-fill>.nav-link{flex:1 1 auto;text-align:center}.nav-justified .nav-item,.nav-justified>.nav-link{flex-basis:0;flex-grow:1;text-align:center}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.navbar{position:relative;padding:.5rem 1rem}.navbar,.navbar .container,.navbar .container-fluid,.navbar .container-lg,.navbar .container-md,.navbar .container-sm,.navbar .container-xl{display:flex;flex-wrap:wrap;align-items:center;justify-content:space-between}.navbar-brand{display:inline-block;padding-top:.3125rem;padding-bottom:.3125rem;margin-right:1rem;font-size:1.25rem;line-height:inherit;white-space:nowrap}.navbar-brand:focus,.navbar-brand:hover{text-decoration:none}.navbar-nav{display:flex;flex-direction:column;padding-left:0;margin-bottom:0;list-style:none}.navbar-nav .nav-link{padding-right:0;padding-left:0}.navbar-nav .dropdown-menu{position:static;float:none}.navbar-text{display:inline-block;padding-top:.5rem;padding-bottom:.5rem}.navbar-collapse{flex-basis:100%;flex-grow:1;align-items:center}.navbar-toggler{padding:.25rem .75rem;font-size:1.25rem;line-height:1;background-color:transparent;border:1px solid transparent;border-radius:.25rem}.navbar-toggler:focus,.navbar-toggler:hover{text-decoration:none}.navbar-toggler-icon{display:inline-block;width:1.5em;height:1.5em;vertical-align:middle;content:"";background:50%/100% 100% no-repeat}.navbar-nav-scroll{max-height:75vh;overflow-y:auto}@media (max-width:539.98px){.navbar-expand-sm>.container,.navbar-expand-sm>.container-fluid,.navbar-expand-sm>.container-lg,.navbar-expand-sm>.container-md,.navbar-expand-sm>.container-sm,.navbar-expand-sm>.container-xl{padding-right:0;padding-left:0}}@media (min-width:540px){.navbar-expand-sm{flex-flow:row nowrap;justify-content:flex-start}.navbar-expand-sm .navbar-nav{flex-direction:row}.navbar-expand-sm .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-sm .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-sm>.container,.navbar-expand-sm>.container-fluid,.navbar-expand-sm>.container-lg,.navbar-expand-sm>.container-md,.navbar-expand-sm>.container-sm,.navbar-expand-sm>.container-xl{flex-wrap:nowrap}.navbar-expand-sm .navbar-nav-scroll{overflow:visible}.navbar-expand-sm .navbar-collapse{display:flex!important;flex-basis:auto}.navbar-expand-sm .navbar-toggler{display:none}}@media (max-width:719.98px){.navbar-expand-md>.container,.navbar-expand-md>.container-fluid,.navbar-expand-md>.container-lg,.navbar-expand-md>.container-md,.navbar-expand-md>.container-sm,.navbar-expand-md>.container-xl{padding-right:0;padding-left:0}}@media (min-width:720px){.navbar-expand-md{flex-flow:row nowrap;justify-content:flex-start}.navbar-expand-md .navbar-nav{flex-direction:row}.navbar-expand-md .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-md .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-md>.container,.navbar-expand-md>.container-fluid,.navbar-expand-md>.container-lg,.navbar-expand-md>.container-md,.navbar-expand-md>.container-sm,.navbar-expand-md>.container-xl{flex-wrap:nowrap}.navbar-expand-md .navbar-nav-scroll{overflow:visible}.navbar-expand-md .navbar-collapse{display:flex!important;flex-basis:auto}.navbar-expand-md .navbar-toggler{display:none}}@media (max-width:959.98px){.navbar-expand-lg>.container,.navbar-expand-lg>.container-fluid,.navbar-expand-lg>.container-lg,.navbar-expand-lg>.container-md,.navbar-expand-lg>.container-sm,.navbar-expand-lg>.container-xl{padding-right:0;padding-left:0}}@media (min-width:960px){.navbar-expand-lg{flex-flow:row nowrap;justify-content:flex-start}.navbar-expand-lg .navbar-nav{flex-direction:row}.navbar-expand-lg .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-lg .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-lg>.container,.navbar-expand-lg>.container-fluid,.navbar-expand-lg>.container-lg,.navbar-expand-lg>.container-md,.navbar-expand-lg>.container-sm,.navbar-expand-lg>.container-xl{flex-wrap:nowrap}.navbar-expand-lg .navbar-nav-scroll{overflow:visible}.navbar-expand-lg .navbar-collapse{display:flex!important;flex-basis:auto}.navbar-expand-lg .navbar-toggler{display:none}}@media (max-width:1199.98px){.navbar-expand-xl>.container,.navbar-expand-xl>.container-fluid,.navbar-expand-xl>.container-lg,.navbar-expand-xl>.container-md,.navbar-expand-xl>.container-sm,.navbar-expand-xl>.container-xl{padding-right:0;padding-left:0}}@media (min-width:1200px){.navbar-expand-xl{flex-flow:row nowrap;justify-content:flex-start}.navbar-expand-xl .navbar-nav{flex-direction:row}.navbar-expand-xl .navbar-nav .dropdown-menu{position:absolute}.navbar-expand-xl .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand-xl>.container,.navbar-expand-xl>.container-fluid,.navbar-expand-xl>.container-lg,.navbar-expand-xl>.container-md,.navbar-expand-xl>.container-sm,.navbar-expand-xl>.container-xl{flex-wrap:nowrap}.navbar-expand-xl .navbar-nav-scroll{overflow:visible}.navbar-expand-xl .navbar-collapse{display:flex!important;flex-basis:auto}.navbar-expand-xl .navbar-toggler{display:none}}.navbar-expand{flex-flow:row nowrap;justify-content:flex-start}.navbar-expand>.container,.navbar-expand>.container-fluid,.navbar-expand>.container-lg,.navbar-expand>.container-md,.navbar-expand>.container-sm,.navbar-expand>.container-xl{padding-right:0;padding-left:0}.navbar-expand .navbar-nav{flex-direction:row}.navbar-expand .navbar-nav .dropdown-menu{position:absolute}.navbar-expand .navbar-nav .nav-link{padding-right:.5rem;padding-left:.5rem}.navbar-expand>.container,.navbar-expand>.container-fluid,.navbar-expand>.container-lg,.navbar-expand>.container-md,.navbar-expand>.container-sm,.navbar-expand>.container-xl{flex-wrap:nowrap}.navbar-expand .navbar-nav-scroll{overflow:visible}.navbar-expand .navbar-collapse{display:flex!important;flex-basis:auto}.navbar-expand .navbar-toggler{display:none}.navbar-light .navbar-brand,.navbar-light .navbar-brand:focus,.navbar-light .navbar-brand:hover{color:rgba(0,0,0,.9)}.navbar-light .navbar-nav .nav-link{color:rgba(0,0,0,.5)}.navbar-light .navbar-nav .nav-link:focus,.navbar-light .navbar-nav .nav-link:hover{color:rgba(0,0,0,.7)}.navbar-light .navbar-nav .nav-link.disabled{color:rgba(0,0,0,.3)}.navbar-light .navbar-nav .active>.nav-link,.navbar-light .navbar-nav .nav-link.active,.navbar-light .navbar-nav .nav-link.show,.navbar-light .navbar-nav .show>.nav-link{color:rgba(0,0,0,.9)}.navbar-light .navbar-toggler{color:rgba(0,0,0,.5);border-color:rgba(0,0,0,.1)}.navbar-light .navbar-toggler-icon{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='30' height='30'%3E%3Cpath stroke='rgba(0,0,0,0.5)' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/%3E%3C/svg%3E")}.navbar-light .navbar-text{color:rgba(0,0,0,.5)}.navbar-light .navbar-text a,.navbar-light .navbar-text a:focus,.navbar-light .navbar-text a:hover{color:rgba(0,0,0,.9)}.navbar-dark .navbar-brand,.navbar-dark .navbar-brand:focus,.navbar-dark .navbar-brand:hover{color:#fff}.navbar-dark .navbar-nav .nav-link{color:hsla(0,0%,100%,.5)}.navbar-dark .navbar-nav .nav-link:focus,.navbar-dark .navbar-nav .nav-link:hover{color:hsla(0,0%,100%,.75)}.navbar-dark .navbar-nav .nav-link.disabled{color:hsla(0,0%,100%,.25)}.navbar-dark .navbar-nav .active>.nav-link,.navbar-dark .navbar-nav .nav-link.active,.navbar-dark .navbar-nav .nav-link.show,.navbar-dark .navbar-nav .show>.nav-link{color:#fff}.navbar-dark .navbar-toggler{color:hsla(0,0%,100%,.5);border-color:hsla(0,0%,100%,.1)}.navbar-dark .navbar-toggler-icon{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='30' height='30'%3E%3Cpath stroke='rgba(255,255,255,0.5)' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/%3E%3C/svg%3E")}.navbar-dark .navbar-text{color:hsla(0,0%,100%,.5)}.navbar-dark .navbar-text a,.navbar-dark .navbar-text a:focus,.navbar-dark .navbar-text a:hover{color:#fff}.card{position:relative;display:flex;flex-direction:column;min-width:0;word-wrap:break-word;background-color:#fff;background-clip:border-box;border:1px solid rgba(0,0,0,.125);border-radius:.25rem}.card>hr{margin-right:0;margin-left:0}.card>.list-group{border-top:inherit;border-bottom:inherit}.card>.list-group:first-child{border-top-width:0;border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card>.list-group:last-child{border-bottom-width:0;border-bottom-right-radius:calc(.25rem - 1px);border-bottom-left-radius:calc(.25rem - 1px)}.card>.card-header+.list-group,.card>.list-group+.card-footer{border-top:0}.card-body{flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-top:-.375rem}.card-subtitle,.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{padding:.75rem 1.25rem;margin-bottom:0;background-color:rgba(0,0,0,.03);border-bottom:1px solid rgba(0,0,0,.125)}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-footer{padding:.75rem 1.25rem;background-color:rgba(0,0,0,.03);border-top:1px solid rgba(0,0,0,.125)}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{margin-bottom:-.75rem;border-bottom:0}.card-header-pills,.card-header-tabs{margin-right:-.625rem;margin-left:-.625rem}.card-img-overlay{position:absolute;top:0;right:0;bottom:0;left:0;padding:1.25rem;border-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom,.card-img-top{flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-right-radius:calc(.25rem - 1px);border-bottom-left-radius:calc(.25rem - 1px)}.card-deck .card{margin-bottom:15px}@media (min-width:540px){.card-deck{display:flex;flex-flow:row wrap;margin-right:-15px;margin-left:-15px}.card-deck .card{flex:1 0 0%;margin-right:15px;margin-bottom:0;margin-left:15px}}.card-group>.card{margin-bottom:15px}@media (min-width:540px){.card-group{display:flex;flex-flow:row wrap}.card-group>.card{flex:1 0 0%;margin-bottom:0}.card-group>.card+.card{margin-left:0;border-left:0}.card-group>.card:not(:last-child){border-top-right-radius:0;border-bottom-right-radius:0}.card-group>.card:not(:last-child) .card-header,.card-group>.card:not(:last-child) .card-img-top{border-top-right-radius:0}.card-group>.card:not(:last-child) .card-footer,.card-group>.card:not(:last-child) .card-img-bottom{border-bottom-right-radius:0}.card-group>.card:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.card-group>.card:not(:first-child) .card-header,.card-group>.card:not(:first-child) .card-img-top{border-top-left-radius:0}.card-group>.card:not(:first-child) .card-footer,.card-group>.card:not(:first-child) .card-img-bottom{border-bottom-left-radius:0}}.card-columns .card{margin-bottom:.75rem}@media (min-width:540px){.card-columns{column-count:3;column-gap:1.25rem;orphans:1;widows:1}.card-columns .card{display:inline-block;width:100%}}.accordion{overflow-anchor:none}.accordion>.card{overflow:hidden}.accordion>.card:not(:last-of-type){border-bottom:0;border-bottom-right-radius:0;border-bottom-left-radius:0}.accordion>.card:not(:first-of-type){border-top-left-radius:0;border-top-right-radius:0}.accordion>.card>.card-header{border-radius:0;margin-bottom:-1px}.breadcrumb{display:flex;flex-wrap:wrap;padding:.75rem 1rem;margin-bottom:1rem;list-style:none;background-color:#e9ecef;border-radius:.25rem}.breadcrumb-item+.breadcrumb-item{padding-left:.5rem}.breadcrumb-item+.breadcrumb-item:before{float:left;padding-right:.5rem;color:#6c757d;content:"/"}.breadcrumb-item+.breadcrumb-item:hover:before{text-decoration:underline;text-decoration:none}.breadcrumb-item.active{color:#6c757d}.pagination{display:flex;padding-left:0;list-style:none;border-radius:.25rem}.page-link{position:relative;display:block;padding:.5rem .75rem;margin-left:-1px;line-height:1.25;color:#007bff;background-color:#fff;border:1px solid #dee2e6}.page-link:hover{z-index:2;color:#0056b3;text-decoration:none;background-color:#e9ecef;border-color:#dee2e6}.page-link:focus{z-index:3;outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.page-item:first-child .page-link{margin-left:0;border-top-left-radius:.25rem;border-bottom-left-radius:.25rem}.page-item:last-child .page-link{border-top-right-radius:.25rem;border-bottom-right-radius:.25rem}.page-item.active .page-link{z-index:3;color:#fff;background-color:#007bff;border-color:#007bff}.page-item.disabled .page-link{color:#6c757d;pointer-events:none;cursor:auto;background-color:#fff;border-color:#dee2e6}.pagination-lg .page-link{padding:.75rem 1.5rem;font-size:1.25rem;line-height:1.5}.pagination-lg .page-item:first-child .page-link{border-top-left-radius:.3rem;border-bottom-left-radius:.3rem}.pagination-lg .page-item:last-child .page-link{border-top-right-radius:.3rem;border-bottom-right-radius:.3rem}.pagination-sm .page-link{padding:.25rem .5rem;font-size:.875rem;line-height:1.5}.pagination-sm .page-item:first-child .page-link{border-top-left-radius:.2rem;border-bottom-left-radius:.2rem}.pagination-sm .page-item:last-child .page-link{border-top-right-radius:.2rem;border-bottom-right-radius:.2rem}.badge{display:inline-block;padding:.25em .4em;font-size:75%;font-weight:700;line-height:1;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25rem;transition:color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.badge{transition:none}}a.badge:focus,a.badge:hover{text-decoration:none}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{padding-right:.6em;padding-left:.6em;border-radius:10rem}.badge-primary{color:#fff;background-color:#007bff}a.badge-primary:focus,a.badge-primary:hover{color:#fff;background-color:#0062cc}a.badge-primary.focus,a.badge-primary:focus{outline:0;box-shadow:0 0 0 .2rem rgba(0,123,255,.5)}.badge-secondary{color:#fff;background-color:#6c757d}a.badge-secondary:focus,a.badge-secondary:hover{color:#fff;background-color:#545b62}a.badge-secondary.focus,a.badge-secondary:focus{outline:0;box-shadow:0 0 0 .2rem rgba(108,117,125,.5)}.badge-success{color:#fff;background-color:#28a745}a.badge-success:focus,a.badge-success:hover{color:#fff;background-color:#1e7e34}a.badge-success.focus,a.badge-success:focus{outline:0;box-shadow:0 0 0 .2rem rgba(40,167,69,.5)}.badge-info{color:#fff;background-color:#17a2b8}a.badge-info:focus,a.badge-info:hover{color:#fff;background-color:#117a8b}a.badge-info.focus,a.badge-info:focus{outline:0;box-shadow:0 0 0 .2rem rgba(23,162,184,.5)}.badge-warning{color:#212529;background-color:#ffc107}a.badge-warning:focus,a.badge-warning:hover{color:#212529;background-color:#d39e00}a.badge-warning.focus,a.badge-warning:focus{outline:0;box-shadow:0 0 0 .2rem rgba(255,193,7,.5)}.badge-danger{color:#fff;background-color:#dc3545}a.badge-danger:focus,a.badge-danger:hover{color:#fff;background-color:#bd2130}a.badge-danger.focus,a.badge-danger:focus{outline:0;box-shadow:0 0 0 .2rem rgba(220,53,69,.5)}.badge-light{color:#212529;background-color:#f8f9fa}a.badge-light:focus,a.badge-light:hover{color:#212529;background-color:#dae0e5}a.badge-light.focus,a.badge-light:focus{outline:0;box-shadow:0 0 0 .2rem rgba(248,249,250,.5)}.badge-dark{color:#fff;background-color:#343a40}a.badge-dark:focus,a.badge-dark:hover{color:#fff;background-color:#1d2124}a.badge-dark.focus,a.badge-dark:focus{outline:0;box-shadow:0 0 0 .2rem rgba(52,58,64,.5)}.jumbotron{padding:2rem 1rem;margin-bottom:2rem;background-color:#e9ecef;border-radius:.3rem}@media (min-width:540px){.jumbotron{padding:4rem 2rem}}.jumbotron-fluid{padding-right:0;padding-left:0;border-radius:0}.alert{position:relative;padding:.75rem 1.25rem;margin-bottom:1rem;border:1px solid transparent;border-radius:.25rem}.alert-heading{color:inherit}.alert-link{font-weight:700}.alert-dismissible{padding-right:4rem}.alert-dismissible .close{position:absolute;top:0;right:0;z-index:2;padding:.75rem 1.25rem;color:inherit}.alert-primary{color:#004085;background-color:#cce5ff;border-color:#b8daff}.alert-primary hr{border-top-color:#9fcdff}.alert-primary .alert-link{color:#002752}.alert-secondary{color:#383d41;background-color:#e2e3e5;border-color:#d6d8db}.alert-secondary hr{border-top-color:#c8cbcf}.alert-secondary .alert-link{color:#202326}.alert-success{color:#155724;background-color:#d4edda;border-color:#c3e6cb}.alert-success hr{border-top-color:#b1dfbb}.alert-success .alert-link{color:#0b2e13}.alert-info{color:#0c5460;background-color:#d1ecf1;border-color:#bee5eb}.alert-info hr{border-top-color:#abdde5}.alert-info .alert-link{color:#062c33}.alert-warning{color:#856404;background-color:#fff3cd;border-color:#ffeeba}.alert-warning hr{border-top-color:#ffe8a1}.alert-warning .alert-link{color:#533f03}.alert-danger{color:#721c24;background-color:#f8d7da;border-color:#f5c6cb}.alert-danger hr{border-top-color:#f1b0b7}.alert-danger .alert-link{color:#491217}.alert-light{color:#818182;background-color:#fefefe;border-color:#fdfdfe}.alert-light hr{border-top-color:#ececf6}.alert-light .alert-link{color:#686868}.alert-dark{color:#1b1e21;background-color:#d6d8d9;border-color:#c6c8ca}.alert-dark hr{border-top-color:#b9bbbe}.alert-dark .alert-link{color:#040505}@keyframes progress-bar-stripes{0%{background-position:1rem 0}to{background-position:0 0}}.progress{height:1rem;line-height:0;font-size:.75rem;background-color:#e9ecef;border-radius:.25rem}.progress,.progress-bar{display:flex;overflow:hidden}.progress-bar{flex-direction:column;justify-content:center;color:#fff;text-align:center;white-space:nowrap;background-color:#007bff;transition:width .6s ease}@media (prefers-reduced-motion:reduce){.progress-bar{transition:none}}.progress-bar-striped{background-image:linear-gradient(45deg,hsla(0,0%,100%,.15) 25%,transparent 0,transparent 50%,hsla(0,0%,100%,.15) 0,hsla(0,0%,100%,.15) 75%,transparent 0,transparent);background-size:1rem 1rem}.progress-bar-animated{animation:progress-bar-stripes 1s linear infinite}@media (prefers-reduced-motion:reduce){.progress-bar-animated{animation:none}}.media{display:flex;align-items:flex-start}.media-body{flex:1}.list-group{display:flex;flex-direction:column;padding-left:0;margin-bottom:0;border-radius:.25rem}.list-group-item-action{width:100%;color:#495057;text-align:inherit}.list-group-item-action:focus,.list-group-item-action:hover{z-index:1;color:#495057;text-decoration:none;background-color:#f8f9fa}.list-group-item-action:active{color:#212529;background-color:#e9ecef}.list-group-item{position:relative;display:block;padding:.75rem 1.25rem;background-color:#fff;border:1px solid rgba(0,0,0,.125)}.list-group-item:first-child{border-top-left-radius:inherit;border-top-right-radius:inherit}.list-group-item:last-child{border-bottom-right-radius:inherit;border-bottom-left-radius:inherit}.list-group-item.disabled,.list-group-item:disabled{color:#6c757d;pointer-events:none;background-color:#fff}.list-group-item.active{z-index:2;color:#fff;background-color:#007bff;border-color:#007bff}.list-group-item+.list-group-item{border-top-width:0}.list-group-item+.list-group-item.active{margin-top:-1px;border-top-width:1px}.list-group-horizontal{flex-direction:row}.list-group-horizontal>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal>.list-group-item.active{margin-top:0}.list-group-horizontal>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}@media (min-width:540px){.list-group-horizontal-sm{flex-direction:row}.list-group-horizontal-sm>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-sm>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-sm>.list-group-item.active{margin-top:0}.list-group-horizontal-sm>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-sm>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}@media (min-width:720px){.list-group-horizontal-md{flex-direction:row}.list-group-horizontal-md>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-md>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-md>.list-group-item.active{margin-top:0}.list-group-horizontal-md>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-md>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}@media (min-width:960px){.list-group-horizontal-lg{flex-direction:row}.list-group-horizontal-lg>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-lg>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-lg>.list-group-item.active{margin-top:0}.list-group-horizontal-lg>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-lg>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}@media (min-width:1200px){.list-group-horizontal-xl{flex-direction:row}.list-group-horizontal-xl>.list-group-item:first-child{border-bottom-left-radius:.25rem;border-top-right-radius:0}.list-group-horizontal-xl>.list-group-item:last-child{border-top-right-radius:.25rem;border-bottom-left-radius:0}.list-group-horizontal-xl>.list-group-item.active{margin-top:0}.list-group-horizontal-xl>.list-group-item+.list-group-item{border-top-width:1px;border-left-width:0}.list-group-horizontal-xl>.list-group-item+.list-group-item.active{margin-left:-1px;border-left-width:1px}}.list-group-flush{border-radius:0}.list-group-flush>.list-group-item{border-width:0 0 1px}.list-group-flush>.list-group-item:last-child{border-bottom-width:0}.list-group-item-primary{color:#004085;background-color:#b8daff}.list-group-item-primary.list-group-item-action:focus,.list-group-item-primary.list-group-item-action:hover{color:#004085;background-color:#9fcdff}.list-group-item-primary.list-group-item-action.active{color:#fff;background-color:#004085;border-color:#004085}.list-group-item-secondary{color:#383d41;background-color:#d6d8db}.list-group-item-secondary.list-group-item-action:focus,.list-group-item-secondary.list-group-item-action:hover{color:#383d41;background-color:#c8cbcf}.list-group-item-secondary.list-group-item-action.active{color:#fff;background-color:#383d41;border-color:#383d41}.list-group-item-success{color:#155724;background-color:#c3e6cb}.list-group-item-success.list-group-item-action:focus,.list-group-item-success.list-group-item-action:hover{color:#155724;background-color:#b1dfbb}.list-group-item-success.list-group-item-action.active{color:#fff;background-color:#155724;border-color:#155724}.list-group-item-info{color:#0c5460;background-color:#bee5eb}.list-group-item-info.list-group-item-action:focus,.list-group-item-info.list-group-item-action:hover{color:#0c5460;background-color:#abdde5}.list-group-item-info.list-group-item-action.active{color:#fff;background-color:#0c5460;border-color:#0c5460}.list-group-item-warning{color:#856404;background-color:#ffeeba}.list-group-item-warning.list-group-item-action:focus,.list-group-item-warning.list-group-item-action:hover{color:#856404;background-color:#ffe8a1}.list-group-item-warning.list-group-item-action.active{color:#fff;background-color:#856404;border-color:#856404}.list-group-item-danger{color:#721c24;background-color:#f5c6cb}.list-group-item-danger.list-group-item-action:focus,.list-group-item-danger.list-group-item-action:hover{color:#721c24;background-color:#f1b0b7}.list-group-item-danger.list-group-item-action.active{color:#fff;background-color:#721c24;border-color:#721c24}.list-group-item-light{color:#818182;background-color:#fdfdfe}.list-group-item-light.list-group-item-action:focus,.list-group-item-light.list-group-item-action:hover{color:#818182;background-color:#ececf6}.list-group-item-light.list-group-item-action.active{color:#fff;background-color:#818182;border-color:#818182}.list-group-item-dark{color:#1b1e21;background-color:#c6c8ca}.list-group-item-dark.list-group-item-action:focus,.list-group-item-dark.list-group-item-action:hover{color:#1b1e21;background-color:#b9bbbe}.list-group-item-dark.list-group-item-action.active{color:#fff;background-color:#1b1e21;border-color:#1b1e21}.close{float:right;font-size:1.5rem;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;opacity:.5}.close:hover{color:#000;text-decoration:none}.close:not(:disabled):not(.disabled):focus,.close:not(:disabled):not(.disabled):hover{opacity:.75}button.close{padding:0;background-color:transparent;border:0}a.close.disabled{pointer-events:none}.toast{flex-basis:350px;max-width:350px;font-size:.875rem;background-color:hsla(0,0%,100%,.85);background-clip:padding-box;border:1px solid rgba(0,0,0,.1);box-shadow:0 .25rem .75rem rgba(0,0,0,.1);opacity:0;border-radius:.25rem}.toast:not(:last-child){margin-bottom:.75rem}.toast.showing{opacity:1}.toast.show{display:block;opacity:1}.toast.hide{display:none}.toast-header{display:flex;align-items:center;padding:.25rem .75rem;color:#6c757d;background-color:hsla(0,0%,100%,.85);background-clip:padding-box;border-bottom:1px solid rgba(0,0,0,.05);border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.toast-body{padding:.75rem}.modal-open{overflow:hidden}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal{position:fixed;top:0;left:0;z-index:1050;display:none;width:100%;height:100%;overflow:hidden;outline:0}.modal-dialog{position:relative;width:auto;margin:.5rem;pointer-events:none}.modal.fade .modal-dialog{transition:transform .3s ease-out;transform:translateY(-50px)}@media (prefers-reduced-motion:reduce){.modal.fade .modal-dialog{transition:none}}.modal.show .modal-dialog{transform:none}.modal.modal-static .modal-dialog{transform:scale(1.02)}.modal-dialog-scrollable{display:flex;max-height:calc(100% - 1rem)}.modal-dialog-scrollable .modal-content{max-height:calc(100vh - 1rem);overflow:hidden}.modal-dialog-scrollable .modal-footer,.modal-dialog-scrollable .modal-header{flex-shrink:0}.modal-dialog-scrollable .modal-body{overflow-y:auto}.modal-dialog-centered{display:flex;align-items:center;min-height:calc(100% - 1rem)}.modal-dialog-centered:before{display:block;height:calc(100vh - 1rem);height:min-content;content:""}.modal-dialog-centered.modal-dialog-scrollable{flex-direction:column;justify-content:center;height:100%}.modal-dialog-centered.modal-dialog-scrollable .modal-content{max-height:none}.modal-dialog-centered.modal-dialog-scrollable:before{content:none}.modal-content{position:relative;display:flex;flex-direction:column;width:100%;pointer-events:auto;background-color:#fff;background-clip:padding-box;border:1px solid rgba(0,0,0,.2);border-radius:.3rem;outline:0}.modal-backdrop{position:fixed;top:0;left:0;z-index:1040;width:100vw;height:100vh;background-color:#000}.modal-backdrop.fade{opacity:0}.modal-backdrop.show{opacity:.5}.modal-header{display:flex;align-items:flex-start;justify-content:space-between;padding:1rem;border-bottom:1px solid #dee2e6;border-top-left-radius:calc(.3rem - 1px);border-top-right-radius:calc(.3rem - 1px)}.modal-header .close{padding:1rem;margin:-1rem -1rem -1rem auto}.modal-title{margin-bottom:0;line-height:1.5}.modal-body{position:relative;flex:1 1 auto;padding:1rem}.modal-footer{display:flex;flex-wrap:wrap;align-items:center;justify-content:flex-end;padding:.75rem;border-top:1px solid #dee2e6;border-bottom-right-radius:calc(.3rem - 1px);border-bottom-left-radius:calc(.3rem - 1px)}.modal-footer>*{margin:.25rem}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:540px){.modal-dialog{max-width:500px;margin:1.75rem auto}.modal-dialog-scrollable{max-height:calc(100% - 3.5rem)}.modal-dialog-scrollable .modal-content{max-height:calc(100vh - 3.5rem)}.modal-dialog-centered{min-height:calc(100% - 3.5rem)}.modal-dialog-centered:before{height:calc(100vh - 3.5rem);height:min-content}.modal-sm{max-width:300px}}@media (min-width:960px){.modal-lg,.modal-xl{max-width:800px}}@media (min-width:1200px){.modal-xl{max-width:1140px}}.tooltip{position:absolute;z-index:1070;display:block;margin:0;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,Liberation Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;font-style:normal;font-weight:400;line-height:1.5;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;white-space:normal;line-break:auto;font-size:.875rem;word-wrap:break-word;opacity:0}.tooltip.show{opacity:.9}.tooltip .arrow{position:absolute;display:block;width:.8rem;height:.4rem}.tooltip .arrow:before{position:absolute;content:"";border-color:transparent;border-style:solid}.bs-tooltip-auto[x-placement^=top],.bs-tooltip-top{padding:.4rem 0}.bs-tooltip-auto[x-placement^=top] .arrow,.bs-tooltip-top .arrow{bottom:0}.bs-tooltip-auto[x-placement^=top] .arrow:before,.bs-tooltip-top .arrow:before{top:0;border-width:.4rem .4rem 0;border-top-color:#000}.bs-tooltip-auto[x-placement^=right],.bs-tooltip-right{padding:0 .4rem}.bs-tooltip-auto[x-placement^=right] .arrow,.bs-tooltip-right .arrow{left:0;width:.4rem;height:.8rem}.bs-tooltip-auto[x-placement^=right] .arrow:before,.bs-tooltip-right .arrow:before{right:0;border-width:.4rem .4rem .4rem 0;border-right-color:#000}.bs-tooltip-auto[x-placement^=bottom],.bs-tooltip-bottom{padding:.4rem 0}.bs-tooltip-auto[x-placement^=bottom] .arrow,.bs-tooltip-bottom .arrow{top:0}.bs-tooltip-auto[x-placement^=bottom] .arrow:before,.bs-tooltip-bottom .arrow:before{bottom:0;border-width:0 .4rem .4rem;border-bottom-color:#000}.bs-tooltip-auto[x-placement^=left],.bs-tooltip-left{padding:0 .4rem}.bs-tooltip-auto[x-placement^=left] .arrow,.bs-tooltip-left .arrow{right:0;width:.4rem;height:.8rem}.bs-tooltip-auto[x-placement^=left] .arrow:before,.bs-tooltip-left .arrow:before{left:0;border-width:.4rem 0 .4rem .4rem;border-left-color:#000}.tooltip-inner{max-width:200px;padding:.25rem .5rem;color:#fff;text-align:center;background-color:#000;border-radius:.25rem}.popover{top:0;left:0;z-index:1060;max-width:276px;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,Liberation Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;font-style:normal;font-weight:400;line-height:1.5;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;white-space:normal;line-break:auto;font-size:.875rem;word-wrap:break-word;background-color:#fff;background-clip:padding-box;border:1px solid rgba(0,0,0,.2);border-radius:.3rem}.popover,.popover .arrow{position:absolute;display:block}.popover .arrow{width:1rem;height:.5rem;margin:0 .3rem}.popover .arrow:after,.popover .arrow:before{position:absolute;display:block;content:"";border-color:transparent;border-style:solid}.bs-popover-auto[x-placement^=top],.bs-popover-top{margin-bottom:.5rem}.bs-popover-auto[x-placement^=top]>.arrow,.bs-popover-top>.arrow{bottom:calc(-.5rem - 1px)}.bs-popover-auto[x-placement^=top]>.arrow:before,.bs-popover-top>.arrow:before{bottom:0;border-width:.5rem .5rem 0;border-top-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=top]>.arrow:after,.bs-popover-top>.arrow:after{bottom:1px;border-width:.5rem .5rem 0;border-top-color:#fff}.bs-popover-auto[x-placement^=right],.bs-popover-right{margin-left:.5rem}.bs-popover-auto[x-placement^=right]>.arrow,.bs-popover-right>.arrow{left:calc(-.5rem - 1px);width:.5rem;height:1rem;margin:.3rem 0}.bs-popover-auto[x-placement^=right]>.arrow:before,.bs-popover-right>.arrow:before{left:0;border-width:.5rem .5rem .5rem 0;border-right-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=right]>.arrow:after,.bs-popover-right>.arrow:after{left:1px;border-width:.5rem .5rem .5rem 0;border-right-color:#fff}.bs-popover-auto[x-placement^=bottom],.bs-popover-bottom{margin-top:.5rem}.bs-popover-auto[x-placement^=bottom]>.arrow,.bs-popover-bottom>.arrow{top:calc(-.5rem - 1px)}.bs-popover-auto[x-placement^=bottom]>.arrow:before,.bs-popover-bottom>.arrow:before{top:0;border-width:0 .5rem .5rem;border-bottom-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=bottom]>.arrow:after,.bs-popover-bottom>.arrow:after{top:1px;border-width:0 .5rem .5rem;border-bottom-color:#fff}.bs-popover-auto[x-placement^=bottom] .popover-header:before,.bs-popover-bottom .popover-header:before{position:absolute;top:0;left:50%;display:block;width:1rem;margin-left:-.5rem;content:"";border-bottom:1px solid #f7f7f7}.bs-popover-auto[x-placement^=left],.bs-popover-left{margin-right:.5rem}.bs-popover-auto[x-placement^=left]>.arrow,.bs-popover-left>.arrow{right:calc(-.5rem - 1px);width:.5rem;height:1rem;margin:.3rem 0}.bs-popover-auto[x-placement^=left]>.arrow:before,.bs-popover-left>.arrow:before{right:0;border-width:.5rem 0 .5rem .5rem;border-left-color:rgba(0,0,0,.25)}.bs-popover-auto[x-placement^=left]>.arrow:after,.bs-popover-left>.arrow:after{right:1px;border-width:.5rem 0 .5rem .5rem;border-left-color:#fff}.popover-header{padding:.5rem .75rem;margin-bottom:0;font-size:1rem;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-top-left-radius:calc(.3rem - 1px);border-top-right-radius:calc(.3rem - 1px)}.popover-header:empty{display:none}.popover-body{padding:.5rem .75rem;color:#212529}.carousel{position:relative}.carousel.pointer-event{touch-action:pan-y}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner:after{display:block;clear:both;content:""}.carousel-item{position:relative;display:none;float:left;width:100%;margin-right:-100%;backface-visibility:hidden;transition:transform .6s ease-in-out}@media (prefers-reduced-motion:reduce){.carousel-item{transition:none}}.carousel-item-next,.carousel-item-prev,.carousel-item.active{display:block}.active.carousel-item-right,.carousel-item-next:not(.carousel-item-left){transform:translateX(100%)}.active.carousel-item-left,.carousel-item-prev:not(.carousel-item-right){transform:translateX(-100%)}.carousel-fade .carousel-item{opacity:0;transition-property:opacity;transform:none}.carousel-fade .carousel-item-next.carousel-item-left,.carousel-fade .carousel-item-prev.carousel-item-right,.carousel-fade .carousel-item.active{z-index:1;opacity:1}.carousel-fade .active.carousel-item-left,.carousel-fade .active.carousel-item-right{z-index:0;opacity:0;transition:opacity 0s .6s}@media (prefers-reduced-motion:reduce){.carousel-fade .active.carousel-item-left,.carousel-fade .active.carousel-item-right{transition:none}}.carousel-control-next,.carousel-control-prev{position:absolute;top:0;bottom:0;z-index:1;display:flex;align-items:center;justify-content:center;width:15%;padding:0;color:#fff;text-align:center;background:none;border:0;opacity:.5;transition:opacity .15s ease}@media (prefers-reduced-motion:reduce){.carousel-control-next,.carousel-control-prev{transition:none}}.carousel-control-next:focus,.carousel-control-next:hover,.carousel-control-prev:focus,.carousel-control-prev:hover{color:#fff;text-decoration:none;outline:0;opacity:.9}.carousel-control-prev{left:0}.carousel-control-next{right:0}.carousel-control-next-icon,.carousel-control-prev-icon{display:inline-block;width:20px;height:20px;background:50%/100% 100% no-repeat}.carousel-control-prev-icon{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%23fff' width='8' height='8'%3E%3Cpath d='M5.25 0l-4 4 4 4 1.5-1.5L4.25 4l2.5-2.5L5.25 0z'/%3E%3C/svg%3E")}.carousel-control-next-icon{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%23fff' width='8' height='8'%3E%3Cpath d='M2.75 0l-1.5 1.5L3.75 4l-2.5 2.5L2.75 8l4-4-4-4z'/%3E%3C/svg%3E")}.carousel-indicators{position:absolute;right:0;bottom:0;left:0;z-index:15;display:flex;justify-content:center;padding-left:0;margin-right:15%;margin-left:15%;list-style:none}.carousel-indicators li{box-sizing:content-box;flex:0 1 auto;width:30px;height:3px;margin-right:3px;margin-left:3px;text-indent:-999px;cursor:pointer;background-color:#fff;background-clip:padding-box;border-top:10px solid transparent;border-bottom:10px solid transparent;opacity:.5;transition:opacity .6s ease}@media (prefers-reduced-motion:reduce){.carousel-indicators li{transition:none}}.carousel-indicators .active{opacity:1}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center}@keyframes spinner-border{to{transform:rotate(1turn)}}.spinner-border{display:inline-block;width:2rem;height:2rem;vertical-align:-.125em;border:.25em solid;border-right:.25em solid transparent;border-radius:50%;animation:spinner-border .75s linear infinite}.spinner-border-sm{width:1rem;height:1rem;border-width:.2em}@keyframes spinner-grow{0%{transform:scale(0)}50%{opacity:1;transform:none}}.spinner-grow{display:inline-block;width:2rem;height:2rem;vertical-align:-.125em;background-color:currentColor;border-radius:50%;opacity:0;animation:spinner-grow .75s linear infinite}.spinner-grow-sm{width:1rem;height:1rem}@media (prefers-reduced-motion:reduce){.spinner-border,.spinner-grow{animation-duration:1.5s}}.align-baseline{vertical-align:baseline!important}.align-top{vertical-align:top!important}.align-middle{vertical-align:middle!important}.align-bottom{vertical-align:bottom!important}.align-text-bottom{vertical-align:text-bottom!important}.align-text-top{vertical-align:text-top!important}.bg-primary{background-color:#007bff!important}a.bg-primary:focus,a.bg-primary:hover,button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc!important}.bg-secondary{background-color:#6c757d!important}a.bg-secondary:focus,a.bg-secondary:hover,button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62!important}.bg-success{background-color:#28a745!important}a.bg-success:focus,a.bg-success:hover,button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34!important}.bg-info{background-color:#17a2b8!important}a.bg-info:focus,a.bg-info:hover,button.bg-info:focus,button.bg-info:hover{background-color:#117a8b!important}.bg-warning{background-color:#ffc107!important}a.bg-warning:focus,a.bg-warning:hover,button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00!important}.bg-danger{background-color:#dc3545!important}a.bg-danger:focus,a.bg-danger:hover,button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130!important}.bg-light{background-color:#f8f9fa!important}a.bg-light:focus,a.bg-light:hover,button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5!important}.bg-dark{background-color:#343a40!important}a.bg-dark:focus,a.bg-dark:hover,button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124!important}.bg-white{background-color:#fff!important}.bg-transparent{background-color:transparent!important}.border{border:1px solid #dee2e6!important}.border-top{border-top:1px solid #dee2e6!important}.border-right{border-right:1px solid #dee2e6!important}.border-bottom{border-bottom:1px solid #dee2e6!important}.border-left{border-left:1px solid #dee2e6!important}.border-0{border:0!important}.border-top-0{border-top:0!important}.border-right-0{border-right:0!important}.border-bottom-0{border-bottom:0!important}.border-left-0{border-left:0!important}.border-primary{border-color:#007bff!important}.border-secondary{border-color:#6c757d!important}.border-success{border-color:#28a745!important}.border-info{border-color:#17a2b8!important}.border-warning{border-color:#ffc107!important}.border-danger{border-color:#dc3545!important}.border-light{border-color:#f8f9fa!important}.border-dark{border-color:#343a40!important}.border-white{border-color:#fff!important}.rounded-sm{border-radius:.2rem!important}.rounded{border-radius:.25rem!important}.rounded-top{border-top-left-radius:.25rem!important}.rounded-right,.rounded-top{border-top-right-radius:.25rem!important}.rounded-bottom,.rounded-right{border-bottom-right-radius:.25rem!important}.rounded-bottom,.rounded-left{border-bottom-left-radius:.25rem!important}.rounded-left{border-top-left-radius:.25rem!important}.rounded-lg{border-radius:.3rem!important}.rounded-circle{border-radius:50%!important}.rounded-pill{border-radius:50rem!important}.rounded-0{border-radius:0!important}.clearfix:after{display:block;clear:both;content:""}.d-none{display:none!important}.d-inline{display:inline!important}.d-inline-block{display:inline-block!important}.d-block{display:block!important}.d-table{display:table!important}.d-table-row{display:table-row!important}.d-table-cell{display:table-cell!important}.d-flex{display:flex!important}.d-inline-flex{display:inline-flex!important}@media (min-width:540px){.d-sm-none{display:none!important}.d-sm-inline{display:inline!important}.d-sm-inline-block{display:inline-block!important}.d-sm-block{display:block!important}.d-sm-table{display:table!important}.d-sm-table-row{display:table-row!important}.d-sm-table-cell{display:table-cell!important}.d-sm-flex{display:flex!important}.d-sm-inline-flex{display:inline-flex!important}}@media (min-width:720px){.d-md-none{display:none!important}.d-md-inline{display:inline!important}.d-md-inline-block{display:inline-block!important}.d-md-block{display:block!important}.d-md-table{display:table!important}.d-md-table-row{display:table-row!important}.d-md-table-cell{display:table-cell!important}.d-md-flex{display:flex!important}.d-md-inline-flex{display:inline-flex!important}}@media (min-width:960px){.d-lg-none{display:none!important}.d-lg-inline{display:inline!important}.d-lg-inline-block{display:inline-block!important}.d-lg-block{display:block!important}.d-lg-table{display:table!important}.d-lg-table-row{display:table-row!important}.d-lg-table-cell{display:table-cell!important}.d-lg-flex{display:flex!important}.d-lg-inline-flex{display:inline-flex!important}}@media (min-width:1200px){.d-xl-none{display:none!important}.d-xl-inline{display:inline!important}.d-xl-inline-block{display:inline-block!important}.d-xl-block{display:block!important}.d-xl-table{display:table!important}.d-xl-table-row{display:table-row!important}.d-xl-table-cell{display:table-cell!important}.d-xl-flex{display:flex!important}.d-xl-inline-flex{display:inline-flex!important}}@media print{.d-print-none{display:none!important}.d-print-inline{display:inline!important}.d-print-inline-block{display:inline-block!important}.d-print-block{display:block!important}.d-print-table{display:table!important}.d-print-table-row{display:table-row!important}.d-print-table-cell{display:table-cell!important}.d-print-flex{display:flex!important}.d-print-inline-flex{display:inline-flex!important}}.embed-responsive{position:relative;display:block;width:100%;padding:0;overflow:hidden}.embed-responsive:before{display:block;content:""}.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-21by9:before{padding-top:42.85714%}.embed-responsive-16by9:before{padding-top:56.25%}.embed-responsive-4by3:before{padding-top:75%}.embed-responsive-1by1:before{padding-top:100%}.flex-row{flex-direction:row!important}.flex-column{flex-direction:column!important}.flex-row-reverse{flex-direction:row-reverse!important}.flex-column-reverse{flex-direction:column-reverse!important}.flex-wrap{flex-wrap:wrap!important}.flex-nowrap{flex-wrap:nowrap!important}.flex-wrap-reverse{flex-wrap:wrap-reverse!important}.flex-fill{flex:1 1 auto!important}.flex-grow-0{flex-grow:0!important}.flex-grow-1{flex-grow:1!important}.flex-shrink-0{flex-shrink:0!important}.flex-shrink-1{flex-shrink:1!important}.justify-content-start{justify-content:flex-start!important}.justify-content-end{justify-content:flex-end!important}.justify-content-center{justify-content:center!important}.justify-content-between{justify-content:space-between!important}.justify-content-around{justify-content:space-around!important}.align-items-start{align-items:flex-start!important}.align-items-end{align-items:flex-end!important}.align-items-center{align-items:center!important}.align-items-baseline{align-items:baseline!important}.align-items-stretch{align-items:stretch!important}.align-content-start{align-content:flex-start!important}.align-content-end{align-content:flex-end!important}.align-content-center{align-content:center!important}.align-content-between{align-content:space-between!important}.align-content-around{align-content:space-around!important}.align-content-stretch{align-content:stretch!important}.align-self-auto{align-self:auto!important}.align-self-start{align-self:flex-start!important}.align-self-end{align-self:flex-end!important}.align-self-center{align-self:center!important}.align-self-baseline{align-self:baseline!important}.align-self-stretch{align-self:stretch!important}@media (min-width:540px){.flex-sm-row{flex-direction:row!important}.flex-sm-column{flex-direction:column!important}.flex-sm-row-reverse{flex-direction:row-reverse!important}.flex-sm-column-reverse{flex-direction:column-reverse!important}.flex-sm-wrap{flex-wrap:wrap!important}.flex-sm-nowrap{flex-wrap:nowrap!important}.flex-sm-wrap-reverse{flex-wrap:wrap-reverse!important}.flex-sm-fill{flex:1 1 auto!important}.flex-sm-grow-0{flex-grow:0!important}.flex-sm-grow-1{flex-grow:1!important}.flex-sm-shrink-0{flex-shrink:0!important}.flex-sm-shrink-1{flex-shrink:1!important}.justify-content-sm-start{justify-content:flex-start!important}.justify-content-sm-end{justify-content:flex-end!important}.justify-content-sm-center{justify-content:center!important}.justify-content-sm-between{justify-content:space-between!important}.justify-content-sm-around{justify-content:space-around!important}.align-items-sm-start{align-items:flex-start!important}.align-items-sm-end{align-items:flex-end!important}.align-items-sm-center{align-items:center!important}.align-items-sm-baseline{align-items:baseline!important}.align-items-sm-stretch{align-items:stretch!important}.align-content-sm-start{align-content:flex-start!important}.align-content-sm-end{align-content:flex-end!important}.align-content-sm-center{align-content:center!important}.align-content-sm-between{align-content:space-between!important}.align-content-sm-around{align-content:space-around!important}.align-content-sm-stretch{align-content:stretch!important}.align-self-sm-auto{align-self:auto!important}.align-self-sm-start{align-self:flex-start!important}.align-self-sm-end{align-self:flex-end!important}.align-self-sm-center{align-self:center!important}.align-self-sm-baseline{align-self:baseline!important}.align-self-sm-stretch{align-self:stretch!important}}@media (min-width:720px){.flex-md-row{flex-direction:row!important}.flex-md-column{flex-direction:column!important}.flex-md-row-reverse{flex-direction:row-reverse!important}.flex-md-column-reverse{flex-direction:column-reverse!important}.flex-md-wrap{flex-wrap:wrap!important}.flex-md-nowrap{flex-wrap:nowrap!important}.flex-md-wrap-reverse{flex-wrap:wrap-reverse!important}.flex-md-fill{flex:1 1 auto!important}.flex-md-grow-0{flex-grow:0!important}.flex-md-grow-1{flex-grow:1!important}.flex-md-shrink-0{flex-shrink:0!important}.flex-md-shrink-1{flex-shrink:1!important}.justify-content-md-start{justify-content:flex-start!important}.justify-content-md-end{justify-content:flex-end!important}.justify-content-md-center{justify-content:center!important}.justify-content-md-between{justify-content:space-between!important}.justify-content-md-around{justify-content:space-around!important}.align-items-md-start{align-items:flex-start!important}.align-items-md-end{align-items:flex-end!important}.align-items-md-center{align-items:center!important}.align-items-md-baseline{align-items:baseline!important}.align-items-md-stretch{align-items:stretch!important}.align-content-md-start{align-content:flex-start!important}.align-content-md-end{align-content:flex-end!important}.align-content-md-center{align-content:center!important}.align-content-md-between{align-content:space-between!important}.align-content-md-around{align-content:space-around!important}.align-content-md-stretch{align-content:stretch!important}.align-self-md-auto{align-self:auto!important}.align-self-md-start{align-self:flex-start!important}.align-self-md-end{align-self:flex-end!important}.align-self-md-center{align-self:center!important}.align-self-md-baseline{align-self:baseline!important}.align-self-md-stretch{align-self:stretch!important}}@media (min-width:960px){.flex-lg-row{flex-direction:row!important}.flex-lg-column{flex-direction:column!important}.flex-lg-row-reverse{flex-direction:row-reverse!important}.flex-lg-column-reverse{flex-direction:column-reverse!important}.flex-lg-wrap{flex-wrap:wrap!important}.flex-lg-nowrap{flex-wrap:nowrap!important}.flex-lg-wrap-reverse{flex-wrap:wrap-reverse!important}.flex-lg-fill{flex:1 1 auto!important}.flex-lg-grow-0{flex-grow:0!important}.flex-lg-grow-1{flex-grow:1!important}.flex-lg-shrink-0{flex-shrink:0!important}.flex-lg-shrink-1{flex-shrink:1!important}.justify-content-lg-start{justify-content:flex-start!important}.justify-content-lg-end{justify-content:flex-end!important}.justify-content-lg-center{justify-content:center!important}.justify-content-lg-between{justify-content:space-between!important}.justify-content-lg-around{justify-content:space-around!important}.align-items-lg-start{align-items:flex-start!important}.align-items-lg-end{align-items:flex-end!important}.align-items-lg-center{align-items:center!important}.align-items-lg-baseline{align-items:baseline!important}.align-items-lg-stretch{align-items:stretch!important}.align-content-lg-start{align-content:flex-start!important}.align-content-lg-end{align-content:flex-end!important}.align-content-lg-center{align-content:center!important}.align-content-lg-between{align-content:space-between!important}.align-content-lg-around{align-content:space-around!important}.align-content-lg-stretch{align-content:stretch!important}.align-self-lg-auto{align-self:auto!important}.align-self-lg-start{align-self:flex-start!important}.align-self-lg-end{align-self:flex-end!important}.align-self-lg-center{align-self:center!important}.align-self-lg-baseline{align-self:baseline!important}.align-self-lg-stretch{align-self:stretch!important}}@media (min-width:1200px){.flex-xl-row{flex-direction:row!important}.flex-xl-column{flex-direction:column!important}.flex-xl-row-reverse{flex-direction:row-reverse!important}.flex-xl-column-reverse{flex-direction:column-reverse!important}.flex-xl-wrap{flex-wrap:wrap!important}.flex-xl-nowrap{flex-wrap:nowrap!important}.flex-xl-wrap-reverse{flex-wrap:wrap-reverse!important}.flex-xl-fill{flex:1 1 auto!important}.flex-xl-grow-0{flex-grow:0!important}.flex-xl-grow-1{flex-grow:1!important}.flex-xl-shrink-0{flex-shrink:0!important}.flex-xl-shrink-1{flex-shrink:1!important}.justify-content-xl-start{justify-content:flex-start!important}.justify-content-xl-end{justify-content:flex-end!important}.justify-content-xl-center{justify-content:center!important}.justify-content-xl-between{justify-content:space-between!important}.justify-content-xl-around{justify-content:space-around!important}.align-items-xl-start{align-items:flex-start!important}.align-items-xl-end{align-items:flex-end!important}.align-items-xl-center{align-items:center!important}.align-items-xl-baseline{align-items:baseline!important}.align-items-xl-stretch{align-items:stretch!important}.align-content-xl-start{align-content:flex-start!important}.align-content-xl-end{align-content:flex-end!important}.align-content-xl-center{align-content:center!important}.align-content-xl-between{align-content:space-between!important}.align-content-xl-around{align-content:space-around!important}.align-content-xl-stretch{align-content:stretch!important}.align-self-xl-auto{align-self:auto!important}.align-self-xl-start{align-self:flex-start!important}.align-self-xl-end{align-self:flex-end!important}.align-self-xl-center{align-self:center!important}.align-self-xl-baseline{align-self:baseline!important}.align-self-xl-stretch{align-self:stretch!important}}.float-left{float:left!important}.float-right{float:right!important}.float-none{float:none!important}@media (min-width:540px){.float-sm-left{float:left!important}.float-sm-right{float:right!important}.float-sm-none{float:none!important}}@media (min-width:720px){.float-md-left{float:left!important}.float-md-right{float:right!important}.float-md-none{float:none!important}}@media (min-width:960px){.float-lg-left{float:left!important}.float-lg-right{float:right!important}.float-lg-none{float:none!important}}@media (min-width:1200px){.float-xl-left{float:left!important}.float-xl-right{float:right!important}.float-xl-none{float:none!important}}.user-select-all{user-select:all!important}.user-select-auto{user-select:auto!important}.user-select-none{user-select:none!important}.overflow-auto{overflow:auto!important}.overflow-hidden{overflow:hidden!important}.position-static{position:static!important}.position-relative{position:relative!important}.position-absolute{position:absolute!important}.position-fixed{position:fixed!important}.position-sticky{position:sticky!important}.fixed-top{top:0}.fixed-bottom,.fixed-top{position:fixed;right:0;left:0;z-index:1030}.fixed-bottom{bottom:0}@supports (position:sticky){.sticky-top{position:sticky;top:0;z-index:1020}}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;overflow:visible;clip:auto;white-space:normal}.shadow-sm{box-shadow:0 .125rem .25rem rgba(0,0,0,.075)!important}.shadow{box-shadow:0 .5rem 1rem rgba(0,0,0,.15)!important}.shadow-lg{box-shadow:0 1rem 3rem rgba(0,0,0,.175)!important}.shadow-none{box-shadow:none!important}.w-25{width:25%!important}.w-50{width:50%!important}.w-75{width:75%!important}.w-100{width:100%!important}.w-auto{width:auto!important}.h-25{height:25%!important}.h-50{height:50%!important}.h-75{height:75%!important}.h-100{height:100%!important}.h-auto{height:auto!important}.mw-100{max-width:100%!important}.mh-100{max-height:100%!important}.min-vw-100{min-width:100vw!important}.min-vh-100{min-height:100vh!important}.vw-100{width:100vw!important}.vh-100{height:100vh!important}.m-0{margin:0!important}.mt-0,.my-0{margin-top:0!important}.mr-0,.mx-0{margin-right:0!important}.mb-0,.my-0{margin-bottom:0!important}.ml-0,.mx-0{margin-left:0!important}.m-1{margin:.25rem!important}.mt-1,.my-1{margin-top:.25rem!important}.mr-1,.mx-1{margin-right:.25rem!important}.mb-1,.my-1{margin-bottom:.25rem!important}.ml-1,.mx-1{margin-left:.25rem!important}.m-2{margin:.5rem!important}.mt-2,.my-2{margin-top:.5rem!important}.mr-2,.mx-2{margin-right:.5rem!important}.mb-2,.my-2{margin-bottom:.5rem!important}.ml-2,.mx-2{margin-left:.5rem!important}.m-3{margin:1rem!important}.mt-3,.my-3{margin-top:1rem!important}.mr-3,.mx-3{margin-right:1rem!important}.mb-3,.my-3{margin-bottom:1rem!important}.ml-3,.mx-3{margin-left:1rem!important}.m-4{margin:1.5rem!important}.mt-4,.my-4{margin-top:1.5rem!important}.mr-4,.mx-4{margin-right:1.5rem!important}.mb-4,.my-4{margin-bottom:1.5rem!important}.ml-4,.mx-4{margin-left:1.5rem!important}.m-5{margin:3rem!important}.mt-5,.my-5{margin-top:3rem!important}.mr-5,.mx-5{margin-right:3rem!important}.mb-5,.my-5{margin-bottom:3rem!important}.ml-5,.mx-5{margin-left:3rem!important}.p-0{padding:0!important}.pt-0,.py-0{padding-top:0!important}.pr-0,.px-0{padding-right:0!important}.pb-0,.py-0{padding-bottom:0!important}.pl-0,.px-0{padding-left:0!important}.p-1{padding:.25rem!important}.pt-1,.py-1{padding-top:.25rem!important}.pr-1,.px-1{padding-right:.25rem!important}.pb-1,.py-1{padding-bottom:.25rem!important}.pl-1,.px-1{padding-left:.25rem!important}.p-2{padding:.5rem!important}.pt-2,.py-2{padding-top:.5rem!important}.pr-2,.px-2{padding-right:.5rem!important}.pb-2,.py-2{padding-bottom:.5rem!important}.pl-2,.px-2{padding-left:.5rem!important}.p-3{padding:1rem!important}.pt-3,.py-3{padding-top:1rem!important}.pr-3,.px-3{padding-right:1rem!important}.pb-3,.py-3{padding-bottom:1rem!important}.pl-3,.px-3{padding-left:1rem!important}.p-4{padding:1.5rem!important}.pt-4,.py-4{padding-top:1.5rem!important}.pr-4,.px-4{padding-right:1.5rem!important}.pb-4,.py-4{padding-bottom:1.5rem!important}.pl-4,.px-4{padding-left:1.5rem!important}.p-5{padding:3rem!important}.pt-5,.py-5{padding-top:3rem!important}.pr-5,.px-5{padding-right:3rem!important}.pb-5,.py-5{padding-bottom:3rem!important}.pl-5,.px-5{padding-left:3rem!important}.m-n1{margin:-.25rem!important}.mt-n1,.my-n1{margin-top:-.25rem!important}.mr-n1,.mx-n1{margin-right:-.25rem!important}.mb-n1,.my-n1{margin-bottom:-.25rem!important}.ml-n1,.mx-n1{margin-left:-.25rem!important}.m-n2{margin:-.5rem!important}.mt-n2,.my-n2{margin-top:-.5rem!important}.mr-n2,.mx-n2{margin-right:-.5rem!important}.mb-n2,.my-n2{margin-bottom:-.5rem!important}.ml-n2,.mx-n2{margin-left:-.5rem!important}.m-n3{margin:-1rem!important}.mt-n3,.my-n3{margin-top:-1rem!important}.mr-n3,.mx-n3{margin-right:-1rem!important}.mb-n3,.my-n3{margin-bottom:-1rem!important}.ml-n3,.mx-n3{margin-left:-1rem!important}.m-n4{margin:-1.5rem!important}.mt-n4,.my-n4{margin-top:-1.5rem!important}.mr-n4,.mx-n4{margin-right:-1.5rem!important}.mb-n4,.my-n4{margin-bottom:-1.5rem!important}.ml-n4,.mx-n4{margin-left:-1.5rem!important}.m-n5{margin:-3rem!important}.mt-n5,.my-n5{margin-top:-3rem!important}.mr-n5,.mx-n5{margin-right:-3rem!important}.mb-n5,.my-n5{margin-bottom:-3rem!important}.ml-n5,.mx-n5{margin-left:-3rem!important}.m-auto{margin:auto!important}.mt-auto,.my-auto{margin-top:auto!important}.mr-auto,.mx-auto{margin-right:auto!important}.mb-auto,.my-auto{margin-bottom:auto!important}.ml-auto,.mx-auto{margin-left:auto!important}@media (min-width:540px){.m-sm-0{margin:0!important}.mt-sm-0,.my-sm-0{margin-top:0!important}.mr-sm-0,.mx-sm-0{margin-right:0!important}.mb-sm-0,.my-sm-0{margin-bottom:0!important}.ml-sm-0,.mx-sm-0{margin-left:0!important}.m-sm-1{margin:.25rem!important}.mt-sm-1,.my-sm-1{margin-top:.25rem!important}.mr-sm-1,.mx-sm-1{margin-right:.25rem!important}.mb-sm-1,.my-sm-1{margin-bottom:.25rem!important}.ml-sm-1,.mx-sm-1{margin-left:.25rem!important}.m-sm-2{margin:.5rem!important}.mt-sm-2,.my-sm-2{margin-top:.5rem!important}.mr-sm-2,.mx-sm-2{margin-right:.5rem!important}.mb-sm-2,.my-sm-2{margin-bottom:.5rem!important}.ml-sm-2,.mx-sm-2{margin-left:.5rem!important}.m-sm-3{margin:1rem!important}.mt-sm-3,.my-sm-3{margin-top:1rem!important}.mr-sm-3,.mx-sm-3{margin-right:1rem!important}.mb-sm-3,.my-sm-3{margin-bottom:1rem!important}.ml-sm-3,.mx-sm-3{margin-left:1rem!important}.m-sm-4{margin:1.5rem!important}.mt-sm-4,.my-sm-4{margin-top:1.5rem!important}.mr-sm-4,.mx-sm-4{margin-right:1.5rem!important}.mb-sm-4,.my-sm-4{margin-bottom:1.5rem!important}.ml-sm-4,.mx-sm-4{margin-left:1.5rem!important}.m-sm-5{margin:3rem!important}.mt-sm-5,.my-sm-5{margin-top:3rem!important}.mr-sm-5,.mx-sm-5{margin-right:3rem!important}.mb-sm-5,.my-sm-5{margin-bottom:3rem!important}.ml-sm-5,.mx-sm-5{margin-left:3rem!important}.p-sm-0{padding:0!important}.pt-sm-0,.py-sm-0{padding-top:0!important}.pr-sm-0,.px-sm-0{padding-right:0!important}.pb-sm-0,.py-sm-0{padding-bottom:0!important}.pl-sm-0,.px-sm-0{padding-left:0!important}.p-sm-1{padding:.25rem!important}.pt-sm-1,.py-sm-1{padding-top:.25rem!important}.pr-sm-1,.px-sm-1{padding-right:.25rem!important}.pb-sm-1,.py-sm-1{padding-bottom:.25rem!important}.pl-sm-1,.px-sm-1{padding-left:.25rem!important}.p-sm-2{padding:.5rem!important}.pt-sm-2,.py-sm-2{padding-top:.5rem!important}.pr-sm-2,.px-sm-2{padding-right:.5rem!important}.pb-sm-2,.py-sm-2{padding-bottom:.5rem!important}.pl-sm-2,.px-sm-2{padding-left:.5rem!important}.p-sm-3{padding:1rem!important}.pt-sm-3,.py-sm-3{padding-top:1rem!important}.pr-sm-3,.px-sm-3{padding-right:1rem!important}.pb-sm-3,.py-sm-3{padding-bottom:1rem!important}.pl-sm-3,.px-sm-3{padding-left:1rem!important}.p-sm-4{padding:1.5rem!important}.pt-sm-4,.py-sm-4{padding-top:1.5rem!important}.pr-sm-4,.px-sm-4{padding-right:1.5rem!important}.pb-sm-4,.py-sm-4{padding-bottom:1.5rem!important}.pl-sm-4,.px-sm-4{padding-left:1.5rem!important}.p-sm-5{padding:3rem!important}.pt-sm-5,.py-sm-5{padding-top:3rem!important}.pr-sm-5,.px-sm-5{padding-right:3rem!important}.pb-sm-5,.py-sm-5{padding-bottom:3rem!important}.pl-sm-5,.px-sm-5{padding-left:3rem!important}.m-sm-n1{margin:-.25rem!important}.mt-sm-n1,.my-sm-n1{margin-top:-.25rem!important}.mr-sm-n1,.mx-sm-n1{margin-right:-.25rem!important}.mb-sm-n1,.my-sm-n1{margin-bottom:-.25rem!important}.ml-sm-n1,.mx-sm-n1{margin-left:-.25rem!important}.m-sm-n2{margin:-.5rem!important}.mt-sm-n2,.my-sm-n2{margin-top:-.5rem!important}.mr-sm-n2,.mx-sm-n2{margin-right:-.5rem!important}.mb-sm-n2,.my-sm-n2{margin-bottom:-.5rem!important}.ml-sm-n2,.mx-sm-n2{margin-left:-.5rem!important}.m-sm-n3{margin:-1rem!important}.mt-sm-n3,.my-sm-n3{margin-top:-1rem!important}.mr-sm-n3,.mx-sm-n3{margin-right:-1rem!important}.mb-sm-n3,.my-sm-n3{margin-bottom:-1rem!important}.ml-sm-n3,.mx-sm-n3{margin-left:-1rem!important}.m-sm-n4{margin:-1.5rem!important}.mt-sm-n4,.my-sm-n4{margin-top:-1.5rem!important}.mr-sm-n4,.mx-sm-n4{margin-right:-1.5rem!important}.mb-sm-n4,.my-sm-n4{margin-bottom:-1.5rem!important}.ml-sm-n4,.mx-sm-n4{margin-left:-1.5rem!important}.m-sm-n5{margin:-3rem!important}.mt-sm-n5,.my-sm-n5{margin-top:-3rem!important}.mr-sm-n5,.mx-sm-n5{margin-right:-3rem!important}.mb-sm-n5,.my-sm-n5{margin-bottom:-3rem!important}.ml-sm-n5,.mx-sm-n5{margin-left:-3rem!important}.m-sm-auto{margin:auto!important}.mt-sm-auto,.my-sm-auto{margin-top:auto!important}.mr-sm-auto,.mx-sm-auto{margin-right:auto!important}.mb-sm-auto,.my-sm-auto{margin-bottom:auto!important}.ml-sm-auto,.mx-sm-auto{margin-left:auto!important}}@media (min-width:720px){.m-md-0{margin:0!important}.mt-md-0,.my-md-0{margin-top:0!important}.mr-md-0,.mx-md-0{margin-right:0!important}.mb-md-0,.my-md-0{margin-bottom:0!important}.ml-md-0,.mx-md-0{margin-left:0!important}.m-md-1{margin:.25rem!important}.mt-md-1,.my-md-1{margin-top:.25rem!important}.mr-md-1,.mx-md-1{margin-right:.25rem!important}.mb-md-1,.my-md-1{margin-bottom:.25rem!important}.ml-md-1,.mx-md-1{margin-left:.25rem!important}.m-md-2{margin:.5rem!important}.mt-md-2,.my-md-2{margin-top:.5rem!important}.mr-md-2,.mx-md-2{margin-right:.5rem!important}.mb-md-2,.my-md-2{margin-bottom:.5rem!important}.ml-md-2,.mx-md-2{margin-left:.5rem!important}.m-md-3{margin:1rem!important}.mt-md-3,.my-md-3{margin-top:1rem!important}.mr-md-3,.mx-md-3{margin-right:1rem!important}.mb-md-3,.my-md-3{margin-bottom:1rem!important}.ml-md-3,.mx-md-3{margin-left:1rem!important}.m-md-4{margin:1.5rem!important}.mt-md-4,.my-md-4{margin-top:1.5rem!important}.mr-md-4,.mx-md-4{margin-right:1.5rem!important}.mb-md-4,.my-md-4{margin-bottom:1.5rem!important}.ml-md-4,.mx-md-4{margin-left:1.5rem!important}.m-md-5{margin:3rem!important}.mt-md-5,.my-md-5{margin-top:3rem!important}.mr-md-5,.mx-md-5{margin-right:3rem!important}.mb-md-5,.my-md-5{margin-bottom:3rem!important}.ml-md-5,.mx-md-5{margin-left:3rem!important}.p-md-0{padding:0!important}.pt-md-0,.py-md-0{padding-top:0!important}.pr-md-0,.px-md-0{padding-right:0!important}.pb-md-0,.py-md-0{padding-bottom:0!important}.pl-md-0,.px-md-0{padding-left:0!important}.p-md-1{padding:.25rem!important}.pt-md-1,.py-md-1{padding-top:.25rem!important}.pr-md-1,.px-md-1{padding-right:.25rem!important}.pb-md-1,.py-md-1{padding-bottom:.25rem!important}.pl-md-1,.px-md-1{padding-left:.25rem!important}.p-md-2{padding:.5rem!important}.pt-md-2,.py-md-2{padding-top:.5rem!important}.pr-md-2,.px-md-2{padding-right:.5rem!important}.pb-md-2,.py-md-2{padding-bottom:.5rem!important}.pl-md-2,.px-md-2{padding-left:.5rem!important}.p-md-3{padding:1rem!important}.pt-md-3,.py-md-3{padding-top:1rem!important}.pr-md-3,.px-md-3{padding-right:1rem!important}.pb-md-3,.py-md-3{padding-bottom:1rem!important}.pl-md-3,.px-md-3{padding-left:1rem!important}.p-md-4{padding:1.5rem!important}.pt-md-4,.py-md-4{padding-top:1.5rem!important}.pr-md-4,.px-md-4{padding-right:1.5rem!important}.pb-md-4,.py-md-4{padding-bottom:1.5rem!important}.pl-md-4,.px-md-4{padding-left:1.5rem!important}.p-md-5{padding:3rem!important}.pt-md-5,.py-md-5{padding-top:3rem!important}.pr-md-5,.px-md-5{padding-right:3rem!important}.pb-md-5,.py-md-5{padding-bottom:3rem!important}.pl-md-5,.px-md-5{padding-left:3rem!important}.m-md-n1{margin:-.25rem!important}.mt-md-n1,.my-md-n1{margin-top:-.25rem!important}.mr-md-n1,.mx-md-n1{margin-right:-.25rem!important}.mb-md-n1,.my-md-n1{margin-bottom:-.25rem!important}.ml-md-n1,.mx-md-n1{margin-left:-.25rem!important}.m-md-n2{margin:-.5rem!important}.mt-md-n2,.my-md-n2{margin-top:-.5rem!important}.mr-md-n2,.mx-md-n2{margin-right:-.5rem!important}.mb-md-n2,.my-md-n2{margin-bottom:-.5rem!important}.ml-md-n2,.mx-md-n2{margin-left:-.5rem!important}.m-md-n3{margin:-1rem!important}.mt-md-n3,.my-md-n3{margin-top:-1rem!important}.mr-md-n3,.mx-md-n3{margin-right:-1rem!important}.mb-md-n3,.my-md-n3{margin-bottom:-1rem!important}.ml-md-n3,.mx-md-n3{margin-left:-1rem!important}.m-md-n4{margin:-1.5rem!important}.mt-md-n4,.my-md-n4{margin-top:-1.5rem!important}.mr-md-n4,.mx-md-n4{margin-right:-1.5rem!important}.mb-md-n4,.my-md-n4{margin-bottom:-1.5rem!important}.ml-md-n4,.mx-md-n4{margin-left:-1.5rem!important}.m-md-n5{margin:-3rem!important}.mt-md-n5,.my-md-n5{margin-top:-3rem!important}.mr-md-n5,.mx-md-n5{margin-right:-3rem!important}.mb-md-n5,.my-md-n5{margin-bottom:-3rem!important}.ml-md-n5,.mx-md-n5{margin-left:-3rem!important}.m-md-auto{margin:auto!important}.mt-md-auto,.my-md-auto{margin-top:auto!important}.mr-md-auto,.mx-md-auto{margin-right:auto!important}.mb-md-auto,.my-md-auto{margin-bottom:auto!important}.ml-md-auto,.mx-md-auto{margin-left:auto!important}}@media (min-width:960px){.m-lg-0{margin:0!important}.mt-lg-0,.my-lg-0{margin-top:0!important}.mr-lg-0,.mx-lg-0{margin-right:0!important}.mb-lg-0,.my-lg-0{margin-bottom:0!important}.ml-lg-0,.mx-lg-0{margin-left:0!important}.m-lg-1{margin:.25rem!important}.mt-lg-1,.my-lg-1{margin-top:.25rem!important}.mr-lg-1,.mx-lg-1{margin-right:.25rem!important}.mb-lg-1,.my-lg-1{margin-bottom:.25rem!important}.ml-lg-1,.mx-lg-1{margin-left:.25rem!important}.m-lg-2{margin:.5rem!important}.mt-lg-2,.my-lg-2{margin-top:.5rem!important}.mr-lg-2,.mx-lg-2{margin-right:.5rem!important}.mb-lg-2,.my-lg-2{margin-bottom:.5rem!important}.ml-lg-2,.mx-lg-2{margin-left:.5rem!important}.m-lg-3{margin:1rem!important}.mt-lg-3,.my-lg-3{margin-top:1rem!important}.mr-lg-3,.mx-lg-3{margin-right:1rem!important}.mb-lg-3,.my-lg-3{margin-bottom:1rem!important}.ml-lg-3,.mx-lg-3{margin-left:1rem!important}.m-lg-4{margin:1.5rem!important}.mt-lg-4,.my-lg-4{margin-top:1.5rem!important}.mr-lg-4,.mx-lg-4{margin-right:1.5rem!important}.mb-lg-4,.my-lg-4{margin-bottom:1.5rem!important}.ml-lg-4,.mx-lg-4{margin-left:1.5rem!important}.m-lg-5{margin:3rem!important}.mt-lg-5,.my-lg-5{margin-top:3rem!important}.mr-lg-5,.mx-lg-5{margin-right:3rem!important}.mb-lg-5,.my-lg-5{margin-bottom:3rem!important}.ml-lg-5,.mx-lg-5{margin-left:3rem!important}.p-lg-0{padding:0!important}.pt-lg-0,.py-lg-0{padding-top:0!important}.pr-lg-0,.px-lg-0{padding-right:0!important}.pb-lg-0,.py-lg-0{padding-bottom:0!important}.pl-lg-0,.px-lg-0{padding-left:0!important}.p-lg-1{padding:.25rem!important}.pt-lg-1,.py-lg-1{padding-top:.25rem!important}.pr-lg-1,.px-lg-1{padding-right:.25rem!important}.pb-lg-1,.py-lg-1{padding-bottom:.25rem!important}.pl-lg-1,.px-lg-1{padding-left:.25rem!important}.p-lg-2{padding:.5rem!important}.pt-lg-2,.py-lg-2{padding-top:.5rem!important}.pr-lg-2,.px-lg-2{padding-right:.5rem!important}.pb-lg-2,.py-lg-2{padding-bottom:.5rem!important}.pl-lg-2,.px-lg-2{padding-left:.5rem!important}.p-lg-3{padding:1rem!important}.pt-lg-3,.py-lg-3{padding-top:1rem!important}.pr-lg-3,.px-lg-3{padding-right:1rem!important}.pb-lg-3,.py-lg-3{padding-bottom:1rem!important}.pl-lg-3,.px-lg-3{padding-left:1rem!important}.p-lg-4{padding:1.5rem!important}.pt-lg-4,.py-lg-4{padding-top:1.5rem!important}.pr-lg-4,.px-lg-4{padding-right:1.5rem!important}.pb-lg-4,.py-lg-4{padding-bottom:1.5rem!important}.pl-lg-4,.px-lg-4{padding-left:1.5rem!important}.p-lg-5{padding:3rem!important}.pt-lg-5,.py-lg-5{padding-top:3rem!important}.pr-lg-5,.px-lg-5{padding-right:3rem!important}.pb-lg-5,.py-lg-5{padding-bottom:3rem!important}.pl-lg-5,.px-lg-5{padding-left:3rem!important}.m-lg-n1{margin:-.25rem!important}.mt-lg-n1,.my-lg-n1{margin-top:-.25rem!important}.mr-lg-n1,.mx-lg-n1{margin-right:-.25rem!important}.mb-lg-n1,.my-lg-n1{margin-bottom:-.25rem!important}.ml-lg-n1,.mx-lg-n1{margin-left:-.25rem!important}.m-lg-n2{margin:-.5rem!important}.mt-lg-n2,.my-lg-n2{margin-top:-.5rem!important}.mr-lg-n2,.mx-lg-n2{margin-right:-.5rem!important}.mb-lg-n2,.my-lg-n2{margin-bottom:-.5rem!important}.ml-lg-n2,.mx-lg-n2{margin-left:-.5rem!important}.m-lg-n3{margin:-1rem!important}.mt-lg-n3,.my-lg-n3{margin-top:-1rem!important}.mr-lg-n3,.mx-lg-n3{margin-right:-1rem!important}.mb-lg-n3,.my-lg-n3{margin-bottom:-1rem!important}.ml-lg-n3,.mx-lg-n3{margin-left:-1rem!important}.m-lg-n4{margin:-1.5rem!important}.mt-lg-n4,.my-lg-n4{margin-top:-1.5rem!important}.mr-lg-n4,.mx-lg-n4{margin-right:-1.5rem!important}.mb-lg-n4,.my-lg-n4{margin-bottom:-1.5rem!important}.ml-lg-n4,.mx-lg-n4{margin-left:-1.5rem!important}.m-lg-n5{margin:-3rem!important}.mt-lg-n5,.my-lg-n5{margin-top:-3rem!important}.mr-lg-n5,.mx-lg-n5{margin-right:-3rem!important}.mb-lg-n5,.my-lg-n5{margin-bottom:-3rem!important}.ml-lg-n5,.mx-lg-n5{margin-left:-3rem!important}.m-lg-auto{margin:auto!important}.mt-lg-auto,.my-lg-auto{margin-top:auto!important}.mr-lg-auto,.mx-lg-auto{margin-right:auto!important}.mb-lg-auto,.my-lg-auto{margin-bottom:auto!important}.ml-lg-auto,.mx-lg-auto{margin-left:auto!important}}@media (min-width:1200px){.m-xl-0{margin:0!important}.mt-xl-0,.my-xl-0{margin-top:0!important}.mr-xl-0,.mx-xl-0{margin-right:0!important}.mb-xl-0,.my-xl-0{margin-bottom:0!important}.ml-xl-0,.mx-xl-0{margin-left:0!important}.m-xl-1{margin:.25rem!important}.mt-xl-1,.my-xl-1{margin-top:.25rem!important}.mr-xl-1,.mx-xl-1{margin-right:.25rem!important}.mb-xl-1,.my-xl-1{margin-bottom:.25rem!important}.ml-xl-1,.mx-xl-1{margin-left:.25rem!important}.m-xl-2{margin:.5rem!important}.mt-xl-2,.my-xl-2{margin-top:.5rem!important}.mr-xl-2,.mx-xl-2{margin-right:.5rem!important}.mb-xl-2,.my-xl-2{margin-bottom:.5rem!important}.ml-xl-2,.mx-xl-2{margin-left:.5rem!important}.m-xl-3{margin:1rem!important}.mt-xl-3,.my-xl-3{margin-top:1rem!important}.mr-xl-3,.mx-xl-3{margin-right:1rem!important}.mb-xl-3,.my-xl-3{margin-bottom:1rem!important}.ml-xl-3,.mx-xl-3{margin-left:1rem!important}.m-xl-4{margin:1.5rem!important}.mt-xl-4,.my-xl-4{margin-top:1.5rem!important}.mr-xl-4,.mx-xl-4{margin-right:1.5rem!important}.mb-xl-4,.my-xl-4{margin-bottom:1.5rem!important}.ml-xl-4,.mx-xl-4{margin-left:1.5rem!important}.m-xl-5{margin:3rem!important}.mt-xl-5,.my-xl-5{margin-top:3rem!important}.mr-xl-5,.mx-xl-5{margin-right:3rem!important}.mb-xl-5,.my-xl-5{margin-bottom:3rem!important}.ml-xl-5,.mx-xl-5{margin-left:3rem!important}.p-xl-0{padding:0!important}.pt-xl-0,.py-xl-0{padding-top:0!important}.pr-xl-0,.px-xl-0{padding-right:0!important}.pb-xl-0,.py-xl-0{padding-bottom:0!important}.pl-xl-0,.px-xl-0{padding-left:0!important}.p-xl-1{padding:.25rem!important}.pt-xl-1,.py-xl-1{padding-top:.25rem!important}.pr-xl-1,.px-xl-1{padding-right:.25rem!important}.pb-xl-1,.py-xl-1{padding-bottom:.25rem!important}.pl-xl-1,.px-xl-1{padding-left:.25rem!important}.p-xl-2{padding:.5rem!important}.pt-xl-2,.py-xl-2{padding-top:.5rem!important}.pr-xl-2,.px-xl-2{padding-right:.5rem!important}.pb-xl-2,.py-xl-2{padding-bottom:.5rem!important}.pl-xl-2,.px-xl-2{padding-left:.5rem!important}.p-xl-3{padding:1rem!important}.pt-xl-3,.py-xl-3{padding-top:1rem!important}.pr-xl-3,.px-xl-3{padding-right:1rem!important}.pb-xl-3,.py-xl-3{padding-bottom:1rem!important}.pl-xl-3,.px-xl-3{padding-left:1rem!important}.p-xl-4{padding:1.5rem!important}.pt-xl-4,.py-xl-4{padding-top:1.5rem!important}.pr-xl-4,.px-xl-4{padding-right:1.5rem!important}.pb-xl-4,.py-xl-4{padding-bottom:1.5rem!important}.pl-xl-4,.px-xl-4{padding-left:1.5rem!important}.p-xl-5{padding:3rem!important}.pt-xl-5,.py-xl-5{padding-top:3rem!important}.pr-xl-5,.px-xl-5{padding-right:3rem!important}.pb-xl-5,.py-xl-5{padding-bottom:3rem!important}.pl-xl-5,.px-xl-5{padding-left:3rem!important}.m-xl-n1{margin:-.25rem!important}.mt-xl-n1,.my-xl-n1{margin-top:-.25rem!important}.mr-xl-n1,.mx-xl-n1{margin-right:-.25rem!important}.mb-xl-n1,.my-xl-n1{margin-bottom:-.25rem!important}.ml-xl-n1,.mx-xl-n1{margin-left:-.25rem!important}.m-xl-n2{margin:-.5rem!important}.mt-xl-n2,.my-xl-n2{margin-top:-.5rem!important}.mr-xl-n2,.mx-xl-n2{margin-right:-.5rem!important}.mb-xl-n2,.my-xl-n2{margin-bottom:-.5rem!important}.ml-xl-n2,.mx-xl-n2{margin-left:-.5rem!important}.m-xl-n3{margin:-1rem!important}.mt-xl-n3,.my-xl-n3{margin-top:-1rem!important}.mr-xl-n3,.mx-xl-n3{margin-right:-1rem!important}.mb-xl-n3,.my-xl-n3{margin-bottom:-1rem!important}.ml-xl-n3,.mx-xl-n3{margin-left:-1rem!important}.m-xl-n4{margin:-1.5rem!important}.mt-xl-n4,.my-xl-n4{margin-top:-1.5rem!important}.mr-xl-n4,.mx-xl-n4{margin-right:-1.5rem!important}.mb-xl-n4,.my-xl-n4{margin-bottom:-1.5rem!important}.ml-xl-n4,.mx-xl-n4{margin-left:-1.5rem!important}.m-xl-n5{margin:-3rem!important}.mt-xl-n5,.my-xl-n5{margin-top:-3rem!important}.mr-xl-n5,.mx-xl-n5{margin-right:-3rem!important}.mb-xl-n5,.my-xl-n5{margin-bottom:-3rem!important}.ml-xl-n5,.mx-xl-n5{margin-left:-3rem!important}.m-xl-auto{margin:auto!important}.mt-xl-auto,.my-xl-auto{margin-top:auto!important}.mr-xl-auto,.mx-xl-auto{margin-right:auto!important}.mb-xl-auto,.my-xl-auto{margin-bottom:auto!important}.ml-xl-auto,.mx-xl-auto{margin-left:auto!important}}.stretched-link:after{position:absolute;top:0;right:0;bottom:0;left:0;z-index:1;pointer-events:auto;content:"";background-color:transparent}.text-monospace{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace!important}.text-justify{text-align:justify!important}.text-wrap{white-space:normal!important}.text-nowrap{white-space:nowrap!important}.text-truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text-left{text-align:left!important}.text-right{text-align:right!important}.text-center{text-align:center!important}@media (min-width:540px){.text-sm-left{text-align:left!important}.text-sm-right{text-align:right!important}.text-sm-center{text-align:center!important}}@media (min-width:720px){.text-md-left{text-align:left!important}.text-md-right{text-align:right!important}.text-md-center{text-align:center!important}}@media (min-width:960px){.text-lg-left{text-align:left!important}.text-lg-right{text-align:right!important}.text-lg-center{text-align:center!important}}@media (min-width:1200px){.text-xl-left{text-align:left!important}.text-xl-right{text-align:right!important}.text-xl-center{text-align:center!important}}.text-lowercase{text-transform:lowercase!important}.text-uppercase{text-transform:uppercase!important}.text-capitalize{text-transform:capitalize!important}.font-weight-light{font-weight:300!important}.font-weight-lighter{font-weight:lighter!important}.font-weight-normal{font-weight:400!important}.font-weight-bold{font-weight:700!important}.font-weight-bolder{font-weight:bolder!important}.font-italic{font-style:italic!important}.text-white{color:#fff!important}.text-primary{color:#007bff!important}a.text-primary:focus,a.text-primary:hover{color:#0056b3!important}.text-secondary{color:#6c757d!important}a.text-secondary:focus,a.text-secondary:hover{color:#494f54!important}.text-success{color:#28a745!important}a.text-success:focus,a.text-success:hover{color:#19692c!important}.text-info{color:#17a2b8!important}a.text-info:focus,a.text-info:hover{color:#0f6674!important}.text-warning{color:#ffc107!important}a.text-warning:focus,a.text-warning:hover{color:#ba8b00!important}.text-danger{color:#dc3545!important}a.text-danger:focus,a.text-danger:hover{color:#a71d2a!important}.text-light{color:#f8f9fa!important}a.text-light:focus,a.text-light:hover{color:#cbd3da!important}.text-dark{color:#343a40!important}a.text-dark:focus,a.text-dark:hover{color:#121416!important}.text-body{color:#212529!important}.text-muted{color:#6c757d!important}.text-black-50{color:rgba(0,0,0,.5)!important}.text-white-50{color:hsla(0,0%,100%,.5)!important}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.text-decoration-none{text-decoration:none!important}.text-break{word-break:break-word!important;word-wrap:break-word!important}.text-reset{color:inherit!important}.visible{visibility:visible!important}.invisible{visibility:hidden!important}@media print{*,:after,:before{text-shadow:none!important;box-shadow:none!important}a:not(.btn){text-decoration:underline}abbr[title]:after{content:" (" attr(title) ")"}pre{white-space:pre-wrap!important}blockquote,pre{border:1px solid #adb5bd}blockquote,img,pre,tr{page-break-inside:avoid}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}@page{size:a3}.container,body{min-width:960px!important}.navbar{display:none}.badge{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #dee2e6!important}.table-dark{color:inherit}.table-dark tbody+tbody,.table-dark td,.table-dark th,.table-dark thead th{border-color:#dee2e6}.table .thead-dark th{color:inherit;border-color:#dee2e6}}html{font-size:var(--pst-font-size-base);scroll-padding-top:calc(var(--pst-header-height) + 12px)}body{padding-top:var(--pst-header-height);background-color:#fff;font-family:var(--pst-font-family-base);font-weight:400;line-height:1.65;color:rgba(var(--pst-color-text-base),1)}p{margin-bottom:1.15rem;font-size:1em;color:rgba(var(--pst-color-paragraph),1)}p.rubric{border-bottom:1px solid #c9c9c9}a{color:rgba(var(--pst-color-link),1);text-decoration:none}a:hover{color:rgba(var(--pst-color-link-hover),1);text-decoration:underline}a.headerlink{color:rgba(var(--pst-color-headerlink),1);opacity:.4;font-size:.8em;padding:0 4px;margin-left:.2em;text-decoration:none;transition:all .3s ease-out;user-select:none}a.headerlink:hover{opacity:1}.heading-style,h1,h2,h3,h4,h5,h6{margin:2.75rem 0 1.05rem;font-family:var(--pst-font-family-heading);font-weight:400;line-height:1.15}h1{margin-top:0;font-size:var(--pst-font-size-h1);color:rgba(var(--pst-color-h1),1)}h2{font-size:var(--pst-font-size-h2);color:rgba(var(--pst-color-h2),1)}h3{font-size:var(--pst-font-size-h3);color:rgba(var(--pst-color-h3),1)}h4{font-size:var(--pst-font-size-h4);color:rgba(var(--pst-color-h4),1)}h5{font-size:var(--pst-font-size-h5);color:rgba(var(--pst-color-h5),1)}h6{font-size:var(--pst-font-size-h6);color:rgba(var(--pst-color-h6),1)}.text_small,small{font-size:var(--pst-font-size-milli)}hr{border:0;border-top:1px solid #e5e5e5}code,kbd,pre,samp{font-family:var(--pst-font-family-monospace)}code{color:rgba(var(--pst-color-inline-code),1)}pre{margin:1.5em 0;padding:10px;background-color:rgba(var(--pst-color-preformatted-background),1);color:rgba(var(--pst-color-preformatted-text),1);line-height:1.2em;border:1px solid #c9c9c9;border-radius:.2rem;box-shadow:1px 1px 1px #d8d8d8}dd{margin-top:3px;margin-bottom:10px;margin-left:30px}dl.field-list{display:grid;grid-template-columns:fit-content(30%) minmax(0,1fr)}.navbar{position:fixed;min-height:var(--pst-header-height);width:100%;padding:0}.navbar .container-xl{height:100%}@media (max-width:1199.98px){.navbar #navbar-start{margin-left:1em}.navbar button.navbar-toggler{margin-right:1em}}@media (min-width:960px){.navbar #navbar-end>.navbar-end-item{display:inline-block}}.navbar-brand{position:relative;height:var(--pst-header-height);width:auto;padding:.5rem 0;display:flex;align-items:center}.navbar-brand p{margin-bottom:0}.navbar-brand img{max-width:100%;height:100%;width:auto}.navbar-light{background:#fff!important;box-shadow:0 .125rem .25rem 0 rgba(0,0,0,.11)}.navbar-light .navbar-nav li a.nav-link{padding:0 .5rem;color:rgba(var(--pst-color-navbar-link),1)}.navbar-light .navbar-nav li a.nav-link:hover{color:rgba(var(--pst-color-navbar-link-hover),1)}.navbar-light .navbar-nav>.active>.nav-link{font-weight:600;color:rgba(var(--pst-color-navbar-link-active),1)}.navbar-header a{padding:0 15px}.admonition,div.admonition{margin:1.5625em auto;padding:0 .6rem .8rem;overflow:hidden;page-break-inside:avoid;border-left:.2rem solid;border-left-color:rgba(var(--pst-color-admonition-default),1);border-bottom-color:rgba(var(--pst-color-admonition-default),1);border-right-color:rgba(var(--pst-color-admonition-default),1);border-top-color:rgba(var(--pst-color-admonition-default),1);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);transition:color .25s,background-color .25s,border-color .25s}.admonition :last-child,div.admonition :last-child{margin-bottom:0}.admonition p.admonition-title~*,div.admonition p.admonition-title~*{margin-left:1.4rem;margin-right:1.4rem}.admonition>ol,.admonition>ul,div.admonition>ol,div.admonition>ul{margin-left:1em}.admonition>.admonition-title,div.admonition>.admonition-title{position:relative;margin:0 -.6rem;padding:.4rem .6rem .4rem 2rem;font-weight:700;background-color:rgba(var(--pst-color-admonition-default),.1)}.admonition>.admonition-title:before,div.admonition>.admonition-title:before{position:absolute;left:.6rem;width:1rem;height:1rem;color:rgba(var(--pst-color-admonition-default),1);font-family:Font Awesome\ 5 Free;font-weight:900;content:var(--pst-icon-admonition-default)}.admonition>.admonition-title+*,div.admonition>.admonition-title+*{margin-top:.4em}.admonition.attention,div.admonition.attention{border-color:rgba(var(--pst-color-admonition-attention),1)}.admonition.attention>.admonition-title,div.admonition.attention>.admonition-title{background-color:rgba(var(--pst-color-admonition-attention),.1)}.admonition.attention>.admonition-title:before,div.admonition.attention>.admonition-title:before{color:rgba(var(--pst-color-admonition-attention),1);content:var(--pst-icon-admonition-attention)}.admonition.caution,div.admonition.caution{border-color:rgba(var(--pst-color-admonition-caution),1)}.admonition.caution>.admonition-title,div.admonition.caution>.admonition-title{background-color:rgba(var(--pst-color-admonition-caution),.1)}.admonition.caution>.admonition-title:before,div.admonition.caution>.admonition-title:before{color:rgba(var(--pst-color-admonition-caution),1);content:var(--pst-icon-admonition-caution)}.admonition.warning,div.admonition.warning{border-color:rgba(var(--pst-color-admonition-warning),1)}.admonition.warning>.admonition-title,div.admonition.warning>.admonition-title{background-color:rgba(var(--pst-color-admonition-warning),.1)}.admonition.warning>.admonition-title:before,div.admonition.warning>.admonition-title:before{color:rgba(var(--pst-color-admonition-warning),1);content:var(--pst-icon-admonition-warning)}.admonition.danger,div.admonition.danger{border-color:rgba(var(--pst-color-admonition-danger),1)}.admonition.danger>.admonition-title,div.admonition.danger>.admonition-title{background-color:rgba(var(--pst-color-admonition-danger),.1)}.admonition.danger>.admonition-title:before,div.admonition.danger>.admonition-title:before{color:rgba(var(--pst-color-admonition-danger),1);content:var(--pst-icon-admonition-danger)}.admonition.error,div.admonition.error{border-color:rgba(var(--pst-color-admonition-error),1)}.admonition.error>.admonition-title,div.admonition.error>.admonition-title{background-color:rgba(var(--pst-color-admonition-error),.1)}.admonition.error>.admonition-title:before,div.admonition.error>.admonition-title:before{color:rgba(var(--pst-color-admonition-error),1);content:var(--pst-icon-admonition-error)}.admonition.hint,div.admonition.hint{border-color:rgba(var(--pst-color-admonition-hint),1)}.admonition.hint>.admonition-title,div.admonition.hint>.admonition-title{background-color:rgba(var(--pst-color-admonition-hint),.1)}.admonition.hint>.admonition-title:before,div.admonition.hint>.admonition-title:before{color:rgba(var(--pst-color-admonition-hint),1);content:var(--pst-icon-admonition-hint)}.admonition.tip,div.admonition.tip{border-color:rgba(var(--pst-color-admonition-tip),1)}.admonition.tip>.admonition-title,div.admonition.tip>.admonition-title{background-color:rgba(var(--pst-color-admonition-tip),.1)}.admonition.tip>.admonition-title:before,div.admonition.tip>.admonition-title:before{color:rgba(var(--pst-color-admonition-tip),1);content:var(--pst-icon-admonition-tip)}.admonition.important,div.admonition.important{border-color:rgba(var(--pst-color-admonition-important),1)}.admonition.important>.admonition-title,div.admonition.important>.admonition-title{background-color:rgba(var(--pst-color-admonition-important),.1)}.admonition.important>.admonition-title:before,div.admonition.important>.admonition-title:before{color:rgba(var(--pst-color-admonition-important),1);content:var(--pst-icon-admonition-important)}.admonition.note,div.admonition.note{border-color:rgba(var(--pst-color-admonition-note),1)}.admonition.note>.admonition-title,div.admonition.note>.admonition-title{background-color:rgba(var(--pst-color-admonition-note),.1)}.admonition.note>.admonition-title:before,div.admonition.note>.admonition-title:before{color:rgba(var(--pst-color-admonition-note),1);content:var(--pst-icon-admonition-note)}table.field-list{border-collapse:separate;border-spacing:10px;margin-left:1px}table.field-list th.field-name{padding:1px 8px 1px 5px;white-space:nowrap;background-color:#eee}table.field-list td.field-body p{font-style:italic}table.field-list td.field-body p>strong{font-style:normal}table.field-list td.field-body blockquote{border-left:none;margin:0 0 .3em;padding-left:30px}.table.autosummary td:first-child{white-space:nowrap}.sig{font-family:var(--pst-font-family-monospace)}.sig-inline.c-texpr,.sig-inline.cpp-texpr{font-family:unset}.sig.c .k,.sig.c .kt,.sig.c .m,.sig.c .s,.sig.c .sc,.sig.cpp .k,.sig.cpp .kt,.sig.cpp .m,.sig.cpp .s,.sig.cpp .sc{color:rgba(var(--pst-color-text-base),1)}.sig-name{color:rgba(var(--pst-color-inline-code),1)}td.text-align\:left,th.text-align\:left{text-align:left}td.text-align\:right,th.text-align\:right{text-align:right}td.text-align\:center,th.text-align\:center{text-align:center}div.deprecated,div.versionadded,div.versionchanged{vertical-align:middle;margin:1.5625em auto;padding:0 .6rem;overflow:hidden;page-break-inside:avoid;border-left:.2rem solid;border-left-color:rgba(var(--pst-color-versionmodified-default),1);border-bottom-color:rgba(var(--pst-color-versionmodified-default),1);border-right-color:rgba(var(--pst-color-versionmodified-default),1);border-top-color:rgba(var(--pst-color-versionmodified-default),1);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);transition:color .25s,background-color .25s,border-color .25s;background-color:rgba(var(--pst-color-admonition-default),.1)}div.deprecated>p,div.versionadded>p,div.versionchanged>p{margin-bottom:.6rem;margin-top:.6rem}div.versionadded{border-color:rgba(var(--pst-color-versionmodified-added),1);background-color:rgba(var(--pst-color-versionmodified-added),.1)}div.versionchanged{border-color:rgba(var(--pst-color-versionmodified-changed),1);background-color:rgba(var(--pst-color-versionmodified-changed),.1)}div.deprecated{border-color:rgba(var(--pst-color-versionmodified-deprecated),1);background-color:rgba(var(--pst-color-versionmodified-deprecated),.1)}span.versionmodified{font-weight:700}span.versionmodified:before{font-style:normal;margin-right:.6rem;color:rgba(var(--pst-color-versionmodified-default),1);font-family:Font Awesome\ 5 Free;font-weight:900;content:var(--pst-icon-versionmodified-default)}span.versionmodified.added:before{color:rgba(var(--pst-color-versionmodified-added),1);content:var(--pst-icon-versionmodified-added)}span.versionmodified.changed:before{color:rgba(var(--pst-color-versionmodified-changed),1);content:var(--pst-icon-versionmodified-changed)}span.versionmodified.deprecated:before{color:rgba(var(--pst-color-versionmodified-deprecated),1);content:var(--pst-icon-versionmodified-deprecated)}blockquote{padding:0 1em;color:#6a737d;border-left:.25em solid #dfe2e5}dt.label>span.brackets:not(:only-child):before{content:"["}dt.label>span.brackets:not(:only-child):after{content:"]"}a.footnote-reference{vertical-align:super;font-size:small}.topic{background-color:#eee}.seealso dd{margin-top:0;margin-bottom:0}.viewcode-back{font-family:var(--pst-font-family-base)}.viewcode-block:target{background-color:#f4debf;border-top:1px solid #ac9;border-bottom:1px solid #ac9}span.guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}footer{width:100%;border-top:1px solid #ccc;padding:10px}footer .footer-item p{margin-bottom:0}.bd-search{position:relative;padding:1rem 15px;margin-right:-15px;margin-left:-15px}.bd-search .icon{position:absolute;color:#a4a6a7;left:25px}.bd-search input{border-radius:.2rem;border:1px solid #e5e5e5;padding-left:35px}.bd-toc{-ms-flex-order:2;order:2;height:calc(100vh - 2rem);overflow-y:auto}@supports (position:-webkit-sticky) or (position:sticky){.bd-toc{position:-webkit-sticky;position:sticky;top:var(--pst-header-height);height:calc(100vh - 5rem);overflow-y:auto}}.bd-toc .onthispage{color:#a4a6a7}.section-nav{padding-left:0;border-left:1px solid #eee;border-bottom:none}.section-nav ul{padding-left:1rem}.toc-entry,.toc-entry a{display:block}.toc-entry a{padding:.125rem 1.5rem;color:rgba(var(--pst-color-toc-link),1)}@media (min-width:1200px){.toc-entry a{padding-right:0}}.toc-entry a:hover{color:rgba(var(--pst-color-toc-link-hover),1);text-decoration:none}.bd-links{padding-top:1rem;padding-bottom:1rem;margin-right:-15px;margin-left:-15px}@media (min-width:720px){.bd-links{display:block}}.bd-sidenav{display:none}.bd-content{padding-top:20px}.bd-content .section{max-width:100%}.bd-content .section table{display:block;overflow:auto}.bd-toc-link{display:block;padding:.25rem 1.5rem;font-weight:600;color:rgba(0,0,0,.65)}.bd-toc-link:hover{color:rgba(0,0,0,.85);text-decoration:none}.bd-toc-item.active{margin-bottom:1rem}.bd-toc-item.active:not(:first-child){margin-top:1rem}.bd-toc-item.active>.bd-toc-link{color:rgba(0,0,0,.85)}.bd-toc-item.active>.bd-toc-link:hover{background-color:transparent}.bd-toc-item.active>.bd-sidenav{display:block}nav.bd-links p.caption{font-size:var(--pst-sidebar-caption-font-size);text-transform:uppercase;font-weight:700;position:relative;margin-top:1.25em;margin-bottom:.5em;padding:0 1.5rem;color:rgba(var(--pst-color-sidebar-caption),1)}nav.bd-links p.caption:first-child{margin-top:0}.bd-sidebar .nav{font-size:var(--pst-sidebar-font-size)}.bd-sidebar .nav ul{list-style:none;padding:0 0 0 1.5rem}.bd-sidebar .nav li>a{display:block;padding:.25rem 1.5rem;color:rgba(var(--pst-color-sidebar-link),1)}.bd-sidebar .nav li>a:hover{color:rgba(var(--pst-color-sidebar-link-hover),1);text-decoration:none;background-color:transparent}.bd-sidebar .nav li>a.reference.external:after{font-family:Font Awesome\ 5 Free;font-weight:900;content:"\f35d";font-size:.75em;margin-left:.3em}.bd-sidebar .nav .active:hover>a,.bd-sidebar .nav .active>a{font-weight:600;color:rgba(var(--pst-color-sidebar-link-active),1)}.toc-h2{font-size:.85rem}.toc-h3{font-size:.75rem}.toc-h4{font-size:.65rem}.toc-entry>.nav-link.active{font-weight:600;color:#130654;color:rgba(var(--pst-color-toc-link-active),1);background-color:transparent;border-left:2px solid rgba(var(--pst-color-toc-link-active),1)}.nav-link:hover{border-style:none}#navbar-main-elements li.nav-item i{font-size:.7rem;padding-left:2px;vertical-align:middle}.bd-toc .nav .nav,.list-caption .nav{display:none}.bd-toc .nav .nav.visible,.bd-toc .nav>.active>ul,.list-caption .nav.visible,.list-caption>.active>ul{display:block}.prev-next-area{margin:20px 0}.prev-next-area p{margin:0 .3em;line-height:1.3em}.prev-next-area i{font-size:1.2em}.prev-next-area a{display:flex;align-items:center;border:none;padding:10px;max-width:45%;overflow-x:hidden;color:rgba(0,0,0,.65);text-decoration:none}.prev-next-area a p.prev-next-title{color:rgba(var(--pst-color-link),1);font-weight:600;font-size:1.1em}.prev-next-area a:hover p.prev-next-title{text-decoration:underline}.prev-next-area a .prev-next-info{flex-direction:column;margin:0 .5em}.prev-next-area a .prev-next-info .prev-next-subtitle{text-transform:capitalize}.prev-next-area a.left-prev{float:left}.prev-next-area a.right-next{float:right}.prev-next-area a.right-next div.prev-next-info{text-align:right}.alert{padding-bottom:0}.alert-info a{color:#e83e8c}#navbar-icon-links i.fa,#navbar-icon-links i.fab,#navbar-icon-links i.far,#navbar-icon-links i.fas{vertical-align:middle;font-style:normal;font-size:1.5rem;line-height:1.25}#navbar-icon-links i.fa-github-square:before{color:#333}#navbar-icon-links i.fa-twitter-square:before{color:#55acee}#navbar-icon-links i.fa-gitlab:before{color:#548}#navbar-icon-links i.fa-bitbucket:before{color:#0052cc}#navbar-icon-links img.icon-link-image{height:1.5em}.tocsection{border-left:1px solid #eee;padding:.3rem 1.5rem}.tocsection i{padding-right:.5rem}.editthispage{padding-top:2rem}.editthispage a{color:var(--pst-color-sidebar-link-active)}.xr-wrap[hidden]{display:block!important}.toctree-checkbox{position:absolute;display:none}.toctree-checkbox~ul{display:none}.toctree-checkbox~label i{transform:rotate(0deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label i{transform:rotate(180deg)}.bd-sidebar{padding-top:1em;overflow-y:auto;display:flex;flex-direction:column}@media (min-width:720px){.bd-sidebar{border-right:1px solid rgba(0,0,0,.1)}@supports (position:-webkit-sticky) or (position:sticky){.bd-sidebar{position:-webkit-sticky;position:sticky;top:var(--pst-header-height);z-index:1000;height:calc(100vh - var(--pst-header-height))}}}.bd-sidebar.no-sidebar{border-right:0}.bd-sidebar .sidebar-end-items{margin-top:auto;margin-bottom:1em}.bd-sidebar .list-caption{list-style:none;padding-left:0}.bd-sidebar li{position:relative}.bd-sidebar li.has-children>.reference{padding-right:30px}.bd-sidebar label{position:absolute;top:0;right:0;height:30px;width:30px;cursor:pointer;display:flex;justify-content:center;align-items:center}.bd-sidebar label:hover{background:rgba(var(--pst-color-sidebar-expander-background-hover),1)}.bd-sidebar label i{display:inline-block;font-size:.75rem;text-align:center}.bd-sidebar label i:hover{color:rgba(var(--pst-color-sidebar-link-hover),1)}.bd-sidebar .label-parts{width:100%;height:100%}.bd-sidebar .label-parts:hover{background:none}.bd-sidebar .label-parts i{width:30px;position:absolute;top:.3em;right:0}div.doctest>div.highlight span.gp,span.linenos,table.highlighttable td.linenos{user-select:none;-webkit-user-select:text;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none}.docutils.container{padding-left:unset;padding-right:unset} \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/styles/sphinx-book-theme.css b/branch/sphinx-book-theme-old-copybutton/_static/styles/sphinx-book-theme.css new file mode 100644 index 00000000..2dbb3598 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/styles/sphinx-book-theme.css @@ -0,0 +1,8 @@ +/*! sphinx-book-theme CSS + * BSD 3-Clause License + * Copyright (c) 2020, EBP + * All rights reserved. + * + * This follows the 7-1 pattern described here: + * https://sass-guidelin.es/#architecture + */:root{--pst-font-size-base:none;--pst-color-primary:87,154,202;--pst-color-admonition-note:var(--pst-color-primary);--pst-color-admonition-default:var(--pst-color-primary);--pst-color-info:255,193,7;--pst-color-admonition-tip:var(--pst-color-info);--pst-color-admonition-hint:var(--pst-color-info);--pst-color-admonition-important:var(--pst-color-info);--pst-color-warning:245,162,82;--pst-color-danger:230,101,129;--pst-color-admonition-warning:var(--pst-color-danger);--pst-color-link:0,113,188;--sbt-font-size-regular:100%;--sbt-font-size-large:112.5%;--sbt-font-size-small-1:87.5%;--sbt-font-size-small-2:70%;--sbt-sidebar-font-size:var(--sbt-font-size-small-1);--sbt-header-article-font-size:var(--sbt-font-size-small-1);--sbt-prevnext-font-size:var(--sbt-font-size-small-1);--sbt-footer-font-size:var(--sbt-font-size-small-1)}.sbt-scroll-pixel-helper{position:absolute;width:0;height:0;top:0;left:0}.visually-hidden{clip:rect(0,0,0,0)!important;border:0!important;height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;white-space:nowrap!important;width:1px!important}.d-n,.onlyprint{display:none}@media print{.onlyprint{display:block!important}}@media print{.noprint{display:none!important}}.col{min-width:0}.content-container a.headerlink{opacity:0;margin-left:.2em}.content-container a.headerlink:hover{background-color:transparent;color:rgba(var(--pst-color-link),1);opacity:1!important}.content-container a,.content-container a:visited{color:rgba(var(--pst-color-link),1)}.content-container h1,.content-container h2,.content-container h3,.content-container h4,.content-container h5{color:#000}.content-container h1:hover a.headerlink,.content-container h2:hover a.headerlink,.content-container h3:hover a.headerlink,.content-container h4:hover a.headerlink,.content-container h5:hover a.headerlink{opacity:.5}.content-container h1 a.toc-backref,.content-container h2 a.toc-backref,.content-container h3 a.toc-backref,.content-container h4 a.toc-backref,.content-container h5 a.toc-backref{color:inherit}.content-container h3,.content-container h4,.content-container h5,.content-container h6{margin-top:1em}.content-container ol p,.content-container ul p{margin-bottom:0}.content-container p.centered{text-align:center}.content-container .footnote-reference,.content-container a.bibtex.internal{font-size:1em}@media print{#jb-print-docs-body{max-width:90%;margin:auto}#jb-print-docs-body h1{font-size:3em;text-align:center;margin-bottom:0}#main-content{max-width:67%!important;margin-left:5%!important;padding-top:0}#main-content h1:first-of-type{display:none}.container{min-width:0!important}h1{margin-top:1em;margin-bottom:1em}h1,h2,h3,h4{break-after:avoid;color:#000}table{break-inside:avoid}pre{word-wrap:break-word}a.headerlink{display:none}blockquote.epigraph{border:none}.footer{margin-top:1em}}body{padding-top:0!important}#main-content,#print-main-content{transition:padding .25s ease-out;padding-top:1.5em}@media (min-width:768px){#main-content{max-width:70%}}footer.footer-article{border-top:none;padding:0}footer.footer-article .prev-next-area{font-size:var(--sbt-prevnext-font-size)}footer.footer-article .prev-next-area a{margin-bottom:1em;padding-left:0;padding-right:0}@media (min-width:768px){footer.footer-article .prev-next-area{max-width:70%}}footer{font-size:var(--sbt-font-size-small-1)}.header-article{height:3em;background-color:#fff;transition:left .2s;font-size:var(--sbt-header-article-font-size)}@media (max-width:768px){.header-article{height:3.75em}}.scrolled .header-article{box-shadow:0 6px 6px -6px rgba(0,0,0,.3)}.header-article .header-article-main{height:3em}@media (max-width:768px){.header-article .header-article-main{height:3.75em}}.header-article .header-article-main .header-article__left,.header-article .header-article-main .header-article__right{display:flex;align-items:center}.header-article .header-article-main .header-article__right{margin-left:auto}.header-item{width:100%;text-align:center}.header-item:empty{display:none}.header-item.announcement{background-color:#616161;color:#fff;padding:.4em 12.5%}@media (max-width:768px){.header-item.announcement{padding:.4em 2%}}#site-navigation{padding-top:0;width:275px;font-size:var(--sbt-sidebar-font-size);top:0!important;background:#fff;border-right:1px solid rgba(0,0,0,.1);transition:margin-left .25s ease 0s,opacity .25s ease 0s,visibility .25s ease 0s;overflow-y:unset;height:100vh}@media (max-width:768px){#site-navigation{height:100%;position:fixed;width:75%;max-width:300px;font-size:1.2em;z-index:1100}}#site-navigation .bd-sidebar__content{overflow-y:auto;flex-grow:1;display:flex;flex-direction:column}#site-navigation .bd-sidebar__content::-webkit-scrollbar{width:.3rem;height:.3rem}#site-navigation .bd-sidebar__content::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:.25rem}#site-navigation .bd-sidebar__content::-webkit-scrollbar-thumb:hover{background:#a0a0a0}#site-navigation .bd-sidebar__content:not(:hover)::-webkit-scrollbar-thumb{visibility:hidden}#site-navigation .bd-sidebar__bottom,#site-navigation .bd-sidebar__top{padding:0 1rem 0 1.5rem}#site-navigation .bd-sidebar__bottom{margin-top:auto;margin-bottom:2em}#site-navigation nav ul.nav li a,#site-navigation nav ul.nav ul li a{color:#5a5a5a}#site-navigation nav ul.nav a:hover,#site-navigation nav ul.nav li.active>a,#site-navigation nav ul.nav li.active>a:hover{color:rgba(var(--pst-color-link),1)}#site-navigation nav ul.nav ul{padding-left:1rem}#site-navigation h1.site-logo{margin:.5em 0 0;font-size:1.1em;color:#000;text-align:center}#site-navigation div.navbar_extra_footer{text-align:center;font-size:.9em;color:#5a5a5a;margin-bottom:3em}#site-navigation.single-page{border-right:0}@media (min-width:768px){div.navbar-brand-box{padding-top:2em}}div.navbar-brand-box a.navbar-brand{width:100%;height:auto;flex-direction:column}div.navbar-brand-box a.navbar-brand img{display:block;height:auto;width:auto;max-height:10vh;max-width:100%;margin:0 auto}@media (min-width:768px){div.navbar-brand-box a.navbar-brand img{max-height:15vh!important}}nav.bd-links{margin-left:0;overflow-y:visible;max-height:none}nav.bd-links .toctree-l1 a,nav.bd-links p.caption{padding-left:0}.bd-toc{padding:0!important;right:-1em;height:auto;transition:margin-right .25s ease 0s,opacity .25s ease 0s,visibility .25s ease 0s}.bd-toc .toc-entry a,.bd-toc div.onthispage{color:#5a5a5a}@media (max-width:768px){.bd-toc{z-index:1100;top:0;right:0;position:fixed;height:100%;width:75%;max-width:300px;background-color:#fff;border-left:1px solid rgba(0,0,0,.1);font-size:1.4em}.bd-toc li{font-size:.8em}}.bd-toc nav{opacity:0;max-height:0;transition:opacity .2s ease,max-height .7s ease;overflow-y:hidden;background:#fff}.bd-toc nav::-webkit-scrollbar{width:.3rem;height:.3rem}.bd-toc nav::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:.25rem}.bd-toc nav::-webkit-scrollbar-thumb:hover{background:#a0a0a0}.bd-toc nav:not(:hover)::-webkit-scrollbar-thumb{visibility:hidden}.bd-toc nav a:hover,.bd-toc nav li.active>a.active{color:rgba(var(--pst-color-link),1)}.bd-toc nav li.active>a.active{border-left:2px solid rgba(var(--pst-color-link),1)}.bd-toc nav>.nav{border-left:1px solid #eee}.bd-toc nav>.nav .nav{border-left:none}.bd-toc.show nav,.bd-toc:hover nav{max-height:90vh;opacity:1;overflow-y:auto}.bd-toc.show .tocsection:after,.bd-toc:hover .tocsection:after{opacity:0}@media (max-width:768px){.bd-toc nav{max-height:90vh;opacity:1;overflow-y:auto}.bd-toc .tocsection:after{opacity:0}}.bd-toc .tocsection{padding:.5rem 0 .5rem 1rem!important}.bd-toc .tocsection:after{content:"\f107";font-family:Font Awesome\ 5 Free;font-weight:900;padding-left:.5em;transition:opacity .3s ease}.bd-toc .toc-entry a{padding:.125rem 1rem!important}.bd-toc div.editthispage{display:none}input.sidebar-toggle{display:none;position:absolute}@media (min-width:768px){input#__navigation:checked~.container-xl #site-navigation{visibility:hidden;opacity:0;margin-left:-275px}input#__navigation:checked~.container-xl #main-content{padding-left:4rem;padding-right:4rem}}@media (max-width:768px){input#__navigation:not(:checked)~.container-xl #site-navigation{visibility:hidden;opacity:0;margin-left:-75%}}@media (max-width:768px){input#__page-toc:not(:checked)~.container-xl .bd-toc{visibility:hidden;opacity:0;margin-right:-75%}}label.overlay{height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}label.overlay.overlay-navbar{background-color:rgba(0,0,0,.54)}@media (max-width:768px){input:checked+label.overlay{height:100%;opacity:1;width:100%}input:checked+label.overlay.overlay-navbar{z-index:1099}input:checked+label.overlay.overlay-pagetoc{z-index:1019}}.headerbtn{justify-content:center;background-color:#fff;color:#5a5a5a;cursor:pointer;border:none;padding:.1rem .5rem;margin:0 .1rem}.headerbtn,.headerbtn span{display:flex;align-items:center}.headerbtn i,.headerbtn img{margin:auto;width:1em;text-align:center;font-size:1.5em}.menu-dropdown__content:hover,.menu-dropdown__trigger:hover+.menu-dropdown__content{visibility:visible;opacity:1}.menu-dropdown__content{position:absolute;visibility:hidden;opacity:0;transform:translateX(-75%);transition:opacity .2s ease-out;width:10rem;border-radius:.4em;box-shadow:0 3px 10px 0 rgba(0,0,0,.25);padding:.5em;background-color:#fff}.menu-dropdown__content .headerbtn{justify-content:left;padding:.1rem 0}.menu-dropdown__content ul{list-style:none;padding-left:0;margin-bottom:0}.menu-dropdown__content span{display:flex}.menu-dropdown__content span.headerbtn__icon-container{width:2em}.menu-dropdown__content span.headerbtn__text-container{flex-grow:1;margin-left:.5em}.menu-dropdown__content i,.menu-dropdown__content img{font-size:1.2em}div.header-article-main .header-article__left a,div.header-article-main .header-article__left button,div.header-article-main .header-article__left label,div.header-article-main .header-article__right a,div.header-article-main .header-article__right button,div.header-article-main .header-article__right label{color:#5a5a5a}div.header-article-main .header-article__left a:focus,div.header-article-main .header-article__left a:hover,div.header-article-main .header-article__left button:focus,div.header-article-main .header-article__left button:hover,div.header-article-main .header-article__left label:focus,div.header-article-main .header-article__left label:hover,div.header-article-main .header-article__right a:focus,div.header-article-main .header-article__right a:hover,div.header-article-main .header-article__right button:focus,div.header-article-main .header-article__right button:hover,div.header-article-main .header-article__right label:focus,div.header-article-main .header-article__right label:hover{color:#000;box-shadow:none;text-decoration:none}.headerbtn-page-toc{display:block}@media (min-width:768px){.headerbtn-page-toc{display:none}}dt:target,span.highlighted{background-color:rgba(243,119,38,.25882352941176473)}.admonition{border-radius:.4em;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}.admonition.seealso{border-color:#28a745}.admonition.seealso .admonition-title{background-color:rgba(40,167,70,.1)}.admonition.seealso .admonition-title:before{color:#28a745;content:"\f064"}code{font-size:87.5%!important}pre{border-radius:.4em}pre::-webkit-scrollbar{width:.3rem;height:.3rem}pre::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:.25rem}pre::-webkit-scrollbar-thumb:hover{background:#a0a0a0}div[class*=highlight-],pre{clear:none}.highlighttable .linenos{vertical-align:baseline}div.highlight{background:none;margin-bottom:1em}.cm-s-default{font-family:var(--jp-code-font-family);font-size:var(--jp-code-font-size);line-height:var(--jp-code-line-height)}.CodeMirror-focused{background-color:var(--jp-cell-editor-active-background)!important;border:var(--jp-border-width) solid var(--jp-cell-editor-active-border-color);margin:-1px}dl.field-list dd,dl.simple dd{margin-left:1.5em}dl.footnote span.fn-backref{font-size:1em;padding-left:.1em}dl.footnote dd{font-size:.9em;margin-left:3em}.footnote-reference,a.bibtex.internal{font-size:1em}dl.glossary dd{margin-left:1.5em}img{max-width:100%}img.align-center{margin-left:auto;margin-right:auto;display:block}img.align-left{clear:left;float:left;margin-right:1em}img.align-right{clear:right;float:right;margin-left:1em}div.figure{width:100%;margin-bottom:1em;text-align:center}div.figure.align-left{text-align:left}div.figure.align-left p.caption{margin-left:0}div.figure.align-right{text-align:right}div.figure.align-right p.caption{margin-right:0}div.figure p.caption{margin:.5em 10%}div.figure.margin-caption p.caption,div.figure.margin p.caption{margin:.5em 0}div.figure.margin-caption p.caption{text-align:left}div.figure span.caption-number{font-weight:700}div.figure span{font-size:.9rem}label.margin-toggle{margin-bottom:0}label.margin-toggle.marginnote-label{display:none}label.margin-toggle sup{user-select:none}@media (max-width:768px){label.margin-toggle{cursor:pointer;color:#0071bc}label.margin-toggle.marginnote-label{display:inline}label.margin-toggle.marginnote-label:after{content:"\2295"}}input.margin-toggle{display:none}@media (max-width:768px){input.margin-toggle:checked+.marginnote,input.margin-toggle:checked+.sidenote{display:block;float:left;left:1rem;clear:both;width:95%;margin:1rem 2.5%;position:relative}}span.marginnote,span.sidenote{width:40%;float:right;background-color:unset;font-size:.9em;border-left:none}span.marginnote sup,span.sidenote sup{user-select:none}@media (min-width:768px){span.marginnote,span.sidenote{border:none;width:39.85714%;margin:0 -42.85714% 0 0;clear:right}span.marginnote p.sidebar-title,span.sidenote p.sidebar-title{margin-bottom:.1em}}@media (max-width:768px){span.marginnote,span.sidenote{display:none}}.cell.tag_margin,.cell.tag_popout,aside.margin,div.margin,figure.margin{width:40%;float:right;background-color:unset;border-left:1px solid #a4a6a7;font-size:.9em}@media (min-width:768px){.cell.tag_margin,.cell.tag_popout,aside.margin,div.margin,figure.margin{border:none;width:39.85714%;margin:0 -42.85714% 0 0;clear:right}.cell.tag_margin p.sidebar-title,.cell.tag_popout p.sidebar-title,aside.margin p.sidebar-title,div.margin p.sidebar-title,figure.margin p.sidebar-title{margin-bottom:.1em}}.cell.tag_margin div.cell.tag_margin .cell_output,.cell.tag_popout div.cell.tag_margin .cell_output,aside.margin div.cell.tag_margin .cell_output,div.margin div.cell.tag_margin .cell_output,figure.margin div.cell.tag_margin .cell_output{padding-left:0}div.figure.margin-caption figcaption,div.figure.margin-caption p.caption,figure.margin-caption figcaption{width:40%;float:right;background-color:unset;border-left:1px solid #a4a6a7;font-size:.9em}@media (min-width:768px){div.figure.margin-caption figcaption,div.figure.margin-caption p.caption,figure.margin-caption figcaption{border:none;width:39.85714%;margin:0 -42.85714% 0 0;clear:right}div.figure.margin-caption figcaption p.sidebar-title,div.figure.margin-caption p.caption p.sidebar-title,figure.margin-caption figcaption p.sidebar-title{margin-bottom:.1em}}@media (min-width:768px){.full-width,.full_width,div.cell.tag_full-width,div.cell.tag_full_width{max-width:142.85714%;width:142.85714%}}.margin-caption figcaption{text-align:left}div.math{position:relative;display:flex;flex-direction:row-reverse;align-items:center}div.math .headerlink{font-size:1em;padding:0 .2em;margin-left:0}div.math .headerlink:hover{opacity:1}div.math:hover .headerlink{opacity:.5}span.eqno{font-size:1.2em;margin-left:.5em}.MathJax{overflow-x:auto;margin-right:auto!important;margin-left:auto!important;overflow-y:hidden}.MathJax::-webkit-scrollbar{width:.3rem;height:.3rem}.MathJax::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:.25rem}.MathJax::-webkit-scrollbar-thumb:hover{background:#a0a0a0}p~div.math{margin-top:-1.15rem}blockquote{margin:1em;padding:.2em 1.5em;border-left:4px solid #ccc}blockquote.epigraph,blockquote.highlights,blockquote.pull-quote{font-size:1.25em;border-left:none}blockquote div>p{margin-bottom:.5em}blockquote div>p+p.attribution{font-style:normal;font-size:.9em;text-align:right;color:#6c757d;padding-right:2em}aside.sidebar:not(.margin),div.sidebar:not(.margin){background-color:unset;padding:1em;border-radius:.4em;border-color:#aaa}@media (min-width:992px){aside.sidebar:not(.margin),div.sidebar:not(.margin){width:65%;margin:0 -35% 0 3%}}div.tableofcontents-wrapper p.caption{font-weight:600!important;margin-bottom:0!important}div.toctree-wrapper p.caption{font-size:1.4em}div.toctree-wrapper>ul{padding-left:1.5em}div.toctree-wrapper>ul>li>a{font-size:1.1em}div.contents{border-radius:.4em;padding:1em 1em 2em}div.contents p.topic-title{font-size:1.5em;padding:0 0 0 .5em;margin-bottom:0}div.contents>ul{list-style:none;padding-left:1em}div.contents>ul>li>ul{padding-left:1.5em}div.contents>ul>li>p>a{font-size:1.2em;margin-bottom:.5em}@media print{#jb-print-toc{margin-bottom:1.5rem}#jb-print-toc .section-nav{border-left:0;list-style-type:disc;margin-left:3em}#jb-print-toc .section-nav a{text-decoration:none;padding-left:0}#jb-print-toc .section-nav li{display:list-item!important}#jb-print-toc .section-nav .nav{display:none}}ul.ablog-archive,ul.postlist{padding-left:0}ul.postlist>li>p:first-child{font-size:1.5em}ul.postlist li+li{margin-top:2em}ul.postlist li>p>a{font-style:normal;font-size:1.3em}div.bd-sidebar h2{font-size:1.5em}div.bd-sidebar h3{font-size:1.4em}div.bd-sidebar>ul{list-style:none;padding-left:0}@media only print{div.utterances,hypothesis-sidebar{display:none}}div.cell div.highlight{margin-bottom:0}div.cell div.cell_input,div.cell div.cell_output pre{border-radius:.4em;border:1px solid #ccc}div.cell div.cell_output{padding-right:0}div.cell.tag_output_scroll div.cell_output,div.cell.tag_scroll-output div.cell_output{max-height:24em;overflow-y:auto}div.cell.tag_output_scroll div.cell_output::-webkit-scrollbar,div.cell.tag_scroll-output div.cell_output::-webkit-scrollbar{width:.3rem;height:.3rem}div.cell.tag_output_scroll div.cell_output::-webkit-scrollbar-thumb,div.cell.tag_scroll-output div.cell_output::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:.25rem}div.cell.tag_output_scroll div.cell_output::-webkit-scrollbar-thumb:hover,div.cell.tag_scroll-output div.cell_output::-webkit-scrollbar-thumb:hover{background:#a0a0a0}@media print{div.cell.tag_output_scroll div.cell_output,div.cell.tag_scroll-output div.cell_output{max-height:unset;overflow-y:visible}}div.cell.tag_scroll-input div.cell_input{max-height:24em;overflow-y:auto}div.cell.tag_scroll-input div.cell_input::-webkit-scrollbar{width:.3rem;height:.3rem}div.cell.tag_scroll-input div.cell_input::-webkit-scrollbar-thumb{background:#c1c1c1;border-radius:.25rem}div.cell.tag_scroll-input div.cell_input::-webkit-scrollbar-thumb:hover{background:#a0a0a0}@media print{div.cell.tag_scroll-input div.cell_input{max-height:unset;overflow-y:visible}}div.sphinx-tabs>div.sphinx-menu{padding:0}div.sphinx-tabs>div.sphinx-menu>a.item{width:auto;margin:0 0 -1px}.bd-sidebar div#rtd-footer-container{position:sticky;bottom:0}.bd-sidebar .rst-versions.rst-badge{position:unset;font-size:.9em}.bd-sidebar .rst-versions.rst-badge .rst-current-version{display:flex;align-items:center;gap:.2rem;height:2.5rem;transition:background-color .2s ease-out;background-color:#fff;color:#5a5a5a;border-top:1px solid rgba(0,0,0,.1)}@media (max-width:768px){.bd-sidebar .rst-versions.rst-badge .rst-current-version{height:3rem}}.bd-sidebar .rst-versions.rst-badge .rst-current-version:hover{background-color:rgba(var(--pst-color-sidebar-expander-background-hover),1);cursor:pointer}.bd-sidebar .rst-versions.rst-badge .rst-current-version .fa{color:#5a5a5a}.bd-sidebar .rst-versions.rst-badge .rst-current-version .fa-book{float:unset;margin-right:auto}.bd-sidebar .rst-versions.rst-badge .rst-current-version .fa-book:after{content:"Read the Docs";font-family:sans-serif;font-weight:700;margin-left:.2em}.bd-sidebar .rst-versions.rst-badge .rst-other-versions dt{color:#ccc}.thebelab-cell{border:none!important;margin-right:.5em!important}.thebelab-cell .thebelab-input{padding-left:10px!important}.cell.docutils.container{padding-right:0!important}button.thebe-launch-button{height:2.5em;font-size:1em}#search-documentation,#search-documentation~form,#search-documentation~p{display:none}div#search-results>h2{margin-top:0}ul.search{margin:0;list-style:none}ul.search li{background-image:none;margin-bottom:1em;padding:0 0 1em;border-bottom:1px solid rgba(0,0,0,.1)}ul.search li>a{font-size:1.2em}ul.search li div.context,ul.search li p.context{margin:.5em 0 0}ul.search li div.context a:before,ul.search li p.context a:before{content:"#";padding-right:.2em;color:#aaa} \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/styles/theme.css b/branch/sphinx-book-theme-old-copybutton/_static/styles/theme.css new file mode 100644 index 00000000..22779d96 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/styles/theme.css @@ -0,0 +1,134 @@ +/* Provided by Sphinx's 'basic' theme, and included in the final set of assets */ +@import "../basic.css"; + +:root { + /***************************************************************************** + * Theme config + **/ + --pst-header-height: 60px; + + /***************************************************************************** + * Font size + **/ + --pst-font-size-base: 15px; /* base font size - applied at body / html level */ + + /* heading font sizes */ + --pst-font-size-h1: 36px; + --pst-font-size-h2: 32px; + --pst-font-size-h3: 26px; + --pst-font-size-h4: 21px; + --pst-font-size-h5: 18px; + --pst-font-size-h6: 16px; + + /* smaller then heading font sizes*/ + --pst-font-size-milli: 12px; + + --pst-sidebar-font-size: 0.9em; + --pst-sidebar-caption-font-size: 0.9em; + + /***************************************************************************** + * Font family + **/ + /* These are adapted from https://systemfontstack.com/ */ + --pst-font-family-base-system: -apple-system, BlinkMacSystemFont, Segoe UI, + "Helvetica Neue", Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, + Segoe UI Symbol; + --pst-font-family-monospace-system: "SFMono-Regular", Menlo, Consolas, Monaco, + Liberation Mono, Lucida Console, monospace; + + --pst-font-family-base: var(--pst-font-family-base-system); + --pst-font-family-heading: var(--pst-font-family-base); + --pst-font-family-monospace: var(--pst-font-family-monospace-system); + + /***************************************************************************** + * Color + * + * Colors are defined in rgb string way, "red, green, blue" + **/ + --pst-color-primary: 19, 6, 84; + --pst-color-success: 40, 167, 69; + --pst-color-info: 0, 123, 255; /*23, 162, 184;*/ + --pst-color-warning: 255, 193, 7; + --pst-color-danger: 220, 53, 69; + --pst-color-text-base: 51, 51, 51; + + --pst-color-h1: var(--pst-color-primary); + --pst-color-h2: var(--pst-color-primary); + --pst-color-h3: var(--pst-color-text-base); + --pst-color-h4: var(--pst-color-text-base); + --pst-color-h5: var(--pst-color-text-base); + --pst-color-h6: var(--pst-color-text-base); + --pst-color-paragraph: var(--pst-color-text-base); + --pst-color-link: 0, 91, 129; + --pst-color-link-hover: 227, 46, 0; + --pst-color-headerlink: 198, 15, 15; + --pst-color-headerlink-hover: 255, 255, 255; + --pst-color-preformatted-text: 34, 34, 34; + --pst-color-preformatted-background: 250, 250, 250; + --pst-color-inline-code: 232, 62, 140; + + --pst-color-active-navigation: 19, 6, 84; + --pst-color-navbar-link: 77, 77, 77; + --pst-color-navbar-link-hover: var(--pst-color-active-navigation); + --pst-color-navbar-link-active: var(--pst-color-active-navigation); + --pst-color-sidebar-link: 77, 77, 77; + --pst-color-sidebar-link-hover: var(--pst-color-active-navigation); + --pst-color-sidebar-link-active: var(--pst-color-active-navigation); + --pst-color-sidebar-expander-background-hover: 244, 244, 244; + --pst-color-sidebar-caption: 77, 77, 77; + --pst-color-toc-link: 119, 117, 122; + --pst-color-toc-link-hover: var(--pst-color-active-navigation); + --pst-color-toc-link-active: var(--pst-color-active-navigation); + + /***************************************************************************** + * Icon + **/ + + /* font awesome icons*/ + --pst-icon-check-circle: "\f058"; + --pst-icon-info-circle: "\f05a"; + --pst-icon-exclamation-triangle: "\f071"; + --pst-icon-exclamation-circle: "\f06a"; + --pst-icon-times-circle: "\f057"; + --pst-icon-lightbulb: "\f0eb"; + + /***************************************************************************** + * Admonitions + **/ + + --pst-color-admonition-default: var(--pst-color-info); + --pst-color-admonition-note: var(--pst-color-info); + --pst-color-admonition-attention: var(--pst-color-warning); + --pst-color-admonition-caution: var(--pst-color-warning); + --pst-color-admonition-warning: var(--pst-color-warning); + --pst-color-admonition-danger: var(--pst-color-danger); + --pst-color-admonition-error: var(--pst-color-danger); + --pst-color-admonition-hint: var(--pst-color-success); + --pst-color-admonition-tip: var(--pst-color-success); + --pst-color-admonition-important: var(--pst-color-success); + + --pst-icon-admonition-default: var(--pst-icon-info-circle); + --pst-icon-admonition-note: var(--pst-icon-info-circle); + --pst-icon-admonition-attention: var(--pst-icon-exclamation-circle); + --pst-icon-admonition-caution: var(--pst-icon-exclamation-triangle); + --pst-icon-admonition-warning: var(--pst-icon-exclamation-triangle); + --pst-icon-admonition-danger: var(--pst-icon-exclamation-triangle); + --pst-icon-admonition-error: var(--pst-icon-times-circle); + --pst-icon-admonition-hint: var(--pst-icon-lightbulb); + --pst-icon-admonition-tip: var(--pst-icon-lightbulb); + --pst-icon-admonition-important: var(--pst-icon-exclamation-circle); + + /***************************************************************************** + * versionmodified + **/ + + --pst-color-versionmodified-default: var(--pst-color-info); + --pst-color-versionmodified-added: var(--pst-color-success); + --pst-color-versionmodified-changed: var(--pst-color-warning); + --pst-color-versionmodified-deprecated: var(--pst-color-danger); + + --pst-icon-versionmodified-default: var(--pst-icon-exclamation-circle); + --pst-icon-versionmodified-added: var(--pst-icon-exclamation-circle); + --pst-icon-versionmodified-changed: var(--pst-icon-exclamation-circle); + --pst-icon-versionmodified-deprecated: var(--pst-icon-exclamation-circle); +} diff --git a/branch/sphinx-book-theme-old-copybutton/_static/tabs.css b/branch/sphinx-book-theme-old-copybutton/_static/tabs.css new file mode 100644 index 00000000..957ba60d --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/tabs.css @@ -0,0 +1,89 @@ +.sphinx-tabs { + margin-bottom: 1rem; +} + +[role="tablist"] { + border-bottom: 1px solid #a0b3bf; +} + +.sphinx-tabs-tab { + position: relative; + font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif; + color: #1D5C87; + line-height: 24px; + margin: 0; + font-size: 16px; + font-weight: 400; + background-color: rgba(255, 255, 255, 0); + border-radius: 5px 5px 0 0; + border: 0; + padding: 1rem 1.5rem; + margin-bottom: 0; +} + +.sphinx-tabs-tab[aria-selected="true"] { + font-weight: 700; + border: 1px solid #a0b3bf; + border-bottom: 1px solid white; + margin: -1px; + background-color: white; +} + +.sphinx-tabs-tab:focus { + z-index: 1; + outline-offset: 1px; +} + +.sphinx-tabs-panel { + position: relative; + padding: 1rem; + border: 1px solid #a0b3bf; + margin: 0px -1px -1px -1px; + border-radius: 0 0 5px 5px; + border-top: 0; + background: white; +} + +.sphinx-tabs-panel.code-tab { + padding: 0.4rem; +} + +.sphinx-tab img { + margin-bottom: 24 px; +} + +/* Dark theme preference styling */ + +@media (prefers-color-scheme: dark) { + body[data-theme="auto"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); + } + + body[data-theme="auto"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); + } + + body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 1px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); + } +} + +/* Explicit dark theme styling */ + +body[data-theme="dark"] .sphinx-tabs-panel { + color: white; + background-color: rgb(50, 50, 50); +} + +body[data-theme="dark"] .sphinx-tabs-tab { + color: white; + background-color: rgba(255, 255, 255, 0.05); +} + +body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] { + border-bottom: 2px solid rgb(50, 50, 50); + background-color: rgb(50, 50, 50); +} diff --git a/branch/sphinx-book-theme-old-copybutton/_static/tabs.js b/branch/sphinx-book-theme-old-copybutton/_static/tabs.js new file mode 100644 index 00000000..48dc303c --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/tabs.js @@ -0,0 +1,145 @@ +try { + var session = window.sessionStorage || {}; +} catch (e) { + var session = {}; +} + +window.addEventListener("DOMContentLoaded", () => { + const allTabs = document.querySelectorAll('.sphinx-tabs-tab'); + const tabLists = document.querySelectorAll('[role="tablist"]'); + + allTabs.forEach(tab => { + tab.addEventListener("click", changeTabs); + }); + + tabLists.forEach(tabList => { + tabList.addEventListener("keydown", keyTabs); + }); + + // Restore group tab selection from session + const lastSelected = session.getItem('sphinx-tabs-last-selected'); + if (lastSelected != null) selectNamedTabs(lastSelected); +}); + +/** + * Key focus left and right between sibling elements using arrows + * @param {Node} e the element in focus when key was pressed + */ +function keyTabs(e) { + const tab = e.target; + let nextTab = null; + if (e.keyCode === 39 || e.keyCode === 37) { + tab.setAttribute("tabindex", -1); + // Move right + if (e.keyCode === 39) { + nextTab = tab.nextElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.firstElementChild; + } + // Move left + } else if (e.keyCode === 37) { + nextTab = tab.previousElementSibling; + if (nextTab === null) { + nextTab = tab.parentNode.lastElementChild; + } + } + } + + if (nextTab !== null) { + nextTab.setAttribute("tabindex", 0); + nextTab.focus(); + } +} + +/** + * Select or deselect clicked tab. If a group tab + * is selected, also select tab in other tabLists. + * @param {Node} e the element that was clicked + */ +function changeTabs(e) { + // Use this instead of the element that was clicked, in case it's a child + const notSelected = this.getAttribute("aria-selected") === "false"; + const positionBefore = this.parentNode.getBoundingClientRect().top; + const notClosable = !this.parentNode.classList.contains("closeable"); + + deselectTabList(this); + + if (notSelected || notClosable) { + selectTab(this); + const name = this.getAttribute("name"); + selectNamedTabs(name, this.id); + + if (this.classList.contains("group-tab")) { + // Persist during session + session.setItem('sphinx-tabs-last-selected', name); + } + } + + const positionAfter = this.parentNode.getBoundingClientRect().top; + const positionDelta = positionAfter - positionBefore; + // Scroll to offset content resizing + window.scrollTo(0, window.scrollY + positionDelta); +} + +/** + * Select tab and show associated panel. + * @param {Node} tab tab to select + */ +function selectTab(tab) { + tab.setAttribute("aria-selected", true); + + // Show the associated panel + document + .getElementById(tab.getAttribute("aria-controls")) + .removeAttribute("hidden"); +} + +/** + * Hide the panels associated with all tabs within the + * tablist containing this tab. + * @param {Node} tab a tab within the tablist to deselect + */ +function deselectTabList(tab) { + const parent = tab.parentNode; + const grandparent = parent.parentNode; + + Array.from(parent.children) + .forEach(t => t.setAttribute("aria-selected", false)); + + Array.from(grandparent.children) + .slice(1) // Skip tablist + .forEach(panel => panel.setAttribute("hidden", true)); +} + +/** + * Select grouped tabs with the same name, but no the tab + * with the given id. + * @param {Node} name name of grouped tab to be selected + * @param {Node} clickedId id of clicked tab + */ +function selectNamedTabs(name, clickedId=null) { + const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`); + const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode); + + tabLists + .forEach(tabList => { + // Don't want to change the tabList containing the clicked tab + const clickedTab = tabList.querySelector(`[id="${clickedId}"]`); + if (clickedTab === null ) { + // Select first tab with matching name + const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`); + deselectTabList(tab); + selectTab(tab); + } + }) +} + +if (typeof exports === 'undefined') { + exports = {}; +} + +exports.keyTabs = keyTabs; +exports.changeTabs = changeTabs; +exports.selectTab = selectTab; +exports.deselectTabList = deselectTabList; +exports.selectNamedTabs = selectNamedTabs; diff --git a/branch/sphinx-book-theme-old-copybutton/_static/togglebutton.css b/branch/sphinx-book-theme-old-copybutton/_static/togglebutton.css new file mode 100644 index 00000000..54a67879 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/togglebutton.css @@ -0,0 +1,160 @@ +/** + * Admonition-based toggles + */ + +/* Visibility of the target */ +.admonition.toggle .admonition-title ~ * { + transition: opacity .3s, height .3s; +} + +/* Toggle buttons inside admonitions so we see the title */ +.admonition.toggle { + position: relative; +} + +/* Titles should cut off earlier to avoid overlapping w/ button */ +.admonition.toggle .admonition-title { + padding-right: 25%; + cursor: pointer; +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:hover { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 1%); +} + +/* Hovering will cause a slight shift in color to make it feel interactive */ +.admonition.toggle .admonition-title:active { + box-shadow: inset 0 0 0px 20px rgb(0 0 0 / 3%); +} + +/* Remove extra whitespace below the admonition title when hidden */ +.admonition.toggle-hidden { + padding-bottom: 0; +} + +.admonition.toggle-hidden .admonition-title { + margin-bottom: 0; +} + +/* hides all the content of a page until de-toggled */ +.admonition.toggle-hidden .admonition-title ~ * { + height: 0; + margin: 0; + opacity: 0; + visibility: hidden; +} + +/* General button style and position*/ +button.toggle-button { + /** + * Background and shape. By default there's no background + * but users can style as they wish + */ + background: none; + border: none; + outline: none; + + /* Positioning just inside the admonition title */ + position: absolute; + right: 0.5em; + padding: 0px; + border: none; + outline: none; +} + +/* Display the toggle hint on wide screens */ +@media (min-width: 768px) { + button.toggle-button.toggle-button-hidden:before { + content: attr(data-toggle-hint); /* This will be filled in by JS */ + font-size: .8em; + align-self: center; + } +} + +/* Icon behavior */ +.tb-icon { + transition: transform .2s ease-out; + height: 1.5em; + width: 1.5em; + stroke: currentColor; /* So that we inherit the color of other text */ +} + +/* The icon should point right when closed, down when open. */ +/* Open */ +.admonition.toggle button .tb-icon { + transform: rotate(90deg); +} + +/* Closed */ +.admonition.toggle button.toggle-button-hidden .tb-icon { + transform: rotate(0deg); +} + +/* With details toggles, we don't rotate the icon so it points right */ +details.toggle-details .tb-icon { + height: 1.4em; + width: 1.4em; + margin-top: 0.1em; /* To center the button vertically */ +} + + +/** + * Details-based toggles. + * In this case, we wrap elements with `.toggle` in a details block. + */ + +/* Details blocks */ +details.toggle-details { + margin: 1em 0; +} + + +details.toggle-details summary { + display: flex; + align-items: center; + cursor: pointer; + list-style: none; + border-radius: .2em; + border-left: 3px solid #1976d2; + background-color: rgb(204 204 204 / 10%); + padding: 0.2em 0.7em 0.3em 0.5em; /* Less padding on left because the SVG has left margin */ + font-size: 0.9em; +} + +details.toggle-details summary:hover { + background-color: rgb(204 204 204 / 20%); +} + +details.toggle-details summary:active { + background: rgb(204 204 204 / 28%); +} + +.toggle-details__summary-text { + margin-left: 0.2em; +} + +details.toggle-details[open] summary { + margin-bottom: .5em; +} + +details.toggle-details[open] summary .tb-icon { + transform: rotate(90deg); +} + +details.toggle-details[open] summary ~ * { + animation: toggle-fade-in .3s ease-out; +} + +@keyframes toggle-fade-in { + from {opacity: 0%;} + to {opacity: 100%;} +} + +/* Print rules - we hide all toggle button elements at print */ +@media print { + /* Always hide the summary so the button doesn't show up */ + details.toggle-details summary { + display: none; + } +} \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/togglebutton.js b/branch/sphinx-book-theme-old-copybutton/_static/togglebutton.js new file mode 100644 index 00000000..215a7eef --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/togglebutton.js @@ -0,0 +1,187 @@ +/** + * Add Toggle Buttons to elements + */ + +let toggleChevron = ` + + + +`; + +var initToggleItems = () => { + var itemsToToggle = document.querySelectorAll(togglebuttonSelector); + console.log(`[togglebutton]: Adding toggle buttons to ${itemsToToggle.length} items`) + // Add the button to each admonition and hook up a callback to toggle visibility + itemsToToggle.forEach((item, index) => { + if (item.classList.contains("admonition")) { + // If it's an admonition block, then we'll add a button inside + // Generate unique IDs for this item + var toggleID = `toggle-${index}`; + var buttonID = `button-${toggleID}`; + + item.setAttribute('id', toggleID); + if (!item.classList.contains("toggle")){ + item.classList.add("toggle"); + } + // This is the button that will be added to each item to trigger the toggle + var collapseButton = ` + `; + + title = item.querySelector(".admonition-title") + title.insertAdjacentHTML("beforeend", collapseButton); + thisButton = document.getElementById(buttonID); + + // Add click handlers for the button + admonition title (if admonition) + admonitionTitle = document.querySelector(`#${toggleID} > .admonition-title`) + if (admonitionTitle) { + // If an admonition, then make the whole title block clickable + admonitionTitle.addEventListener('click', toggleClickHandler); + admonitionTitle.dataset.target = toggleID + admonitionTitle.dataset.button = buttonID + } else { + // If not an admonition then we'll listen for the button click + thisButton.addEventListener('click', toggleClickHandler); + } + + // Now hide the item for this toggle button unless explicitly noted to show + if (!item.classList.contains("toggle-shown")) { + toggleHidden(thisButton); + } + } else { + // If not an admonition, wrap the block in a
    block + // Define the structure of the details block and insert it as a sibling + var detailsBlock = ` +
    + + ${toggleChevron} + ${toggleHintShow} + +
    `; + item.insertAdjacentHTML("beforebegin", detailsBlock); + + // Now move the toggle-able content inside of the details block + details = item.previousElementSibling + details.appendChild(item) + item.classList.add("toggle-details__container") + + // Set up a click trigger to change the text as needed + details.addEventListener('click', (click) => { + let parent = click.target.parentElement; + if (parent.tagName.toLowerCase() == "details") { + summary = parent.querySelector("summary"); + details = parent; + } else { + summary = parent; + details = parent.parentElement; + } + // Update the inner text for the proper hint + if (details.open) { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintShow; + } else { + summary.querySelector("span.toggle-details__summary-text").innerText = toggleHintHide; + } + + }); + + // If we have a toggle-shown class, open details block should be open + if (item.classList.contains("toggle-shown")) { + details.click(); + } + } + }) +}; + +// This should simply add / remove the collapsed class and change the button text +var toggleHidden = (button) => { + target = button.dataset['target'] + var itemToToggle = document.getElementById(target); + if (itemToToggle.classList.contains("toggle-hidden")) { + itemToToggle.classList.remove("toggle-hidden"); + button.classList.remove("toggle-button-hidden"); + } else { + itemToToggle.classList.add("toggle-hidden"); + button.classList.add("toggle-button-hidden"); + } +} + +var toggleClickHandler = (click) => { + // Be cause the admonition title is clickable and extends to the whole admonition + // We only look for a click event on this title to trigger the toggle. + + if (click.target.classList.contains("admonition-title")) { + button = click.target.querySelector(".toggle-button"); + } else if (click.target.classList.contains("tb-icon")) { + // We've clicked the icon and need to search up one parent for the button + button = click.target.parentElement; + } else if (click.target.tagName == "polyline") { + // We've clicked the SVG elements inside the button, need to up 2 layers + button = click.target.parentElement.parentElement; + } else if (click.target.classList.contains("toggle-button")) { + // We've clicked the button itself and so don't need to do anything + button = click.target; + } else { + console.log(`[togglebutton]: Couldn't find button for ${click.target}`) + } + target = document.getElementById(button.dataset['button']); + toggleHidden(target); +} + +// If we want to blanket-add toggle classes to certain cells +var addToggleToSelector = () => { + const selector = ""; + if (selector.length > 0) { + document.querySelectorAll(selector).forEach((item) => { + item.classList.add("toggle"); + }) + } +} + +// Helper function to run when the DOM is finished +const sphinxToggleRunWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} +sphinxToggleRunWhenDOMLoaded(addToggleToSelector) +sphinxToggleRunWhenDOMLoaded(initToggleItems) + +/** Toggle details blocks to be open when printing */ +if (toggleOpenOnPrint == "true") { + window.addEventListener("beforeprint", () => { + // Open the details + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.dataset["togglestatus"] = el.open; + el.open = true; + }); + + // Open the admonitions + document.querySelectorAll(".admonition.toggle.toggle-hidden").forEach((el) => { + console.log(el); + el.querySelector("button.toggle-button").click(); + el.dataset["toggle_after_print"] = "true"; + }); + }); + window.addEventListener("afterprint", () => { + // Re-close the details that were closed + document.querySelectorAll("details.toggle-details").forEach((el) => { + el.open = el.dataset["togglestatus"] == "true"; + delete el.dataset["togglestatus"]; + }); + + // Re-close the admonition toggle buttons + document.querySelectorAll(".admonition.toggle").forEach((el) => { + if (el.dataset["toggle_after_print"] == "true") { + el.querySelector("button.toggle-button").click(); + delete el.dataset["toggle_after_print"]; + } + }); + }); +} diff --git a/branch/sphinx-book-theme-old-copybutton/_static/underscore-1.13.1.js b/branch/sphinx-book-theme-old-copybutton/_static/underscore-1.13.1.js new file mode 100644 index 00000000..ffd77af9 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/underscore-1.13.1.js @@ -0,0 +1,2042 @@ +(function (global, factory) { + typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : + typeof define === 'function' && define.amd ? define('underscore', factory) : + (global = typeof globalThis !== 'undefined' ? globalThis : global || self, (function () { + var current = global._; + var exports = global._ = factory(); + exports.noConflict = function () { global._ = current; return exports; }; + }())); +}(this, (function () { + // Underscore.js 1.13.1 + // https://underscorejs.org + // (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors + // Underscore may be freely distributed under the MIT license. + + // Current version. + var VERSION = '1.13.1'; + + // Establish the root object, `window` (`self`) in the browser, `global` + // on the server, or `this` in some virtual machines. We use `self` + // instead of `window` for `WebWorker` support. + var root = typeof self == 'object' && self.self === self && self || + typeof global == 'object' && global.global === global && global || + Function('return this')() || + {}; + + // Save bytes in the minified (but not gzipped) version: + var ArrayProto = Array.prototype, ObjProto = Object.prototype; + var SymbolProto = typeof Symbol !== 'undefined' ? Symbol.prototype : null; + + // Create quick reference variables for speed access to core prototypes. + var push = ArrayProto.push, + slice = ArrayProto.slice, + toString = ObjProto.toString, + hasOwnProperty = ObjProto.hasOwnProperty; + + // Modern feature detection. + var supportsArrayBuffer = typeof ArrayBuffer !== 'undefined', + supportsDataView = typeof DataView !== 'undefined'; + + // All **ECMAScript 5+** native function implementations that we hope to use + // are declared here. + var nativeIsArray = Array.isArray, + nativeKeys = Object.keys, + nativeCreate = Object.create, + nativeIsView = supportsArrayBuffer && ArrayBuffer.isView; + + // Create references to these builtin functions because we override them. + var _isNaN = isNaN, + _isFinite = isFinite; + + // Keys in IE < 9 that won't be iterated by `for key in ...` and thus missed. + var hasEnumBug = !{toString: null}.propertyIsEnumerable('toString'); + var nonEnumerableProps = ['valueOf', 'isPrototypeOf', 'toString', + 'propertyIsEnumerable', 'hasOwnProperty', 'toLocaleString']; + + // The largest integer that can be represented exactly. + var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1; + + // Some functions take a variable number of arguments, or a few expected + // arguments at the beginning and then a variable number of values to operate + // on. This helper accumulates all remaining arguments past the function’s + // argument length (or an explicit `startIndex`), into an array that becomes + // the last argument. Similar to ES6’s "rest parameter". + function restArguments(func, startIndex) { + startIndex = startIndex == null ? func.length - 1 : +startIndex; + return function() { + var length = Math.max(arguments.length - startIndex, 0), + rest = Array(length), + index = 0; + for (; index < length; index++) { + rest[index] = arguments[index + startIndex]; + } + switch (startIndex) { + case 0: return func.call(this, rest); + case 1: return func.call(this, arguments[0], rest); + case 2: return func.call(this, arguments[0], arguments[1], rest); + } + var args = Array(startIndex + 1); + for (index = 0; index < startIndex; index++) { + args[index] = arguments[index]; + } + args[startIndex] = rest; + return func.apply(this, args); + }; + } + + // Is a given variable an object? + function isObject(obj) { + var type = typeof obj; + return type === 'function' || type === 'object' && !!obj; + } + + // Is a given value equal to null? + function isNull(obj) { + return obj === null; + } + + // Is a given variable undefined? + function isUndefined(obj) { + return obj === void 0; + } + + // Is a given value a boolean? + function isBoolean(obj) { + return obj === true || obj === false || toString.call(obj) === '[object Boolean]'; + } + + // Is a given value a DOM element? + function isElement(obj) { + return !!(obj && obj.nodeType === 1); + } + + // Internal function for creating a `toString`-based type tester. + function tagTester(name) { + var tag = '[object ' + name + ']'; + return function(obj) { + return toString.call(obj) === tag; + }; + } + + var isString = tagTester('String'); + + var isNumber = tagTester('Number'); + + var isDate = tagTester('Date'); + + var isRegExp = tagTester('RegExp'); + + var isError = tagTester('Error'); + + var isSymbol = tagTester('Symbol'); + + var isArrayBuffer = tagTester('ArrayBuffer'); + + var isFunction = tagTester('Function'); + + // Optimize `isFunction` if appropriate. Work around some `typeof` bugs in old + // v8, IE 11 (#1621), Safari 8 (#1929), and PhantomJS (#2236). + var nodelist = root.document && root.document.childNodes; + if (typeof /./ != 'function' && typeof Int8Array != 'object' && typeof nodelist != 'function') { + isFunction = function(obj) { + return typeof obj == 'function' || false; + }; + } + + var isFunction$1 = isFunction; + + var hasObjectTag = tagTester('Object'); + + // In IE 10 - Edge 13, `DataView` has string tag `'[object Object]'`. + // In IE 11, the most common among them, this problem also applies to + // `Map`, `WeakMap` and `Set`. + var hasStringTagBug = ( + supportsDataView && hasObjectTag(new DataView(new ArrayBuffer(8))) + ), + isIE11 = (typeof Map !== 'undefined' && hasObjectTag(new Map)); + + var isDataView = tagTester('DataView'); + + // In IE 10 - Edge 13, we need a different heuristic + // to determine whether an object is a `DataView`. + function ie10IsDataView(obj) { + return obj != null && isFunction$1(obj.getInt8) && isArrayBuffer(obj.buffer); + } + + var isDataView$1 = (hasStringTagBug ? ie10IsDataView : isDataView); + + // Is a given value an array? + // Delegates to ECMA5's native `Array.isArray`. + var isArray = nativeIsArray || tagTester('Array'); + + // Internal function to check whether `key` is an own property name of `obj`. + function has$1(obj, key) { + return obj != null && hasOwnProperty.call(obj, key); + } + + var isArguments = tagTester('Arguments'); + + // Define a fallback version of the method in browsers (ahem, IE < 9), where + // there isn't any inspectable "Arguments" type. + (function() { + if (!isArguments(arguments)) { + isArguments = function(obj) { + return has$1(obj, 'callee'); + }; + } + }()); + + var isArguments$1 = isArguments; + + // Is a given object a finite number? + function isFinite$1(obj) { + return !isSymbol(obj) && _isFinite(obj) && !isNaN(parseFloat(obj)); + } + + // Is the given value `NaN`? + function isNaN$1(obj) { + return isNumber(obj) && _isNaN(obj); + } + + // Predicate-generating function. Often useful outside of Underscore. + function constant(value) { + return function() { + return value; + }; + } + + // Common internal logic for `isArrayLike` and `isBufferLike`. + function createSizePropertyCheck(getSizeProperty) { + return function(collection) { + var sizeProperty = getSizeProperty(collection); + return typeof sizeProperty == 'number' && sizeProperty >= 0 && sizeProperty <= MAX_ARRAY_INDEX; + } + } + + // Internal helper to generate a function to obtain property `key` from `obj`. + function shallowProperty(key) { + return function(obj) { + return obj == null ? void 0 : obj[key]; + }; + } + + // Internal helper to obtain the `byteLength` property of an object. + var getByteLength = shallowProperty('byteLength'); + + // Internal helper to determine whether we should spend extensive checks against + // `ArrayBuffer` et al. + var isBufferLike = createSizePropertyCheck(getByteLength); + + // Is a given value a typed array? + var typedArrayPattern = /\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/; + function isTypedArray(obj) { + // `ArrayBuffer.isView` is the most future-proof, so use it when available. + // Otherwise, fall back on the above regular expression. + return nativeIsView ? (nativeIsView(obj) && !isDataView$1(obj)) : + isBufferLike(obj) && typedArrayPattern.test(toString.call(obj)); + } + + var isTypedArray$1 = supportsArrayBuffer ? isTypedArray : constant(false); + + // Internal helper to obtain the `length` property of an object. + var getLength = shallowProperty('length'); + + // Internal helper to create a simple lookup structure. + // `collectNonEnumProps` used to depend on `_.contains`, but this led to + // circular imports. `emulatedSet` is a one-off solution that only works for + // arrays of strings. + function emulatedSet(keys) { + var hash = {}; + for (var l = keys.length, i = 0; i < l; ++i) hash[keys[i]] = true; + return { + contains: function(key) { return hash[key]; }, + push: function(key) { + hash[key] = true; + return keys.push(key); + } + }; + } + + // Internal helper. Checks `keys` for the presence of keys in IE < 9 that won't + // be iterated by `for key in ...` and thus missed. Extends `keys` in place if + // needed. + function collectNonEnumProps(obj, keys) { + keys = emulatedSet(keys); + var nonEnumIdx = nonEnumerableProps.length; + var constructor = obj.constructor; + var proto = isFunction$1(constructor) && constructor.prototype || ObjProto; + + // Constructor is a special case. + var prop = 'constructor'; + if (has$1(obj, prop) && !keys.contains(prop)) keys.push(prop); + + while (nonEnumIdx--) { + prop = nonEnumerableProps[nonEnumIdx]; + if (prop in obj && obj[prop] !== proto[prop] && !keys.contains(prop)) { + keys.push(prop); + } + } + } + + // Retrieve the names of an object's own properties. + // Delegates to **ECMAScript 5**'s native `Object.keys`. + function keys(obj) { + if (!isObject(obj)) return []; + if (nativeKeys) return nativeKeys(obj); + var keys = []; + for (var key in obj) if (has$1(obj, key)) keys.push(key); + // Ahem, IE < 9. + if (hasEnumBug) collectNonEnumProps(obj, keys); + return keys; + } + + // Is a given array, string, or object empty? + // An "empty" object has no enumerable own-properties. + function isEmpty(obj) { + if (obj == null) return true; + // Skip the more expensive `toString`-based type checks if `obj` has no + // `.length`. + var length = getLength(obj); + if (typeof length == 'number' && ( + isArray(obj) || isString(obj) || isArguments$1(obj) + )) return length === 0; + return getLength(keys(obj)) === 0; + } + + // Returns whether an object has a given set of `key:value` pairs. + function isMatch(object, attrs) { + var _keys = keys(attrs), length = _keys.length; + if (object == null) return !length; + var obj = Object(object); + for (var i = 0; i < length; i++) { + var key = _keys[i]; + if (attrs[key] !== obj[key] || !(key in obj)) return false; + } + return true; + } + + // If Underscore is called as a function, it returns a wrapped object that can + // be used OO-style. This wrapper holds altered versions of all functions added + // through `_.mixin`. Wrapped objects may be chained. + function _$1(obj) { + if (obj instanceof _$1) return obj; + if (!(this instanceof _$1)) return new _$1(obj); + this._wrapped = obj; + } + + _$1.VERSION = VERSION; + + // Extracts the result from a wrapped and chained object. + _$1.prototype.value = function() { + return this._wrapped; + }; + + // Provide unwrapping proxies for some methods used in engine operations + // such as arithmetic and JSON stringification. + _$1.prototype.valueOf = _$1.prototype.toJSON = _$1.prototype.value; + + _$1.prototype.toString = function() { + return String(this._wrapped); + }; + + // Internal function to wrap or shallow-copy an ArrayBuffer, + // typed array or DataView to a new view, reusing the buffer. + function toBufferView(bufferSource) { + return new Uint8Array( + bufferSource.buffer || bufferSource, + bufferSource.byteOffset || 0, + getByteLength(bufferSource) + ); + } + + // We use this string twice, so give it a name for minification. + var tagDataView = '[object DataView]'; + + // Internal recursive comparison function for `_.isEqual`. + function eq(a, b, aStack, bStack) { + // Identical objects are equal. `0 === -0`, but they aren't identical. + // See the [Harmony `egal` proposal](https://wiki.ecmascript.org/doku.php?id=harmony:egal). + if (a === b) return a !== 0 || 1 / a === 1 / b; + // `null` or `undefined` only equal to itself (strict comparison). + if (a == null || b == null) return false; + // `NaN`s are equivalent, but non-reflexive. + if (a !== a) return b !== b; + // Exhaust primitive checks + var type = typeof a; + if (type !== 'function' && type !== 'object' && typeof b != 'object') return false; + return deepEq(a, b, aStack, bStack); + } + + // Internal recursive comparison function for `_.isEqual`. + function deepEq(a, b, aStack, bStack) { + // Unwrap any wrapped objects. + if (a instanceof _$1) a = a._wrapped; + if (b instanceof _$1) b = b._wrapped; + // Compare `[[Class]]` names. + var className = toString.call(a); + if (className !== toString.call(b)) return false; + // Work around a bug in IE 10 - Edge 13. + if (hasStringTagBug && className == '[object Object]' && isDataView$1(a)) { + if (!isDataView$1(b)) return false; + className = tagDataView; + } + switch (className) { + // These types are compared by value. + case '[object RegExp]': + // RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i') + case '[object String]': + // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is + // equivalent to `new String("5")`. + return '' + a === '' + b; + case '[object Number]': + // `NaN`s are equivalent, but non-reflexive. + // Object(NaN) is equivalent to NaN. + if (+a !== +a) return +b !== +b; + // An `egal` comparison is performed for other numeric values. + return +a === 0 ? 1 / +a === 1 / b : +a === +b; + case '[object Date]': + case '[object Boolean]': + // Coerce dates and booleans to numeric primitive values. Dates are compared by their + // millisecond representations. Note that invalid dates with millisecond representations + // of `NaN` are not equivalent. + return +a === +b; + case '[object Symbol]': + return SymbolProto.valueOf.call(a) === SymbolProto.valueOf.call(b); + case '[object ArrayBuffer]': + case tagDataView: + // Coerce to typed array so we can fall through. + return deepEq(toBufferView(a), toBufferView(b), aStack, bStack); + } + + var areArrays = className === '[object Array]'; + if (!areArrays && isTypedArray$1(a)) { + var byteLength = getByteLength(a); + if (byteLength !== getByteLength(b)) return false; + if (a.buffer === b.buffer && a.byteOffset === b.byteOffset) return true; + areArrays = true; + } + if (!areArrays) { + if (typeof a != 'object' || typeof b != 'object') return false; + + // Objects with different constructors are not equivalent, but `Object`s or `Array`s + // from different frames are. + var aCtor = a.constructor, bCtor = b.constructor; + if (aCtor !== bCtor && !(isFunction$1(aCtor) && aCtor instanceof aCtor && + isFunction$1(bCtor) && bCtor instanceof bCtor) + && ('constructor' in a && 'constructor' in b)) { + return false; + } + } + // Assume equality for cyclic structures. The algorithm for detecting cyclic + // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`. + + // Initializing stack of traversed objects. + // It's done here since we only need them for objects and arrays comparison. + aStack = aStack || []; + bStack = bStack || []; + var length = aStack.length; + while (length--) { + // Linear search. Performance is inversely proportional to the number of + // unique nested structures. + if (aStack[length] === a) return bStack[length] === b; + } + + // Add the first object to the stack of traversed objects. + aStack.push(a); + bStack.push(b); + + // Recursively compare objects and arrays. + if (areArrays) { + // Compare array lengths to determine if a deep comparison is necessary. + length = a.length; + if (length !== b.length) return false; + // Deep compare the contents, ignoring non-numeric properties. + while (length--) { + if (!eq(a[length], b[length], aStack, bStack)) return false; + } + } else { + // Deep compare objects. + var _keys = keys(a), key; + length = _keys.length; + // Ensure that both objects contain the same number of properties before comparing deep equality. + if (keys(b).length !== length) return false; + while (length--) { + // Deep compare each member + key = _keys[length]; + if (!(has$1(b, key) && eq(a[key], b[key], aStack, bStack))) return false; + } + } + // Remove the first object from the stack of traversed objects. + aStack.pop(); + bStack.pop(); + return true; + } + + // Perform a deep comparison to check if two objects are equal. + function isEqual(a, b) { + return eq(a, b); + } + + // Retrieve all the enumerable property names of an object. + function allKeys(obj) { + if (!isObject(obj)) return []; + var keys = []; + for (var key in obj) keys.push(key); + // Ahem, IE < 9. + if (hasEnumBug) collectNonEnumProps(obj, keys); + return keys; + } + + // Since the regular `Object.prototype.toString` type tests don't work for + // some types in IE 11, we use a fingerprinting heuristic instead, based + // on the methods. It's not great, but it's the best we got. + // The fingerprint method lists are defined below. + function ie11fingerprint(methods) { + var length = getLength(methods); + return function(obj) { + if (obj == null) return false; + // `Map`, `WeakMap` and `Set` have no enumerable keys. + var keys = allKeys(obj); + if (getLength(keys)) return false; + for (var i = 0; i < length; i++) { + if (!isFunction$1(obj[methods[i]])) return false; + } + // If we are testing against `WeakMap`, we need to ensure that + // `obj` doesn't have a `forEach` method in order to distinguish + // it from a regular `Map`. + return methods !== weakMapMethods || !isFunction$1(obj[forEachName]); + }; + } + + // In the interest of compact minification, we write + // each string in the fingerprints only once. + var forEachName = 'forEach', + hasName = 'has', + commonInit = ['clear', 'delete'], + mapTail = ['get', hasName, 'set']; + + // `Map`, `WeakMap` and `Set` each have slightly different + // combinations of the above sublists. + var mapMethods = commonInit.concat(forEachName, mapTail), + weakMapMethods = commonInit.concat(mapTail), + setMethods = ['add'].concat(commonInit, forEachName, hasName); + + var isMap = isIE11 ? ie11fingerprint(mapMethods) : tagTester('Map'); + + var isWeakMap = isIE11 ? ie11fingerprint(weakMapMethods) : tagTester('WeakMap'); + + var isSet = isIE11 ? ie11fingerprint(setMethods) : tagTester('Set'); + + var isWeakSet = tagTester('WeakSet'); + + // Retrieve the values of an object's properties. + function values(obj) { + var _keys = keys(obj); + var length = _keys.length; + var values = Array(length); + for (var i = 0; i < length; i++) { + values[i] = obj[_keys[i]]; + } + return values; + } + + // Convert an object into a list of `[key, value]` pairs. + // The opposite of `_.object` with one argument. + function pairs(obj) { + var _keys = keys(obj); + var length = _keys.length; + var pairs = Array(length); + for (var i = 0; i < length; i++) { + pairs[i] = [_keys[i], obj[_keys[i]]]; + } + return pairs; + } + + // Invert the keys and values of an object. The values must be serializable. + function invert(obj) { + var result = {}; + var _keys = keys(obj); + for (var i = 0, length = _keys.length; i < length; i++) { + result[obj[_keys[i]]] = _keys[i]; + } + return result; + } + + // Return a sorted list of the function names available on the object. + function functions(obj) { + var names = []; + for (var key in obj) { + if (isFunction$1(obj[key])) names.push(key); + } + return names.sort(); + } + + // An internal function for creating assigner functions. + function createAssigner(keysFunc, defaults) { + return function(obj) { + var length = arguments.length; + if (defaults) obj = Object(obj); + if (length < 2 || obj == null) return obj; + for (var index = 1; index < length; index++) { + var source = arguments[index], + keys = keysFunc(source), + l = keys.length; + for (var i = 0; i < l; i++) { + var key = keys[i]; + if (!defaults || obj[key] === void 0) obj[key] = source[key]; + } + } + return obj; + }; + } + + // Extend a given object with all the properties in passed-in object(s). + var extend = createAssigner(allKeys); + + // Assigns a given object with all the own properties in the passed-in + // object(s). + // (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) + var extendOwn = createAssigner(keys); + + // Fill in a given object with default properties. + var defaults = createAssigner(allKeys, true); + + // Create a naked function reference for surrogate-prototype-swapping. + function ctor() { + return function(){}; + } + + // An internal function for creating a new object that inherits from another. + function baseCreate(prototype) { + if (!isObject(prototype)) return {}; + if (nativeCreate) return nativeCreate(prototype); + var Ctor = ctor(); + Ctor.prototype = prototype; + var result = new Ctor; + Ctor.prototype = null; + return result; + } + + // Creates an object that inherits from the given prototype object. + // If additional properties are provided then they will be added to the + // created object. + function create(prototype, props) { + var result = baseCreate(prototype); + if (props) extendOwn(result, props); + return result; + } + + // Create a (shallow-cloned) duplicate of an object. + function clone(obj) { + if (!isObject(obj)) return obj; + return isArray(obj) ? obj.slice() : extend({}, obj); + } + + // Invokes `interceptor` with the `obj` and then returns `obj`. + // The primary purpose of this method is to "tap into" a method chain, in + // order to perform operations on intermediate results within the chain. + function tap(obj, interceptor) { + interceptor(obj); + return obj; + } + + // Normalize a (deep) property `path` to array. + // Like `_.iteratee`, this function can be customized. + function toPath$1(path) { + return isArray(path) ? path : [path]; + } + _$1.toPath = toPath$1; + + // Internal wrapper for `_.toPath` to enable minification. + // Similar to `cb` for `_.iteratee`. + function toPath(path) { + return _$1.toPath(path); + } + + // Internal function to obtain a nested property in `obj` along `path`. + function deepGet(obj, path) { + var length = path.length; + for (var i = 0; i < length; i++) { + if (obj == null) return void 0; + obj = obj[path[i]]; + } + return length ? obj : void 0; + } + + // Get the value of the (deep) property on `path` from `object`. + // If any property in `path` does not exist or if the value is + // `undefined`, return `defaultValue` instead. + // The `path` is normalized through `_.toPath`. + function get(object, path, defaultValue) { + var value = deepGet(object, toPath(path)); + return isUndefined(value) ? defaultValue : value; + } + + // Shortcut function for checking if an object has a given property directly on + // itself (in other words, not on a prototype). Unlike the internal `has` + // function, this public version can also traverse nested properties. + function has(obj, path) { + path = toPath(path); + var length = path.length; + for (var i = 0; i < length; i++) { + var key = path[i]; + if (!has$1(obj, key)) return false; + obj = obj[key]; + } + return !!length; + } + + // Keep the identity function around for default iteratees. + function identity(value) { + return value; + } + + // Returns a predicate for checking whether an object has a given set of + // `key:value` pairs. + function matcher(attrs) { + attrs = extendOwn({}, attrs); + return function(obj) { + return isMatch(obj, attrs); + }; + } + + // Creates a function that, when passed an object, will traverse that object’s + // properties down the given `path`, specified as an array of keys or indices. + function property(path) { + path = toPath(path); + return function(obj) { + return deepGet(obj, path); + }; + } + + // Internal function that returns an efficient (for current engines) version + // of the passed-in callback, to be repeatedly applied in other Underscore + // functions. + function optimizeCb(func, context, argCount) { + if (context === void 0) return func; + switch (argCount == null ? 3 : argCount) { + case 1: return function(value) { + return func.call(context, value); + }; + // The 2-argument case is omitted because we’re not using it. + case 3: return function(value, index, collection) { + return func.call(context, value, index, collection); + }; + case 4: return function(accumulator, value, index, collection) { + return func.call(context, accumulator, value, index, collection); + }; + } + return function() { + return func.apply(context, arguments); + }; + } + + // An internal function to generate callbacks that can be applied to each + // element in a collection, returning the desired result — either `_.identity`, + // an arbitrary callback, a property matcher, or a property accessor. + function baseIteratee(value, context, argCount) { + if (value == null) return identity; + if (isFunction$1(value)) return optimizeCb(value, context, argCount); + if (isObject(value) && !isArray(value)) return matcher(value); + return property(value); + } + + // External wrapper for our callback generator. Users may customize + // `_.iteratee` if they want additional predicate/iteratee shorthand styles. + // This abstraction hides the internal-only `argCount` argument. + function iteratee(value, context) { + return baseIteratee(value, context, Infinity); + } + _$1.iteratee = iteratee; + + // The function we call internally to generate a callback. It invokes + // `_.iteratee` if overridden, otherwise `baseIteratee`. + function cb(value, context, argCount) { + if (_$1.iteratee !== iteratee) return _$1.iteratee(value, context); + return baseIteratee(value, context, argCount); + } + + // Returns the results of applying the `iteratee` to each element of `obj`. + // In contrast to `_.map` it returns an object. + function mapObject(obj, iteratee, context) { + iteratee = cb(iteratee, context); + var _keys = keys(obj), + length = _keys.length, + results = {}; + for (var index = 0; index < length; index++) { + var currentKey = _keys[index]; + results[currentKey] = iteratee(obj[currentKey], currentKey, obj); + } + return results; + } + + // Predicate-generating function. Often useful outside of Underscore. + function noop(){} + + // Generates a function for a given object that returns a given property. + function propertyOf(obj) { + if (obj == null) return noop; + return function(path) { + return get(obj, path); + }; + } + + // Run a function **n** times. + function times(n, iteratee, context) { + var accum = Array(Math.max(0, n)); + iteratee = optimizeCb(iteratee, context, 1); + for (var i = 0; i < n; i++) accum[i] = iteratee(i); + return accum; + } + + // Return a random integer between `min` and `max` (inclusive). + function random(min, max) { + if (max == null) { + max = min; + min = 0; + } + return min + Math.floor(Math.random() * (max - min + 1)); + } + + // A (possibly faster) way to get the current timestamp as an integer. + var now = Date.now || function() { + return new Date().getTime(); + }; + + // Internal helper to generate functions for escaping and unescaping strings + // to/from HTML interpolation. + function createEscaper(map) { + var escaper = function(match) { + return map[match]; + }; + // Regexes for identifying a key that needs to be escaped. + var source = '(?:' + keys(map).join('|') + ')'; + var testRegexp = RegExp(source); + var replaceRegexp = RegExp(source, 'g'); + return function(string) { + string = string == null ? '' : '' + string; + return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string; + }; + } + + // Internal list of HTML entities for escaping. + var escapeMap = { + '&': '&', + '<': '<', + '>': '>', + '"': '"', + "'": ''', + '`': '`' + }; + + // Function for escaping strings to HTML interpolation. + var _escape = createEscaper(escapeMap); + + // Internal list of HTML entities for unescaping. + var unescapeMap = invert(escapeMap); + + // Function for unescaping strings from HTML interpolation. + var _unescape = createEscaper(unescapeMap); + + // By default, Underscore uses ERB-style template delimiters. Change the + // following template settings to use alternative delimiters. + var templateSettings = _$1.templateSettings = { + evaluate: /<%([\s\S]+?)%>/g, + interpolate: /<%=([\s\S]+?)%>/g, + escape: /<%-([\s\S]+?)%>/g + }; + + // When customizing `_.templateSettings`, if you don't want to define an + // interpolation, evaluation or escaping regex, we need one that is + // guaranteed not to match. + var noMatch = /(.)^/; + + // Certain characters need to be escaped so that they can be put into a + // string literal. + var escapes = { + "'": "'", + '\\': '\\', + '\r': 'r', + '\n': 'n', + '\u2028': 'u2028', + '\u2029': 'u2029' + }; + + var escapeRegExp = /\\|'|\r|\n|\u2028|\u2029/g; + + function escapeChar(match) { + return '\\' + escapes[match]; + } + + // In order to prevent third-party code injection through + // `_.templateSettings.variable`, we test it against the following regular + // expression. It is intentionally a bit more liberal than just matching valid + // identifiers, but still prevents possible loopholes through defaults or + // destructuring assignment. + var bareIdentifier = /^\s*(\w|\$)+\s*$/; + + // JavaScript micro-templating, similar to John Resig's implementation. + // Underscore templating handles arbitrary delimiters, preserves whitespace, + // and correctly escapes quotes within interpolated code. + // NB: `oldSettings` only exists for backwards compatibility. + function template(text, settings, oldSettings) { + if (!settings && oldSettings) settings = oldSettings; + settings = defaults({}, settings, _$1.templateSettings); + + // Combine delimiters into one regular expression via alternation. + var matcher = RegExp([ + (settings.escape || noMatch).source, + (settings.interpolate || noMatch).source, + (settings.evaluate || noMatch).source + ].join('|') + '|$', 'g'); + + // Compile the template source, escaping string literals appropriately. + var index = 0; + var source = "__p+='"; + text.replace(matcher, function(match, escape, interpolate, evaluate, offset) { + source += text.slice(index, offset).replace(escapeRegExp, escapeChar); + index = offset + match.length; + + if (escape) { + source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'"; + } else if (interpolate) { + source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'"; + } else if (evaluate) { + source += "';\n" + evaluate + "\n__p+='"; + } + + // Adobe VMs need the match returned to produce the correct offset. + return match; + }); + source += "';\n"; + + var argument = settings.variable; + if (argument) { + // Insure against third-party code injection. (CVE-2021-23358) + if (!bareIdentifier.test(argument)) throw new Error( + 'variable is not a bare identifier: ' + argument + ); + } else { + // If a variable is not specified, place data values in local scope. + source = 'with(obj||{}){\n' + source + '}\n'; + argument = 'obj'; + } + + source = "var __t,__p='',__j=Array.prototype.join," + + "print=function(){__p+=__j.call(arguments,'');};\n" + + source + 'return __p;\n'; + + var render; + try { + render = new Function(argument, '_', source); + } catch (e) { + e.source = source; + throw e; + } + + var template = function(data) { + return render.call(this, data, _$1); + }; + + // Provide the compiled source as a convenience for precompilation. + template.source = 'function(' + argument + '){\n' + source + '}'; + + return template; + } + + // Traverses the children of `obj` along `path`. If a child is a function, it + // is invoked with its parent as context. Returns the value of the final + // child, or `fallback` if any child is undefined. + function result(obj, path, fallback) { + path = toPath(path); + var length = path.length; + if (!length) { + return isFunction$1(fallback) ? fallback.call(obj) : fallback; + } + for (var i = 0; i < length; i++) { + var prop = obj == null ? void 0 : obj[path[i]]; + if (prop === void 0) { + prop = fallback; + i = length; // Ensure we don't continue iterating. + } + obj = isFunction$1(prop) ? prop.call(obj) : prop; + } + return obj; + } + + // Generate a unique integer id (unique within the entire client session). + // Useful for temporary DOM ids. + var idCounter = 0; + function uniqueId(prefix) { + var id = ++idCounter + ''; + return prefix ? prefix + id : id; + } + + // Start chaining a wrapped Underscore object. + function chain(obj) { + var instance = _$1(obj); + instance._chain = true; + return instance; + } + + // Internal function to execute `sourceFunc` bound to `context` with optional + // `args`. Determines whether to execute a function as a constructor or as a + // normal function. + function executeBound(sourceFunc, boundFunc, context, callingContext, args) { + if (!(callingContext instanceof boundFunc)) return sourceFunc.apply(context, args); + var self = baseCreate(sourceFunc.prototype); + var result = sourceFunc.apply(self, args); + if (isObject(result)) return result; + return self; + } + + // Partially apply a function by creating a version that has had some of its + // arguments pre-filled, without changing its dynamic `this` context. `_` acts + // as a placeholder by default, allowing any combination of arguments to be + // pre-filled. Set `_.partial.placeholder` for a custom placeholder argument. + var partial = restArguments(function(func, boundArgs) { + var placeholder = partial.placeholder; + var bound = function() { + var position = 0, length = boundArgs.length; + var args = Array(length); + for (var i = 0; i < length; i++) { + args[i] = boundArgs[i] === placeholder ? arguments[position++] : boundArgs[i]; + } + while (position < arguments.length) args.push(arguments[position++]); + return executeBound(func, bound, this, this, args); + }; + return bound; + }); + + partial.placeholder = _$1; + + // Create a function bound to a given object (assigning `this`, and arguments, + // optionally). + var bind = restArguments(function(func, context, args) { + if (!isFunction$1(func)) throw new TypeError('Bind must be called on a function'); + var bound = restArguments(function(callArgs) { + return executeBound(func, bound, context, this, args.concat(callArgs)); + }); + return bound; + }); + + // Internal helper for collection methods to determine whether a collection + // should be iterated as an array or as an object. + // Related: https://people.mozilla.org/~jorendorff/es6-draft.html#sec-tolength + // Avoids a very nasty iOS 8 JIT bug on ARM-64. #2094 + var isArrayLike = createSizePropertyCheck(getLength); + + // Internal implementation of a recursive `flatten` function. + function flatten$1(input, depth, strict, output) { + output = output || []; + if (!depth && depth !== 0) { + depth = Infinity; + } else if (depth <= 0) { + return output.concat(input); + } + var idx = output.length; + for (var i = 0, length = getLength(input); i < length; i++) { + var value = input[i]; + if (isArrayLike(value) && (isArray(value) || isArguments$1(value))) { + // Flatten current level of array or arguments object. + if (depth > 1) { + flatten$1(value, depth - 1, strict, output); + idx = output.length; + } else { + var j = 0, len = value.length; + while (j < len) output[idx++] = value[j++]; + } + } else if (!strict) { + output[idx++] = value; + } + } + return output; + } + + // Bind a number of an object's methods to that object. Remaining arguments + // are the method names to be bound. Useful for ensuring that all callbacks + // defined on an object belong to it. + var bindAll = restArguments(function(obj, keys) { + keys = flatten$1(keys, false, false); + var index = keys.length; + if (index < 1) throw new Error('bindAll must be passed function names'); + while (index--) { + var key = keys[index]; + obj[key] = bind(obj[key], obj); + } + return obj; + }); + + // Memoize an expensive function by storing its results. + function memoize(func, hasher) { + var memoize = function(key) { + var cache = memoize.cache; + var address = '' + (hasher ? hasher.apply(this, arguments) : key); + if (!has$1(cache, address)) cache[address] = func.apply(this, arguments); + return cache[address]; + }; + memoize.cache = {}; + return memoize; + } + + // Delays a function for the given number of milliseconds, and then calls + // it with the arguments supplied. + var delay = restArguments(function(func, wait, args) { + return setTimeout(function() { + return func.apply(null, args); + }, wait); + }); + + // Defers a function, scheduling it to run after the current call stack has + // cleared. + var defer = partial(delay, _$1, 1); + + // Returns a function, that, when invoked, will only be triggered at most once + // during a given window of time. Normally, the throttled function will run + // as much as it can, without ever going more than once per `wait` duration; + // but if you'd like to disable the execution on the leading edge, pass + // `{leading: false}`. To disable execution on the trailing edge, ditto. + function throttle(func, wait, options) { + var timeout, context, args, result; + var previous = 0; + if (!options) options = {}; + + var later = function() { + previous = options.leading === false ? 0 : now(); + timeout = null; + result = func.apply(context, args); + if (!timeout) context = args = null; + }; + + var throttled = function() { + var _now = now(); + if (!previous && options.leading === false) previous = _now; + var remaining = wait - (_now - previous); + context = this; + args = arguments; + if (remaining <= 0 || remaining > wait) { + if (timeout) { + clearTimeout(timeout); + timeout = null; + } + previous = _now; + result = func.apply(context, args); + if (!timeout) context = args = null; + } else if (!timeout && options.trailing !== false) { + timeout = setTimeout(later, remaining); + } + return result; + }; + + throttled.cancel = function() { + clearTimeout(timeout); + previous = 0; + timeout = context = args = null; + }; + + return throttled; + } + + // When a sequence of calls of the returned function ends, the argument + // function is triggered. The end of a sequence is defined by the `wait` + // parameter. If `immediate` is passed, the argument function will be + // triggered at the beginning of the sequence instead of at the end. + function debounce(func, wait, immediate) { + var timeout, previous, args, result, context; + + var later = function() { + var passed = now() - previous; + if (wait > passed) { + timeout = setTimeout(later, wait - passed); + } else { + timeout = null; + if (!immediate) result = func.apply(context, args); + // This check is needed because `func` can recursively invoke `debounced`. + if (!timeout) args = context = null; + } + }; + + var debounced = restArguments(function(_args) { + context = this; + args = _args; + previous = now(); + if (!timeout) { + timeout = setTimeout(later, wait); + if (immediate) result = func.apply(context, args); + } + return result; + }); + + debounced.cancel = function() { + clearTimeout(timeout); + timeout = args = context = null; + }; + + return debounced; + } + + // Returns the first function passed as an argument to the second, + // allowing you to adjust arguments, run code before and after, and + // conditionally execute the original function. + function wrap(func, wrapper) { + return partial(wrapper, func); + } + + // Returns a negated version of the passed-in predicate. + function negate(predicate) { + return function() { + return !predicate.apply(this, arguments); + }; + } + + // Returns a function that is the composition of a list of functions, each + // consuming the return value of the function that follows. + function compose() { + var args = arguments; + var start = args.length - 1; + return function() { + var i = start; + var result = args[start].apply(this, arguments); + while (i--) result = args[i].call(this, result); + return result; + }; + } + + // Returns a function that will only be executed on and after the Nth call. + function after(times, func) { + return function() { + if (--times < 1) { + return func.apply(this, arguments); + } + }; + } + + // Returns a function that will only be executed up to (but not including) the + // Nth call. + function before(times, func) { + var memo; + return function() { + if (--times > 0) { + memo = func.apply(this, arguments); + } + if (times <= 1) func = null; + return memo; + }; + } + + // Returns a function that will be executed at most one time, no matter how + // often you call it. Useful for lazy initialization. + var once = partial(before, 2); + + // Returns the first key on an object that passes a truth test. + function findKey(obj, predicate, context) { + predicate = cb(predicate, context); + var _keys = keys(obj), key; + for (var i = 0, length = _keys.length; i < length; i++) { + key = _keys[i]; + if (predicate(obj[key], key, obj)) return key; + } + } + + // Internal function to generate `_.findIndex` and `_.findLastIndex`. + function createPredicateIndexFinder(dir) { + return function(array, predicate, context) { + predicate = cb(predicate, context); + var length = getLength(array); + var index = dir > 0 ? 0 : length - 1; + for (; index >= 0 && index < length; index += dir) { + if (predicate(array[index], index, array)) return index; + } + return -1; + }; + } + + // Returns the first index on an array-like that passes a truth test. + var findIndex = createPredicateIndexFinder(1); + + // Returns the last index on an array-like that passes a truth test. + var findLastIndex = createPredicateIndexFinder(-1); + + // Use a comparator function to figure out the smallest index at which + // an object should be inserted so as to maintain order. Uses binary search. + function sortedIndex(array, obj, iteratee, context) { + iteratee = cb(iteratee, context, 1); + var value = iteratee(obj); + var low = 0, high = getLength(array); + while (low < high) { + var mid = Math.floor((low + high) / 2); + if (iteratee(array[mid]) < value) low = mid + 1; else high = mid; + } + return low; + } + + // Internal function to generate the `_.indexOf` and `_.lastIndexOf` functions. + function createIndexFinder(dir, predicateFind, sortedIndex) { + return function(array, item, idx) { + var i = 0, length = getLength(array); + if (typeof idx == 'number') { + if (dir > 0) { + i = idx >= 0 ? idx : Math.max(idx + length, i); + } else { + length = idx >= 0 ? Math.min(idx + 1, length) : idx + length + 1; + } + } else if (sortedIndex && idx && length) { + idx = sortedIndex(array, item); + return array[idx] === item ? idx : -1; + } + if (item !== item) { + idx = predicateFind(slice.call(array, i, length), isNaN$1); + return idx >= 0 ? idx + i : -1; + } + for (idx = dir > 0 ? i : length - 1; idx >= 0 && idx < length; idx += dir) { + if (array[idx] === item) return idx; + } + return -1; + }; + } + + // Return the position of the first occurrence of an item in an array, + // or -1 if the item is not included in the array. + // If the array is large and already in sort order, pass `true` + // for **isSorted** to use binary search. + var indexOf = createIndexFinder(1, findIndex, sortedIndex); + + // Return the position of the last occurrence of an item in an array, + // or -1 if the item is not included in the array. + var lastIndexOf = createIndexFinder(-1, findLastIndex); + + // Return the first value which passes a truth test. + function find(obj, predicate, context) { + var keyFinder = isArrayLike(obj) ? findIndex : findKey; + var key = keyFinder(obj, predicate, context); + if (key !== void 0 && key !== -1) return obj[key]; + } + + // Convenience version of a common use case of `_.find`: getting the first + // object containing specific `key:value` pairs. + function findWhere(obj, attrs) { + return find(obj, matcher(attrs)); + } + + // The cornerstone for collection functions, an `each` + // implementation, aka `forEach`. + // Handles raw objects in addition to array-likes. Treats all + // sparse array-likes as if they were dense. + function each(obj, iteratee, context) { + iteratee = optimizeCb(iteratee, context); + var i, length; + if (isArrayLike(obj)) { + for (i = 0, length = obj.length; i < length; i++) { + iteratee(obj[i], i, obj); + } + } else { + var _keys = keys(obj); + for (i = 0, length = _keys.length; i < length; i++) { + iteratee(obj[_keys[i]], _keys[i], obj); + } + } + return obj; + } + + // Return the results of applying the iteratee to each element. + function map(obj, iteratee, context) { + iteratee = cb(iteratee, context); + var _keys = !isArrayLike(obj) && keys(obj), + length = (_keys || obj).length, + results = Array(length); + for (var index = 0; index < length; index++) { + var currentKey = _keys ? _keys[index] : index; + results[index] = iteratee(obj[currentKey], currentKey, obj); + } + return results; + } + + // Internal helper to create a reducing function, iterating left or right. + function createReduce(dir) { + // Wrap code that reassigns argument variables in a separate function than + // the one that accesses `arguments.length` to avoid a perf hit. (#1991) + var reducer = function(obj, iteratee, memo, initial) { + var _keys = !isArrayLike(obj) && keys(obj), + length = (_keys || obj).length, + index = dir > 0 ? 0 : length - 1; + if (!initial) { + memo = obj[_keys ? _keys[index] : index]; + index += dir; + } + for (; index >= 0 && index < length; index += dir) { + var currentKey = _keys ? _keys[index] : index; + memo = iteratee(memo, obj[currentKey], currentKey, obj); + } + return memo; + }; + + return function(obj, iteratee, memo, context) { + var initial = arguments.length >= 3; + return reducer(obj, optimizeCb(iteratee, context, 4), memo, initial); + }; + } + + // **Reduce** builds up a single result from a list of values, aka `inject`, + // or `foldl`. + var reduce = createReduce(1); + + // The right-associative version of reduce, also known as `foldr`. + var reduceRight = createReduce(-1); + + // Return all the elements that pass a truth test. + function filter(obj, predicate, context) { + var results = []; + predicate = cb(predicate, context); + each(obj, function(value, index, list) { + if (predicate(value, index, list)) results.push(value); + }); + return results; + } + + // Return all the elements for which a truth test fails. + function reject(obj, predicate, context) { + return filter(obj, negate(cb(predicate)), context); + } + + // Determine whether all of the elements pass a truth test. + function every(obj, predicate, context) { + predicate = cb(predicate, context); + var _keys = !isArrayLike(obj) && keys(obj), + length = (_keys || obj).length; + for (var index = 0; index < length; index++) { + var currentKey = _keys ? _keys[index] : index; + if (!predicate(obj[currentKey], currentKey, obj)) return false; + } + return true; + } + + // Determine if at least one element in the object passes a truth test. + function some(obj, predicate, context) { + predicate = cb(predicate, context); + var _keys = !isArrayLike(obj) && keys(obj), + length = (_keys || obj).length; + for (var index = 0; index < length; index++) { + var currentKey = _keys ? _keys[index] : index; + if (predicate(obj[currentKey], currentKey, obj)) return true; + } + return false; + } + + // Determine if the array or object contains a given item (using `===`). + function contains(obj, item, fromIndex, guard) { + if (!isArrayLike(obj)) obj = values(obj); + if (typeof fromIndex != 'number' || guard) fromIndex = 0; + return indexOf(obj, item, fromIndex) >= 0; + } + + // Invoke a method (with arguments) on every item in a collection. + var invoke = restArguments(function(obj, path, args) { + var contextPath, func; + if (isFunction$1(path)) { + func = path; + } else { + path = toPath(path); + contextPath = path.slice(0, -1); + path = path[path.length - 1]; + } + return map(obj, function(context) { + var method = func; + if (!method) { + if (contextPath && contextPath.length) { + context = deepGet(context, contextPath); + } + if (context == null) return void 0; + method = context[path]; + } + return method == null ? method : method.apply(context, args); + }); + }); + + // Convenience version of a common use case of `_.map`: fetching a property. + function pluck(obj, key) { + return map(obj, property(key)); + } + + // Convenience version of a common use case of `_.filter`: selecting only + // objects containing specific `key:value` pairs. + function where(obj, attrs) { + return filter(obj, matcher(attrs)); + } + + // Return the maximum element (or element-based computation). + function max(obj, iteratee, context) { + var result = -Infinity, lastComputed = -Infinity, + value, computed; + if (iteratee == null || typeof iteratee == 'number' && typeof obj[0] != 'object' && obj != null) { + obj = isArrayLike(obj) ? obj : values(obj); + for (var i = 0, length = obj.length; i < length; i++) { + value = obj[i]; + if (value != null && value > result) { + result = value; + } + } + } else { + iteratee = cb(iteratee, context); + each(obj, function(v, index, list) { + computed = iteratee(v, index, list); + if (computed > lastComputed || computed === -Infinity && result === -Infinity) { + result = v; + lastComputed = computed; + } + }); + } + return result; + } + + // Return the minimum element (or element-based computation). + function min(obj, iteratee, context) { + var result = Infinity, lastComputed = Infinity, + value, computed; + if (iteratee == null || typeof iteratee == 'number' && typeof obj[0] != 'object' && obj != null) { + obj = isArrayLike(obj) ? obj : values(obj); + for (var i = 0, length = obj.length; i < length; i++) { + value = obj[i]; + if (value != null && value < result) { + result = value; + } + } + } else { + iteratee = cb(iteratee, context); + each(obj, function(v, index, list) { + computed = iteratee(v, index, list); + if (computed < lastComputed || computed === Infinity && result === Infinity) { + result = v; + lastComputed = computed; + } + }); + } + return result; + } + + // Sample **n** random values from a collection using the modern version of the + // [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher–Yates_shuffle). + // If **n** is not specified, returns a single random element. + // The internal `guard` argument allows it to work with `_.map`. + function sample(obj, n, guard) { + if (n == null || guard) { + if (!isArrayLike(obj)) obj = values(obj); + return obj[random(obj.length - 1)]; + } + var sample = isArrayLike(obj) ? clone(obj) : values(obj); + var length = getLength(sample); + n = Math.max(Math.min(n, length), 0); + var last = length - 1; + for (var index = 0; index < n; index++) { + var rand = random(index, last); + var temp = sample[index]; + sample[index] = sample[rand]; + sample[rand] = temp; + } + return sample.slice(0, n); + } + + // Shuffle a collection. + function shuffle(obj) { + return sample(obj, Infinity); + } + + // Sort the object's values by a criterion produced by an iteratee. + function sortBy(obj, iteratee, context) { + var index = 0; + iteratee = cb(iteratee, context); + return pluck(map(obj, function(value, key, list) { + return { + value: value, + index: index++, + criteria: iteratee(value, key, list) + }; + }).sort(function(left, right) { + var a = left.criteria; + var b = right.criteria; + if (a !== b) { + if (a > b || a === void 0) return 1; + if (a < b || b === void 0) return -1; + } + return left.index - right.index; + }), 'value'); + } + + // An internal function used for aggregate "group by" operations. + function group(behavior, partition) { + return function(obj, iteratee, context) { + var result = partition ? [[], []] : {}; + iteratee = cb(iteratee, context); + each(obj, function(value, index) { + var key = iteratee(value, index, obj); + behavior(result, value, key); + }); + return result; + }; + } + + // Groups the object's values by a criterion. Pass either a string attribute + // to group by, or a function that returns the criterion. + var groupBy = group(function(result, value, key) { + if (has$1(result, key)) result[key].push(value); else result[key] = [value]; + }); + + // Indexes the object's values by a criterion, similar to `_.groupBy`, but for + // when you know that your index values will be unique. + var indexBy = group(function(result, value, key) { + result[key] = value; + }); + + // Counts instances of an object that group by a certain criterion. Pass + // either a string attribute to count by, or a function that returns the + // criterion. + var countBy = group(function(result, value, key) { + if (has$1(result, key)) result[key]++; else result[key] = 1; + }); + + // Split a collection into two arrays: one whose elements all pass the given + // truth test, and one whose elements all do not pass the truth test. + var partition = group(function(result, value, pass) { + result[pass ? 0 : 1].push(value); + }, true); + + // Safely create a real, live array from anything iterable. + var reStrSymbol = /[^\ud800-\udfff]|[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]/g; + function toArray(obj) { + if (!obj) return []; + if (isArray(obj)) return slice.call(obj); + if (isString(obj)) { + // Keep surrogate pair characters together. + return obj.match(reStrSymbol); + } + if (isArrayLike(obj)) return map(obj, identity); + return values(obj); + } + + // Return the number of elements in a collection. + function size(obj) { + if (obj == null) return 0; + return isArrayLike(obj) ? obj.length : keys(obj).length; + } + + // Internal `_.pick` helper function to determine whether `key` is an enumerable + // property name of `obj`. + function keyInObj(value, key, obj) { + return key in obj; + } + + // Return a copy of the object only containing the allowed properties. + var pick = restArguments(function(obj, keys) { + var result = {}, iteratee = keys[0]; + if (obj == null) return result; + if (isFunction$1(iteratee)) { + if (keys.length > 1) iteratee = optimizeCb(iteratee, keys[1]); + keys = allKeys(obj); + } else { + iteratee = keyInObj; + keys = flatten$1(keys, false, false); + obj = Object(obj); + } + for (var i = 0, length = keys.length; i < length; i++) { + var key = keys[i]; + var value = obj[key]; + if (iteratee(value, key, obj)) result[key] = value; + } + return result; + }); + + // Return a copy of the object without the disallowed properties. + var omit = restArguments(function(obj, keys) { + var iteratee = keys[0], context; + if (isFunction$1(iteratee)) { + iteratee = negate(iteratee); + if (keys.length > 1) context = keys[1]; + } else { + keys = map(flatten$1(keys, false, false), String); + iteratee = function(value, key) { + return !contains(keys, key); + }; + } + return pick(obj, iteratee, context); + }); + + // Returns everything but the last entry of the array. Especially useful on + // the arguments object. Passing **n** will return all the values in + // the array, excluding the last N. + function initial(array, n, guard) { + return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n))); + } + + // Get the first element of an array. Passing **n** will return the first N + // values in the array. The **guard** check allows it to work with `_.map`. + function first(array, n, guard) { + if (array == null || array.length < 1) return n == null || guard ? void 0 : []; + if (n == null || guard) return array[0]; + return initial(array, array.length - n); + } + + // Returns everything but the first entry of the `array`. Especially useful on + // the `arguments` object. Passing an **n** will return the rest N values in the + // `array`. + function rest(array, n, guard) { + return slice.call(array, n == null || guard ? 1 : n); + } + + // Get the last element of an array. Passing **n** will return the last N + // values in the array. + function last(array, n, guard) { + if (array == null || array.length < 1) return n == null || guard ? void 0 : []; + if (n == null || guard) return array[array.length - 1]; + return rest(array, Math.max(0, array.length - n)); + } + + // Trim out all falsy values from an array. + function compact(array) { + return filter(array, Boolean); + } + + // Flatten out an array, either recursively (by default), or up to `depth`. + // Passing `true` or `false` as `depth` means `1` or `Infinity`, respectively. + function flatten(array, depth) { + return flatten$1(array, depth, false); + } + + // Take the difference between one array and a number of other arrays. + // Only the elements present in just the first array will remain. + var difference = restArguments(function(array, rest) { + rest = flatten$1(rest, true, true); + return filter(array, function(value){ + return !contains(rest, value); + }); + }); + + // Return a version of the array that does not contain the specified value(s). + var without = restArguments(function(array, otherArrays) { + return difference(array, otherArrays); + }); + + // Produce a duplicate-free version of the array. If the array has already + // been sorted, you have the option of using a faster algorithm. + // The faster algorithm will not work with an iteratee if the iteratee + // is not a one-to-one function, so providing an iteratee will disable + // the faster algorithm. + function uniq(array, isSorted, iteratee, context) { + if (!isBoolean(isSorted)) { + context = iteratee; + iteratee = isSorted; + isSorted = false; + } + if (iteratee != null) iteratee = cb(iteratee, context); + var result = []; + var seen = []; + for (var i = 0, length = getLength(array); i < length; i++) { + var value = array[i], + computed = iteratee ? iteratee(value, i, array) : value; + if (isSorted && !iteratee) { + if (!i || seen !== computed) result.push(value); + seen = computed; + } else if (iteratee) { + if (!contains(seen, computed)) { + seen.push(computed); + result.push(value); + } + } else if (!contains(result, value)) { + result.push(value); + } + } + return result; + } + + // Produce an array that contains the union: each distinct element from all of + // the passed-in arrays. + var union = restArguments(function(arrays) { + return uniq(flatten$1(arrays, true, true)); + }); + + // Produce an array that contains every item shared between all the + // passed-in arrays. + function intersection(array) { + var result = []; + var argsLength = arguments.length; + for (var i = 0, length = getLength(array); i < length; i++) { + var item = array[i]; + if (contains(result, item)) continue; + var j; + for (j = 1; j < argsLength; j++) { + if (!contains(arguments[j], item)) break; + } + if (j === argsLength) result.push(item); + } + return result; + } + + // Complement of zip. Unzip accepts an array of arrays and groups + // each array's elements on shared indices. + function unzip(array) { + var length = array && max(array, getLength).length || 0; + var result = Array(length); + + for (var index = 0; index < length; index++) { + result[index] = pluck(array, index); + } + return result; + } + + // Zip together multiple lists into a single array -- elements that share + // an index go together. + var zip = restArguments(unzip); + + // Converts lists into objects. Pass either a single array of `[key, value]` + // pairs, or two parallel arrays of the same length -- one of keys, and one of + // the corresponding values. Passing by pairs is the reverse of `_.pairs`. + function object(list, values) { + var result = {}; + for (var i = 0, length = getLength(list); i < length; i++) { + if (values) { + result[list[i]] = values[i]; + } else { + result[list[i][0]] = list[i][1]; + } + } + return result; + } + + // Generate an integer Array containing an arithmetic progression. A port of + // the native Python `range()` function. See + // [the Python documentation](https://docs.python.org/library/functions.html#range). + function range(start, stop, step) { + if (stop == null) { + stop = start || 0; + start = 0; + } + if (!step) { + step = stop < start ? -1 : 1; + } + + var length = Math.max(Math.ceil((stop - start) / step), 0); + var range = Array(length); + + for (var idx = 0; idx < length; idx++, start += step) { + range[idx] = start; + } + + return range; + } + + // Chunk a single array into multiple arrays, each containing `count` or fewer + // items. + function chunk(array, count) { + if (count == null || count < 1) return []; + var result = []; + var i = 0, length = array.length; + while (i < length) { + result.push(slice.call(array, i, i += count)); + } + return result; + } + + // Helper function to continue chaining intermediate results. + function chainResult(instance, obj) { + return instance._chain ? _$1(obj).chain() : obj; + } + + // Add your own custom functions to the Underscore object. + function mixin(obj) { + each(functions(obj), function(name) { + var func = _$1[name] = obj[name]; + _$1.prototype[name] = function() { + var args = [this._wrapped]; + push.apply(args, arguments); + return chainResult(this, func.apply(_$1, args)); + }; + }); + return _$1; + } + + // Add all mutator `Array` functions to the wrapper. + each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) { + var method = ArrayProto[name]; + _$1.prototype[name] = function() { + var obj = this._wrapped; + if (obj != null) { + method.apply(obj, arguments); + if ((name === 'shift' || name === 'splice') && obj.length === 0) { + delete obj[0]; + } + } + return chainResult(this, obj); + }; + }); + + // Add all accessor `Array` functions to the wrapper. + each(['concat', 'join', 'slice'], function(name) { + var method = ArrayProto[name]; + _$1.prototype[name] = function() { + var obj = this._wrapped; + if (obj != null) obj = method.apply(obj, arguments); + return chainResult(this, obj); + }; + }); + + // Named Exports + + var allExports = { + __proto__: null, + VERSION: VERSION, + restArguments: restArguments, + isObject: isObject, + isNull: isNull, + isUndefined: isUndefined, + isBoolean: isBoolean, + isElement: isElement, + isString: isString, + isNumber: isNumber, + isDate: isDate, + isRegExp: isRegExp, + isError: isError, + isSymbol: isSymbol, + isArrayBuffer: isArrayBuffer, + isDataView: isDataView$1, + isArray: isArray, + isFunction: isFunction$1, + isArguments: isArguments$1, + isFinite: isFinite$1, + isNaN: isNaN$1, + isTypedArray: isTypedArray$1, + isEmpty: isEmpty, + isMatch: isMatch, + isEqual: isEqual, + isMap: isMap, + isWeakMap: isWeakMap, + isSet: isSet, + isWeakSet: isWeakSet, + keys: keys, + allKeys: allKeys, + values: values, + pairs: pairs, + invert: invert, + functions: functions, + methods: functions, + extend: extend, + extendOwn: extendOwn, + assign: extendOwn, + defaults: defaults, + create: create, + clone: clone, + tap: tap, + get: get, + has: has, + mapObject: mapObject, + identity: identity, + constant: constant, + noop: noop, + toPath: toPath$1, + property: property, + propertyOf: propertyOf, + matcher: matcher, + matches: matcher, + times: times, + random: random, + now: now, + escape: _escape, + unescape: _unescape, + templateSettings: templateSettings, + template: template, + result: result, + uniqueId: uniqueId, + chain: chain, + iteratee: iteratee, + partial: partial, + bind: bind, + bindAll: bindAll, + memoize: memoize, + delay: delay, + defer: defer, + throttle: throttle, + debounce: debounce, + wrap: wrap, + negate: negate, + compose: compose, + after: after, + before: before, + once: once, + findKey: findKey, + findIndex: findIndex, + findLastIndex: findLastIndex, + sortedIndex: sortedIndex, + indexOf: indexOf, + lastIndexOf: lastIndexOf, + find: find, + detect: find, + findWhere: findWhere, + each: each, + forEach: each, + map: map, + collect: map, + reduce: reduce, + foldl: reduce, + inject: reduce, + reduceRight: reduceRight, + foldr: reduceRight, + filter: filter, + select: filter, + reject: reject, + every: every, + all: every, + some: some, + any: some, + contains: contains, + includes: contains, + include: contains, + invoke: invoke, + pluck: pluck, + where: where, + max: max, + min: min, + shuffle: shuffle, + sample: sample, + sortBy: sortBy, + groupBy: groupBy, + indexBy: indexBy, + countBy: countBy, + partition: partition, + toArray: toArray, + size: size, + pick: pick, + omit: omit, + first: first, + head: first, + take: first, + initial: initial, + last: last, + rest: rest, + tail: rest, + drop: rest, + compact: compact, + flatten: flatten, + without: without, + uniq: uniq, + unique: uniq, + union: union, + intersection: intersection, + difference: difference, + unzip: unzip, + transpose: unzip, + zip: zip, + object: object, + range: range, + chunk: chunk, + mixin: mixin, + 'default': _$1 + }; + + // Default Export + + // Add all of the Underscore functions to the wrapper object. + var _ = mixin(allExports); + // Legacy Node.js API. + _._ = _; + + return _; + +}))); +//# sourceMappingURL=underscore-umd.js.map diff --git a/branch/sphinx-book-theme-old-copybutton/_static/underscore.js b/branch/sphinx-book-theme-old-copybutton/_static/underscore.js new file mode 100644 index 00000000..cf177d42 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/underscore.js @@ -0,0 +1,6 @@ +!function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n="undefined"!=typeof globalThis?globalThis:n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){ +// Underscore.js 1.13.1 +// https://underscorejs.org +// (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors +// Underscore may be freely distributed under the MIT license. +var n="1.13.1",r="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global||Function("return this")()||{},t=Array.prototype,e=Object.prototype,u="undefined"!=typeof Symbol?Symbol.prototype:null,o=t.push,i=t.slice,a=e.toString,f=e.hasOwnProperty,c="undefined"!=typeof ArrayBuffer,l="undefined"!=typeof DataView,s=Array.isArray,p=Object.keys,v=Object.create,h=c&&ArrayBuffer.isView,y=isNaN,d=isFinite,g=!{toString:null}.propertyIsEnumerable("toString"),b=["valueOf","isPrototypeOf","toString","propertyIsEnumerable","hasOwnProperty","toLocaleString"],m=Math.pow(2,53)-1;function j(n,r){return r=null==r?n.length-1:+r,function(){for(var t=Math.max(arguments.length-r,0),e=Array(t),u=0;u=0&&t<=m}}function J(n){return function(r){return null==r?void 0:r[n]}}var G=J("byteLength"),H=K(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:C(!1),Y=J("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e":">",'"':""","'":"'","`":"`"},Cn=Ln($n),Kn=Ln(_n($n)),Jn=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=/^\s*(\w|\$)+\s*$/;var Zn=0;function nr(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var rr=j((function(n,r){var t=rr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a1)ur(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var lr=rr(cr,2);function sr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o0?0:u-1;o>=0&&o0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),$))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a=3;return r(n,Fn(t,u,4),e,o)}}var Ar=wr(1),xr=wr(-1);function Sr(n,r,t){var e=[];return r=qn(r,t),jr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Or(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o=0}var Br=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),_r(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Nr(n,r){return _r(n,Rn(r))}function Ir(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;ao&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Tr(n,r,t){if(null==r||t)return er(n)||(n=jn(n)),n[Wn(n.length-1)];var e=er(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i1&&(e=Fn(e,r[1])),r=an(n)):(e=qr,r=ur(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u1&&(t=r[1])):(r=_r(ur(r,!1,!1),String),e=function(n,t){return!Er(r,t)}),Ur(n,e,t)}));function zr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function Lr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:zr(n,n.length-r)}function $r(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=ur(r,!0,!0),Sr(n,(function(n){return!Er(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);ir?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o,i,a,f=function(){var c=zn()-u;r>c?e=setTimeout(f,r-c):(e=null,t||(i=n.apply(a,o)),e||(o=a=null))},c=j((function(c){return a=this,o=c,u=zn(),e||(e=setTimeout(f,r),t&&(i=n.apply(a,o))),i}));return c.cancel=function(){clearTimeout(e),e=o=a=null},c},wrap:function(n,r){return rr(r,n)},negate:fr,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:cr,once:lr,findKey:sr,findIndex:vr,findLastIndex:hr,sortedIndex:yr,indexOf:gr,lastIndexOf:br,find:mr,detect:mr,findWhere:function(n,r){return mr(n,Dn(r))},each:jr,forEach:jr,map:_r,collect:_r,reduce:Ar,foldl:Ar,inject:Ar,reduceRight:xr,foldr:xr,filter:Sr,select:Sr,reject:function(n,r,t){return Sr(n,fr(qn(r)),t)},every:Or,all:Or,some:Mr,any:Mr,contains:Er,includes:Er,include:Er,invoke:Br,pluck:Nr,where:function(n,r){return Sr(n,Dn(r))},max:Ir,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;ae||void 0===t)return 1;if(tli{position:relative}.fa-li{left:-2em;position:absolute;text-align:center;width:2em;line-height:inherit}.fa-border{border:.08em solid #eee;border-radius:.1em;padding:.2em .25em .15em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.fab.fa-pull-left,.fal.fa-pull-left,.far.fa-pull-left,.fas.fa-pull-left{margin-right:.3em}.fa.fa-pull-right,.fab.fa-pull-right,.fal.fa-pull-right,.far.fa-pull-right,.fas.fa-pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-webkit-transform:scaleY(-1);transform:scaleY(-1)}.fa-flip-both,.fa-flip-horizontal.fa-flip-vertical,.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)"}.fa-flip-both,.fa-flip-horizontal.fa-flip-vertical{-webkit-transform:scale(-1);transform:scale(-1)}:root .fa-flip-both,:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{-webkit-filter:none;filter:none}.fa-stack{display:inline-block;height:2em;line-height:2em;position:relative;vertical-align:middle;width:2.5em}.fa-stack-1x,.fa-stack-2x{left:0;position:absolute;text-align:center;width:100%}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-500px:before{content:"\f26e"}.fa-accessible-icon:before{content:"\f368"}.fa-accusoft:before{content:"\f369"}.fa-acquisitions-incorporated:before{content:"\f6af"}.fa-ad:before{content:"\f641"}.fa-address-book:before{content:"\f2b9"}.fa-address-card:before{content:"\f2bb"}.fa-adjust:before{content:"\f042"}.fa-adn:before{content:"\f170"}.fa-adobe:before{content:"\f778"}.fa-adversal:before{content:"\f36a"}.fa-affiliatetheme:before{content:"\f36b"}.fa-air-freshener:before{content:"\f5d0"}.fa-airbnb:before{content:"\f834"}.fa-algolia:before{content:"\f36c"}.fa-align-center:before{content:"\f037"}.fa-align-justify:before{content:"\f039"}.fa-align-left:before{content:"\f036"}.fa-align-right:before{content:"\f038"}.fa-alipay:before{content:"\f642"}.fa-allergies:before{content:"\f461"}.fa-amazon:before{content:"\f270"}.fa-amazon-pay:before{content:"\f42c"}.fa-ambulance:before{content:"\f0f9"}.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-amilia:before{content:"\f36d"}.fa-anchor:before{content:"\f13d"}.fa-android:before{content:"\f17b"}.fa-angellist:before{content:"\f209"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-down:before{content:"\f107"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angry:before{content:"\f556"}.fa-angrycreative:before{content:"\f36e"}.fa-angular:before{content:"\f420"}.fa-ankh:before{content:"\f644"}.fa-app-store:before{content:"\f36f"}.fa-app-store-ios:before{content:"\f370"}.fa-apper:before{content:"\f371"}.fa-apple:before{content:"\f179"}.fa-apple-alt:before{content:"\f5d1"}.fa-apple-pay:before{content:"\f415"}.fa-archive:before{content:"\f187"}.fa-archway:before{content:"\f557"}.fa-arrow-alt-circle-down:before{content:"\f358"}.fa-arrow-alt-circle-left:before{content:"\f359"}.fa-arrow-alt-circle-right:before{content:"\f35a"}.fa-arrow-alt-circle-up:before{content:"\f35b"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-down:before{content:"\f063"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrows-alt:before{content:"\f0b2"}.fa-arrows-alt-h:before{content:"\f337"}.fa-arrows-alt-v:before{content:"\f338"}.fa-artstation:before{content:"\f77a"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asterisk:before{content:"\f069"}.fa-asymmetrik:before{content:"\f372"}.fa-at:before{content:"\f1fa"}.fa-atlas:before{content:"\f558"}.fa-atlassian:before{content:"\f77b"}.fa-atom:before{content:"\f5d2"}.fa-audible:before{content:"\f373"}.fa-audio-description:before{content:"\f29e"}.fa-autoprefixer:before{content:"\f41c"}.fa-avianex:before{content:"\f374"}.fa-aviato:before{content:"\f421"}.fa-award:before{content:"\f559"}.fa-aws:before{content:"\f375"}.fa-baby:before{content:"\f77c"}.fa-baby-carriage:before{content:"\f77d"}.fa-backspace:before{content:"\f55a"}.fa-backward:before{content:"\f04a"}.fa-bacon:before{content:"\f7e5"}.fa-bahai:before{content:"\f666"}.fa-balance-scale:before{content:"\f24e"}.fa-balance-scale-left:before{content:"\f515"}.fa-balance-scale-right:before{content:"\f516"}.fa-ban:before{content:"\f05e"}.fa-band-aid:before{content:"\f462"}.fa-bandcamp:before{content:"\f2d5"}.fa-barcode:before{content:"\f02a"}.fa-bars:before{content:"\f0c9"}.fa-baseball-ball:before{content:"\f433"}.fa-basketball-ball:before{content:"\f434"}.fa-bath:before{content:"\f2cd"}.fa-battery-empty:before{content:"\f244"}.fa-battery-full:before{content:"\f240"}.fa-battery-half:before{content:"\f242"}.fa-battery-quarter:before{content:"\f243"}.fa-battery-three-quarters:before{content:"\f241"}.fa-battle-net:before{content:"\f835"}.fa-bed:before{content:"\f236"}.fa-beer:before{content:"\f0fc"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-bell:before{content:"\f0f3"}.fa-bell-slash:before{content:"\f1f6"}.fa-bezier-curve:before{content:"\f55b"}.fa-bible:before{content:"\f647"}.fa-bicycle:before{content:"\f206"}.fa-biking:before{content:"\f84a"}.fa-bimobject:before{content:"\f378"}.fa-binoculars:before{content:"\f1e5"}.fa-biohazard:before{content:"\f780"}.fa-birthday-cake:before{content:"\f1fd"}.fa-bitbucket:before{content:"\f171"}.fa-bitcoin:before{content:"\f379"}.fa-bity:before{content:"\f37a"}.fa-black-tie:before{content:"\f27e"}.fa-blackberry:before{content:"\f37b"}.fa-blender:before{content:"\f517"}.fa-blender-phone:before{content:"\f6b6"}.fa-blind:before{content:"\f29d"}.fa-blog:before{content:"\f781"}.fa-blogger:before{content:"\f37c"}.fa-blogger-b:before{content:"\f37d"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-bold:before{content:"\f032"}.fa-bolt:before{content:"\f0e7"}.fa-bomb:before{content:"\f1e2"}.fa-bone:before{content:"\f5d7"}.fa-bong:before{content:"\f55c"}.fa-book:before{content:"\f02d"}.fa-book-dead:before{content:"\f6b7"}.fa-book-medical:before{content:"\f7e6"}.fa-book-open:before{content:"\f518"}.fa-book-reader:before{content:"\f5da"}.fa-bookmark:before{content:"\f02e"}.fa-bootstrap:before{content:"\f836"}.fa-border-all:before{content:"\f84c"}.fa-border-none:before{content:"\f850"}.fa-border-style:before{content:"\f853"}.fa-bowling-ball:before{content:"\f436"}.fa-box:before{content:"\f466"}.fa-box-open:before{content:"\f49e"}.fa-box-tissue:before{content:"\f95b"}.fa-boxes:before{content:"\f468"}.fa-braille:before{content:"\f2a1"}.fa-brain:before{content:"\f5dc"}.fa-bread-slice:before{content:"\f7ec"}.fa-briefcase:before{content:"\f0b1"}.fa-briefcase-medical:before{content:"\f469"}.fa-broadcast-tower:before{content:"\f519"}.fa-broom:before{content:"\f51a"}.fa-brush:before{content:"\f55d"}.fa-btc:before{content:"\f15a"}.fa-buffer:before{content:"\f837"}.fa-bug:before{content:"\f188"}.fa-building:before{content:"\f1ad"}.fa-bullhorn:before{content:"\f0a1"}.fa-bullseye:before{content:"\f140"}.fa-burn:before{content:"\f46a"}.fa-buromobelexperte:before{content:"\f37f"}.fa-bus:before{content:"\f207"}.fa-bus-alt:before{content:"\f55e"}.fa-business-time:before{content:"\f64a"}.fa-buy-n-large:before{content:"\f8a6"}.fa-buysellads:before{content:"\f20d"}.fa-calculator:before{content:"\f1ec"}.fa-calendar:before{content:"\f133"}.fa-calendar-alt:before{content:"\f073"}.fa-calendar-check:before{content:"\f274"}.fa-calendar-day:before{content:"\f783"}.fa-calendar-minus:before{content:"\f272"}.fa-calendar-plus:before{content:"\f271"}.fa-calendar-times:before{content:"\f273"}.fa-calendar-week:before{content:"\f784"}.fa-camera:before{content:"\f030"}.fa-camera-retro:before{content:"\f083"}.fa-campground:before{content:"\f6bb"}.fa-canadian-maple-leaf:before{content:"\f785"}.fa-candy-cane:before{content:"\f786"}.fa-cannabis:before{content:"\f55f"}.fa-capsules:before{content:"\f46b"}.fa-car:before{content:"\f1b9"}.fa-car-alt:before{content:"\f5de"}.fa-car-battery:before{content:"\f5df"}.fa-car-crash:before{content:"\f5e1"}.fa-car-side:before{content:"\f5e4"}.fa-caravan:before{content:"\f8ff"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-caret-square-down:before{content:"\f150"}.fa-caret-square-left:before{content:"\f191"}.fa-caret-square-right:before{content:"\f152"}.fa-caret-square-up:before{content:"\f151"}.fa-caret-up:before{content:"\f0d8"}.fa-carrot:before{content:"\f787"}.fa-cart-arrow-down:before{content:"\f218"}.fa-cart-plus:before{content:"\f217"}.fa-cash-register:before{content:"\f788"}.fa-cat:before{content:"\f6be"}.fa-cc-amazon-pay:before{content:"\f42d"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-apple-pay:before{content:"\f416"}.fa-cc-diners-club:before{content:"\f24c"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-cc-visa:before{content:"\f1f0"}.fa-centercode:before{content:"\f380"}.fa-centos:before{content:"\f789"}.fa-certificate:before{content:"\f0a3"}.fa-chair:before{content:"\f6c0"}.fa-chalkboard:before{content:"\f51b"}.fa-chalkboard-teacher:before{content:"\f51c"}.fa-charging-station:before{content:"\f5e7"}.fa-chart-area:before{content:"\f1fe"}.fa-chart-bar:before{content:"\f080"}.fa-chart-line:before{content:"\f201"}.fa-chart-pie:before{content:"\f200"}.fa-check:before{content:"\f00c"}.fa-check-circle:before{content:"\f058"}.fa-check-double:before{content:"\f560"}.fa-check-square:before{content:"\f14a"}.fa-cheese:before{content:"\f7ef"}.fa-chess:before{content:"\f439"}.fa-chess-bishop:before{content:"\f43a"}.fa-chess-board:before{content:"\f43c"}.fa-chess-king:before{content:"\f43f"}.fa-chess-knight:before{content:"\f441"}.fa-chess-pawn:before{content:"\f443"}.fa-chess-queen:before{content:"\f445"}.fa-chess-rook:before{content:"\f447"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-down:before{content:"\f078"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-chevron-up:before{content:"\f077"}.fa-child:before{content:"\f1ae"}.fa-chrome:before{content:"\f268"}.fa-chromecast:before{content:"\f838"}.fa-church:before{content:"\f51d"}.fa-circle:before{content:"\f111"}.fa-circle-notch:before{content:"\f1ce"}.fa-city:before{content:"\f64f"}.fa-clinic-medical:before{content:"\f7f2"}.fa-clipboard:before{content:"\f328"}.fa-clipboard-check:before{content:"\f46c"}.fa-clipboard-list:before{content:"\f46d"}.fa-clock:before{content:"\f017"}.fa-clone:before{content:"\f24d"}.fa-closed-captioning:before{content:"\f20a"}.fa-cloud:before{content:"\f0c2"}.fa-cloud-download-alt:before{content:"\f381"}.fa-cloud-meatball:before{content:"\f73b"}.fa-cloud-moon:before{content:"\f6c3"}.fa-cloud-moon-rain:before{content:"\f73c"}.fa-cloud-rain:before{content:"\f73d"}.fa-cloud-showers-heavy:before{content:"\f740"}.fa-cloud-sun:before{content:"\f6c4"}.fa-cloud-sun-rain:before{content:"\f743"}.fa-cloud-upload-alt:before{content:"\f382"}.fa-cloudscale:before{content:"\f383"}.fa-cloudsmith:before{content:"\f384"}.fa-cloudversify:before{content:"\f385"}.fa-cocktail:before{content:"\f561"}.fa-code:before{content:"\f121"}.fa-code-branch:before{content:"\f126"}.fa-codepen:before{content:"\f1cb"}.fa-codiepie:before{content:"\f284"}.fa-coffee:before{content:"\f0f4"}.fa-cog:before{content:"\f013"}.fa-cogs:before{content:"\f085"}.fa-coins:before{content:"\f51e"}.fa-columns:before{content:"\f0db"}.fa-comment:before{content:"\f075"}.fa-comment-alt:before{content:"\f27a"}.fa-comment-dollar:before{content:"\f651"}.fa-comment-dots:before{content:"\f4ad"}.fa-comment-medical:before{content:"\f7f5"}.fa-comment-slash:before{content:"\f4b3"}.fa-comments:before{content:"\f086"}.fa-comments-dollar:before{content:"\f653"}.fa-compact-disc:before{content:"\f51f"}.fa-compass:before{content:"\f14e"}.fa-compress:before{content:"\f066"}.fa-compress-alt:before{content:"\f422"}.fa-compress-arrows-alt:before{content:"\f78c"}.fa-concierge-bell:before{content:"\f562"}.fa-confluence:before{content:"\f78d"}.fa-connectdevelop:before{content:"\f20e"}.fa-contao:before{content:"\f26d"}.fa-cookie:before{content:"\f563"}.fa-cookie-bite:before{content:"\f564"}.fa-copy:before{content:"\f0c5"}.fa-copyright:before{content:"\f1f9"}.fa-cotton-bureau:before{content:"\f89e"}.fa-couch:before{content:"\f4b8"}.fa-cpanel:before{content:"\f388"}.fa-creative-commons:before{content:"\f25e"}.fa-creative-commons-by:before{content:"\f4e7"}.fa-creative-commons-nc:before{content:"\f4e8"}.fa-creative-commons-nc-eu:before{content:"\f4e9"}.fa-creative-commons-nc-jp:before{content:"\f4ea"}.fa-creative-commons-nd:before{content:"\f4eb"}.fa-creative-commons-pd:before{content:"\f4ec"}.fa-creative-commons-pd-alt:before{content:"\f4ed"}.fa-creative-commons-remix:before{content:"\f4ee"}.fa-creative-commons-sa:before{content:"\f4ef"}.fa-creative-commons-sampling:before{content:"\f4f0"}.fa-creative-commons-sampling-plus:before{content:"\f4f1"}.fa-creative-commons-share:before{content:"\f4f2"}.fa-creative-commons-zero:before{content:"\f4f3"}.fa-credit-card:before{content:"\f09d"}.fa-critical-role:before{content:"\f6c9"}.fa-crop:before{content:"\f125"}.fa-crop-alt:before{content:"\f565"}.fa-cross:before{content:"\f654"}.fa-crosshairs:before{content:"\f05b"}.fa-crow:before{content:"\f520"}.fa-crown:before{content:"\f521"}.fa-crutch:before{content:"\f7f7"}.fa-css3:before{content:"\f13c"}.fa-css3-alt:before{content:"\f38b"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-cut:before{content:"\f0c4"}.fa-cuttlefish:before{content:"\f38c"}.fa-d-and-d:before{content:"\f38d"}.fa-d-and-d-beyond:before{content:"\f6ca"}.fa-dailymotion:before{content:"\f952"}.fa-dashcube:before{content:"\f210"}.fa-database:before{content:"\f1c0"}.fa-deaf:before{content:"\f2a4"}.fa-delicious:before{content:"\f1a5"}.fa-democrat:before{content:"\f747"}.fa-deploydog:before{content:"\f38e"}.fa-deskpro:before{content:"\f38f"}.fa-desktop:before{content:"\f108"}.fa-dev:before{content:"\f6cc"}.fa-deviantart:before{content:"\f1bd"}.fa-dharmachakra:before{content:"\f655"}.fa-dhl:before{content:"\f790"}.fa-diagnoses:before{content:"\f470"}.fa-diaspora:before{content:"\f791"}.fa-dice:before{content:"\f522"}.fa-dice-d20:before{content:"\f6cf"}.fa-dice-d6:before{content:"\f6d1"}.fa-dice-five:before{content:"\f523"}.fa-dice-four:before{content:"\f524"}.fa-dice-one:before{content:"\f525"}.fa-dice-six:before{content:"\f526"}.fa-dice-three:before{content:"\f527"}.fa-dice-two:before{content:"\f528"}.fa-digg:before{content:"\f1a6"}.fa-digital-ocean:before{content:"\f391"}.fa-digital-tachograph:before{content:"\f566"}.fa-directions:before{content:"\f5eb"}.fa-discord:before{content:"\f392"}.fa-discourse:before{content:"\f393"}.fa-disease:before{content:"\f7fa"}.fa-divide:before{content:"\f529"}.fa-dizzy:before{content:"\f567"}.fa-dna:before{content:"\f471"}.fa-dochub:before{content:"\f394"}.fa-docker:before{content:"\f395"}.fa-dog:before{content:"\f6d3"}.fa-dollar-sign:before{content:"\f155"}.fa-dolly:before{content:"\f472"}.fa-dolly-flatbed:before{content:"\f474"}.fa-donate:before{content:"\f4b9"}.fa-door-closed:before{content:"\f52a"}.fa-door-open:before{content:"\f52b"}.fa-dot-circle:before{content:"\f192"}.fa-dove:before{content:"\f4ba"}.fa-download:before{content:"\f019"}.fa-draft2digital:before{content:"\f396"}.fa-drafting-compass:before{content:"\f568"}.fa-dragon:before{content:"\f6d5"}.fa-draw-polygon:before{content:"\f5ee"}.fa-dribbble:before{content:"\f17d"}.fa-dribbble-square:before{content:"\f397"}.fa-dropbox:before{content:"\f16b"}.fa-drum:before{content:"\f569"}.fa-drum-steelpan:before{content:"\f56a"}.fa-drumstick-bite:before{content:"\f6d7"}.fa-drupal:before{content:"\f1a9"}.fa-dumbbell:before{content:"\f44b"}.fa-dumpster:before{content:"\f793"}.fa-dumpster-fire:before{content:"\f794"}.fa-dungeon:before{content:"\f6d9"}.fa-dyalog:before{content:"\f399"}.fa-earlybirds:before{content:"\f39a"}.fa-ebay:before{content:"\f4f4"}.fa-edge:before{content:"\f282"}.fa-edit:before{content:"\f044"}.fa-egg:before{content:"\f7fb"}.fa-eject:before{content:"\f052"}.fa-elementor:before{content:"\f430"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-ello:before{content:"\f5f1"}.fa-ember:before{content:"\f423"}.fa-empire:before{content:"\f1d1"}.fa-envelope:before{content:"\f0e0"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-text:before{content:"\f658"}.fa-envelope-square:before{content:"\f199"}.fa-envira:before{content:"\f299"}.fa-equals:before{content:"\f52c"}.fa-eraser:before{content:"\f12d"}.fa-erlang:before{content:"\f39d"}.fa-ethereum:before{content:"\f42e"}.fa-ethernet:before{content:"\f796"}.fa-etsy:before{content:"\f2d7"}.fa-euro-sign:before{content:"\f153"}.fa-evernote:before{content:"\f839"}.fa-exchange-alt:before{content:"\f362"}.fa-exclamation:before{content:"\f12a"}.fa-exclamation-circle:before{content:"\f06a"}.fa-exclamation-triangle:before{content:"\f071"}.fa-expand:before{content:"\f065"}.fa-expand-alt:before{content:"\f424"}.fa-expand-arrows-alt:before{content:"\f31e"}.fa-expeditedssl:before{content:"\f23e"}.fa-external-link-alt:before{content:"\f35d"}.fa-external-link-square-alt:before{content:"\f360"}.fa-eye:before{content:"\f06e"}.fa-eye-dropper:before{content:"\f1fb"}.fa-eye-slash:before{content:"\f070"}.fa-facebook:before{content:"\f09a"}.fa-facebook-f:before{content:"\f39e"}.fa-facebook-messenger:before{content:"\f39f"}.fa-facebook-square:before{content:"\f082"}.fa-fan:before{content:"\f863"}.fa-fantasy-flight-games:before{content:"\f6dc"}.fa-fast-backward:before{content:"\f049"}.fa-fast-forward:before{content:"\f050"}.fa-faucet:before{content:"\f905"}.fa-fax:before{content:"\f1ac"}.fa-feather:before{content:"\f52d"}.fa-feather-alt:before{content:"\f56b"}.fa-fedex:before{content:"\f797"}.fa-fedora:before{content:"\f798"}.fa-female:before{content:"\f182"}.fa-fighter-jet:before{content:"\f0fb"}.fa-figma:before{content:"\f799"}.fa-file:before{content:"\f15b"}.fa-file-alt:before{content:"\f15c"}.fa-file-archive:before{content:"\f1c6"}.fa-file-audio:before{content:"\f1c7"}.fa-file-code:before{content:"\f1c9"}.fa-file-contract:before{content:"\f56c"}.fa-file-csv:before{content:"\f6dd"}.fa-file-download:before{content:"\f56d"}.fa-file-excel:before{content:"\f1c3"}.fa-file-export:before{content:"\f56e"}.fa-file-image:before{content:"\f1c5"}.fa-file-import:before{content:"\f56f"}.fa-file-invoice:before{content:"\f570"}.fa-file-invoice-dollar:before{content:"\f571"}.fa-file-medical:before{content:"\f477"}.fa-file-medical-alt:before{content:"\f478"}.fa-file-pdf:before{content:"\f1c1"}.fa-file-powerpoint:before{content:"\f1c4"}.fa-file-prescription:before{content:"\f572"}.fa-file-signature:before{content:"\f573"}.fa-file-upload:before{content:"\f574"}.fa-file-video:before{content:"\f1c8"}.fa-file-word:before{content:"\f1c2"}.fa-fill:before{content:"\f575"}.fa-fill-drip:before{content:"\f576"}.fa-film:before{content:"\f008"}.fa-filter:before{content:"\f0b0"}.fa-fingerprint:before{content:"\f577"}.fa-fire:before{content:"\f06d"}.fa-fire-alt:before{content:"\f7e4"}.fa-fire-extinguisher:before{content:"\f134"}.fa-firefox:before{content:"\f269"}.fa-firefox-browser:before{content:"\f907"}.fa-first-aid:before{content:"\f479"}.fa-first-order:before{content:"\f2b0"}.fa-first-order-alt:before{content:"\f50a"}.fa-firstdraft:before{content:"\f3a1"}.fa-fish:before{content:"\f578"}.fa-fist-raised:before{content:"\f6de"}.fa-flag:before{content:"\f024"}.fa-flag-checkered:before{content:"\f11e"}.fa-flag-usa:before{content:"\f74d"}.fa-flask:before{content:"\f0c3"}.fa-flickr:before{content:"\f16e"}.fa-flipboard:before{content:"\f44d"}.fa-flushed:before{content:"\f579"}.fa-fly:before{content:"\f417"}.fa-folder:before{content:"\f07b"}.fa-folder-minus:before{content:"\f65d"}.fa-folder-open:before{content:"\f07c"}.fa-folder-plus:before{content:"\f65e"}.fa-font:before{content:"\f031"}.fa-font-awesome:before{content:"\f2b4"}.fa-font-awesome-alt:before{content:"\f35c"}.fa-font-awesome-flag:before{content:"\f425"}.fa-font-awesome-logo-full:before{content:"\f4e6"}.fa-fonticons:before{content:"\f280"}.fa-fonticons-fi:before{content:"\f3a2"}.fa-football-ball:before{content:"\f44e"}.fa-fort-awesome:before{content:"\f286"}.fa-fort-awesome-alt:before{content:"\f3a3"}.fa-forumbee:before{content:"\f211"}.fa-forward:before{content:"\f04e"}.fa-foursquare:before{content:"\f180"}.fa-free-code-camp:before{content:"\f2c5"}.fa-freebsd:before{content:"\f3a4"}.fa-frog:before{content:"\f52e"}.fa-frown:before{content:"\f119"}.fa-frown-open:before{content:"\f57a"}.fa-fulcrum:before{content:"\f50b"}.fa-funnel-dollar:before{content:"\f662"}.fa-futbol:before{content:"\f1e3"}.fa-galactic-republic:before{content:"\f50c"}.fa-galactic-senate:before{content:"\f50d"}.fa-gamepad:before{content:"\f11b"}.fa-gas-pump:before{content:"\f52f"}.fa-gavel:before{content:"\f0e3"}.fa-gem:before{content:"\f3a5"}.fa-genderless:before{content:"\f22d"}.fa-get-pocket:before{content:"\f265"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-ghost:before{content:"\f6e2"}.fa-gift:before{content:"\f06b"}.fa-gifts:before{content:"\f79c"}.fa-git:before{content:"\f1d3"}.fa-git-alt:before{content:"\f841"}.fa-git-square:before{content:"\f1d2"}.fa-github:before{content:"\f09b"}.fa-github-alt:before{content:"\f113"}.fa-github-square:before{content:"\f092"}.fa-gitkraken:before{content:"\f3a6"}.fa-gitlab:before{content:"\f296"}.fa-gitter:before{content:"\f426"}.fa-glass-cheers:before{content:"\f79f"}.fa-glass-martini:before{content:"\f000"}.fa-glass-martini-alt:before{content:"\f57b"}.fa-glass-whiskey:before{content:"\f7a0"}.fa-glasses:before{content:"\f530"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-globe:before{content:"\f0ac"}.fa-globe-africa:before{content:"\f57c"}.fa-globe-americas:before{content:"\f57d"}.fa-globe-asia:before{content:"\f57e"}.fa-globe-europe:before{content:"\f7a2"}.fa-gofore:before{content:"\f3a7"}.fa-golf-ball:before{content:"\f450"}.fa-goodreads:before{content:"\f3a8"}.fa-goodreads-g:before{content:"\f3a9"}.fa-google:before{content:"\f1a0"}.fa-google-drive:before{content:"\f3aa"}.fa-google-play:before{content:"\f3ab"}.fa-google-plus:before{content:"\f2b3"}.fa-google-plus-g:before{content:"\f0d5"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-wallet:before{content:"\f1ee"}.fa-gopuram:before{content:"\f664"}.fa-graduation-cap:before{content:"\f19d"}.fa-gratipay:before{content:"\f184"}.fa-grav:before{content:"\f2d6"}.fa-greater-than:before{content:"\f531"}.fa-greater-than-equal:before{content:"\f532"}.fa-grimace:before{content:"\f57f"}.fa-grin:before{content:"\f580"}.fa-grin-alt:before{content:"\f581"}.fa-grin-beam:before{content:"\f582"}.fa-grin-beam-sweat:before{content:"\f583"}.fa-grin-hearts:before{content:"\f584"}.fa-grin-squint:before{content:"\f585"}.fa-grin-squint-tears:before{content:"\f586"}.fa-grin-stars:before{content:"\f587"}.fa-grin-tears:before{content:"\f588"}.fa-grin-tongue:before{content:"\f589"}.fa-grin-tongue-squint:before{content:"\f58a"}.fa-grin-tongue-wink:before{content:"\f58b"}.fa-grin-wink:before{content:"\f58c"}.fa-grip-horizontal:before{content:"\f58d"}.fa-grip-lines:before{content:"\f7a4"}.fa-grip-lines-vertical:before{content:"\f7a5"}.fa-grip-vertical:before{content:"\f58e"}.fa-gripfire:before{content:"\f3ac"}.fa-grunt:before{content:"\f3ad"}.fa-guitar:before{content:"\f7a6"}.fa-gulp:before{content:"\f3ae"}.fa-h-square:before{content:"\f0fd"}.fa-hacker-news:before{content:"\f1d4"}.fa-hacker-news-square:before{content:"\f3af"}.fa-hackerrank:before{content:"\f5f7"}.fa-hamburger:before{content:"\f805"}.fa-hammer:before{content:"\f6e3"}.fa-hamsa:before{content:"\f665"}.fa-hand-holding:before{content:"\f4bd"}.fa-hand-holding-heart:before{content:"\f4be"}.fa-hand-holding-medical:before{content:"\f95c"}.fa-hand-holding-usd:before{content:"\f4c0"}.fa-hand-holding-water:before{content:"\f4c1"}.fa-hand-lizard:before{content:"\f258"}.fa-hand-middle-finger:before{content:"\f806"}.fa-hand-paper:before{content:"\f256"}.fa-hand-peace:before{content:"\f25b"}.fa-hand-point-down:before{content:"\f0a7"}.fa-hand-point-left:before{content:"\f0a5"}.fa-hand-point-right:before{content:"\f0a4"}.fa-hand-point-up:before{content:"\f0a6"}.fa-hand-pointer:before{content:"\f25a"}.fa-hand-rock:before{content:"\f255"}.fa-hand-scissors:before{content:"\f257"}.fa-hand-sparkles:before{content:"\f95d"}.fa-hand-spock:before{content:"\f259"}.fa-hands:before{content:"\f4c2"}.fa-hands-helping:before{content:"\f4c4"}.fa-hands-wash:before{content:"\f95e"}.fa-handshake:before{content:"\f2b5"}.fa-handshake-alt-slash:before{content:"\f95f"}.fa-handshake-slash:before{content:"\f960"}.fa-hanukiah:before{content:"\f6e6"}.fa-hard-hat:before{content:"\f807"}.fa-hashtag:before{content:"\f292"}.fa-hat-cowboy:before{content:"\f8c0"}.fa-hat-cowboy-side:before{content:"\f8c1"}.fa-hat-wizard:before{content:"\f6e8"}.fa-hdd:before{content:"\f0a0"}.fa-head-side-cough:before{content:"\f961"}.fa-head-side-cough-slash:before{content:"\f962"}.fa-head-side-mask:before{content:"\f963"}.fa-head-side-virus:before{content:"\f964"}.fa-heading:before{content:"\f1dc"}.fa-headphones:before{content:"\f025"}.fa-headphones-alt:before{content:"\f58f"}.fa-headset:before{content:"\f590"}.fa-heart:before{content:"\f004"}.fa-heart-broken:before{content:"\f7a9"}.fa-heartbeat:before{content:"\f21e"}.fa-helicopter:before{content:"\f533"}.fa-highlighter:before{content:"\f591"}.fa-hiking:before{content:"\f6ec"}.fa-hippo:before{content:"\f6ed"}.fa-hips:before{content:"\f452"}.fa-hire-a-helper:before{content:"\f3b0"}.fa-history:before{content:"\f1da"}.fa-hockey-puck:before{content:"\f453"}.fa-holly-berry:before{content:"\f7aa"}.fa-home:before{content:"\f015"}.fa-hooli:before{content:"\f427"}.fa-hornbill:before{content:"\f592"}.fa-horse:before{content:"\f6f0"}.fa-horse-head:before{content:"\f7ab"}.fa-hospital:before{content:"\f0f8"}.fa-hospital-alt:before{content:"\f47d"}.fa-hospital-symbol:before{content:"\f47e"}.fa-hospital-user:before{content:"\f80d"}.fa-hot-tub:before{content:"\f593"}.fa-hotdog:before{content:"\f80f"}.fa-hotel:before{content:"\f594"}.fa-hotjar:before{content:"\f3b1"}.fa-hourglass:before{content:"\f254"}.fa-hourglass-end:before{content:"\f253"}.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-start:before{content:"\f251"}.fa-house-damage:before{content:"\f6f1"}.fa-house-user:before{content:"\f965"}.fa-houzz:before{content:"\f27c"}.fa-hryvnia:before{content:"\f6f2"}.fa-html5:before{content:"\f13b"}.fa-hubspot:before{content:"\f3b2"}.fa-i-cursor:before{content:"\f246"}.fa-ice-cream:before{content:"\f810"}.fa-icicles:before{content:"\f7ad"}.fa-icons:before{content:"\f86d"}.fa-id-badge:before{content:"\f2c1"}.fa-id-card:before{content:"\f2c2"}.fa-id-card-alt:before{content:"\f47f"}.fa-ideal:before{content:"\f913"}.fa-igloo:before{content:"\f7ae"}.fa-image:before{content:"\f03e"}.fa-images:before{content:"\f302"}.fa-imdb:before{content:"\f2d8"}.fa-inbox:before{content:"\f01c"}.fa-indent:before{content:"\f03c"}.fa-industry:before{content:"\f275"}.fa-infinity:before{content:"\f534"}.fa-info:before{content:"\f129"}.fa-info-circle:before{content:"\f05a"}.fa-instagram:before{content:"\f16d"}.fa-instagram-square:before{content:"\f955"}.fa-intercom:before{content:"\f7af"}.fa-internet-explorer:before{content:"\f26b"}.fa-invision:before{content:"\f7b0"}.fa-ioxhost:before{content:"\f208"}.fa-italic:before{content:"\f033"}.fa-itch-io:before{content:"\f83a"}.fa-itunes:before{content:"\f3b4"}.fa-itunes-note:before{content:"\f3b5"}.fa-java:before{content:"\f4e4"}.fa-jedi:before{content:"\f669"}.fa-jedi-order:before{content:"\f50e"}.fa-jenkins:before{content:"\f3b6"}.fa-jira:before{content:"\f7b1"}.fa-joget:before{content:"\f3b7"}.fa-joint:before{content:"\f595"}.fa-joomla:before{content:"\f1aa"}.fa-journal-whills:before{content:"\f66a"}.fa-js:before{content:"\f3b8"}.fa-js-square:before{content:"\f3b9"}.fa-jsfiddle:before{content:"\f1cc"}.fa-kaaba:before{content:"\f66b"}.fa-kaggle:before{content:"\f5fa"}.fa-key:before{content:"\f084"}.fa-keybase:before{content:"\f4f5"}.fa-keyboard:before{content:"\f11c"}.fa-keycdn:before{content:"\f3ba"}.fa-khanda:before{content:"\f66d"}.fa-kickstarter:before{content:"\f3bb"}.fa-kickstarter-k:before{content:"\f3bc"}.fa-kiss:before{content:"\f596"}.fa-kiss-beam:before{content:"\f597"}.fa-kiss-wink-heart:before{content:"\f598"}.fa-kiwi-bird:before{content:"\f535"}.fa-korvue:before{content:"\f42f"}.fa-landmark:before{content:"\f66f"}.fa-language:before{content:"\f1ab"}.fa-laptop:before{content:"\f109"}.fa-laptop-code:before{content:"\f5fc"}.fa-laptop-house:before{content:"\f966"}.fa-laptop-medical:before{content:"\f812"}.fa-laravel:before{content:"\f3bd"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-laugh:before{content:"\f599"}.fa-laugh-beam:before{content:"\f59a"}.fa-laugh-squint:before{content:"\f59b"}.fa-laugh-wink:before{content:"\f59c"}.fa-layer-group:before{content:"\f5fd"}.fa-leaf:before{content:"\f06c"}.fa-leanpub:before{content:"\f212"}.fa-lemon:before{content:"\f094"}.fa-less:before{content:"\f41d"}.fa-less-than:before{content:"\f536"}.fa-less-than-equal:before{content:"\f537"}.fa-level-down-alt:before{content:"\f3be"}.fa-level-up-alt:before{content:"\f3bf"}.fa-life-ring:before{content:"\f1cd"}.fa-lightbulb:before{content:"\f0eb"}.fa-line:before{content:"\f3c0"}.fa-link:before{content:"\f0c1"}.fa-linkedin:before{content:"\f08c"}.fa-linkedin-in:before{content:"\f0e1"}.fa-linode:before{content:"\f2b8"}.fa-linux:before{content:"\f17c"}.fa-lira-sign:before{content:"\f195"}.fa-list:before{content:"\f03a"}.fa-list-alt:before{content:"\f022"}.fa-list-ol:before{content:"\f0cb"}.fa-list-ul:before{content:"\f0ca"}.fa-location-arrow:before{content:"\f124"}.fa-lock:before{content:"\f023"}.fa-lock-open:before{content:"\f3c1"}.fa-long-arrow-alt-down:before{content:"\f309"}.fa-long-arrow-alt-left:before{content:"\f30a"}.fa-long-arrow-alt-right:before{content:"\f30b"}.fa-long-arrow-alt-up:before{content:"\f30c"}.fa-low-vision:before{content:"\f2a8"}.fa-luggage-cart:before{content:"\f59d"}.fa-lungs:before{content:"\f604"}.fa-lungs-virus:before{content:"\f967"}.fa-lyft:before{content:"\f3c3"}.fa-magento:before{content:"\f3c4"}.fa-magic:before{content:"\f0d0"}.fa-magnet:before{content:"\f076"}.fa-mail-bulk:before{content:"\f674"}.fa-mailchimp:before{content:"\f59e"}.fa-male:before{content:"\f183"}.fa-mandalorian:before{content:"\f50f"}.fa-map:before{content:"\f279"}.fa-map-marked:before{content:"\f59f"}.fa-map-marked-alt:before{content:"\f5a0"}.fa-map-marker:before{content:"\f041"}.fa-map-marker-alt:before{content:"\f3c5"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-markdown:before{content:"\f60f"}.fa-marker:before{content:"\f5a1"}.fa-mars:before{content:"\f222"}.fa-mars-double:before{content:"\f227"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mask:before{content:"\f6fa"}.fa-mastodon:before{content:"\f4f6"}.fa-maxcdn:before{content:"\f136"}.fa-mdb:before{content:"\f8ca"}.fa-medal:before{content:"\f5a2"}.fa-medapps:before{content:"\f3c6"}.fa-medium:before{content:"\f23a"}.fa-medium-m:before{content:"\f3c7"}.fa-medkit:before{content:"\f0fa"}.fa-medrt:before{content:"\f3c8"}.fa-meetup:before{content:"\f2e0"}.fa-megaport:before{content:"\f5a3"}.fa-meh:before{content:"\f11a"}.fa-meh-blank:before{content:"\f5a4"}.fa-meh-rolling-eyes:before{content:"\f5a5"}.fa-memory:before{content:"\f538"}.fa-mendeley:before{content:"\f7b3"}.fa-menorah:before{content:"\f676"}.fa-mercury:before{content:"\f223"}.fa-meteor:before{content:"\f753"}.fa-microblog:before{content:"\f91a"}.fa-microchip:before{content:"\f2db"}.fa-microphone:before{content:"\f130"}.fa-microphone-alt:before{content:"\f3c9"}.fa-microphone-alt-slash:before{content:"\f539"}.fa-microphone-slash:before{content:"\f131"}.fa-microscope:before{content:"\f610"}.fa-microsoft:before{content:"\f3ca"}.fa-minus:before{content:"\f068"}.fa-minus-circle:before{content:"\f056"}.fa-minus-square:before{content:"\f146"}.fa-mitten:before{content:"\f7b5"}.fa-mix:before{content:"\f3cb"}.fa-mixcloud:before{content:"\f289"}.fa-mixer:before{content:"\f956"}.fa-mizuni:before{content:"\f3cc"}.fa-mobile:before{content:"\f10b"}.fa-mobile-alt:before{content:"\f3cd"}.fa-modx:before{content:"\f285"}.fa-monero:before{content:"\f3d0"}.fa-money-bill:before{content:"\f0d6"}.fa-money-bill-alt:before{content:"\f3d1"}.fa-money-bill-wave:before{content:"\f53a"}.fa-money-bill-wave-alt:before{content:"\f53b"}.fa-money-check:before{content:"\f53c"}.fa-money-check-alt:before{content:"\f53d"}.fa-monument:before{content:"\f5a6"}.fa-moon:before{content:"\f186"}.fa-mortar-pestle:before{content:"\f5a7"}.fa-mosque:before{content:"\f678"}.fa-motorcycle:before{content:"\f21c"}.fa-mountain:before{content:"\f6fc"}.fa-mouse:before{content:"\f8cc"}.fa-mouse-pointer:before{content:"\f245"}.fa-mug-hot:before{content:"\f7b6"}.fa-music:before{content:"\f001"}.fa-napster:before{content:"\f3d2"}.fa-neos:before{content:"\f612"}.fa-network-wired:before{content:"\f6ff"}.fa-neuter:before{content:"\f22c"}.fa-newspaper:before{content:"\f1ea"}.fa-nimblr:before{content:"\f5a8"}.fa-node:before{content:"\f419"}.fa-node-js:before{content:"\f3d3"}.fa-not-equal:before{content:"\f53e"}.fa-notes-medical:before{content:"\f481"}.fa-npm:before{content:"\f3d4"}.fa-ns8:before{content:"\f3d5"}.fa-nutritionix:before{content:"\f3d6"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-oil-can:before{content:"\f613"}.fa-old-republic:before{content:"\f510"}.fa-om:before{content:"\f679"}.fa-opencart:before{content:"\f23d"}.fa-openid:before{content:"\f19b"}.fa-opera:before{content:"\f26a"}.fa-optin-monster:before{content:"\f23c"}.fa-orcid:before{content:"\f8d2"}.fa-osi:before{content:"\f41a"}.fa-otter:before{content:"\f700"}.fa-outdent:before{content:"\f03b"}.fa-page4:before{content:"\f3d7"}.fa-pagelines:before{content:"\f18c"}.fa-pager:before{content:"\f815"}.fa-paint-brush:before{content:"\f1fc"}.fa-paint-roller:before{content:"\f5aa"}.fa-palette:before{content:"\f53f"}.fa-palfed:before{content:"\f3d8"}.fa-pallet:before{content:"\f482"}.fa-paper-plane:before{content:"\f1d8"}.fa-paperclip:before{content:"\f0c6"}.fa-parachute-box:before{content:"\f4cd"}.fa-paragraph:before{content:"\f1dd"}.fa-parking:before{content:"\f540"}.fa-passport:before{content:"\f5ab"}.fa-pastafarianism:before{content:"\f67b"}.fa-paste:before{content:"\f0ea"}.fa-patreon:before{content:"\f3d9"}.fa-pause:before{content:"\f04c"}.fa-pause-circle:before{content:"\f28b"}.fa-paw:before{content:"\f1b0"}.fa-paypal:before{content:"\f1ed"}.fa-peace:before{content:"\f67c"}.fa-pen:before{content:"\f304"}.fa-pen-alt:before{content:"\f305"}.fa-pen-fancy:before{content:"\f5ac"}.fa-pen-nib:before{content:"\f5ad"}.fa-pen-square:before{content:"\f14b"}.fa-pencil-alt:before{content:"\f303"}.fa-pencil-ruler:before{content:"\f5ae"}.fa-penny-arcade:before{content:"\f704"}.fa-people-arrows:before{content:"\f968"}.fa-people-carry:before{content:"\f4ce"}.fa-pepper-hot:before{content:"\f816"}.fa-percent:before{content:"\f295"}.fa-percentage:before{content:"\f541"}.fa-periscope:before{content:"\f3da"}.fa-person-booth:before{content:"\f756"}.fa-phabricator:before{content:"\f3db"}.fa-phoenix-framework:before{content:"\f3dc"}.fa-phoenix-squadron:before{content:"\f511"}.fa-phone:before{content:"\f095"}.fa-phone-alt:before{content:"\f879"}.fa-phone-slash:before{content:"\f3dd"}.fa-phone-square:before{content:"\f098"}.fa-phone-square-alt:before{content:"\f87b"}.fa-phone-volume:before{content:"\f2a0"}.fa-photo-video:before{content:"\f87c"}.fa-php:before{content:"\f457"}.fa-pied-piper:before{content:"\f2ae"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-pied-piper-hat:before{content:"\f4e5"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-pied-piper-square:before{content:"\f91e"}.fa-piggy-bank:before{content:"\f4d3"}.fa-pills:before{content:"\f484"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-p:before{content:"\f231"}.fa-pinterest-square:before{content:"\f0d3"}.fa-pizza-slice:before{content:"\f818"}.fa-place-of-worship:before{content:"\f67f"}.fa-plane:before{content:"\f072"}.fa-plane-arrival:before{content:"\f5af"}.fa-plane-departure:before{content:"\f5b0"}.fa-plane-slash:before{content:"\f969"}.fa-play:before{content:"\f04b"}.fa-play-circle:before{content:"\f144"}.fa-playstation:before{content:"\f3df"}.fa-plug:before{content:"\f1e6"}.fa-plus:before{content:"\f067"}.fa-plus-circle:before{content:"\f055"}.fa-plus-square:before{content:"\f0fe"}.fa-podcast:before{content:"\f2ce"}.fa-poll:before{content:"\f681"}.fa-poll-h:before{content:"\f682"}.fa-poo:before{content:"\f2fe"}.fa-poo-storm:before{content:"\f75a"}.fa-poop:before{content:"\f619"}.fa-portrait:before{content:"\f3e0"}.fa-pound-sign:before{content:"\f154"}.fa-power-off:before{content:"\f011"}.fa-pray:before{content:"\f683"}.fa-praying-hands:before{content:"\f684"}.fa-prescription:before{content:"\f5b1"}.fa-prescription-bottle:before{content:"\f485"}.fa-prescription-bottle-alt:before{content:"\f486"}.fa-print:before{content:"\f02f"}.fa-procedures:before{content:"\f487"}.fa-product-hunt:before{content:"\f288"}.fa-project-diagram:before{content:"\f542"}.fa-pump-medical:before{content:"\f96a"}.fa-pump-soap:before{content:"\f96b"}.fa-pushed:before{content:"\f3e1"}.fa-puzzle-piece:before{content:"\f12e"}.fa-python:before{content:"\f3e2"}.fa-qq:before{content:"\f1d6"}.fa-qrcode:before{content:"\f029"}.fa-question:before{content:"\f128"}.fa-question-circle:before{content:"\f059"}.fa-quidditch:before{content:"\f458"}.fa-quinscape:before{content:"\f459"}.fa-quora:before{content:"\f2c4"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-quran:before{content:"\f687"}.fa-r-project:before{content:"\f4f7"}.fa-radiation:before{content:"\f7b9"}.fa-radiation-alt:before{content:"\f7ba"}.fa-rainbow:before{content:"\f75b"}.fa-random:before{content:"\f074"}.fa-raspberry-pi:before{content:"\f7bb"}.fa-ravelry:before{content:"\f2d9"}.fa-react:before{content:"\f41b"}.fa-reacteurope:before{content:"\f75d"}.fa-readme:before{content:"\f4d5"}.fa-rebel:before{content:"\f1d0"}.fa-receipt:before{content:"\f543"}.fa-record-vinyl:before{content:"\f8d9"}.fa-recycle:before{content:"\f1b8"}.fa-red-river:before{content:"\f3e3"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-alien:before{content:"\f281"}.fa-reddit-square:before{content:"\f1a2"}.fa-redhat:before{content:"\f7bc"}.fa-redo:before{content:"\f01e"}.fa-redo-alt:before{content:"\f2f9"}.fa-registered:before{content:"\f25d"}.fa-remove-format:before{content:"\f87d"}.fa-renren:before{content:"\f18b"}.fa-reply:before{content:"\f3e5"}.fa-reply-all:before{content:"\f122"}.fa-replyd:before{content:"\f3e6"}.fa-republican:before{content:"\f75e"}.fa-researchgate:before{content:"\f4f8"}.fa-resolving:before{content:"\f3e7"}.fa-restroom:before{content:"\f7bd"}.fa-retweet:before{content:"\f079"}.fa-rev:before{content:"\f5b2"}.fa-ribbon:before{content:"\f4d6"}.fa-ring:before{content:"\f70b"}.fa-road:before{content:"\f018"}.fa-robot:before{content:"\f544"}.fa-rocket:before{content:"\f135"}.fa-rocketchat:before{content:"\f3e8"}.fa-rockrms:before{content:"\f3e9"}.fa-route:before{content:"\f4d7"}.fa-rss:before{content:"\f09e"}.fa-rss-square:before{content:"\f143"}.fa-ruble-sign:before{content:"\f158"}.fa-ruler:before{content:"\f545"}.fa-ruler-combined:before{content:"\f546"}.fa-ruler-horizontal:before{content:"\f547"}.fa-ruler-vertical:before{content:"\f548"}.fa-running:before{content:"\f70c"}.fa-rupee-sign:before{content:"\f156"}.fa-sad-cry:before{content:"\f5b3"}.fa-sad-tear:before{content:"\f5b4"}.fa-safari:before{content:"\f267"}.fa-salesforce:before{content:"\f83b"}.fa-sass:before{content:"\f41e"}.fa-satellite:before{content:"\f7bf"}.fa-satellite-dish:before{content:"\f7c0"}.fa-save:before{content:"\f0c7"}.fa-schlix:before{content:"\f3ea"}.fa-school:before{content:"\f549"}.fa-screwdriver:before{content:"\f54a"}.fa-scribd:before{content:"\f28a"}.fa-scroll:before{content:"\f70e"}.fa-sd-card:before{content:"\f7c2"}.fa-search:before{content:"\f002"}.fa-search-dollar:before{content:"\f688"}.fa-search-location:before{content:"\f689"}.fa-search-minus:before{content:"\f010"}.fa-search-plus:before{content:"\f00e"}.fa-searchengin:before{content:"\f3eb"}.fa-seedling:before{content:"\f4d8"}.fa-sellcast:before{content:"\f2da"}.fa-sellsy:before{content:"\f213"}.fa-server:before{content:"\f233"}.fa-servicestack:before{content:"\f3ec"}.fa-shapes:before{content:"\f61f"}.fa-share:before{content:"\f064"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-share-square:before{content:"\f14d"}.fa-shekel-sign:before{content:"\f20b"}.fa-shield-alt:before{content:"\f3ed"}.fa-shield-virus:before{content:"\f96c"}.fa-ship:before{content:"\f21a"}.fa-shipping-fast:before{content:"\f48b"}.fa-shirtsinbulk:before{content:"\f214"}.fa-shoe-prints:before{content:"\f54b"}.fa-shopify:before{content:"\f957"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-shopping-cart:before{content:"\f07a"}.fa-shopware:before{content:"\f5b5"}.fa-shower:before{content:"\f2cc"}.fa-shuttle-van:before{content:"\f5b6"}.fa-sign:before{content:"\f4d9"}.fa-sign-in-alt:before{content:"\f2f6"}.fa-sign-language:before{content:"\f2a7"}.fa-sign-out-alt:before{content:"\f2f5"}.fa-signal:before{content:"\f012"}.fa-signature:before{content:"\f5b7"}.fa-sim-card:before{content:"\f7c4"}.fa-simplybuilt:before{content:"\f215"}.fa-sistrix:before{content:"\f3ee"}.fa-sitemap:before{content:"\f0e8"}.fa-sith:before{content:"\f512"}.fa-skating:before{content:"\f7c5"}.fa-sketch:before{content:"\f7c6"}.fa-skiing:before{content:"\f7c9"}.fa-skiing-nordic:before{content:"\f7ca"}.fa-skull:before{content:"\f54c"}.fa-skull-crossbones:before{content:"\f714"}.fa-skyatlas:before{content:"\f216"}.fa-skype:before{content:"\f17e"}.fa-slack:before{content:"\f198"}.fa-slack-hash:before{content:"\f3ef"}.fa-slash:before{content:"\f715"}.fa-sleigh:before{content:"\f7cc"}.fa-sliders-h:before{content:"\f1de"}.fa-slideshare:before{content:"\f1e7"}.fa-smile:before{content:"\f118"}.fa-smile-beam:before{content:"\f5b8"}.fa-smile-wink:before{content:"\f4da"}.fa-smog:before{content:"\f75f"}.fa-smoking:before{content:"\f48d"}.fa-smoking-ban:before{content:"\f54d"}.fa-sms:before{content:"\f7cd"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-snowboarding:before{content:"\f7ce"}.fa-snowflake:before{content:"\f2dc"}.fa-snowman:before{content:"\f7d0"}.fa-snowplow:before{content:"\f7d2"}.fa-soap:before{content:"\f96e"}.fa-socks:before{content:"\f696"}.fa-solar-panel:before{content:"\f5ba"}.fa-sort:before{content:"\f0dc"}.fa-sort-alpha-down:before{content:"\f15d"}.fa-sort-alpha-down-alt:before{content:"\f881"}.fa-sort-alpha-up:before{content:"\f15e"}.fa-sort-alpha-up-alt:before{content:"\f882"}.fa-sort-amount-down:before{content:"\f160"}.fa-sort-amount-down-alt:before{content:"\f884"}.fa-sort-amount-up:before{content:"\f161"}.fa-sort-amount-up-alt:before{content:"\f885"}.fa-sort-down:before{content:"\f0dd"}.fa-sort-numeric-down:before{content:"\f162"}.fa-sort-numeric-down-alt:before{content:"\f886"}.fa-sort-numeric-up:before{content:"\f163"}.fa-sort-numeric-up-alt:before{content:"\f887"}.fa-sort-up:before{content:"\f0de"}.fa-soundcloud:before{content:"\f1be"}.fa-sourcetree:before{content:"\f7d3"}.fa-spa:before{content:"\f5bb"}.fa-space-shuttle:before{content:"\f197"}.fa-speakap:before{content:"\f3f3"}.fa-speaker-deck:before{content:"\f83c"}.fa-spell-check:before{content:"\f891"}.fa-spider:before{content:"\f717"}.fa-spinner:before{content:"\f110"}.fa-splotch:before{content:"\f5bc"}.fa-spotify:before{content:"\f1bc"}.fa-spray-can:before{content:"\f5bd"}.fa-square:before{content:"\f0c8"}.fa-square-full:before{content:"\f45c"}.fa-square-root-alt:before{content:"\f698"}.fa-squarespace:before{content:"\f5be"}.fa-stack-exchange:before{content:"\f18d"}.fa-stack-overflow:before{content:"\f16c"}.fa-stackpath:before{content:"\f842"}.fa-stamp:before{content:"\f5bf"}.fa-star:before{content:"\f005"}.fa-star-and-crescent:before{content:"\f699"}.fa-star-half:before{content:"\f089"}.fa-star-half-alt:before{content:"\f5c0"}.fa-star-of-david:before{content:"\f69a"}.fa-star-of-life:before{content:"\f621"}.fa-staylinked:before{content:"\f3f5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-steam-symbol:before{content:"\f3f6"}.fa-step-backward:before{content:"\f048"}.fa-step-forward:before{content:"\f051"}.fa-stethoscope:before{content:"\f0f1"}.fa-sticker-mule:before{content:"\f3f7"}.fa-sticky-note:before{content:"\f249"}.fa-stop:before{content:"\f04d"}.fa-stop-circle:before{content:"\f28d"}.fa-stopwatch:before{content:"\f2f2"}.fa-stopwatch-20:before{content:"\f96f"}.fa-store:before{content:"\f54e"}.fa-store-alt:before{content:"\f54f"}.fa-store-alt-slash:before{content:"\f970"}.fa-store-slash:before{content:"\f971"}.fa-strava:before{content:"\f428"}.fa-stream:before{content:"\f550"}.fa-street-view:before{content:"\f21d"}.fa-strikethrough:before{content:"\f0cc"}.fa-stripe:before{content:"\f429"}.fa-stripe-s:before{content:"\f42a"}.fa-stroopwafel:before{content:"\f551"}.fa-studiovinari:before{content:"\f3f8"}.fa-stumbleupon:before{content:"\f1a4"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-subscript:before{content:"\f12c"}.fa-subway:before{content:"\f239"}.fa-suitcase:before{content:"\f0f2"}.fa-suitcase-rolling:before{content:"\f5c1"}.fa-sun:before{content:"\f185"}.fa-superpowers:before{content:"\f2dd"}.fa-superscript:before{content:"\f12b"}.fa-supple:before{content:"\f3f9"}.fa-surprise:before{content:"\f5c2"}.fa-suse:before{content:"\f7d6"}.fa-swatchbook:before{content:"\f5c3"}.fa-swift:before{content:"\f8e1"}.fa-swimmer:before{content:"\f5c4"}.fa-swimming-pool:before{content:"\f5c5"}.fa-symfony:before{content:"\f83d"}.fa-synagogue:before{content:"\f69b"}.fa-sync:before{content:"\f021"}.fa-sync-alt:before{content:"\f2f1"}.fa-syringe:before{content:"\f48e"}.fa-table:before{content:"\f0ce"}.fa-table-tennis:before{content:"\f45d"}.fa-tablet:before{content:"\f10a"}.fa-tablet-alt:before{content:"\f3fa"}.fa-tablets:before{content:"\f490"}.fa-tachometer-alt:before{content:"\f3fd"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-tape:before{content:"\f4db"}.fa-tasks:before{content:"\f0ae"}.fa-taxi:before{content:"\f1ba"}.fa-teamspeak:before{content:"\f4f9"}.fa-teeth:before{content:"\f62e"}.fa-teeth-open:before{content:"\f62f"}.fa-telegram:before{content:"\f2c6"}.fa-telegram-plane:before{content:"\f3fe"}.fa-temperature-high:before{content:"\f769"}.fa-temperature-low:before{content:"\f76b"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-tenge:before{content:"\f7d7"}.fa-terminal:before{content:"\f120"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-th:before{content:"\f00a"}.fa-th-large:before{content:"\f009"}.fa-th-list:before{content:"\f00b"}.fa-the-red-yeti:before{content:"\f69d"}.fa-theater-masks:before{content:"\f630"}.fa-themeco:before{content:"\f5c6"}.fa-themeisle:before{content:"\f2b2"}.fa-thermometer:before{content:"\f491"}.fa-thermometer-empty:before{content:"\f2cb"}.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-think-peaks:before{content:"\f731"}.fa-thumbs-down:before{content:"\f165"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbtack:before{content:"\f08d"}.fa-ticket-alt:before{content:"\f3ff"}.fa-times:before{content:"\f00d"}.fa-times-circle:before{content:"\f057"}.fa-tint:before{content:"\f043"}.fa-tint-slash:before{content:"\f5c7"}.fa-tired:before{content:"\f5c8"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-toilet:before{content:"\f7d8"}.fa-toilet-paper:before{content:"\f71e"}.fa-toilet-paper-slash:before{content:"\f972"}.fa-toolbox:before{content:"\f552"}.fa-tools:before{content:"\f7d9"}.fa-tooth:before{content:"\f5c9"}.fa-torah:before{content:"\f6a0"}.fa-torii-gate:before{content:"\f6a1"}.fa-tractor:before{content:"\f722"}.fa-trade-federation:before{content:"\f513"}.fa-trademark:before{content:"\f25c"}.fa-traffic-light:before{content:"\f637"}.fa-trailer:before{content:"\f941"}.fa-train:before{content:"\f238"}.fa-tram:before{content:"\f7da"}.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-trash:before{content:"\f1f8"}.fa-trash-alt:before{content:"\f2ed"}.fa-trash-restore:before{content:"\f829"}.fa-trash-restore-alt:before{content:"\f82a"}.fa-tree:before{content:"\f1bb"}.fa-trello:before{content:"\f181"}.fa-tripadvisor:before{content:"\f262"}.fa-trophy:before{content:"\f091"}.fa-truck:before{content:"\f0d1"}.fa-truck-loading:before{content:"\f4de"}.fa-truck-monster:before{content:"\f63b"}.fa-truck-moving:before{content:"\f4df"}.fa-truck-pickup:before{content:"\f63c"}.fa-tshirt:before{content:"\f553"}.fa-tty:before{content:"\f1e4"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-tv:before{content:"\f26c"}.fa-twitch:before{content:"\f1e8"}.fa-twitter:before{content:"\f099"}.fa-twitter-square:before{content:"\f081"}.fa-typo3:before{content:"\f42b"}.fa-uber:before{content:"\f402"}.fa-ubuntu:before{content:"\f7df"}.fa-uikit:before{content:"\f403"}.fa-umbraco:before{content:"\f8e8"}.fa-umbrella:before{content:"\f0e9"}.fa-umbrella-beach:before{content:"\f5ca"}.fa-underline:before{content:"\f0cd"}.fa-undo:before{content:"\f0e2"}.fa-undo-alt:before{content:"\f2ea"}.fa-uniregistry:before{content:"\f404"}.fa-unity:before{content:"\f949"}.fa-universal-access:before{content:"\f29a"}.fa-university:before{content:"\f19c"}.fa-unlink:before{content:"\f127"}.fa-unlock:before{content:"\f09c"}.fa-unlock-alt:before{content:"\f13e"}.fa-untappd:before{content:"\f405"}.fa-upload:before{content:"\f093"}.fa-ups:before{content:"\f7e0"}.fa-usb:before{content:"\f287"}.fa-user:before{content:"\f007"}.fa-user-alt:before{content:"\f406"}.fa-user-alt-slash:before{content:"\f4fa"}.fa-user-astronaut:before{content:"\f4fb"}.fa-user-check:before{content:"\f4fc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-clock:before{content:"\f4fd"}.fa-user-cog:before{content:"\f4fe"}.fa-user-edit:before{content:"\f4ff"}.fa-user-friends:before{content:"\f500"}.fa-user-graduate:before{content:"\f501"}.fa-user-injured:before{content:"\f728"}.fa-user-lock:before{content:"\f502"}.fa-user-md:before{content:"\f0f0"}.fa-user-minus:before{content:"\f503"}.fa-user-ninja:before{content:"\f504"}.fa-user-nurse:before{content:"\f82f"}.fa-user-plus:before{content:"\f234"}.fa-user-secret:before{content:"\f21b"}.fa-user-shield:before{content:"\f505"}.fa-user-slash:before{content:"\f506"}.fa-user-tag:before{content:"\f507"}.fa-user-tie:before{content:"\f508"}.fa-user-times:before{content:"\f235"}.fa-users:before{content:"\f0c0"}.fa-users-cog:before{content:"\f509"}.fa-usps:before{content:"\f7e1"}.fa-ussunnah:before{content:"\f407"}.fa-utensil-spoon:before{content:"\f2e5"}.fa-utensils:before{content:"\f2e7"}.fa-vaadin:before{content:"\f408"}.fa-vector-square:before{content:"\f5cb"}.fa-venus:before{content:"\f221"}.fa-venus-double:before{content:"\f226"}.fa-venus-mars:before{content:"\f228"}.fa-viacoin:before{content:"\f237"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-vial:before{content:"\f492"}.fa-vials:before{content:"\f493"}.fa-viber:before{content:"\f409"}.fa-video:before{content:"\f03d"}.fa-video-slash:before{content:"\f4e2"}.fa-vihara:before{content:"\f6a7"}.fa-vimeo:before{content:"\f40a"}.fa-vimeo-square:before{content:"\f194"}.fa-vimeo-v:before{content:"\f27d"}.fa-vine:before{content:"\f1ca"}.fa-virus:before{content:"\f974"}.fa-virus-slash:before{content:"\f975"}.fa-viruses:before{content:"\f976"}.fa-vk:before{content:"\f189"}.fa-vnv:before{content:"\f40b"}.fa-voicemail:before{content:"\f897"}.fa-volleyball-ball:before{content:"\f45f"}.fa-volume-down:before{content:"\f027"}.fa-volume-mute:before{content:"\f6a9"}.fa-volume-off:before{content:"\f026"}.fa-volume-up:before{content:"\f028"}.fa-vote-yea:before{content:"\f772"}.fa-vr-cardboard:before{content:"\f729"}.fa-vuejs:before{content:"\f41f"}.fa-walking:before{content:"\f554"}.fa-wallet:before{content:"\f555"}.fa-warehouse:before{content:"\f494"}.fa-water:before{content:"\f773"}.fa-wave-square:before{content:"\f83e"}.fa-waze:before{content:"\f83f"}.fa-weebly:before{content:"\f5cc"}.fa-weibo:before{content:"\f18a"}.fa-weight:before{content:"\f496"}.fa-weight-hanging:before{content:"\f5cd"}.fa-weixin:before{content:"\f1d7"}.fa-whatsapp:before{content:"\f232"}.fa-whatsapp-square:before{content:"\f40c"}.fa-wheelchair:before{content:"\f193"}.fa-whmcs:before{content:"\f40d"}.fa-wifi:before{content:"\f1eb"}.fa-wikipedia-w:before{content:"\f266"}.fa-wind:before{content:"\f72e"}.fa-window-close:before{content:"\f410"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-windows:before{content:"\f17a"}.fa-wine-bottle:before{content:"\f72f"}.fa-wine-glass:before{content:"\f4e3"}.fa-wine-glass-alt:before{content:"\f5ce"}.fa-wix:before{content:"\f5cf"}.fa-wizards-of-the-coast:before{content:"\f730"}.fa-wolf-pack-battalion:before{content:"\f514"}.fa-won-sign:before{content:"\f159"}.fa-wordpress:before{content:"\f19a"}.fa-wordpress-simple:before{content:"\f411"}.fa-wpbeginner:before{content:"\f297"}.fa-wpexplorer:before{content:"\f2de"}.fa-wpforms:before{content:"\f298"}.fa-wpressr:before{content:"\f3e4"}.fa-wrench:before{content:"\f0ad"}.fa-x-ray:before{content:"\f497"}.fa-xbox:before{content:"\f412"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-y-combinator:before{content:"\f23b"}.fa-yahoo:before{content:"\f19e"}.fa-yammer:before{content:"\f840"}.fa-yandex:before{content:"\f413"}.fa-yandex-international:before{content:"\f414"}.fa-yarn:before{content:"\f7e3"}.fa-yelp:before{content:"\f1e9"}.fa-yen-sign:before{content:"\f157"}.fa-yin-yang:before{content:"\f6ad"}.fa-yoast:before{content:"\f2b1"}.fa-youtube:before{content:"\f167"}.fa-youtube-square:before{content:"\f431"}.fa-zhihu:before{content:"\f63f"}.sr-only{border:0;clip:rect(0,0,0,0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.sr-only-focusable:active,.sr-only-focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}@font-face{font-family:"Font Awesome 5 Brands";font-style:normal;font-weight:400;font-display:block;src:url(../webfonts/fa-brands-400.eot);src:url(../webfonts/fa-brands-400.eot?#iefix) format("embedded-opentype"),url(../webfonts/fa-brands-400.woff2) format("woff2"),url(../webfonts/fa-brands-400.woff) format("woff"),url(../webfonts/fa-brands-400.ttf) format("truetype"),url(../webfonts/fa-brands-400.svg#fontawesome) format("svg")}.fab{font-family:"Font Awesome 5 Brands"}@font-face{font-family:"Font Awesome 5 Free";font-style:normal;font-weight:400;font-display:block;src:url(../webfonts/fa-regular-400.eot);src:url(../webfonts/fa-regular-400.eot?#iefix) format("embedded-opentype"),url(../webfonts/fa-regular-400.woff2) format("woff2"),url(../webfonts/fa-regular-400.woff) format("woff"),url(../webfonts/fa-regular-400.ttf) format("truetype"),url(../webfonts/fa-regular-400.svg#fontawesome) format("svg")}.fab,.far{font-weight:400}@font-face{font-family:"Font Awesome 5 Free";font-style:normal;font-weight:900;font-display:block;src:url(../webfonts/fa-solid-900.eot);src:url(../webfonts/fa-solid-900.eot?#iefix) format("embedded-opentype"),url(../webfonts/fa-solid-900.woff2) format("woff2"),url(../webfonts/fa-solid-900.woff) format("woff"),url(../webfonts/fa-solid-900.ttf) format("truetype"),url(../webfonts/fa-solid-900.svg#fontawesome) format("svg")}.fa,.far,.fas{font-family:"Font Awesome 5 Free"}.fa,.fas{font-weight:900} \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.eot b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.eot new file mode 100644 index 00000000..a1bc094a Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.eot differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.svg b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.svg new file mode 100644 index 00000000..46ad237a --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.svg @@ -0,0 +1,3570 @@ + + + + + +Created by FontForge 20190801 at Mon Mar 23 10:45:51 2020 + By Robert Madole +Copyright (c) Font Awesome + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.ttf b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.ttf new file mode 100644 index 00000000..948a2a6c Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.ttf differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff new file mode 100644 index 00000000..2a89d521 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2 b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2 new file mode 100644 index 00000000..141a90a9 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2 differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.eot b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.eot new file mode 100644 index 00000000..38cf2517 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.eot differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.svg b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.svg new file mode 100644 index 00000000..48634a9a --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.svg @@ -0,0 +1,803 @@ + + + + + +Created by FontForge 20190801 at Mon Mar 23 10:45:51 2020 + By Robert Madole +Copyright (c) Font Awesome + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.ttf b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.ttf new file mode 100644 index 00000000..abe99e20 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.ttf differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff new file mode 100644 index 00000000..24de566a Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff2 b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff2 new file mode 100644 index 00000000..7e0118e5 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff2 differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.eot b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.eot new file mode 100644 index 00000000..d3b77c22 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.eot differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.svg b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.svg new file mode 100644 index 00000000..7742838b --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.svg @@ -0,0 +1,4938 @@ + + + + + +Created by FontForge 20190801 at Mon Mar 23 10:45:51 2020 + By Robert Madole +Copyright (c) Font Awesome + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.ttf b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.ttf new file mode 100644 index 00000000..5b979039 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.ttf differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff new file mode 100644 index 00000000..beec7917 Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2 b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2 new file mode 100644 index 00000000..978a681a Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2 differ diff --git a/branch/sphinx-book-theme-old-copybutton/_static/webpack-macros.html b/branch/sphinx-book-theme-old-copybutton/_static/webpack-macros.html new file mode 100644 index 00000000..b51c16ef --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/_static/webpack-macros.html @@ -0,0 +1,29 @@ + +{# Load FontAwesome icons #} +{% macro head_pre_icons() %} + + + +{% endmacro %} + +{% macro head_pre_assets() %} + + + +{% endmacro %} + +{% macro head_js_preload() %} + + +{% endmacro %} + +{% macro body_post() %} + + +{% endmacro %} \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/aliases/index.html b/branch/sphinx-book-theme-old-copybutton/aliases/index.html new file mode 100644 index 00000000..c26024b9 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/aliases/index.html @@ -0,0 +1,630 @@ + + + + + + + + + Aliases and configuration — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Aliases and configuration

    + +
    + +
    +
    +
    + +
    + +
    +

    Aliases and configuration#

    +
    +

    Objectives

    +
      +

    • Learn to use aliases for most common commands.

      • +
    +
    +

    Are you getting tired of typing so much? In Git you can define aliases (shortcuts):

    +
      +

    • These are great because they can save you time typing.

      • +

    • But it’s easy to forget them, get confused, or be inconsistent with your colleagues.

      • +
    +

    There is plenty of other configuration for Git, that can make it nicer.

    +
    +

    Aliases#

    +
      +

    • Aliases are a simple way to improve the usability of Git: for +example git ci instead of git commit.

      • +

    • Aliases are based on simple string replacement in the command.

      • +

    • Aliases can either be specific to a repository or global.

      +
        +

      • Global aliases help you do the things you are used to across Git projects.

        • +

      • Per-project aliases can also be created.

        • +
      +
      • +

    • Global aliases are stored in ~/.gitconfig.

      • +
    +
    +
    +

    Example alias: git graph#

    +

    A very useful shortcut which we use a lot in our workshops:

    +
    $ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ cd your_git_repository
+$ git graph
+
    +
    +
    +
    +

    Using external commands#

    +

    It is possible to call external commands using the exclamation mark character “!”. +In this case we create a local alias which is +stored in .git/config and not synchronized with remotes:

    +
    $ cd your_git_repository
+$ git config alias.hi '!echo hello'
+$ git hi
+
    +
    +
    +

    Food for thought: When to alias?

    +
      +

    • How many times should you wait before aliasing a command?

      • +

    • Do you believe a list of generic two-letter acronyms for common commands will +save your time?

      • +
    +
    +
    +
    +

    List of aliases the instructors use#

    +

    You are welcome to reuse, suggest, improve. +You can see your current aliases in ~/.gitconfig.

    +
    $ git config --global alias.ap "add --patch"
+$ git config --global alias.br branch
+$ git config --global alias.ci "commit -v"
+$ git config --global alias.cip "commit --patch -v"
+$ git config --global alias.cl "clone --recursive"
+$ git config --global alias.co checkout
+$ git config --global alias.cop "checkout --patch"
+$ git config --global alias.di diff
+$ git config --global alias.dic "diff --cached --color-words"
+$ git config --global alias.diw "diff --color-words"
+$ git config --global alias.dis "!git --no-pager diff --stat"
+$ git config --global alias.fe fetch
+$ git config --global alias.graph "log --all --graph --decorate --oneline"
+$ git config --global alias.rem remote
+$ git config --global alias.st status
+$ git config --global alias.su "submodule update --init --recursive"
+
    +
    +

    Here is what they do:

    +
      +

    • ap: add, selecting parts individually, interactively.

      • +

    • br: branch (obvious)

      • +

    • ci: commit (check in), with -v option for clarity

      • +

    • cip: commit, selecting parts individually, interactively.

      • +

    • cl: clone, init submodules (submodules are an advanced topic)

      • +

    • co: checkout (obvious)

      • +

    • cop: checkout, selecting parts individually, interactively.

      • +

    • di: diff (obvious)

      • +

    • dic: diff of staging area vs last commit (what is about to be committed)

      • +

    • diw: a word diff, color. Useful for small changes.

      • +

    • dis: a “diffstat”: what files are changed, not contents

      • +

    • fe: fetch (obvious)

      • +

    • graph: show whole git graph (so useful, some of us call it l)

      • +

    • rem: remote (obvious)

      • +

    • st: status (obvious)

      • +

    • su: submodule update (advanced)

      • +
    +

    A useful setting for the p aliases:

    +
    $ git config --global interactive.singlekey true
+
    +
    +
    +
    +

    Advanced aliases#

    +

    These are advanced aliases and configuration options. We won’t explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages!

    +
    $ git config --global alias.cif "commit -v -p --fixup"
+$ git config --global alias.rb "rebase --autosquash"
+$ git config --global alias.rbi "rebase --interactive --autosquash"
+$ git config --global alias.rbis "rebase --interactive --autosquash --autostash"
+$ git config --global alias.rbs "rebase --autosquash --autostash"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard"
+$ git config --global alias.new "log HEAD..HEAD@{upstream}"
+$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}"
+$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}"
+$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}"
+$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD"
+$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all"
+$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD"
+$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat"
+
    +
    +
    +
    +

    Advanced Git configuration#

    +

    Besides aliases, you can do plenty of other configuration of git. +Here are some of the most common ones:

    +
    $ git config --global interactive.singlekey true
+$ git config --global core.pager "less -RS"
+$ git config --global core.excludesfile ~/.gitignore
+$ git config --global merge.conflictstyle diff3
+$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]"
+$ git config --global diff.mnemonicPrefix true
+
    +
    +

    Do you get tired of typing and copying and pasting your remote names +all the time, like git@github.com:myusername? You can create remote +aliases like this:

    +
    $ git config --global url.git@github.com:.insteadOf gh:
+$ git config --global url.git@github.com:/username/.insteadOf ghu:
+
    +
    +

    Then, when you add a remote ghu:recipe, it will automatically be +translated to git@github.com:/username/recipe using a simple prefix +matching.

    +
    +

    Keypoints

    +
      +

    • If you are frustrated about remembering a command, you should create an alias.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/archaeology/index.html b/branch/sphinx-book-theme-old-copybutton/archaeology/index.html new file mode 100644 index 00000000..33487324 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/archaeology/index.html @@ -0,0 +1,848 @@ + + + + + + + + + Inspecting history — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Inspecting history

    + +
    + +
    +
    +
    + +
    + +
    +

    Inspecting history#

    +
    +

    Objectives

    +
      +

    • Quickly find a line of code, find out why it was introduced and when.

      • +

    • Quickly find the commit that changed a behavior.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 15 min teaching/type-along

      • +

    • 30 min exercise

      • +
    +
    +
    +

    Preparation

    +

    Please make sure that you do not clone repositories inside an already tracked folder:

    +
    $ git status
+
    +
    +

    If you are inside an existing Git repository, step out of it. +You need to find a different location since we will clone a new repository.

    +

    If you see this message, this is good in this case:

    +
    fatal: not a git repository (or any of the parent directories): .git
+
    +
    +
    +
    +

    Our toolbox for history inspection#

    +
    +

    Instructor note

    +

    First the instructor demonstrates few commands on a real life example +repository https://github.com/networkx/networkx (mentioned in the amazing site The +Programming Historian). +Later we will practice these in groups in an archaeology exercise (below). +After demonstrating the command line tools, the instructor can also demonstrate searching, “show” and “annotate” +in the GitHub browser for this example project.

    +
    +
    +

    Warm-up: “Git History” browser#

    +

    As a warm-up we can try the “Git History” browser +on the README.rst file of the networkx repository:

    + +
    +
    +

    git grep: to search through the repository#

    +

    With git grep you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or some error message printed:

    +
    $ git grep sometext
+$ git grep "some text with spaces"
+
    +
    +

    In the networkx repository you can try:

    +
    $ git clone https://github.com/networkx/networkx
+$ cd networkx
+$ git grep -i fixme
+
    +
    +
    +
    +

    git log -S: to search through the history of changes#

    +

    While git grep searches the current state of the repository, +it is also possible to search through all changes for “sometext”:

    +
    $ git log -S sometext
+
    +
    +

    In the networkx repository you can try:

    +
    $ git log -S test_weakly_connected_component
+
    +
    +
    +
    +

    git show: to inspect commits#

    +

    We have seen this one before already. Using git show we can inspect an individual commit if +we know its hash:

    +
    $ git show somehash
+
    +
    +

    For instance:

    +
    $ git show 759d589bdfa61aff99e0535938f14f67b01c83f7
+
    +
    +
    +
    +

    git annotate: to annotate code with commit metadata#

    +

    Try it out on a file - with git annotate you can see line by line who and when the line was modified +last. It also prints the precise hash of the last change which modified each line. Incredibly useful +for reproducibility.

    +
    $ git annotate somefile
+
    +
    +

    Example:

    +
    $ git annotate networkx/convert_matrix.py
+
    +
    +

    If you annotate in a terminal and the file is longer than the screen, Git by default uses the program less to +scroll the output. +Use /sometext <ENTER> to find “sometext” and you can cycle through the results with n (next) and N (last). +You can also use page up/down to scroll. You can quit with q.

    +
    +

    Discussion

    +

    Discuss how these two affect the annotation:

    +
      +

    • wrapping long lines of text/code into shorter lines

      • +

    • autoformatting tools such as black

      • +
    +
    +
    +
    +

    git checkout -b: to inspect code in the past#

    +

    We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code:

    +
    $ git checkout -b branchname somehash
+
    +
    +

    Example (lines starting with “#” are only comments):

    +
    $ # create branch called "older-code" from hash 347e6292419b
+$ git checkout -b older-code 347e6292419bd0e4bff077fe971f983932d7a0e9
+
+$ # now you can navigate and inspect the code as it was back then
+$ # ...
+
+$ # after we are done we can switch back to "main"
+$ git checkout main
+
+$ # if we like we can delete the "older-code" branch
+$ git branch -d older-code
+
    +
    +

    On newer Git versions this is the preferred command:

    +
    $ git switch --create branchname somehash
+
    +
    +
    +
    +
    +

    Exercise: Basic archaeology commands#

    +
    +

    History-1: Explore basic archaeology commands

    +

    Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

    +

    In-person workshops: We recommend that you +do this exercise in groups of two and discuss with your neighbors.

    +

    Video workshops: We will group you in breakout rooms of ~4 persons where you +can work and discuss together. A helper or instructor will pop in to help out. +In the group one participant can share their screen and others +in the group help out, discuss, and try to follow along. +Please write down questions in the collaborative notes. +After 15-20 minutes we will bring you back into the main room and discuss.

    +

    Exercise steps:

    +
      +

    • Clone this repository: +https://github.com/networkx/networkx.git. +Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release:

      +
      $ git clone https://github.com/networkx/networkx.git
+$ cd networkx
+$ git checkout -b exercise networkx-2.6.3
+
      +
      +
      • +
    +

    Then using the above toolbox try to:

    +
      +

    1. Find the code line which contains "Logic error in degree_correlation".

      2. +

    2. Find out when this line was last modified or added. Find the actual commit which modified that line.

      3. +

    3. Inspect that commit with git show.

      4. +

    4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

      5. +

    5. How would can you bring the code to the commit precisely before that line was last modified?

      6. +
    + +
    +
    +
    +
    +

    Finding out when something broke/changed with git bisect#

    +
    +

    But I am sure it used to work! Strange.

    +
    +
      +

    • Sometimes you realize that something broke.

      • +

    • You know that it used to work.

      • +

    • You do not know when it broke.

      • +
    +
    +

    How would you solve this?

    +

    Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now.

    +
      +

    • How would you find the commit which changed it?

      • +

    • Why could it be useful to know the commit that changed it?

      • +
    +

    Video workshops: Write down ideas on how you would solve it in the collaborative +note and we will discuss various approaches.

    +
    +

    We will probably arrive at a solution which is similar to git bisect:

    +
      +

    • First find out a commit in past when it worked.

      • +

    • Then bisect your way until you find the commit that broke it.

      • +
    +
    $ git bisect start
+$ git bisect good f0ea950  # this is a commit that worked
+$ git bisect bad main    # last commit is broken
+
+$ # now compile and/or run
+$ # after that decide whether
+$ git bisect good
+$ # or
+$ git bisect bad
+
+$ # now compile and/or run
+$ # after that decide whether
+$ git bisect good
+$ # or
+$ git bisect bad
+
+$ # iterate until commit is found
+
    +
    +
      +

    • This can even be automatized with git bisect run <script>.

      • +

    • For this you write a script that returns zero/non-zero (success/failure).

      • +
    +
    +
    +

    Optional exercise: Git bisect#

    +
    +

    (optional) History-2: Use git bisect to find the bad commit

    +

    In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

    +

    Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

    +

    Motivation

    +

    The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

    +

    Background

    +

    The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

    +
    $ python get_pi.py
+
+3.57
+
    +
    +

    At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

    +

    Your task

    +
      +

    • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

      • +

    • Once you have found the offending commit, also practice navigating to the last good commit.

      • +

    • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

      • +
    +

    Video workshops: We will group you in breakout rooms of ~4 persons where you +can work and discuss together. A helper or instructor will pop in to help out. +Please write down questions in the collaborative notes. +After 15-20 minutes we will bring you back into the main room and discuss.

    +

    Hints

    +

    Finding the first commit:

    +
    $ git log --oneline | tail -n 1
+
    +
    +

    How to navigate to the parent of a commit with hash somehash:

    +
    $ # create branch pointing to the parent of somehash
+$ git checkout -b branchname somehash~1
+
+$ # instead of a tilde you can also use this
+$ git checkout -b branchname somehash^
+
    +
    +
    +
    +

    Keypoints

    +
      +

    • git log/grep/annotate/show/bisect is a powerful combination when doing archaeology in a project.

      • +

    • git checkout -b <name> <hash> is the recommended mechanism to inspect old code.

      • +

    • On newer Git you can use the more intuitive git switch --create branchname somehash.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/basics/index.html b/branch/sphinx-book-theme-old-copybutton/basics/index.html new file mode 100644 index 00000000..12130d53 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/basics/index.html @@ -0,0 +1,1009 @@ + + + + + + + + + Basics — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Basics

    + +
    + +
    +
    +
    + +
    + +
    +

    Basics#

    +
    +

    Objectives

    +
      +

    • Learn to create Git repositories and make commits.

      • +

    • Get a grasp of the structure of a repository.

      • +

    • Learn how to inspect the project history.

      • +

    • Learn how to write useful commit log messages.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 20 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +
    +

    What is Git, and what is a Git repository?#

    +
      +

    • Git is a version control system: can record/save snapshots and track the content of a folder as it changes over time.

      • +

    • Every time we commit a snapshot, Git records a snapshot of the entire project, saves it, and assigns it a version.

      • +

    • These snapshots are kept inside a sub-folder called .git.

      • +

    • If we remove .git, we remove the repository and history (but keep the working directory!).

      • +

    • .git uses relative paths - you can move the whole thing somewhere else and it will still work

      • +

    • Git doesn’t do anything unless you ask it to (it does not record anything automatically).

      • +

    • Multiple interfaces to Git exist (command line, graphical interfaces, web interfaces).

      • +
    +
    +
    +

    Recording a snapshot with Git#

    +
      +

    • Git takes snapshots only if we request it.

      • +

    • We will record changes always in two steps (we will later explain why this is a recommended practice).

      • +

    • Example (we don’t need to type yet):

      • +
    +
    $ git add somefile.txt
+$ git commit
+
+$ git add file.txt anotherfile.txt
+$ git commit
+
    +
    +
      +

    • We first focus (git add, we “stage” the change), then shoot (git commit):

      • +
    +
    +Git staging +
    +

    Git staging and committing.#

    +
    +
    +
    +

    Question for the more advanced participants

    +

    What do you think will be the outcome if you +stage a file and then edit it and stage it again, do this several times and +at the end perform a commit? (think of focusing several scenes and pressing the +shoot button only at the end)

    +
    +
    +
    +

    Before we start we need to configure Git#

    +

    If you haven’t already configured Git, please follow the instructions in the +installation instructions.

    +
    +
    +

    Type-along: Tracking a guacamole recipe with Git#

    +

    We will learn how to initialize a Git repository, how to track changes, and how +to make delicious guacamole!

    +

    This example is inspired by Byron Smith, for original reference, see +this thread. +The motivation for taking a cooking recipe instead of a program is that everybody can relate to cooking +but not everybody may be able to relate to a program written in e.g. Python or another language.

    +

    Let us start.

    +
    +

    Instructor note

    +

    Instructors, please encourage now that participants type along.

    +
    +

    One of the basic principles of Git is that it is easy to create repositories:

    +
    $ mkdir recipe
+$ cd recipe
+$ git init
+
    +
    +

    That’s it! With git init have now created an empty Git repository.

    +

    We will use git status a lot to check out what is going on:

    +
    $ git status
+
+On branch master
+
+No commits yet
+
+nothing to commit (create/copy files and use "git add" to track)
+
    +
    +

    We will make sense of this information during this workshop.

    +

    Let us now create two files.

    +

    One file is called instructions.txt and contains:

    +
    * chop avocados
+* chop onion
+* squeeze lime
+* add salt
+* and mix well
+
    +
    +

    The second file is called ingredients.txt and contains:

    +
    * 2 avocados
+* 1 lime
+* 2 tsp salt
+
    +
    +

    As mentioned above, in Git you can always check the status of files in your repository using +git status. It is always a safe command to run and in general a good idea to +do when you are trying to figure out what to do next:

    +
    $ git status
+
+On branch master
+
+No commits yet
+
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+
+	ingredients.txt
+	instructions.txt
+
+nothing added to commit but untracked files present (use "git add" to track)
+
    +
    +

    The two files are untracked in the repository (directory). You want to add the files (focus the camera) +to the list of files tracked by Git. Git does not track +any files automatically and you need make a conscious decision to add a file. Let’s do what +Git hints at and add the files:

    +
    $ git add ingredients.txt
+$ git add instructions.txt
+$ git status
+
+On branch master
+
+Initial commit
+
+Changes to be committed:
+  (use "git rm --cached <file>..." to unstage)
+
+	new file:   ingredients.txt
+	new file:   instructions.txt
+
    +
    +

    Now this change is staged and ready to be committed.

    +

    Let us now commit the change to the repository:

    +
    $ git commit -m "adding ingredients and instructions"
+
+[master (root-commit) aa243ea] adding ingredients and instructions
+ 2 files changed, 8 insertions(+)
+ create mode 100644 ingredients.txt
+ create mode 100644 instructions.txt
+
    +
    +

    Right after we query the status to get this useful command into our muscle memory:

    +
    $ git status
+
    +
    +

    What does the -m flag mean? Let us check the help page for that command:

    +
    $ git help commit
+
    +
    +

    You should see a very long help page as the tool is very versatile (press q to quit). +Do not worry about this now but keep in mind that you can always read the help files +when in doubt. Searching online can also be useful, but choosing search terms +to find relevant information takes some practice and discussions in some +online threads may be confusing. +Note that help pages also work when you don’t have a network connection!

    +
    +
    +

    Exercise: Record changes#

    +
    +

    Basic-1: Record changes

    +

    Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt. Do not stage the changes yet.

    +

    When you are done editing the files, try git diff:

    +
    $ git diff
+
    +
    +

    You will see (can you identify in there the two added lines?):

    +
    diff --git a/ingredients.txt b/ingredients.txt
+index 2607525..ec0abc6 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,3 +1,4 @@
+ * 2 avocados
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 6a8b2af..f7dd63a 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -3,3 +3,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
    +
    +

    Now first stage and commit each change separately (what happens when we leave out the -m flag?):

    +
    $ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
    +
    +

    When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

    +

    When you are done committing the changes, experiment with these commands:

    +
    $ git log
+$ git log --stat
+$ git log --oneline
+
    +
    +
    +
    +
    +

    Git history and log#

    +

    If you haven’t yet, please try now git log:

    +
    $ git log
+
+commit ea73a8a9ef9bd5c0aee3f0868d0ebc8457e1f94b
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Wed Feb 9 10:12:39 2022 +0100
+
+    don't forget to enjoy
+
+commit 6316947beb2b7ffa0cc822370cfdd701050227a4
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Wed Feb 9 10:12:30 2022 +0100
+
+    add half an onion
+
+commit 03491ed253ffcee16772e35b1de4efd349711f05
+Author: Radovan Bast <bast@users.noreply.github.com>
+Date:   Wed Feb 9 10:11:30 2022 +0100
+
+    adding ingredients and instructions
+
    +
    +
      +

    • We can browse the development and access each state that we have committed.

      • +

    • The long hashes uniquely label a state of the code.

      • +

    • They are not just integers counting 1, 2, 3, 4, … (why?).

      • +

    • Output is in reverse chronological order, i.e. newest commits on top.

      • +

    • We will use them when comparing versions and when going back in time.

      • +

    • git log --oneline only shows the first 7 characters of the commit hash and is good to get an overview.

      • +

    • If the first characters of the hash are unique it is not necessary to type the entire hash.

      • +

    • git log --stat is nice to show which files have been modified.

      • +
    +
    +
    +

    Optional exercises: comparing, renaming, and removing#

    +
    +

    (optional) Basic-2: Comparing and showing commits

    +
      +

    1. Inspect differences between commit hashes with git diff <hash1> <hash2>.

      2. +

    2. Have a look at specific commits with git show <hash>.

      3. +
    +
    +
    +

    (optional) Basic-3: Visual diff tools

    +
      +

    • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

      • +
    +

    On Windows or Linux:

    +
    $ git difftool --tool=meld <hash>
+
    +
    +

    On macOS:

    +
    $ git difftool --tool=opendiff <hash>
+
    +
    +
    +Git difftool using meld +
    +

    Git difftool using meld.#

    +
    +
    +

    You probably want to use the same visual diff tool every time and +you can configure Git for that:

    +
    $ git config --global diff.tool meld
+
    +
    +
    +
    +

    (optional) Basic-4: Renaming and removing files

    +
      +

    1. Create a new file, git add and git commit the file.

      2. +

    2. Rename the file with git mv (you will need to git commit the rename).

      3. +

    3. Use git log --oneline and git status.

      4. +

    4. Remove the file with git rm (again you need to git commit the change).

      5. +

    5. Inspect the history with git log --stat.

      6. +
    +
    +
    +
    +

    Writing useful commit messages#

    +

    Using git log --oneline we understand that the first line of the commit message is very important.

    +

    Good example:

    +
    increase threshold alpha to 2.0
+
+the motivation for this change is
+to enable ...
+...
+
    +
    +

    Convention: one line summarizing the commit, then one empty line, +then paragraph(s) with more details in free form, if necessary.

    +
      +

    • Why something was changed is more important than what has changed.

      • +

    • Cross-reference to issues and discussions if possible/relevant.

      • +

    • Bad commit messages: “fix”, “oops”, “save work”

      • +

    • Bad examples: http://whatthecommit.com

      • +

    • Write commit messages in English that will be understood +15 years from now by someone else than you. Or by your future you.

      • +

    • Many projects start out as projects “just for me” and end up to be successful projects +that are developed by 50 people over decades.

      • +

    • Commits with multiple authors are possible.

      • +
    +

    Good references:

    + +
    +

    Note

    +

    A great way to learn how to write commit messages and to get inspired by their +style choices: browse repositories of codes that you use/like:

    +

    Some examples (but there are so many good examples):

    + +

    When designing commit message styles consider also these:

    +
      +

    • How will you easily generate a changelog or release notes?

      • +

    • During code review, you can help each other improving commit messages.

      • +
    +
    +

    But remember: it is better to make any commit, than no commit. Especially in small projects, weight the benefit with the time it takes.

    +
    +
    +

    Ignoring files and paths with .gitignore#

    +
    +

    Discussion

    +
      +

    • Should we add and track all files in a project?

      • +

    • How about generated files?

      • +

    • Why is it considered a bad idea to commit compiled binaries to version control?

      • +

    • What types of generated files do you know?

      • +
    +
    +

    Compiled and generated files are not +committed to version control. There are many reasons for this:

    +
      +

    • Your code could be run on different platforms.

      • +

    • These files are automatically generated and thus do not contribute in any meaningful way.

      • +

    • The number of changes to track per source code change can increase quickly.

      • +

    • When tracking generated files you could see differences in the code although you haven’t touched the code.

      • +
    +

    For this we use .gitignore files. Example:

    +
    # ignore compiled python 2 files
+*.pyc
+# ignore compiled python 3 files
+__pycache__
+
    +
    +

    An example taken from the official Git documentation:

    +
    # ignore objects and archives, anywhere in the tree.
+*.[oa]
+# ignore generated html files,
+*.html
+# except foo.html which is maintained by hand
+!foo.html
+# ignore everything under build directory
+build/
+
    +
    +
      +

    • .gitignore should be part of the repository because we want to make sure that all developers see the same behavior.

      • +

    • All files should be either tracked or ignored.

      • +

    • .gitignore uses something called a +shell glob syntax for +determining file patterns to ignore. You can read more about the syntax in the +documentation.

      • +

    • You can have .gitignore files in lower level directories and they affect the paths +relatively.

      • +
    +
    +
    +

    Graphical user interfaces#

    +

    We have seen how to make commits directly via the GitHub website, and also via command line. +But it is also possible to work from within a Git graphical user interface (GUI):

    + +
    +
    +

    Summary#

    +

    Now we know how to save snapshots:

    +
    $ git add <file(s)>
+$ git commit
+
    +
    +

    And this is what we do as we program.

    +

    Every state is then saved and later we will learn how to go back to these “checkpoints” +and how to undo things.

    +
    $ git init    # initialize new repository
+$ git add     # add files or stage file(s)
+$ git commit  # commit staged file(s)
+$ git status  # see what is going on
+$ git log     # see history
+$ git diff    # show unstaged/uncommitted modifications
+$ git show    # show the change for a specific commit
+$ git mv      # move tracked files
+$ git rm      # remove tracked files
+
    +
    +

    Git is not ideal for large binary files +(for this consider http://git-annex.branchable.com).

    +
    +

    Basic-5: Test your understanding

    +

    Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

    +
      +
    1. $ git commit -m "my recent changes"
+
      +
      +
      2. +
    2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
      +
      +
      3. +
    3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
      +
      +
      4. +
    4. $ git commit -m myfile.txt "my recent changes"
+
      +
      +
      5. +
    + +
    +
    +

    Keypoints

    +
      +

    • Initializing a Git repository is simple: git init.

      • +

    • Commits should be used to tell a story.

      • +

    • Git uses the .git folder to store the snapshots.

      • +

    • Don’t be afraid to stage and commit often. Better too often than not often enough.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/branches/index.html b/branch/sphinx-book-theme-old-copybutton/branches/index.html new file mode 100644 index 00000000..16407b33 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/branches/index.html @@ -0,0 +1,1122 @@ + + + + + + + + + Branching and merging — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Branching and merging

    + +
    + +
    +
    +
    + +
    + +
    +

    Branching and merging#

    +
    +

    Objectives

    +
      +

    • Be able to create and merge branches.

      • +

    • Know the difference between a branch and a tag.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 20 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +
    +

    Motivation for branches#

    +

    In the previous section we tracked a guacamole recipe with Git.

    +

    Up until now our repository had only one branch with one commit coming +after the other:

    +
    +Linear Git repository +
    +

    Linear Git repository.#

    +
    +
    +
      +

    • Commits are depicted here as little boxes with abbreviated hashes.

      • +

    • Here the branch master points to a commit.

      • +

    • “HEAD” is the current position (remember the recording head of tape recorders?).

      • +

    • When we talk about branches, we often mean all parent commits, not only the commit pointed to.

      • +
    +
    +

    Now we want to do this:#

    +
    +Branching explained with an octopus +
    +

    Source: https://twitter.com/jay_gee/status/703360688618536960#

    +
    +
    +

    Software development is often not linear:

    +
      +

    • We typically need at least one version of the code to “work” (to compile, to give expected results, …).

      • +

    • At the same time we work on new features, often several features concurrently. +Often they are unfinished.

      • +

    • We need to be able to separate different lines of work really well.

      • +
    +

    The strength of version control is that it permits the researcher to isolate +different tracks of work, which can later be merged to create a composite +version that contains all changes:

    +
    +Collaborative Git +
    +

    Collaborative Git.#

    +
    +
    +
      +

    • We see branching points and merging points.

      • +

    • Main line development is often called master or main.

      • +

    • Other than this convention there is nothing special about master, it is just a branch.

      • +

    • Commits form a directed acyclic graph (we have left out the arrows to avoid confusion about the time arrow).

      • +
    +

    A group of commits that create a single narrative are called a branch. +There are different branching strategies, but it is useful to think that a branch +tells the story of a feature, e.g. “fast sequence extraction” or “Python interface” or “fixing bug in +matrix inversion algorithm”.

    +
    +

    Note

    +

    A useful alias

    +

    We will now define an alias in Git, to be able to nicely visualize branch +structure in the terminal without having to remember a long Git command +(more details about aliases are given +in a later section):

    +
    $ git config --global alias.graph "log --all --graph --decorate --oneline"
+
    +
    +
    +

    Let us inspect the project history using the git graph alias:

    +
    $ git graph
+
+* dd4472c (HEAD -> master) we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +
      +

    • We have three commits and only +one development line (branch) and this branch is called master.

      • +

    • Commits are states characterized by a 40-character hash (checksum).

      • +

    • git graph print abbreviations of these checksums.

      • +

    • Branches are pointers that point to a commit.

      • +

    • Branch master points to commit dd4472c8093b7bbcdaa15e3066da6ca77fcabadd.

      • +

    • HEAD is another pointer, it points to where we are right now (currently master)

      • +
    +
    +
    +

    On which branch are we?#

    +

    To see where we are (where HEAD points to) use git branch:

    +
    $ git branch
+
+* master
+
    +
    +
      +

    • This command shows where we are, it does not create a branch.

      • +

    • There is only master and we are on master (star represents the HEAD).

      • +
    +

    In the following we will learn how to create branches, +how to switch between them, how to merge branches, +and how to remove them afterwards.

    +
    +
    +
    +

    Creating and working with branches#

    +
    +

    Instructor note

    +

    We do the following part together. Encourage participants to type along.

    +
    +

    Let’s create a branch called experiment where we add cilantro to ingredients.txt.

    +
    $ git branch experiment master   # create branch called "experiment" from master
+$                                # pointing to the present commit
+$ git checkout experiment        # switch to branch "experiment"
+$ git branch                     # list all local branches and show on which branch we are
+
    +
    +
      +

    • Verify that you are on the experiment branch (note that git graph also +makes it clear what branch you are on: HEAD -> branchname):

      • +
    +
    $ git branch
+
+* experiment
+  master
+
    +
    +
      +

    • Then add 2 tbsp cilantro on top of the ingredients.txt:

      • +
    +
    * 2 tbsp cilantro
+* 2 avocados
+* 1 lime
+* 2 tsp salt
+* 1/2 onion
+
    +
    +
      +

    • Stage this and commit it with the message “let us try with some cilantro”.

      • +

    • Then reduce the amount of cilantro to 1 tbsp, stage and commit again with “maybe little bit less cilantro”.

      • +
    +

    We have created two new commits:

    +
    $ git graph
+
+* 6feb49d (HEAD -> experiment) maybe little bit less cilantro
+* 7cf6d8c let us try with some cilantro
+* dd4472c (master) we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +
      +

    • The branch experiment is two commits ahead of master.

      • +

    • We commit our changes to this branch.

      • +
    +
    +
    +

    Exercise: Create and commit to branches#

    +
    +

    Branch-1: Create and commit to branches

    +

    In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging.

    +
      +

    • Change to the branch master.

      • +

    • Create another branch called less-salt

      +
        +

      • Note! makes sure you are on master branch when you create the less-salt branch

        • +

      • A safer way would be to explicitly mention to create from the master branch +as shown below

        • +
      +
      • +
    +
    $ git branch less-salt master
+
    +
    +
      +

    • Where you reduce the amount of salt.

      • +

    • Commit your changes to the less-salt branch.

      • +
    +

    Use the same commands as we used above.

    +

    We now have three branches (in this case HEAD points to less-salt):

    +
    $ git branch
+
+  experiment
+* less-salt
+  master
+
+$ git graph
+
+* bf59be6 (HEAD -> less-salt) reduce amount of salt
+| * 6feb49d (experiment) maybe little bit less cilantro
+| * 7cf6d8c let us try with some cilantro
+|/
+* dd4472c (master) we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +

    Here is a graphical representation of what we have created:

    +
    +../_images/git-branch-2.svg
    +
      +

    • Now switch to master.

      • +

    • Add and commit the following README.md to master:

      • +
    +
    # Guacamole recipe
+
+Used in teaching Git.
+
    +
    +

    Now you should have this situation:

    +
    $ git graph
+
+* 40fbb90 (HEAD -> master) draft a readme
+| * bf59be6 (less-salt) reduce amount of salt
+|/
+| * 6feb49d (experiment) maybe little bit less cilantro
+| * 7cf6d8c let us try with some cilantro
+|/
+* dd4472c we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +
    +../_images/git-branch-3.svg
    +

    And for comparison this is how it looks on GitHub.

    +
    +
    +
    +

    Merging branches#

    +

    It turned out that our experiment with cilantro was a good idea. +Our goal now is to merge experiment into master.

    +
    +

    Note

    +

    If you got stuck in the above exercises you can apply the commands below. +But skip this box if you managed to create branches.

    +
    $ cd ..  # step out of the current directory
+
+$ git clone https://github.com/coderefinery/recipe.git recipe-branching
+$ cd recipe-branching
+
+$ git checkout experiment
+$ git checkout less-salt
+$ git checkout master
+
+$ git graph
+
    +
    +

    Or call a helper to un-stuck it for you.

    +
    +

    First we make sure we are on the branch we wish to merge into:

    +
    $ git branch
+
+  experiment
+  less-salt
+* master
+
    +
    +

    Then we merge experiment into master:

    +
    $ git merge experiment
+
    +
    +
    +../_images/git-merge-1.svg
    +

    We can verify the result in the terminal:

    +
    $ git graph
+
+*   c43b24c (HEAD -> master) Merge branch 'experiment'
+|\
+| * 6feb49d (experiment) maybe little bit less cilantro
+| * 7cf6d8c let us try with some cilantro
+* | 40fbb90 draft a readme
+|/
+| * bf59be6 (less-salt) reduce amount of salt
+|/
+* dd4472c we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +

    What happens internally when you merge two branches is that Git creates a new +commit, attempts to incorporate changes from both branches and records the +state of all files in the new commit. While a regular commit has one parent, a +merge commit has two (or more) parents.

    +

    To view the branches that are merged into the current branch we can use the command:

    +
    $ git branch --merged
+
+  experiment
+* master
+
    +
    +

    We are also happy with the work on the less-salt branch. Let us merge that +one, too, into master:

    +
    $ git branch  # make sure you are on master
+$ git merge less-salt
+
    +
    +
    +Commit graph after merge
    +

    Commit graph after merge.#

    +
    +
    +

    We can verify the result in the terminal:

    +
    $ git graph
+
+*   4f00317 (HEAD -> master) Merge branch 'less-salt'
+|\
+| * bf59be6 (less-salt) reduce amount of salt
+* |   c43b24c Merge branch 'experiment'
+|\ \
+| * | 6feb49d (experiment) maybe little bit less cilantro
+| * | 7cf6d8c let us try with some cilantro
+| |/
+* | 40fbb90 draft a readme
+|/
+* dd4472c we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +

    Observe how Git nicely merged the changed amount of salt and the new ingredient in the same file +without us merging it manually:

    +
    $ cat ingredients.txt
+
+* 1 tbsp cilantro
+* 2 avocados
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
    +
    +

    If the same file is changed in both branches, Git attempts to incorporate both +changes into the merged file. If the changes overlap then the user has to +manually settle merge conflicts (we will do that later).

    +
    +
    +

    Deleting branches safely#

    +

    Both feature branches are merged:

    +
    $ git branch --merged
+
+  experiment
+  less-salt
+* master
+
    +
    +

    This means we can delete the branches:

    +
    $ git branch -d experiment less-salt
+
+Deleted branch experiment (was 6feb49d).
+Deleted branch less-salt (was bf59be6).
+
    +
    +

    This is the result:

    +
    +Commit graph after merged branches were deleted
    +

    Commit graph after merged branches were deleted.#

    +
    +
    +

    Compare in the terminal:

    +
    $ git graph
+
+*   4f00317 (HEAD -> master) Merge branch 'less-salt'
+|\
+| * bf59be6 reduce amount of salt
+* |   c43b24c Merge branch 'experiment'
+|\ \
+| * | 6feb49d maybe little bit less cilantro
+| * | 7cf6d8c let us try with some cilantro
+| |/
+* | 40fbb90 draft a readme
+|/
+* dd4472c we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +

    Comparing figures “Commit graph after merge” +and “Commit graph after merged branches were deleted”, +we observe that +only the pointers (“sticky notes”) disappeared, not the commits.

    +

    Git will not let you delete a branch which has not been reintegrated unless you +insist using git branch -D. Even then your commits will not be lost but you +may have a hard time finding them as there is no branch pointing to them.

    +
    +
    +

    Optional exercises with branches#

    +

    The following exercises are advanced, absolutely no problem to postpone them to a +few months later. If you give them a go, keep in mind that you might run into conflicts, +which we will learn to resolve in the next section.

    +
    +

    (optional) Branch-2: Perform a fast-forward merge

    +
      +

    1. Create a new branch from master and switch to it.

      2. +

    2. Create a couple of commits on the new branch (for instance edit README.md):

      +
      +../_images/git-pre-ff.svg
      +
      3. +

    3. Now switch to master.

      4. +

    4. Merge the new branch to master.

      5. +

    5. Examine the result with git graph.

      6. +

    6. Have you expected the result? Discuss what you see.

      7. +
    + +
    +
    +

    (optional) Branch-3: Rebase a branch (instead of merge)

    +

    As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

    +
      +

    1. Create a new branch, and make a couple of commits on it.

      2. +

    2. Switch back to master, and make a couple of commits on it.

      3. +

    3. Inspect the situation with git graph.

      4. +

    4. Now rebase the new branch on top of master by first switching to the new branch, and then git rebase master.

      5. +

    5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

      6. +
    + +
    +
    +
    +

    Tags#

    +
      +

    • A tag is a pointer to a commit but in contrast to a branch it does not ever move.

      • +

    • We use tags to record particular states or milestones of a project at a given +point in time, like for instance versions (have a look at semantic versioning, +v1.0.3 is easier to understand and remember than 64441c1934def7d91ff0b66af0795749d5f1954a).

      • +

    • There are two basic types of tags: annotated and lightweight.

      • +

    • Use annotated tags since they contain the author and can be cryptographically signed using +GPG, timestamped, and a message attached.

      • +
    +

    Let’s add an annotated tag to our current state of the guacamole recipe:

    +
    $ git tag -a nobel-2020 -m "recipe I made for the 2020 Nobel banquet"
+
    +
    +

    As you may have found out already, git show is a very versatile command. Try this:

    +
    $ git show nobel-2020
+
    +
    +

    For more information about tags see for example +the Pro Git book chapter on the +subject.

    +
    +
    +

    Summary#

    +

    Let us pause for a moment and recapitulate what we have just learned:

    +
    $ git branch               # see where we are
+$ git branch <name>        # create branch <name>
+$ git checkout <name>      # switch to branch <name>
+$ git merge <name>         # merge branch <name> (to current branch)
+$ git branch -d <name>     # delete branch <name>
+$ git branch -D <name>     # delete unmerged branch
+
    +
    +

    Since the following command combo is so frequent:

    +
    $ git branch <name>        # create branch <name>
+$ git checkout <name>      # switch to branch <name>
+
    +
    +

    There is a shortcut for it:

    +
    $ git checkout -b <name>   # create branch <name> and switch to it
+
    +
    +
    +

    Typical workflows#

    +

    With this there are two typical workflows:

    +
    $ git checkout -b new-feature  # create branch, switch to it
+$ git commit                   # work, work, work, ...
+$                              # test
+$                              # feature is ready
+$ git checkout master          # switch to master
+$ git merge new-feature        # merge work to master
+$ git branch -d new-feature    # remove branch
+
    +
    +

    Sometimes you have a wild idea which does not work. +Or you want some throw-away branch for debugging:

    +
    $ git checkout -b wild-idea
+$                              # work, work, work, ...
+$                              # realize it was a bad idea
+$ git checkout master
+$ git branch -D wild-idea      # it is gone, off to a new idea
+$                              # -D because we never merged back
+
    +
    +

    No problem: we worked on a branch, branch is deleted, master is clean.

    +
    +

    Branch-4: Test your understanding

    +

    Which of the following combos (one or more) creates a new branch and makes a commit to it?

    +
      +
    1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
      +
      +
      2. +
    2. $ git add file.txt
+$ git branch new-branch
+$ git checkout new-branch
+$ git commit
+
      +
      +
      3. +
    3. $ git checkout -b new-branch
+$ git add file.txt
+$ git commit
+
      +
      +
      4. +
    4. $ git checkout new-branch
+$ git add file.txt
+$ git commit
+
      +
      +
      5. +
    + +
    +
    +

    Different meanings of “checkout”

    +

    Depending on the context git checkout can do very different actions:

    +
      +

    1. Switch to a branch:

      +
      $ git checkout <branchname>
+
      +
      +
      2. +

    2. Bring the working tree to a specific state (commit):

      +
      $ git checkout <hash>
+
      +
      +
      3. +

    3. Set a file/path to a specific state (throws away all unstaged/uncommitted changes):

      +
      $ git checkout <path/file>
+
      +
      +
      4. +
    +

    This is unfortunate from the user’s point of view but the way Git is implemented it makes sense. +Picture git checkout as an operation that brings the working tree to a specific state. +The state can be a commit or a branch (pointing to a commit).

    +

    In Git 2.23 (2019-08-16) and later this is much nicer:

    +
    $ git switch <branchname>  # switch to a different branch
+$ git restore <path/file>  # discard changes in working directory
+
    +
    +
    +
    +

    Keypoints

    +
      +

    • A branch is a division unit of work, to be merged with other units of work.

      • +

    • A tag is a pointer to a moment in the history of a project.

      • +
    +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/conflicts/index.html b/branch/sphinx-book-theme-old-copybutton/conflicts/index.html new file mode 100644 index 00000000..3f4af862 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/conflicts/index.html @@ -0,0 +1,910 @@ + + + + + + + + + Conflict resolution — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Conflict resolution

    + +
    + +
    +
    +
    + +
    + +
    +

    Conflict resolution#

    +
    +

    Objectives

    +
      +

    • Understand merge conflicts sufficiently well to be able to fix them.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 15 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +
    +

    Conflicts in Git and why they are good#

    +

    Imagine we start with the following text file:

    +
    2 avocados
+1 tbsp cilantro
+2 tsp salt
+
    +
    +

    On branch A somebody modifies:

    +
    1 lime
+2 avocados
+1/2 tbsp cilantro
+2 tsp salt
+
    +
    +

    On branch B somebody else modifies:

    +
    2 avocados
+2 tbsp cilantro
+2 tsp salt
+1/2 onion
+
    +
    +

    When we try to merge Git will figure out that we want the lime and the onion +but does not know whether to reduce or increase the amount of cilantro:

    +
    1 lime
+2 avocados
+??????????????
+2 tsp salt
+1/2 onion
+
    +
    +

    Git is very good at resolving modifications when merging branches and +in most cases a git merge runs smooth and automatic. +Then a merge commit appears (unless fast-forward) without you even noticing.

    +

    But sometimes the same portion of the code/text is modified on two branchesin two different ways and Git issues a conflict. +Then you need to tell Git which version to keep (resolve it).

    +

    There are several ways to do that as we will see.

    +

    Please remember:

    +
      +

    • It is good that Git conflicts exist: Git will not silently overwrite one of +two differing modifications.

      • +

    • Conflicts may look scary, but are not that bad after a little bit of +practice. Also they are luckily rare.

      • +

    • Don’t be afraid of Git because of conflicts. You may not meet some conflicts +using other systems because you simply can’t do the kinds of things you do +in Git.

      • +

    • You can take human measures to reduce them.

      • +
    +
    +
    +

    The human side of conflicts

    +
      +

    • What does it mean if two people do the same thing in two different ways?

      • +

    • What if you work on the same file but do two different things in the different sections?

      • +

    • What if you do something, don’t tell someone from 6 months, and then try to combine it with other people’s work?

      • +

    • How are conflicts avoided in other work? (Only one person working at once? +Declaring what you are doing before you start, if there is any chance someone +else might do the same thing, helps.)

      • +

    • Minor conflicts (two people revise spelling) vs semantic (two people rewrite +a function to add two different new features). How did Git solve these in +branching/merging easily?

      • +
    +
    +

    Now we can go to show how Git controls when there is actually a conflict.

    +
    +
    +

    Preparing a conflict#

    +
    +

    Instructor note

    +

    We do the following together as type-along.

    +
    +

    We will make two branches, make two conflicting changes (both increase and +decrease the amount of cilantro), and later we will try to merge them +together.

    +
      +

    • Create two branches from master: one called like-cilantro, one called dislike-cilantro:

      +
      $ git branch like-cilantro master
+$ git branch dislike-cilantro master
+
      +
      +
      • +

    • On the two branches make different modifications to the amount of the same ingredient:

      • +

    • On the branch like-cilantro we have the following change:

      +
      $ git diff master like-cilantro
+
      +
      +
      diff --git a/ingredients.txt b/ingredients.txt
+index a83af39..83f2f94 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 2 tbsp cilantro
+ * 2 avocados
+ * 1 lime
+ * 1 tsp salt
+
      +
      +
      • +

    • And on the branch dislike-cilantro we have the following change:

      +
      $ git diff master dislike-cilantro
+
      +
      +
      diff --git a/ingredients.txt b/ingredients.txt
+index a83af39..2f60e23 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,4 +1,4 @@
+-* 1 tbsp cilantro
++* 0.5 tbsp cilantro
+ * 2 avocados
+ * 1 lime
+ * 1 tsp salt
+
      +
      +
      • +
    +
    +
    +

    Merging conflicting changes#

    +

    What do you expect will happen when we try to merge these two branches into +master?

    +

    The first merge will work:

    +
    $ git checkout master
+$ git status
+$ git merge like-cilantro
+
+Updating 4b3e3cc..55d1ce2
+Fast-forward
+ ingredients.txt | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
    +
    +

    But the second will fail:

    +
    $ git merge dislike-cilantro
+
+Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
    +
    +

    Without conflict Git would have automatically created a merge commit, +but since there is a conflict, Git did not commit:

    +
    $ git status
+
+On branch master
+You have unmerged paths.
+  (fix conflicts and run "git commit")
+  (use "git merge --abort" to abort the merge)
+
+Unmerged paths:
+  (use "git add <file>..." to mark resolution)
+
+	both modified:   ingredients.txt
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
    +
    +

    Git won’t decide which to take and we need to decide. Observe how Git gives +us clear instructions on how to move forward.

    +

    Let us inspect the conflicting file:

    +
    $ cat ingredients.txt
+
+<<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 0.5 tbsp cilantro
+>>>>>>> dislike-cilantro
+* 2 avocados
+* 1 lime
+* 1 tsp salt
+* 1/2 onion
+
    +
    +

    Git inserted resolution markers (the <<<<<<<, >>>>>>>, and =======).

    +

    Try also git diff:

    +
    $ git diff
+
    +
    +
    diff --cc ingredients.txt
+index 83f2f94,2f60e23..0000000
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@@ -1,4 -1,4 +1,8 @@@
+++<<<<<<< HEAD
+ +* 2 tbsp cilantro
+++=======
++ * 0.5 tbsp cilantro
+++>>>>>>> dislike-cilantro
+  * 2 avocados
+  * 1 lime
+  * 1 tsp salt
+
    +
    +

    git diff now only shows the conflicting part, nothing else.

    +

    We have to resolve the conflict. +We will discuss 3 different ways to do this.

    +
    +
    +

    Manual resolution#

    +
    <<<<<<< HEAD
+* 2 tbsp cilantro
+=======
+* 0.5 tbsp cilantro
+>>>>>>> dislike-cilantro
+
    +
    +

    We have to edit the code/text between the resolution markers. You +only have to care about what Git shows you: Git stages all files +without conflicts and leaves the files with conflicts unstaged.

    +
    +

    Note

    +

    Steps to resolve a conflict:

    +
      +

    • Check status with git status and git diff.

      • +

    • Decide what you keep (the one, the other, or both or something +else). Edit the file to do this.

      +
        +

      • Remove the resolution markers, if not already done.

        • +

      • The file(s) should now look exactly how you want them.

        • +
      +
      • +

    • Check status with git status and git diff.

      • +

    • Tell Git that you have resolved the conflict with git add ingredients.txt +(if you use the Emacs editor with a certain plugin the editor may stage the +change for you after you have removed the conflict markers).

      • +

    • Verify the result with git status.

      • +

    • Finally commit the merge with just git commit - everything is pre-filled.

      • +
    +
    +
    +
    +

    Exercise: Create and resolve a conflict#

    +
    +

    Conflict-1: Create another conflict and resolve

    +

    In this exercise, we repeat almost exactly what we did above with a +different ingredient.

    +
      +

    1. Create two branches before making any modifications.

      2. +

    2. Again modify some ingredient on both branches.

      3. +

    3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

      4. +

    4. What happens if you apply the same modification on both branches?

      5. +

    5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into master you will not see a conflict. Can you +explain, why it is different this time?

      6. +
    + +
    +
    +
    +

    Optional exercises with conflict resolution#

    +
    +

    (optional) Conflict-2: Resolve a conflict when rebasing a branch

    +
      +

    1. Create two branches where you anticipate a conflict.

      2. +

    2. Try to merge them and observe that indeed they conflict.

      3. +

    3. Abort the merge with git merge --abort.

      4. +

    4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

      5. +
    + +
    +
    +

    (optional) Conflict-3: Resolve a conflict using mergetool

    +
      +

    • Again create a conflict (for instance disagree on the number of avocados).

      • +

    • Stop at this stage:

      +
      Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
      +
      +
      • +

    • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

      +
      $ git mergetool
+
      +
      +
      +Conflict resolution using mergetool +
      +
      • +

    • Your current branch is left, the branch you merge is right, result is in the middle.

      • +

    • After you are done, close and commit, git add is not needed when using git mergetool.

      • +
    +

    If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

    +

    To view what will be removed:

    +
    $ git clean -n
+
    +
    +

    To remove:

    +
    $ git clean -f
+
    +
    +

    To configure Git to avoid creating backups at all:

    +
    $ git config --global mergetool.keepBackup false
+
    +
    +
    +
    +
    +
    +

    Using “ours” or “theirs” strategy#

    +
      +

    • Sometimes you know that you want to keep “ours” version (version on this branch) +or “theirs” (version on the merged branch).

      • +

    • Then you do not have to resolve conflicts manually.

      • +

    • See merge strategies.

      • +
    +

    Example:

    +
    $ git merge -s recursive -Xours less-avocados  # merge and in doubt take the changes from current branch
+
    +
    +

    Or:

    +
    $ git merge -s recursive -Xtheirs less-avocados  # merge and in doubt take the changes from less-avocados branch
+
    +
    +
    +
    +
    +

    Aborting a conflicting merge#

    +

    Sometimes you get a merge conflict but realize that you can’t solve it without +talking to a colleague (who created the other change) first. What to do?

    +

    You can abort the merge and postponing conflict resolution by resetting the +repository to HEAD (last committed state):

    +
    $ git merge --abort
+
    +
    +

    The repository looks then exactly as it was before the merge.

    +
    +
    +
    +

    Avoiding conflicts#

    +
      +

    • Human measures

      +
        +

      • Think and plan to which branch you will commit to.

        • +

      • Do not put unrelated changes on the same branch.

        • +
      +
      • +

    • Collaboration measures

      +
        +

      • Open an issue and discuss with collaborators before starting a long-living

        • +

      • branch.

        • +
      +
      • +

    • Project layout measures

      +
        +

      • Modifying global data often causes conflicts.

        • +

      • Modular programming minimizes risk of conflicts.

        • +
      +
      • +

    • Technical measures

      +
        +

      • Push early and often - this is one of the happy, +rare circumstances when everyone doing the selfish thing (pushing as +early as practical) results in best case for everyone!

        • +

      • Pull/rebase often to keep up to date with upstream.

        • +

      • Resolve conflicts early.

        • +
      +
      • +
    +
    +

    Discussion

    +

    Discuss how Git handles conflicts compared to the Google Drive.

    +
    +
    +

    Keypoints

    +
      +

    • Conflicts often appear because of not enough communication or not optimal +branching strategy.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/customizing/index.html b/branch/sphinx-book-theme-old-copybutton/customizing/index.html new file mode 100644 index 00000000..abd9e1fe --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/customizing/index.html @@ -0,0 +1,457 @@ + + + + + + + + + Customizing Git — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Customizing Git

    + +
    +
    + +
    +

    Contents

    +
    + +
    +
    +
    +
    + +
    + +
    +

    Customizing Git#

    +
    +

    Shell prompt#

    +
    +

    Instructor note

    +

    Here the instructor can demonstrate how a context-aware and Git-aware shell +prompt can look like.

    +
    +

    You can make your shell display contextual information about +your Git state even at all times.

    +

    Here are few example projects that make this possible and easy:

    + +
    +
    +

    Editors#

    +

    Here we need more text …

    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/exercises/index.html b/branch/sphinx-book-theme-old-copybutton/exercises/index.html new file mode 100644 index 00000000..68f58086 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/exercises/index.html @@ -0,0 +1,1150 @@ + + + + + + + + + List of exercises — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    List of exercises

    + +
    +
    + +
    +

    Contents

    +
    + +
    +
    +
    +
    + +
    + +
    +

    List of exercises#

    +
    +

    Summary#

    +

    Basics:

    + +

    Branching and merging:

    + +

    Conflict resolution:

    + +

    Inspecting history:

    + +

    Using the Git staging area:

    + +

    Undoing and recovering:

    + +

    Interrupted work:

    + +
    +
    +

    Full list#

    +

    This is a list of all exercises and solutions in this lesson, mainly +as a reference for helpers and instructors. This list is +automatically generated from all of the other pages in the lesson. +Any single teaching event will probably cover only a subset of these, +depending on their interests.

    +
    +

    Motivation#

    +

    In motivation.md:

    + +
    +
    +

    Basics#

    +

    In basics.md:

    +
    +

    Basic-1: Record changes

    +

    Add 1/2 onion to ingredients.txt and also the instruction +to “enjoy!” to instructions.txt. Do not stage the changes yet.

    +

    When you are done editing the files, try git diff:

    +
    $ git diff
+
    +
    +

    You will see (can you identify in there the two added lines?):

    +
    diff --git a/ingredients.txt b/ingredients.txt
+index 2607525..ec0abc6 100644
+--- a/ingredients.txt
++++ b/ingredients.txt
+@@ -1,3 +1,4 @@
+ * 2 avocados
+ * 1 lime
+ * 2 tsp salt
++* 1/2 onion
+diff --git a/instructions.txt b/instructions.txt
+index 6a8b2af..f7dd63a 100644
+--- a/instructions.txt
++++ b/instructions.txt
+@@ -3,3 +3,4 @@
+ * squeeze lime
+ * add salt
+ * and mix well
++* enjoy!
+
    +
    +

    Now first stage and commit each change separately (what happens when we leave out the -m flag?):

    +
    $ git add ingredients.txt
+$ git commit -m "add half an onion"
+$ git add instructions.txt
+$ git commit                   # <-- we have left out -m "..."
+
    +
    +

    When you leave out the -m flag, Git should open an editor where you can edit +your commit message. This message will be associated and stored with the +changes you made. This message is your chance to explain what you’ve done and +convince others (and your future self) that the changes you made were +justified. Write a message and save and close the file.

    +

    When you are done committing the changes, experiment with these commands:

    +
    $ git log
+$ git log --stat
+$ git log --oneline
+
    +
    +
    +

    In basics.md:

    +
    +

    (optional) Basic-2: Comparing and showing commits

    +
      +

    1. Inspect differences between commit hashes with git diff <hash1> <hash2>.

      2. +

    2. Have a look at specific commits with git show <hash>.

      3. +
    +
    +

    In basics.md:

    +
    +

    (optional) Basic-3: Visual diff tools

    +
      +

    • Make further modifications and experiment with git difftool (requires installing one of the visual diff tools):

      • +
    +

    On Windows or Linux:

    +
    $ git difftool --tool=meld <hash>
+
    +
    +

    On macOS:

    +
    $ git difftool --tool=opendiff <hash>
+
    +
    +
    +Git difftool using meld +
    +

    Git difftool using meld.#

    +
    +
    +

    You probably want to use the same visual diff tool every time and +you can configure Git for that:

    +
    $ git config --global diff.tool meld
+
    +
    +
    +

    In basics.md:

    +
    +

    (optional) Basic-4: Renaming and removing files

    +
      +

    1. Create a new file, git add and git commit the file.

      2. +

    2. Rename the file with git mv (you will need to git commit the rename).

      3. +

    3. Use git log --oneline and git status.

      4. +

    4. Remove the file with git rm (again you need to git commit the change).

      5. +

    5. Inspect the history with git log --stat.

      6. +
    +
    +

    In basics.md:

    +
    +

    Basic-5: Test your understanding

    +

    Which command(s) below would save the changes of myfile.txt +to an existing local Git repository?

    +
      +
    1. $ git commit -m "my recent changes"
+
      +
      +
      2. +
    2. $ git init myfile.txt
+$ git commit -m "my recent changes"
+
      +
      +
      3. +
    3. $ git add myfile.txt
+$ git commit -m "my recent changes"
+
      +
      +
      4. +
    4. $ git commit -m myfile.txt "my recent changes"
+
      +
      +
      5. +
    + +
    +
    +
    +

    Branching and merging#

    +

    In branches.md:

    +
    +

    Branch-1: Create and commit to branches

    +

    In this exercise, you will create another new branch and few more commits. +We will use this in the next section, to practice +merging.

    +
      +

    • Change to the branch master.

      • +

    • Create another branch called less-salt

      +
        +

      • Note! makes sure you are on master branch when you create the less-salt branch

        • +

      • A safer way would be to explicitly mention to create from the master branch +as shown below

        • +
      +
      • +
    +
    $ git branch less-salt master
+
    +
    +
      +

    • Where you reduce the amount of salt.

      • +

    • Commit your changes to the less-salt branch.

      • +
    +

    Use the same commands as we used above.

    +

    We now have three branches (in this case HEAD points to less-salt):

    +
    $ git branch
+
+  experiment
+* less-salt
+  master
+
+$ git graph
+
+* bf59be6 (HEAD -> less-salt) reduce amount of salt
+| * 6feb49d (experiment) maybe little bit less cilantro
+| * 7cf6d8c let us try with some cilantro
+|/
+* dd4472c (master) we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +

    Here is a graphical representation of what we have created:

    +
    +../_images/git-branch-2.svg
    +
      +

    • Now switch to master.

      • +

    • Add and commit the following README.md to master:

      • +
    +
    # Guacamole recipe
+
+Used in teaching Git.
+
    +
    +

    Now you should have this situation:

    +
    $ git graph
+
+* 40fbb90 (HEAD -> master) draft a readme
+| * bf59be6 (less-salt) reduce amount of salt
+|/
+| * 6feb49d (experiment) maybe little bit less cilantro
+| * 7cf6d8c let us try with some cilantro
+|/
+* dd4472c we should not forget to enjoy
+* 2bb9bb4 add half an onion
+* 2d79e7e adding ingredients and instructions
+
    +
    +
    +../_images/git-branch-3.svg
    +

    And for comparison this is how it looks on GitHub.

    +
    +

    In branches.md:

    +
    +

    (optional) Branch-2: Perform a fast-forward merge

    +
      +

    1. Create a new branch from master and switch to it.

      2. +

    2. Create a couple of commits on the new branch (for instance edit README.md):

      +
      +../_images/git-pre-ff.svg
      +
      3. +

    3. Now switch to master.

      4. +

    4. Merge the new branch to master.

      5. +

    5. Examine the result with git graph.

      6. +

    6. Have you expected the result? Discuss what you see.

      7. +
    + +
    +

    In branches.md:

    +
    +

    (optional) Branch-3: Rebase a branch (instead of merge)

    +

    As an alternative to merging branches, one can also rebase branches. +Rebasing means that the new commits are replayed on top of another branch +(instead of creating an explicit merge commit). +Note that rebasing changes history and should not be done on public commits!

    +
      +

    1. Create a new branch, and make a couple of commits on it.

      2. +

    2. Switch back to master, and make a couple of commits on it.

      3. +

    3. Inspect the situation with git graph.

      4. +

    4. Now rebase the new branch on top of master by first switching to the new branch, and then git rebase master.

      5. +

    5. Inspect again the situation with git graph. Notice that the commit hashes have changed - think about why!

      6. +
    + +
    +

    In branches.md:

    +
    +

    Branch-4: Test your understanding

    +

    Which of the following combos (one or more) creates a new branch and makes a commit to it?

    +
      +
    1. $ git branch new-branch
+$ git add file.txt
+$ git commit
+
      +
      +
      2. +
    2. $ git add file.txt
+$ git branch new-branch
+$ git checkout new-branch
+$ git commit
+
      +
      +
      3. +
    3. $ git checkout -b new-branch
+$ git add file.txt
+$ git commit
+
      +
      +
      4. +
    4. $ git checkout new-branch
+$ git add file.txt
+$ git commit
+
      +
      +
      5. +
    + +
    +
    +
    +

    Conflict resolution#

    +

    In conflicts.md:

    +
    +

    Conflict-1: Create another conflict and resolve

    +

    In this exercise, we repeat almost exactly what we did above with a +different ingredient.

    +
      +

    1. Create two branches before making any modifications.

      2. +

    2. Again modify some ingredient on both branches.

      3. +

    3. Merge one, merge the other and observe a conflict, resolve the conflict and commit the merge.

      4. +

    4. What happens if you apply the same modification on both branches?

      5. +

    5. If you create a branch like-avocados, commit a change, then from this +branch create another banch dislike-avocados, commit again, and try to +merge both branches into master you will not see a conflict. Can you +explain, why it is different this time?

      6. +
    + +
    +

    In conflicts.md:

    +
    +

    (optional) Conflict-2: Resolve a conflict when rebasing a branch

    +
      +

    1. Create two branches where you anticipate a conflict.

      2. +

    2. Try to merge them and observe that indeed they conflict.

      3. +

    3. Abort the merge with git merge --abort.

      4. +

    4. What do you expect will happen if you rebase one branch on top of the +other? Do you anticipate a conflict? Try it out.

      5. +
    + +
    +

    In conflicts.md:

    +
    +

    (optional) Conflict-3: Resolve a conflict using mergetool

    +
      +

    • Again create a conflict (for instance disagree on the number of avocados).

      • +

    • Stop at this stage:

      +
      Auto-merging ingredients.txt
+CONFLICT (content): Merge conflict in ingredients.txt
+Automatic merge failed; fix conflicts and then commit the result.
+
      +
      +
      • +

    • Instead of resolving the conflict manually, use a visual tool +(requires installing one of the visual diff tools):

      +
      $ git mergetool
+
      +
      +
      +Conflict resolution using mergetool +
      +
      • +

    • Your current branch is left, the branch you merge is right, result is in the middle.

      • +

    • After you are done, close and commit, git add is not needed when using git mergetool.

      • +
    +

    If you have not instructed Git to avoid creating backups when using mergetool, then to be on +the safe side there will be additional temporary files created. To remove those you can do +a git clean after the merging.

    +

    To view what will be removed:

    +
    $ git clean -n
+
    +
    +

    To remove:

    +
    $ git clean -f
+
    +
    +

    To configure Git to avoid creating backups at all:

    +
    $ git config --global mergetool.keepBackup false
+
    +
    +
    +
    +
    +

    Inspecting history#

    +

    In archaeology.md:

    +
    +

    History-1: Explore basic archaeology commands

    +

    Let us explore the value of these commands in an exercise. Future +exercises do not depend on this, so it is OK if you do not complete +it fully.

    +

    In-person workshops: We recommend that you +do this exercise in groups of two and discuss with your neighbors.

    +

    Video workshops: We will group you in breakout rooms of ~4 persons where you +can work and discuss together. A helper or instructor will pop in to help out. +In the group one participant can share their screen and others +in the group help out, discuss, and try to follow along. +Please write down questions in the collaborative notes. +After 15-20 minutes we will bring you back into the main room and discuss.

    +

    Exercise steps:

    +
      +

    • Clone this repository: +https://github.com/networkx/networkx.git. +Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release:

      +
      $ git clone https://github.com/networkx/networkx.git
+$ cd networkx
+$ git checkout -b exercise networkx-2.6.3
+
      +
      +
      • +
    +

    Then using the above toolbox try to:

    +
      +

    1. Find the code line which contains "Logic error in degree_correlation".

      2. +

    2. Find out when this line was last modified or added. Find the actual commit which modified that line.

      3. +

    3. Inspect that commit with git show.

      4. +

    4. Create a branch pointing to the past when that commit was created to be +able to browse and use the code as it was back then.

      5. +

    5. How would can you bring the code to the commit precisely before that line was last modified?

      6. +
    + +
    +

    In archaeology.md:

    +
    +

    (optional) History-2: Use git bisect to find the bad commit

    +

    In this exercise, we use git bisect on an example repository. It +is OK if you do not complete this exercise fully.

    +

    Begin by cloning https://github.com/coderefinery/git-bisect-exercise.

    +

    Motivation

    +

    The motivation for this exercise is to be able to do archaeology with Git on a +source code where the bug is difficult to see visually. Finding the offending +commit is often more than half the debugging.

    +

    Background

    +

    The script get_pi.py approximates pi using terms of the Nilakantha series. It +should produce 3.14 but it does not. The script broke at some point and +produces 3.57 using the last commit:

    +
    $ python get_pi.py
+
+3.57
+
    +
    +

    At some point within the 500 first commits, an error was introduced. The only +thing we know is that the first commit worked correctly.

    +

    Your task

    +
      +

    • Clone this repository and use git bisect to find the commit which +broke the computation +(solution - spoiler alert!).

      • +

    • Once you have found the offending commit, also practice navigating to the last good commit.

      • +

    • Bonus exercise: +Write a script that checks for a correct result and use git bisect run to +find the offending commit automatically +(solution - spoiler alert!).

      • +
    +

    Video workshops: We will group you in breakout rooms of ~4 persons where you +can work and discuss together. A helper or instructor will pop in to help out. +Please write down questions in the collaborative notes. +After 15-20 minutes we will bring you back into the main room and discuss.

    +

    Hints

    +

    Finding the first commit:

    +
    $ git log --oneline | tail -n 1
+
    +
    +

    How to navigate to the parent of a commit with hash somehash:

    +
    $ # create branch pointing to the parent of somehash
+$ git checkout -b branchname somehash~1
+
+$ # instead of a tilde you can also use this
+$ git checkout -b branchname somehash^
+
    +
    +
    +
    +
    +

    Using the Git staging area#

    +

    In staging-area.md:

    +
    +

    Staging-1: Perform an interactive commit

    +

    One option to help us create nice logical commits is to stage interactively +with git commit --patch:

    +
      +

    1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

      2. +

    2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

      3. +

    3. Do it again for the other change.

      4. +

    4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

      5. +

    5. When would this be useful?

      6. +
    + +
    +

    In staging-area.md:

    +
    +

    Staging-2: Use the staging area to make a commit in two steps

    +
      +

    1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

      2. +

    2. Use git add to stage one of the changes.

      3. +

    3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

      4. +

    4. Feel some regret and unstage the staged change.

      5. +
    +
    +
    +
    +

    Undoing and recovering#

    +

    In recovering.md:

    +
    +

    Undoing-1: Revert a commit

    +
      +

    • Create a commit (commit A).

      • +

    • Revert the commit with git revert (commit B).

      • +

    • Inspect the history with git log --oneline.

      • +

    • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

      • +
    +
    +

    In recovering.md:

    +
    +

    Undoing-2: Modify a previous commit

    +
      +

    1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

      2. +

    2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

      3. +

    3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

      4. +
    + +
    +

    In recovering.md:

    +
    +

    Undoing-3: Destroy our experimentation in this episode

    +

    After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

    +
      +

    • First, we will look at our history (git log/git graph) and +find the last commit <hash> before our tests.

      • +

    • Then, we will git reset --hard <hash> to that.

      • +

    • Then, git graph again to see what happened.

      • +
    +
    $ git log --oneline
+
+d62ad3e (HEAD -> master) Revert "not sure this is a good idea"
+f960dd3 not sure this is a good idea
+dd4472c we should not forget to enjoy
+2bb9bb4 add half an onion
+2d79e7e adding ingredients and instructions
+
+$ git reset --hard dd4472c
+
+HEAD is now at dd4472c we should not forget to enjoy
+
+$ git log --oneline
+
+dd4472c (HEAD -> master) we should not forget to enjoy
+2bb9bb4 add half an onion
+2d79e7e adding ingredients and instructions
+
    +
    +
    +

    In recovering.md:

    +
    +

    Undoing-4: Test your understanding

    +
      +

    1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

      2. +

    2. Is it OK to modify commits that nobody has seen yet?

      3. +

    3. What situations would justify to modify the Git history and possibly remove commits?

      4. +
    + +
    +
    +
    +

    Interrupted work#

    +

    In interrupted.md:

    +
    +

    Interrupted-1: Stash some uncommitted work

    +
      +

    1. Make a change.

      2. +

    2. Check status/diff, stash the change, check status/diff again.

      3. +

    3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

      4. +

    4. Pop off the stash you saved, check status/diff.

      5. +

    5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

      6. +

    6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

      7. +

    7. Advanced: what does git graph show when you have something +stashed?

      8. +
    + +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/genindex/index.html b/branch/sphinx-book-theme-old-copybutton/genindex/index.html new file mode 100644 index 00000000..959d37ab --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/genindex/index.html @@ -0,0 +1,330 @@ + + + + + + + + Index — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    +
    + + +
    +
    +
    +
    +
    + +
    +

    + +
    +
    + +
    +
    +
    +
    + +
    + + +

    Index

    + +
    + +
    + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/guide/index.html b/branch/sphinx-book-theme-old-copybutton/guide/index.html new file mode 100644 index 00000000..c00e60bd --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/guide/index.html @@ -0,0 +1,726 @@ + + + + + + + + + Instructor guide — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Instructor guide

    + +
    + +
    +
    +
    + +
    + +
    +

    Instructor guide#

    +
    +

    Why we teach this lesson#

    +

    Everyone should be using a version control system for their work, even if they’re working alone. +There are many version control systems out there, but Git is an industry standard and even if one uses another +system chances are high one still encounters Git repositories.

    +

    Specific motivations:

    +
      +

    • Code easily becomes a disaster without version control

      • +

    • Mistakes happen - Git offers roll-back functionality and easy backup mechanism

      • +

    • One often needs to work on multiple things in parallel - branches solve that problem

      • +

    • Git enables people to collaborate on code or text without stepping on each other’s toes

      • +

    • Reproducibility: You can specify exact versions in publications enabling others to reproduce your work, +and if bugs are found one can find out exactly when it was introduced

      • +
    +

    Many learners in a CodeRefinery workshop have developed code for a few years. A majority have +already encountered Git and have used it to some extent, but in most cases they do not yet feel +comfortable with it. They lack a good mental model of how Git operates and are afraid of making mistakes. +Other learners have never used Git before. +This lesson teaches how things are done in Git, which is useful for the newcomers, +but also how Git operates (e.g. what commits and branches really are) and what are some good +practices (e.g. how to use the staging area), which is useful for more experienced users.

    +
    +
    +

    Intended learning outcomes#

    +

    By the end of this lesson, learners should:

    +
      +

    • realize that version control is very important and Git is a valuable tool to learn and use

      • +

    • understand that Git is configurable and know how to set basic configurations

      • +

    • be able to set up Git repositories and make commits

      • +

    • understand that information on commits, branches etc. are stored under .git/, and have a +mental model of how that relates to the working directory

      • +

    • have a mental model of the different stages a file can have in Git (untracked, modified, staged, unmodified)

      • +

    • know how to write good commit messages

      • +

    • have an idea of how the staging area can be used to craft good commits

      • +

    • know how to undo commits using git revert and discard changes using git checkout

      • +

    • understand that git checkout can be dangerous if changes have not been staged

      • +

    • know how to create branches and switch between branches

      • +

    • have a mental model of how branches work and get used to thinking of branches in a graphical (tree-structure) way

      • +

    • know how to merge branches and understand what that means in terms of combining different modifications

      • +

    • know how to resolve conflicts, or to abort conflicting merges

      • +

    • realize that conflicts are generally a good thing since they prevent incorrect merges

      • +

    • be able to set up a repository on GitHub and connect it with local repository

      • +

    • push changes to a remote repository

      • +

    • know a few ways to search through a repository and its history

      • +

    • know about the different meanings of git checkout, and realize how they’re in fact similar

      • +
    +
    +
    +

    How to teach this lesson#

    +
    +

    Take first editor steps slowly#

    +

    Some participants will be new to using a terminal text editor so please open, +edit, and close the editor (Nano) slowly in first type-along sessions and +exercises to avoid that participants will fall behind the instructor. At one +point a student did not follow the file edits of the instructor, and to correct +the mistake they had to do a manual merge, which they were not ready for.

    +
    +
    +

    How to use the exercises#

    +

    Most episodes have standard exercises followed by optional (often more advanced) exercises +for more experienced learners so they don’t get bored waiting for the newcomers. +The instructor should briefly introduce the exercises and mention that after finishing the +standard exercise (and indicating that using the green sticky) the learners can move on to the +optional ones if they wish. When at least half of the learners have raised the green sticky +the instructor should go through the standard exercise to describe its most important take-home messages. +It’s also fine to briefly go though important points from the optional exercises, but don’t spend +too much time on it since everyone will not have attempted them.

    +
    +
    +

    “Test your understanding” exercises#

    +

    Some episodes have a “test your understanding” exercise at the end which is intended as formative assessment, +i.e. an activity that provides feedback to instructors and learners on whether learning objectives are being met. +The instructor should end each episode by posing the “test your understanding” multiple-choice question, +giving learners a minute to think about it, and then asking for the right answer or asking learners to raise their +hands to signal which answer they think is correct.

    +
    +
    +

    Inspecting history#

    +

    Key lesson is how to find when something is broken or what commit has broken +the code.

    +

    It can be useful to emphasize that it can be really valuable to be able to +search through the history of a project efficiently to find when bugs were +introduced or when something changed and why. Also show that git annotate +and git show are available on GitHub and GitLab.

    +

    When discussing git annotate and git bisect the “when” is more important +than “who”. It is not to blame anybody but rather to find out whether published +results are affected.

    +

    Discuss how one would find out this information without version control.

    +

    Questions to involve participants:

    +
      +

    • Have you ever found a bug in your code and wondered whether it has affected published results?

      • +

    • Have you ever wondered when, and by whom, a particular line of code was introduced?

      • +

    • Have you ever found out that a code behaves differently than it used to but you are not sure when +precisely this changed?

      • +
    +

    Confusion during git bisect exercise:

    +

    Learners may get stuck in the git bisect exercise if they incorrectly assign a commit +as bad or good. +To leave the bisect mode and return to the commit before git bisect start was issued, +one can do

    +
    $ git bisect reset
+
    +
    +

    and start over if needed.

    +
    +
    +

    Live better than reading the website material#

    +

    It is better to demonstrate the commands live and type-along. Ideally connecting +to examples discussed earlier.

    +
    +
    +

    Log your history in a separate window#

    +

    The screencasting (shell window cheatsheet) hints have been moved to +the presenting +manual.

    +
    +
    +

    Create a cheatsheet on the board#

    +

    For in-person workshops, create a “cheatsheet” on the board as you go. After +each command is introduced, write it on the board. After each module, make sure +you haven’t forgotten anything. Re-create and expand in future git lessons. +One strategy is:

    +
      +

    • a common section for basic commands: init, config``clone, help, stash

      • +

    • info commands, can be run anytime: status, log, diff, graph

      • +

    • A section for all the commands that move code from different states: +add, commit, etc. See the visual cheat sheet below.

      • +
    +

    You can get inspired by http://www.ndpsoftware.com/git-cheatsheet.html +to make your cheatsheet, but if you show this make it clear there are +far, far more commands on there than you need to know right now., and +it’s probably too confusing to use after this course. But, the idea +of commands moving from the “working dir”, “staging area”, “commits”, +etc is good.

    +
    +Example cheat sheet +
    +

    Example cheat sheet.#

    +
    +
    +

    We also recommend to draw simple diagrams up on the board (e.g.: working +directory - staging area - repository with commands to move between) and keep +them there for students to refer to.

    +
    +
    +

    Draw a graph on the board#

    +

    Draw the standard commit graphs on the board early on - you know, the +thing in all the diagrams. Keep it updated all the time. After the +first few samples, you can basically keep using the same graph the +whole lesson. When you are introducing new commands, explain and +update the graph first, then run git graph, then do the command, +then look at git graph again.

    +
    +
    +

    Repeat the following points#

    +
      +

    • Always check git status, git diff, and git graph (our alias) before and +after every command until you get used to things. These give you a clear view +into what is going on, the key to knowing what you are doing. Even +after you are used to things… anytime you do something you do +infrequently, it’s good to check.

      • +

    • git graph is a direct representation of what we are drawing on the +board and should constantly be compared to it.

      • +

    • Once you git add something, it’s almost impossible to lose it. +This is used all the time, for example once you commit or even add +it is hard to lose. Commit before you merge or rebase. And so on.

      • +
    +
    +
    +

    Start from identical environment#

    +

    You probably have a highly optimized bash and git environment - one +that is different from students. Move .gitconfig and .bashrc out +of the way before you start so that your environment is identical to +what students have.

    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/index.html b/branch/sphinx-book-theme-old-copybutton/index.html new file mode 100644 index 00000000..047543fa --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/index.html @@ -0,0 +1,466 @@ + + + + + + + + + Introduction to version control with Git — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + +
    +
    + + +
    +
    +
    +
    +
    + +
    +

    Introduction to version control with Git

    + +
    +
    + +
    +
    +
    +
    + +
    + +
    +

    Introduction to version control with Git#

    +

    This is the introductory lesson to version control using +Git. It is assumed to be the very first thing +done in a course.

    +

    Our philosophy is that we start from own local repository, branching and +merging (locally), and a brief introduction to pushing to remotes. In +the separate collaborative git +lesson, we teach more use of +remote repositories and good collaborative workflows. We try to stick to +simple workflows, just enough for researchers who are not obsessed with +Git to be able to work well. We try to avoid commands which might get +you into a confusing state.

    +

    The goals of the module as a whole are that the user will feel +comfortable about staging changes, committing them, merging, and +branching.

    +
    +

    Prerequisites

    +
      +

    • A reasonably recent version of Git is installed. For installation +instructions see the CodeRefinery installation +instructions.

      • +

    • Being comfortable with the command line. No expertise is required, +but the lesson will be mostly taken from the command line.

      • +

    • Students should be familiar with using a text editor on their +system. Emacs and Vim are excellent choices if you know how to use +them but Nano or Notepad on Windows are sufficient.

      • +

    • Git should be configured prior to the lesson following our +installation +instructions.

      • +

    • A GitHub user account (but alternatives +exist, see below).

      • +
    +
    +
    +

    Core episodes

    + +
    +
    +

    Optional episodes

    + +
    +
    +

    Reference

    + +
    +
    +

    Note

    +

    Why GitHub?

    +

    In this introduction we will mention and use +GitHub but also +GitLab and +Bitbucket allow similar workflows and +basically everything that we will discuss is transferable. With this +material and these exercises we do not endorse the company +GitHub. We have chosen to demonstrate a +number of concepts using examples with +GitHub because it is currently the most +popular web platform for hosting Git repositories and the chance is +high that you will interact with +GitHub-based repositories even if you choose +to host your Git repository on another platform.

    +

    Course participants are most welcome to use our Nordic research +software repository platform +instead, for more information see +https://coderefinery.org/repository/.

    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/interrupted/index.html b/branch/sphinx-book-theme-old-copybutton/interrupted/index.html new file mode 100644 index 00000000..21484190 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/interrupted/index.html @@ -0,0 +1,574 @@ + + + + + + + + + Interrupted work — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Interrupted work

    + +
    + +
    +
    +
    + +
    + +
    +

    Interrupted work#

    +
    +

    Objectives

    +
      +

    • Learn to switch context or abort work without panicking.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 10 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +
    +

    Keypoints

    +
      +

    • There is almost never reason to clone a fresh copy to complete a task that +you have in mind.

      • +
    +
    +
    +

    Frequent situation: interrupted work#

    +

    We all wish that we could write beautiful perfect code. But the real world is +much more chaotic:

    +
      +

    • You are in the middle of a “Jackson-Pollock-style” debugging spree with 27 modified files +and debugging prints everywhere.

      • +

    • Your colleague comes in and wants you to fix/commit something right now.

      • +

    • What to do?

      • +
    +

    Git provides lots of ways to switch tasks without ruining everything.

    +
    +
    +

    Option 1: Stashing#

    +

    The stash is the first and easiest place to temporarily “stash” +things.

    +
      +

    • git stash will put working directory and staging area changes +away. Your code will be same as last commit.

      • +

    • git stash pop will return to the state you were before. Can give it a list.

      • +

    • git stash list will list the current stashes.

      • +

    • git stash save NAME is like the first, but will give it a name. +Useful if it might last a while.

      • +

    • git stash save [-p] [filename] will stash certain files files +and/or by patches.

      • +

    • git stash drop will drop the most recent stash (or whichever stash +you give).

      • +

    • The stashes form a stack, so you can stash several batches of modifications.

      • +
    +
    +

    Exercise: Stashing#

    +
    +

    Interrupted-1: Stash some uncommitted work

    +
      +

    1. Make a change.

      2. +

    2. Check status/diff, stash the change, check status/diff again.

      3. +

    3. Make a separate, unrelated change which doesn’t touch the same +lines. Commit this change.

      4. +

    4. Pop off the stash you saved, check status/diff.

      5. +

    5. Optional: Do the same but stash twice. Also check git stash list. +Can you pop the stashes in the opposite order?

      6. +

    6. Advanced: What happens if stashes conflict with other changes? Make +a change and stash it. Modify the same line or one right above or +below. Pop the stash back. Resolve the conflict. Note there is no +extra commit.

      7. +

    7. Advanced: what does git graph show when you have something +stashed?

      8. +
    + +
    +
    +
    +
    +

    Option 2: Create branches#

    +

    You can use branches almost like you have already been doing if you +need to save some work. You need to do something else for a bit? +Sounds like a good time to make a feature branch.

    +

    You basically know how to do this:

    +
    $ git checkout -b temporary  # create a branch and switch to it
+$ git add <paths>            # stage changes
+$ git commit                 # commit them
+$ git checkout main          # back to main
+                             # do your work...
+$ git checkout temporary     # continue where you left off
+
    +
    +

    Later you can merge it to main or rebase it on top of main and resume work.

    +
    +
    +

    Storing various junk you don’t need but don’t want to get rid of#

    +

    It happens often that you do something and don’t need it, but you don’t want to +lose it right away. You can use either of the above strategies to stash/branch +it away: using branches is probably better because branches are less easily +overlooked if you come back to the repository in few weeks. Note that if you +try to use a branch after a long time, conflicts might get really bad but at +least you have the data still.

    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/level/index.html b/branch/sphinx-book-theme-old-copybutton/level/index.html new file mode 100644 index 00000000..69ef79d2 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/level/index.html @@ -0,0 +1,542 @@ + + + + + + + + + Practical advice: how much Git is necessary? — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Practical advice: how much Git is necessary?

    + +
    + +
    +
    +
    + +
    + +
    +

    Practical advice: how much Git is necessary?#

    +
    +

    Instructor note

    +
      +

    • 10 min teaching/discussion

      • +
    +
    +
    +

    What level of branching complexity is necessary for each project?#

    +
    +

    Simple personal projects#

    +
      +

    • Typically start with just the main branch.

      • +

    • Use branches for unfinished/untested ideas.

      • +

    • Use branches when you are not sure about a change.

      • +

    • Use tags to mark important milestones.

      • +
    +
    +
    +

    Projects with few persons: you accept things breaking sometimes#

    +
      +

    • It might be reasonable to commit to the main branch and feature branches.

      • +
    +
    +
    +

    Projects with few persons: changes are reviewed by others#

    +
      +

    • The main branch is write-protected.

      • +

    • You create new feature branches for changes.

      • +

    • Changes are reviewed before they are merged to the main branch +(more about that in the collaborative Git lesson).

      • +
    +
    +
    +

    When you distribute releases#

    +
      +

    • If you want to patch releases, you probably need release branches.

      • +

    • The main branch and release branches are read-only.

      • +

    • Many branching models exist.

      • +
    +
    +
    +
    +
    +

    How about staging and committing?#

    +
      +

    • It is OK to start committing directly.

      • +

    • Commit early and often: rather create too many commits than too few. +You can always combine commits later.

      • +

    • Once you commit, it is very, very hard to really lose your code.

      • +

    • Always fully commit (or stash) before you do dangerous things, so that you know you are safe. +Otherwise it can be hard to recover.

      • +

    • Later you can start using the staging area.

      • +

    • Later start using git add -p and/or git commit -p.

      • +
    +
    +
    +

    Keypoints

    +
      +

    • There is no one size fits all - start simple and grow your project.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/motivation/index.html b/branch/sphinx-book-theme-old-copybutton/motivation/index.html new file mode 100644 index 00000000..5012dc63 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/motivation/index.html @@ -0,0 +1,718 @@ + + + + + + + + + Motivation — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Motivation

    + +
    + +
    +
    +
    + +
    + +
    +

    Motivation#

    +
    +

    Objectives

    +
      +

    • Make sure nobody leaves the workshop without starting to use some form of version control.

      • +

    • Discuss the reasons why we advocate distributed version control.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 15 min teaching/demonstration

      • +
    +
    +
    +

    The essence of version control#

    +
      +

    • System which records snapshots of a project

      • +

    • Implements branching:

      +
        +

      • You can work on several feature branches and switch between them

        • +

      • Different people can work on the same code/project without interfering

        • +

      • You can experiment with an idea and discard it if it turns out to be a bad idea

        • +
      +
      • +

    • Implements merging:

      +
        +

      • Person A and B’s simultaneous work can be easily combined

        • +
      +
      • +
    +
    +

    What we typically like to snapshot#

    +
      +

    • Software (this is how it started but Git/GitHub can track a lot more)

      • +

    • Scripts

      • +

    • Documents (plain text files much better suitable than Word documents)

      • +

    • Manuscripts (Git is great for collaborating/sharing LaTeX manuscripts)

      • +

    • Configuration files

      • +

    • Website sources

      • +

    • Data

      • +
    +
    +

    Discussion

    +

    Discuss the following directory listing. What possible problems +do you anticipate with this kind of “version control”:

    +
    mylib-1.2.4_18.3.07.tgz         somecode_CP_10.8.07.tgz
+mylib-1.2.4_27.7.07.tgz         somecode_CP_17.5.07.tgz
+mylib-1.2.4_29.4.08.tgz         somecode_CP_23.8.07_final.tgz
+mylib-1.2.4_6.10.07.tgz         somecode_CP_24.5.07.tgz
+mylib-1.2.5_23.4.08.tgz         somecode_CP_25.5.07.tgz
+mylib-1.2.5_25.5.07.tgz         somecode_CP_29.5.07.tgz
+mylib-1.2.5_6.6.07.tgz          somecode_CP_30.5.07.tgz
+mylib-1.2.5_bexc.tgz            somecode_CP_6.10.07.tgz
+mylib-1.2.5_d0.tgz              somecode_CP_6.6.07.tgz
+mylib-1.3.0_4.4.08.tgz          somecode_CP_8.6.07.tgz
+mylib-1.3.1_4.4.08.tgz          somecode_KT.tgz
+mylib-1.3.2_22.4.08.tgz         somecode_PI1_2007.tgz
+mylib-1.3.2_4.4.08.tgz          somecode_PI_2007.tgz
+mylib-1.3.2_5.4.08.tgz          somecode_PI2_2007.tgz
+mylib-1.3.3_1.5.08.tgz          somecode_PI_CP_18.3.07.tgz
+mylib-1.3.3_20.5.08.tgz         somecode_11.5.08.tgz
+mylib-1.3.3_tstrm_27.6.08.tgz   somecode_15.4.08.tgz
+mylib-1.3.3_wk_10.8.08.tgz      somecode_17.6.09_unfinished.tgz
+mylib-1.3.3_wk_11.8.08.tgz      somecode_19.7.09.tgz
+mylib-1.3.3_wk_13.8.08.tgz      somecode-20.7.09.tgz
+...
+
    +
    + +
    +
    +
    +
    +

    Why version control#

    +
    +

    Roll-back functionality#

    +
      +

    • Mistakes happen - without recorded snapshots you cannot easily undo mistakes and go back to a working version.

      • +
    +
    +
    +

    Branching#

    +
      +

    • Often you need to work on several issues/features in one code - without branching this can be messy and confusing.

      • +

    • You can simulate branching by copying the entire code to multiple places but also this will be messy and confusing.

      • +
    +
    +
    +

    Collaboration#

    +

    With version control, none of these are needed anymore (or have much simpler answers):

    +
      +

    • “I will just finish my work and then you can start with your changes.”

      • +

    • “Can you please send me the latest version?”

      • +

    • “Where is the latest version?”

      • +

    • “Which version are you using?”

      • +

    • “Which version have the authors used in the paper I am trying to reproduce?”

      • +
    +
    +
    +

    Reproducibility#

    +
      +

    • How do you indicate which version of your code you have used in your paper?

      • +

    • When you find a bug, how do you know when precisely this bug was introduced +(Are published results affected? Do you need to inform collaborators or users of your code?).

      • +
    +
    +
    +

    Compare with Dropbox or Google Drive#

    +
      +

    • Document/code is in one place, no need to email snapshots.

      • +

    • How can you use an old version? Possible to get old versions but in a much less useful way - snapshots of files, not directories.

      • +

    • What if you want to work on multiple versions at the same time? Do you make a copy? How do you merge copies?

      • +

    • What if you don’t have internet?

      • +
    +
    +

    Why Git?

    +

    We will use Git to record snapshots of our work:

    +
      +

    • Easy to set up: no server needed.

      • +

    • Very popular: chances are high you will need to contribute to somebody else’s code which is tracked with Git.

      • +

    • Distributed: good backup, no single point of failure, you can track and +clean-up changes offline, simplifies collaboration model for open-source +projects.

      • +

    • Important platforms such as GitHub, GitLab, and Bitbucket +build on top of Git.

      • +
    +

    However, any version control is better than no version control and it is OK to prefer a different tool than Git.

    +

    Other tools:

    + +

    Interesting newcomer:

    + +
    +
    +
    +
    +

    Difficulties of version control#

    +

    Despite the benefits, let’s be honest, there are some difficulties:

    +
      +

    • One more thing to learn (it’s probably worth it and will save you more time in the long run; basic career skill).

      • +

    • Difficult if some people don’t want to use it (in the worst case, you can version control on your side and send them versions).

      • +

    • Advanced things can be difficult, a bit too many gotchas (basics are often enough, ask others for help when needed).

      • +
    +
    +
    +

    A real-life example#

    +

    Before we create a new repository from scratch and learn how to record changes +and create and merge branches, let us explore an existing Git repository on +GitHub. The goal here is not to teach GitHub yet (we will explain some of the +concepts later), but rather to get a glimpse of the wider picture and see the +social aspect to know what our end goal is.

    +

    As an example we can explore a famous Git repository which was used +to produce the Event Horizon Telescope images: https://github.com/achael/eht-imaging.

    +
      +

    • History

      + +
      • +

    • Reproducibility

      +
        +

      • Discuss the enormous value of the annotation feature: example file.

        • +
      +
      • +

    • Collaboration

      +
        +

      • You can refer to code portions +(so much simpler to send a link rather than describe which file to open and where to scroll to).

        • +

      • Browse the forks.

        • +

      • See contributors.

        • +
      +
      • +

    • Releases

      + +
      • +
    +

    While some of these are GitHub features, it all can be done on other sites, or +by yourself without GitHub at all.

    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/objects.inv b/branch/sphinx-book-theme-old-copybutton/objects.inv new file mode 100644 index 00000000..e743a28c Binary files /dev/null and b/branch/sphinx-book-theme-old-copybutton/objects.inv differ diff --git a/branch/sphinx-book-theme-old-copybutton/recovering/index.html b/branch/sphinx-book-theme-old-copybutton/recovering/index.html new file mode 100644 index 00000000..2003060c --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/recovering/index.html @@ -0,0 +1,763 @@ + + + + + + + + + Undoing and recovering — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Undoing and recovering

    + +
    + +
    +
    +
    + +
    + +
    +

    Undoing and recovering#

    +
    +

    Objectives

    +
      +

    • Learn to undo changes safely

      • +

    • See when undone changes are permanently deleted and when they can be retrieved

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 10 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +

    One of the main points of version control is that you can go back in +time to recover. Unlike this xkcd comic implies: https://xkcd.com/1597/

    +

    In this episode we show a couple of commands that can be used to undo mistakes. +We also list a couple of common mistakes and discuss how to recover from them. +Some commands preserve the commit history and some modify commit history. +Modifying history? Isn’t a “commit” permanent?

    +
      +

    • You can modify old commit history.

      • +

    • But if you have shared that history already, modifying it can make +a huge mess.

      • +
    +
    +

    Note

    +

    As long as you commit something once (or at least git add it), you +can almost always go back to it, no matter what you do. +But you may need to ask Stack Overflow or your local +guru… until that guru becomes you.

    +
    +
    +
    +

    Undoing your recent, uncommitted and unstaged changes (preserves history)#

    +

    You do some work, and want to undo your uncommitted and unstaged modifications. +You can always do that with:

    +
      +

    • git restore .: (the dot means “here and in all folders below”)

      • +
    +

    Or, you can undo things selectively:

    +
      +

    • git restore -p (decide which portions of changes to undo) or git restore <path> (decide which path/file)

      • +
    +
    +

    Note

    +

    In case the above does not work, your Git version might be older than from 2019. +On older Git it is git checkout instead of git restore.

    +
    +

    If you have staged changes, you have at least two options to undo the staging:

    +
      +

    • git restore --staged . followed by git status and git restore .

      • +

    • git reset --hard HEAD throws away everything that is not in last commit (HEAD)

      • +
    +
    +
    +
    +

    Reverting commits (preserves history)#

    +
      +

    • Imagine we made a few commits.

      • +

    • We realize that the latest commit f960dd3 was a mistake and we wish to undo it:

      • +
    +
    $ git log --oneline
+
+f960dd3 (HEAD -> master) not sure this is a good idea
+dd4472c we should not forget to enjoy
+2bb9bb4 add half an onion
+2d79e7e adding ingredients and instructions
+
    +
    +

    A safe way to undo the commit is to revert the commit with git revert:

    +
    $ git revert f960dd3
+
    +
    +

    This creates a new commit that does the opposite of the reverted commit. +The old commit remains in the history:

    +
    $ git log --oneline
+
+d62ad3e (HEAD -> master) Revert "not sure this is a good idea"
+f960dd3 not sure this is a good idea
+dd4472c we should not forget to enjoy
+2bb9bb4 add half an onion
+2d79e7e adding ingredients and instructions
+
    +
    +

    You can revert any commit, no matter how old it is. It doesn’t affect +other commits you have done since then - but if they touch the same +code, you may get a conflict (which we’ll learn about later).

    +
    +

    Exercise: Revert a commit#

    +
    +

    Undoing-1: Revert a commit

    +
      +

    • Create a commit (commit A).

      • +

    • Revert the commit with git revert (commit B).

      • +

    • Inspect the history with git log --oneline.

      • +

    • Now try git show on both the reverted (commit A) and the newly created commit (commit B).

      • +
    +
    +
    +
    +
    +

    Adding to the previous commit (modifies history)#

    +

    Sometimes we commit but realize we forgot something. +We can amend to the last commit:

    +
    $ git commit --amend
+
    +
    +

    This can also be used to modify the last commit message.

    +

    Note that this will change the commit hash. This command modifies the history. +This means that we avoid this command on commits that we have shared with others.

    +
    +

    Exercise: Modify a previous commit#

    +
    +

    Undoing-2: Modify a previous commit

    +
      +

    1. Make an incomplete change to the recipe or a typo in your change, git add and git commit the incomplete/unsatisfactory change.

      2. +

    2. Inspect the unsatisfactory but committed change with git show. Remember +or write down the commit hash.

      3. +

    3. Now complete/fix the change but instead of creating a new commit, add the +correction to the previous commit with git add, followed by git commit --amend. What changed?

      4. +
    + +
    +
    +
    +
    +

    Rewinding branches (modifies history)#

    +

    You can reset branch history to move your branch back to some +point in the past.

    +
      +

    • git reset --hard <hash> will force a branch label to any other point. All +other changes are lost (but it is possible to recover if you force reset by mistake).

      • +

    • Be careful if you do this - it can mess stuff up. Use git graph a +lot before and after.

      • +
    +
    +

    Exercise: Git reset#

    +
    +

    Undoing-3: Destroy our experimentation in this episode

    +

    After we have experimented with reverts and amending, let us destroy +all of that and get our repositories to a similar state.

    +
      +

    • First, we will look at our history (git log/git graph) and +find the last commit <hash> before our tests.

      • +

    • Then, we will git reset --hard <hash> to that.

      • +

    • Then, git graph again to see what happened.

      • +
    +
    $ git log --oneline
+
+d62ad3e (HEAD -> master) Revert "not sure this is a good idea"
+f960dd3 not sure this is a good idea
+dd4472c we should not forget to enjoy
+2bb9bb4 add half an onion
+2d79e7e adding ingredients and instructions
+
+$ git reset --hard dd4472c
+
+HEAD is now at dd4472c we should not forget to enjoy
+
+$ git log --oneline
+
+dd4472c (HEAD -> master) we should not forget to enjoy
+2bb9bb4 add half an onion
+2d79e7e adding ingredients and instructions
+
    +
    +
    +
    +
    +
    +
    +

    Recovering from committing to the wrong branch#

    +

    It is easy to forget to create a branch or to create it and forget to switch to +it when committing changes.

    +

    Here we assume that we made a couple of commits but we realize they went to the +wrong branch.

    +

    Solution 1 using git cherry-pick:

    +
      +

    1. Make sure that the correct branch exists and if not, create it. Make sure to +create it from the commit hash where you wish you had created it from: git branch <branchname> <hash>

      2. +

    2. Switch to the correct branch.

      3. +

    3. git cherry-pick <hash> can be used to take a specific commit to the +current branch. Cherry-pick all commits that should have gone to the correct +branch, from oldest to most recent.

      4. +

    4. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

      5. +
    +

    Solution 2 using git reset –hard (makes sense if the correct branch should +contain all commits of the accidentally modified branch):

    +
      +

    1. Create the correct branch, pointing at the latest commit: git branch <branchname>.

      2. +

    2. Check with git log or git graph that both branches point to the same, latest, commit.

      3. +

    3. Rewind the branch that accidentally got wrong commits with git reset --hard (see also above).

      4. +
    +
    +
    +

    Recovering from merging/pulling into the wrong branch#

    +

    git merge, git rebase, and git pull modify the current branch, never +the other branch. But sometimes we run this command on the wrong branch.

    +
      +

    1. Check with git log the commit hash that you would like to rewind the +wrongly modified branch to.

      2. +

    2. Rewind the branch that accidentally got wrong commits with git reset --hard <hash> (see also above).

      3. +
    +
    +
    +

    Recovering from conflict after git pull#

    +

    git pull can create a conflict since git pull always also includes a git merge (more about this +in the collaborative Git lesson).

    +

    The recovery is same as described in Conflict resolution. Either +resolve conflicts or abort the merge with git merge --abort.

    +
    +
    +

    Undoing-4: Test your understanding

    +
      +

    1. What happens if you accidentally remove a tracked file with git rm, is it gone forever?

      2. +

    2. Is it OK to modify commits that nobody has seen yet?

      3. +

    3. What situations would justify to modify the Git history and possibly remove commits?

      4. +
    + +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/reference/index.html b/branch/sphinx-book-theme-old-copybutton/reference/index.html new file mode 100644 index 00000000..4caf98e0 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/reference/index.html @@ -0,0 +1,509 @@ + + + + + + + + + Quick reference — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Quick reference

    + +
    +
    + +
    +

    Contents

    +
    + +
    +
    +
    +
    + +
    + +
    +

    Quick reference#

    +
    +

    Other cheatsheets#

    + +
    +
    +

    Glossary#

    +
      +

    • working directory/ workspace: the actual files you see and edit

      • +

    • staging area: Place files go after git add and before git commit

      • +

    • hash: unique reference of any commit or state

      • +

    • branch: One line of work. Different branches can exist at the +same time and split/merge.

      • +

    • HEAD: Pointer to the most recent commit on the current branch.

      • +

    • remote: Roughly, another server that holds .git.

      • +

    • origin: Default name for a remote repository.

      • +

    • master: Default name for main branch. Depending on the configuration and service, +the default branch is sometimes main.

      • +
    +
    +
    +

    Commands we use#

    +

    Setup:

    +
      +

    • git config: edit configuration options

      • +

    • git init: create new repository

      • +
    +

    See our status:

    +
      +

    • git status: see status of files - use often!

      • +

    • git log: see history of commits and their messages, newest first

      • +

    • git graph: see a detailed graph of commits. Create this command +with git config --global alias.graph "log --all --graph --decorate --oneline"

      • +

    • git diff: show difference between working directory and last commit

      • +

    • git diff --staged: show difference between staging area and last commit

      • +

    • git show <commit>: inspect individual commits

      • +
    +

    General work:

    +
      +

    • git add:

      +
        +

      • Add a new file

        • +

      • Add a file to staging

        • +
      +
      • +

    • git commit: record a version, add it to current branch

      • +

    • git commit --amend: amend our last commit

      • +

    • git branch: show which branch we’re on

      • +

    • git branch <name>: create a new branch called “name”

      • +

    • git checkout <file>: checkout last committed version of <file>, losing unstaged changes

      • +

    • git checkout -b <branch-name>: create a new branch and switch to it

      • +

    • git revert abc123: create a new commit which reverts commit abc123

      • +

    • git reset --soft abc123: remove all commits after abc123, but keep their modifications as staged changes

      • +

    • git reset --hard abc123: remove all commits after abc123, permanently throwing away their changes

      • +

    • git merge <branch-name>: merge branch <branch-name> into current branch

      • +

    • git grep: search for patterns in tracked files

      • +

    • git annotate: find out when a specific line got introduced and by whom

      • +

    • git bisect: find a commit which broke some functionality

      • +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/remotes/index.html b/branch/sphinx-book-theme-old-copybutton/remotes/index.html new file mode 100644 index 00000000..6d631e32 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/remotes/index.html @@ -0,0 +1,635 @@ + + + + + + + + + Sharing repositories online — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Sharing repositories online

    + +
    + +
    +
    +
    + +
    + +
    +

    Sharing repositories online#

    +
    +

    Objectives

    +
      +

    • We get a feeling for remote repositories (more later).

      • +

    • We are able to publish a repository on the web.

      • +

    • We are able to fetch and track a repository from the web.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 10 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +
    +

    From our laptops to the web#

    +

    We have seen that creating Git repositories and moving them around is +simple and that is great.

    +

    So far everything was local and all snapshots, branches, and tags are saved under .git.

    +

    If we remove .git, we remove all Git history of a project.

    +
    +

    Discussion

    +
      +

    • What if the hard disk fails?

      • +

    • What if somebody steals my laptop?

      • +

    • How can we collaborate with others across the web?

      • +
    +
    +
    +
    +

    Remotes#

    +

    We will learn how to work with remote repositories in detail in the +collaborative distributed version control lesson.

    +

    In this section we only want to get a taste to prepare us for other lessons +where we will employ GitHub. Our goal is to publish our guacamole recipe on +the web. Don’t worry, you will be able to remove it afterwards.

    +

    To store your git data on another server, you use remotes. +A remote is a repository on its own, with its own branches +We can push changes to the remote and pull +from the remote.

    +

    You might use remotes to:

    +
      +

    • Back up your own work.

      • +

    • To collaborate with other people.

      • +
    +

    There are different types of remotes:

    +
      +

    • If you have a server you can ssh to, you can use that as a remote.

      • +

    • GitHub is a popular, closed-source commercial site.

      • +

    • GitLab is a popular, open-core +commercial site. Many universities have their own private GitLab servers +set up.

      • +

    • Bitbucket is yet another popular commercial site.

      • +

    • Another option is NotABug

      • +

    • We especially encourage course participants to use our new Nordic +research software repository +platform, for more information +see +https://coderefinery.org/repository/. +This is GitLab, free for researchers and allows private, +cross-university sharing.

      • +
    +
    +
    +

    Type-along: Create a new repository on GitHub#

    +

    For the rest of this page, we will make a new repository for our +guacamole recipe on GitHub (here we motivate why we demonstrate this +with GitHub), +send our code to it, and then see how +others can get the code from it.

    +

    Make sure that you are logged into GitHub.

    +
    +../_images/new-top-left.png +
    +

    To create a repository we either click the green button “New” (top left corner).#

    +
    +
    +
    +../_images/new-top-right.png +
    +

    Or if you see your profile page, there is a “+” menu (top right corner).#

    +
    +
    +

    Yet another way to create a new repository is to visit +https://github.com/new directly.

    +
    +

    On this page choose a project name. +For the sake of this exercise do not select +“Initialize this repository with a README” (what will happen if you do?):

    +
    +../_images/creating.png +
    +

    Once you click the green “Create repository”, you will see a page similar to:

    +
    +../_images/created.png +
    +

    What this means is that we have now an empty project with either an HTTPS or an +SSH address: click on the HTTPS and SSH buttons to see what happens.

    +
    +
    +
    +

    Pushing our guacamole recipe repository to GitHub#

    +

    To push changes to the project please select SSH. +For this to work you will need your SSH keys configured.

    +

    We now want to try the second option that GitHub suggests:

    +
    +

    … or push an existing repository from the command line

    +
    +
      +

    1. Now go to your guacamole repository on your computer.

      2. +

    2. Check that you are in the right place with git status.

      3. +

    3. Copy paste the three lines to the terminal and execute those, in my case (you +need to replace the “user” part and possibly also the repository name):

      4. +
    +
    $ git remote add origin git@github.com:user/recipe.git
+$ git branch -M main
+$ git push -u origin main
+
    +
    +

    The meaning of the above lines:

    +
      +

    • Add a remote reference with the name “origin”

      • +

    • Rename current branch to “main”

      • +

    • Push branch “main” to “origin”

      • +
    +

    You should now see:

    +
    Enumerating objects: 3, done.
+Counting objects: 100% (3/3), done.
+Writing objects: 100% (3/3), 221 bytes | 221.00 KiB/s, done.
+Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
+To github.com:user/recipe.git
+ * [new branch]      main -> main
+Branch 'main' set up to track remote branch 'main' from 'origin'.
+
    +
    +

    Reload your GitHub project website and - taa-daa - your commits should now be +online!

    +

    What just happened? Think of publishing a repository as uploading the .git part online.

    +
    +
    +
    +

    Cloning a repository#

    +

    Now other people can clone this repository and contribute changes. In the +collaborative distributed version control lesson +we will learn how this works.

    +

    At this point only a brief demo - if you copy the SSH or HTTPS address, you can clone repositories like this +(again adapt the “namespace/repository.git” part):

    +
    $ git clone git@github.com:user/recipe.git
+
    +
    +

    This creates a directory called “recipe” unless it already exists. You can also specify the target directory +on your computer:

    +
    $ git clone git@github.com:user/recipe.git myrecipe
+
    +
    +

    What just happened? Think of cloning as downloading the .git part to your +computer. After downloading the .git part the branch pointed to by HEAD is +automatically checked out.

    +
    +

    Keypoints

    +
      +

    • A repository can have one or multiple remotes (we will revisit these later).

      • +

    • Local branches often track remote branches.

      • +

    • A remote serves as a full backup of your work.

      • +

    • We’ll properly learn how to use these in the Collaborative Git lesson.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/resources/index.html b/branch/sphinx-book-theme-old-copybutton/resources/index.html new file mode 100644 index 00000000..744b51f5 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/resources/index.html @@ -0,0 +1,393 @@ + + + + + + + + + Other resources — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + +
    +
    + + +
    +
    +
    +
    +
    + +
    +

    Other resources

    + +
    +
    + +
    +
    +
    +
    + + + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/search/index.html b/branch/sphinx-book-theme-old-copybutton/search/index.html new file mode 100644 index 00000000..31eb1de0 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/search/index.html @@ -0,0 +1,359 @@ + + + + + + + + Search — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    +
    + + +
    +
    +
    +
    +
    + +
    +

    + +
    +
    + +
    +
    +
    +
    + +
    + +

    Search

    + + + + +

    + Searching for multiple words only shows matches that contain + all words. +

    + + +
    + + + +
    + + + +
    + +
    + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/searchindex.js b/branch/sphinx-book-theme-old-copybutton/searchindex.js new file mode 100644 index 00000000..520acf60 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["aliases","archaeology","basics","branches","conflicts","customizing","exercises","guide","index","interrupted","level","motivation","recovering","reference","remotes","resources","staging-area","under-the-hood"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["aliases.md","archaeology.md","basics.md","branches.md","conflicts.md","customizing.md","exercises.md","guide.md","index.rst","interrupted.md","level.md","motivation.md","recovering.md","reference.md","remotes.md","resources.md","staging-area.md","under-the-hood.md"],objects:{},objnames:{},objtypes:{},terms:{"0":[2,3,4,14,17],"00":14,"0000000":4,"0100":2,"02":16,"03":16,"03491ed253ffcee16772e35b1de4efd349711f05":2,"04":16,"06":16,"07":[11,16],"07_final":11,"08":[3,11],"09":11,"09_unfinish":11,"0_4":11,"1":[11,17],"10":[2,9,10,11,12,14,16,17],"100":14,"100644":[2,4,6],"11":[2,17],"1172e02":16,"12":2,"14":[1,6],"15":[1,2,3,4,6,9,11,12,14,17],"1597":12,"16":3,"1949dc4":16,"1_4":11,"1anh":16,"2":[11,13,17],"20":[1,2,3,6,11],"2019":[3,12],"2020":[3,16],"2022":2,"21":17,"221":14,"225":17,"23":3,"2607525":[2,6],"27":9,"2_22":11,"2_4":11,"2_5":11,"2bb9bb4":[3,6,12],"2d79e7e":[3,6,12],"2f60e23":4,"3":[1,11,14,16,17],"30":[1,2],"347e6292419b":1,"347e6292419bd0e4bff077fe971f983932d7a0e9":1,"36":17,"39":2,"3_1":11,"3_20":11,"3_tstrm_27":11,"3_wk_10":11,"3_wk_11":11,"3_wk_13":11,"4":[1,4,11,16,17],"40":[3,17],"4096":17,"40fbb90":[3,6],"41":17,"44":17,"45831a5":16,"46":17,"47":17,"49dc419":16,"4_18":11,"4_27":11,"4_29":11,"4_6":11,"4b3e3cc":4,"4f00317":3,"5":[4,9,11,16,17],"50":2,"500":[1,6],"55d1ce2":4,"57":[1,6],"5_23":11,"5_25":11,"5_6":11,"5_bexc":11,"5_d0":11,"6":[1,4,6,9,11],"61dd3a3":16,"6316947beb2b7ffa0cc822370cfdd701050227a4":2,"64441c1934def7d91ff0b66af0795749d5f1954a":3,"6a8b2af":[2,6],"6f0d49f":16,"6fe2f23":16,"6feb49d":[3,6],"7":[2,6,9,11,17],"703360688618536960":3,"72d78e7":16,"72e0211":16,"73":17,"759d589bdfa61aff99e0535938f14f67b01c83f7":1,"7cf6d8c":[3,6],"7f3582dfbad6539cfa60f5b21bfad41d1b58a618":17,"8":[2,4,11,17],"83f2f94":4,"9":2,"90544b4fa":[1,6],"92":17,"9_":0,"byte":14,"case":[0,1,3,4,6,7,9,11,12,14],"default":[1,13],"do":[0,1,2,4,6,7,8,9,10,11,12,14,16,17],"final":4,"function":[4,7,13],"import":[2,7,10,11,16],"long":[1,2,3,4,9,11,12,15,16],"new":[0,1,2,3,4,6,7,10,11,12,13,16,17],"public":[3,6,7],"return":[1,7,9],"short":16,"switch":[1,3,6,7,9,11,12,13,17],"throw":[3,12,13],"true":0,"try":[0,1,2,3,4,6,8,9,11,12,14],"while":[1,3,6,9,11],A:[0,1,2,3,4,6,7,8,12,14,15,16,17],And:[2,3,4,6,7],As:[1,2,3,6,11,12],At:[1,3,6,7,14],BY:17,Be:[3,12],Being:8,But:[0,1,2,3,4,7,9,12,16],By:7,For:[1,2,3,6,7,8,12,14,17],If:[0,1,2,3,4,6,10,12,14],In:[0,1,3,4,6,8,9,12,14,16,17],Is:[2,6,12,16],It:[0,1,2,3,4,6,7,8,9,10,12,16],No:[2,3,4,6,8],On:[1,2,4,6,12,14,17],One:[2,6,7,11,12,13,16],Or:[2,3,4,12,14],That:2,The:[1,2,3,6,7,8,9,10,12,14,15,17],Then:[0,1,3,4,6,12,17],There:[0,2,3,4,6,7,9,10,14],These:[0,2,7],To:[3,4,6,7,14],With:[1,2,3,6,8,9,11],__pycache__:2,a361dd3:16,a83af39:4,aa243ea:2,ab990f4:16,abbrevi:3,abc123:13,abl:[1,2,3,4,6,7,8,14],abort:[6,7,9,12,16],about:[0,2,3,4,5,6,7,8,12,16,17],abov:[1,2,3,4,6,9,12,14,16],absolut:3,access:[1,2,6],accident:[6,12],account:8,achael:11,acronym:0,across:[0,14],action:3,activ:7,actual:[1,4,6,13,16],acycl:[3,17],ad:[1,2,3,4,6],adapt:14,add:[0,2,3,4,6,7,9,10,12,13,14,16],addit:[4,6,9],address:[14,16],advanc:[3,6,7,9,11],advantag:16,advic:8,advoc:11,affect:[1,2,7,11,12],afraid:[2,4,7],after:[1,2,3,4,6,7,9,13,14],afterward:[3,14],again:[2,3,4,6,7,9,12,14,16],ago:1,aha:17,ahead:3,alert:[1,6],algorithm:[1,3,6],alia:[3,7,13],alias:[3,8],all:[0,1,2,3,4,5,6,7,9,10,11,12,13,14,16,17],allow:[8,14],almost:[4,6,7,9,12],alon:[7,16],along:[1,3,4,6,7,9,12,16,17],alpha:2,alreadi:[1,2,3,4,6,7,9,12,14],alright:[6,12],also:[0,1,2,3,4,6,7,8,9,11,12,14,16,17],alter:[3,6],altern:[3,6,8,16],although:2,alwai:[2,7,10,12,17],am:[1,11],amaz:1,amend:[6,12,13],amount:[3,4,6],an:[0,1,2,3,4,7,9,11,12,14,15,17],analog:16,ancestor:[3,4,6],ani:[1,2,3,4,6,11,12,13],annex:2,annoi:16,annot:[3,6,7,11,13],anoth:[2,3,7,8,13,14,16,17],anotherfil:2,answer:[7,11],anticip:[4,6,11,16],anybodi:7,anymor:11,anyon:[6,12],anyth:[2,7],anytim:7,anywher:2,ap:0,appear:4,appli:[3,4,6],approach:1,approxim:[1,6],ar:[0,1,2,5,6,7,8,9,11,12,14,16,17],archiv:2,area:[0,2,7,8,9,10,13,17],around:14,arriv:1,arrow:3,ask:[2,6,7,9,11,12],aspect:11,assess:7,assign:[2,7],associ:[2,6],assum:[4,6,8,12],attach:3,attempt:[3,7],author:[2,3,11,17],auto:[4,6],autoformat:1,automat:[0,1,2,4,6,14],autosquash:0,autostash:0,avail:[7,16],avocado:[2,3,4,6],avoid:[3,6,7,8,12],awai:[3,9,12,13,17],awar:5,b135ec8:16,b:[2,3,4,6,9,11,12,13,16,17],back:[1,2,3,6,7,9,12,14,16,17],background:[1,6],backup:[4,6,7,11,14],bad:[2,3,4,7,9,11,16],banch:[4,6],banquet:3,base:[0,8,17],bash:[5,7],bashrc:7,basic:[3,7,8,9,11],basket:16,bast:[2,17],batch:9,bathroom:16,bddb280:16,beauti:9,becaus:[0,2,3,4,8,9],becom:[7,12],been:[2,3,6,7,9],befor:[0,1,4,6,7,9,10,11,12,13,16],begin:[1,6,16],behav:7,behavior:[1,2],behind:7,being:7,believ:0,below:[1,2,3,6,7,8,9,12],belt:16,ben:15,benefici:[6,16],benefit:[2,11],besid:0,best:[4,15],better:[2,9,11,16],between:[2,3,4,6,7,9,11,13,16],bf39f9d:16,bf59be6:[3,6],binari:2,bisect:[7,13],bit:[3,4,6,9,11,17],bitbucket:[8,11,14],black:1,blame:7,blank:16,blob:[1,17],bonu:[1,6],book:[3,15,17],bore:[0,7],both:[3,4,6,12,16],bottom:[6,16],box:[3,16],br:0,branch:[0,1,2,7,8,13,14,15],branchabl:2,branchnam:[1,3,6,12],breakout:[1,6],brief:[8,14],briefli:7,bring:[1,3,6],broke:[6,13],broken:[1,7],brows:[1,2,6,11],bug:[1,3,6,7,11],bugfix:16,bui:16,build:[2,11],button:[2,14],byron:2,c43b24c:3,c:16,ca:17,cach:[0,2],call:[0,1,2,3,4,6,13,14],came:16,camera:2,can:[0,1,2,3,4,5,6,7,9,10,11,12,13,14,16,17],cannot:11,care:[4,12],career:11,cat:[3,4,17],caus:4,cc:[4,17],cd:[0,1,2,3,6,17],certain:[4,9],chacon:15,chanc:[2,4,6,7,8,11],chang:[0,3,7,8,9,11,13,14,16,17],changelog:2,chaotic:9,chapter:3,charact:[0,2,3,17],character:3,cheat:7,check:[0,1,2,4,6,7,9,12,14,16,17],checkout:[0,4,6,7,9,12,13,16,17],checkpoint:[2,16],checksum:[3,17],cherri:12,choic:[2,7,8,16],choos:[2,8,14],chop:2,chosen:8,chronolog:2,ci:0,cif:0,cilantro:[3,4,6],cip:0,circumst:4,cl:0,clariti:0,clean:[3,4,6,11,17],clear:[3,4,7,16],click:14,clone:[0,1,3,6,7,9],close:[2,4,6,7,14],co:0,code:[2,3,4,6,7,9,10,11,12,14,16],coderefineri:[1,3,6,7,8,14],collabor:[1,3,4,6,7,8,10,12,14],colleagu:[0,4,9],color:0,com:[0,1,2,3,5,6,7,11,12,14],combin:[1,4,7,10,11],combo:[3,6],come:[3,9],comfort:[7,8],comic:12,command:[2,3,4,7,8,12,14],comment:1,commerci:14,commit:[0,4,7,8,9,13,14,15,17],commit_editmsg:17,common:[0,7,12],commun:4,compact:[1,6],compani:8,compar:[3,4,7,16],comparison:[3,6],compil:[1,2,3,16],complet:[1,6,9,12],complex:16,composit:3,comput:[1,6,14],concept:[8,11],concurr:3,condit:[6,12],config:[0,2,3,4,6,7,13,17],configur:[4,6,7,8,11,13,14],conflict:[3,7,8,9],conflictstyl:0,confus:[0,2,3,7,8,11],connect:[2,7],consciou:2,consid:2,constantli:7,contain:[1,2,3,6,12,17],content:[0,2,4,6],context:[3,5,9],contextu:5,continu:[4,6,9],contrast:3,contribut:[2,11,14],contributor:11,control:[2,3,4,7,12,14],convent:[2,3],convert_matrix:1,conveyor:16,convinc:[2,6],cook:2,cop:0,copi:[0,2,9,11,14],core:[0,14],corner:14,correct:[1,2,6,7,12],correctli:[1,6],correspond:16,could:[1,2,9],count:[2,14],coupl:[3,6,12,17],cours:[7,8,14,17],cover:6,cp:17,craft:[7,16],creat:[0,1,2,10,11,12,13,16,17],cross:[2,14],cryptograph:3,current:[0,1,3,4,6,8,9,12,13,14,16],custom:8,cycl:1,d62ad3:[6,12],d:[1,3],daa:14,danger:[7,10],data:[4,9,11,14,17],date:[2,4],dd4472c8093b7bbcdaa15e3066da6ca77fcabadd:3,dd4472c:[3,6,12],debug:[1,3,6,9,16],decad:2,deci:[6,9],decid:[1,4,6,12,16],decis:2,declar:4,decor:[0,3,13],decreas:4,deeper:0,defin:[0,3,16],degree_correl:[1,6],delet:[1,4,12,17],delici:2,delta:14,demo:14,demonstr:[1,3,5,6,7,8,11,14],demystifi:16,depend:[1,3,6,12,13],depict:3,describ:[7,11,12],descript:[16,17],design:2,desktop:2,despit:11,detail:[2,3,13,14],determin:2,dev:16,develop:[2,3,6,7],di:0,diagram:7,dic:0,did:[3,4,6,7,16],diff3:0,diff:[0,4,7,9,13,16],differ:[1,2,4,6,7,11,13,14,16,17],difficult:[1,6,11],diffstat:0,difftool:[2,6],digest:17,dir:7,direct:[3,7,17],directli:[2,10,14],directori:[1,2,3,6,7,9,11,13,14,16,17],disadvantag:16,disagre:[4,6],disappear:3,disast:7,discard:[3,7,11,16],discov:[6,11],discuss:[3,6,7,8,10,12],disk:14,dislik:[4,6],displai:5,distribut:[11,14],diverg:[3,6],divis:3,diw:0,document:[2,11],doe:[1,2,3,4,6,9,12,17],doesn:[2,6,9,12,17],don:[2,3,4,6,7,11,12,14],done:[1,2,3,4,6,7,8,11,12,14,16],dot:12,doubt:[2,4],down:[1,6,12],download:14,draft:[3,6],drive:4,drop:9,drwx:17,dure:[2,4,6,7],e772d78:16,e:[2,3,6,7,12],ea73a8a9ef9bd5c0aee3f0868d0ebc8457e1f94b:2,each:[1,2,6,7,16,17],earli:[4,7,10],earlier:7,easi:[0,2,5,7,11,12],easier:3,easiest:9,easili:[2,4,7,9,11,16],ec0abc6:[2,6],echo:0,edit:[2,3,4,6,7,13],editor:[2,4,6,8,16,17],effici:[7,15],eht:11,either:[0,2,9,12,14],els:[2,4,9,11],emac:[4,8],email:11,emphas:7,emploi:14,empti:[2,14],enabl:[2,7],encount:7,encourag:[2,3,14],end:[2,7,11,16],endors:8,english:2,enjoi:[2,3,6,12],enorm:11,enough:[2,4,8,11],enter:[1,6],entir:[2,11,15],enumer:14,episod:7,error:[1,6],especi:[2,14],etc:[7,17],even:[1,3,4,5,7,8],event:[6,11],ever:[3,7,16],everi:[2,6,7,16],everybodi:2,everyon:[4,7],everyth:[2,4,8,9,12,14,16,17],everywher:9,exact:7,exactli:[4,6,7],examin:[3,6],exampl:[1,2,3,4,5,6,7,8,12,16],excel:8,except:2,exclam:0,exclud:0,excludesfil:0,execut:14,exercis:[8,14,17],exist:[1,2,4,6,8,10,11,12,13,14],expand:7,expect:[3,4,6],experi:[2,3,6,11,12],experienc:7,expertis:8,explain:[0,2,4,6,7,11,16],explicit:[3,6],explicitli:[3,6],explor:[11,17],express:1,extent:7,extra:[6,9],extract:3,extraordinari:[6,12],extrem:17,f0ea950:1,f7dd63a:[2,6],f960dd3:[6,12],f:[4,6],fact:[7,17],fail:[4,6,14],failur:[1,11],fall:7,fals:[4,6],familiar:[8,17],famou:11,far:[7,14],fast:4,fatal:1,favourit:2,fe:0,featur:[3,4,9,10,11,15,16],feb:2,fee1807:16,feedback:7,feel:[6,7,8,14,16],fetch:[0,14],few:[1,3,5,6,7,9,12,17],figur:[0,2,3,4],file:[0,1,3,4,7,9,11,12,13,16,17],filenam:9,fill:4,find:[2,3,7,11,12,13,17],fine:7,finish:[7,11],first:[1,2,3,4,6,8,9,12,13,17],fish:5,fit:10,five:16,fix:[2,3,4,6,9,12,16],fixm:1,fixup:0,flag:[2,3,6],flask:2,flexibl:16,focu:2,focus:2,folder:[1,2,6,12,17],follow:[1,2,3,4,6,8,11,12],foo:2,forc:12,forev:[6,12],forget:[0,2,3,6,12],forgot:[12,16],forgotten:7,fork:11,form:[2,3,7,9,11,17],forward:4,found:[1,3,6,7],free:[2,14],frequent:3,fresh:9,from:[1,2,3,4,6,8,11,16,17],frustrat:0,full:14,fulli:[1,6,10],further:[2,6],futur:[1,2,6,7],g:[2,3,6,7,12],gener:[0,2,6,7,13],get:[0,2,4,6,7,8,11,12,14,16],get_pi:[1,6],ggplot2:2,gh:0,ghu:0,git:[3,7,9,13,14,15],gitconfig:[0,7],githistori:1,github:[0,1,2,3,5,6,7,8,11,12],gitignor:0,gitlab:[7,8,11,14],give:[1,3,4,6,7,9,11,16],given:3,glimps:11,glob:2,global:[0,2,3,4,6,13],go:[0,1,2,3,4,6,7,11,12,13,14,16,17],goal:[3,8,11,14,17],gone:[3,6,12],good:[1,2,3,6,7,8,9,11,12,15,17],googl:4,got:[3,6,12,13,16],gotcha:11,gpg:3,graph:[3,6,9,12,13,17],graphic:[3,6,7],grasp:2,great:[0,2,11,14,16],green:[7,14],grep:[6,13],ground:16,group:[1,3,6,16],grow:10,guacamol:[3,6],gui:2,guid:[8,15],guru:12,ha:[2,3,6,7,12],had:[3,7,12],half:[1,2,3,6,7,12],hand:[2,7],handl:4,happen:[2,3,4,6,7,9,11,12,14,17],happi:[3,4],hard:[3,6,7,10,12,13,14,17],hardli:16,hash1:[2,6],hash2:[2,6],hash:[1,2,3,6,9,12,13,17],have:[0,1,2,3,4,6,7,8,9,11,12,14,16,17],haven:[2,6,7,12],head:[0,3,4,6,12,13,14,16,17],hello:0,help:[0,1,2,4,6,7,11,16],helper:[1,3,6],here:[0,1,3,5,6,11,12,14,16],hexadecim:17,hi:0,high:[7,8,11],highli:7,hint:[1,2,6,7],histori:[3,4,8,11,13,14],historian:1,hold:13,home:[7,16],honest:11,hood:8,hook:17,hopefulli:17,horizon:11,host:8,how:[0,2,3,4,5,6,8,9,11,12,14,16,17],howev:11,html:[2,7],http:[1,2,3,5,6,7,8,11,12,14,16],huge:12,i:[0,1,2,3,6,7,11,16],idea:[1,2,3,6,7,10,11,12,16,17],ideal:[2,7],identifi:[2,6],ignor:0,im:16,imag:[11,17],imagin:[4,12],implement:[3,11,16,17],impli:[12,16],importantli:16,imposs:7,improv:[0,2],includ:[2,12],incomplet:[6,12],inconsist:0,incorpor:3,incorrect:7,incorrectli:7,increas:[2,4],incred:1,inde:[4,6],index:[2,4,6,9,17],indic:[7,11],individu:[0,1,13,16],industri:7,ineffici:16,info:[7,17],inform:[2,3,5,6,7,8,11,12,14,17],infrequ:7,ingredi:[2,3,4,6,12,16],init:[0,2,6,7,13],initi:[2,14],insert:[2,4],insid:[1,2,17],insist:3,inspect:[2,3,4,8,12,13,16,17],inspir:[2,7],instal:[2,4,6,8],instanc:[1,3,4,6],instead:[0,1,2,4,8,12],insteadof:0,instruct:[2,3,4,6,8,12,16],instructor:[6,8],integ:2,interact:[0,8,13],interest:[6,11],interf:11,interfac:3,intern:[3,15],internet:11,interrupt:8,introduc:[1,6,7,11,13],introductori:8,intuit:1,invers:3,involv:7,isn:[12,16],isol:3,issu:[2,4,7,11,16],item:16,iter:1,its:[1,7,14,17],jackson:9,jay_ge:3,jimeh:5,job:[3,6],julia:2,just:[1,2,3,4,6,8,10,11,14,16],justifi:[2,6,12],keep:[2,3,4,7,13,16],keepbackup:[4,6],kei:[1,7,14,16],kept:2,keystrok:[6,16],kib:14,kind:[4,11],kitchen:16,know:[1,2,3,4,6,7,8,9,10,11,16],l:[0,17],label:[2,3,6,12,16],lack:7,languag:2,larg:2,last:[0,1,4,6,9,12,13,16],later:[1,2,3,4,6,9,10,11,12,14,15,16],latest:[11,12],latex:11,layout:4,learn:[0,2,3,9,11,12,14,15,16,17],learner:7,least:[3,6,7,9,12,16],leav:[2,4,6,7,11],left:[1,2,3,4,6,9,14],less:[0,1,3,4,6,9,11],lesson:[6,8,10,12,14,16],let:[1,2,3,4,6,11,12,16,17],letter:0,level:[2,17],licens:17,life:1,lift:17,lightweight:[3,17],like:[0,1,2,3,4,5,6,9,12,14,16,17],lime:[2,3,4,6],line:[1,2,3,4,6,7,8,9,13,14,16],linear:[3,6],link:[4,6,11,17],linux:[2,6],list:[2,3,8,9,11,12,17],littl:[3,4,6],live:[4,16],ll:[12,14],local:[0,2,3,6,7,8,12,14],locat:[1,16,17],log:[0,3,6,12,13,14,16,17],logic:[1,6,16],longer:1,look:[2,3,4,5,6,7,12,16,17],lose:[7,9,10,13,17],lost:[3,12],lot:[0,2,6,9,11,12],lower:2,ls:[0,17],luckili:4,m:[2,3,6,14],maco:[2,6],made:[2,3,6,12,16,17],magicmonti:5,mai:[2,3,4,7,12,17],main:[1,3,6,9,10,12,13,14],mainli:6,maintain:2,major:7,make:[0,1,2,3,4,5,7,9,11,12,14],manag:3,mani:[0,2,7,10,11,14,16],manual:[0,3,6,7,17],manuscript:11,mark:[0,4,10],marker:[4,6],master:[2,3,4,6,12,13,17],match:0,materi:8,matrix:3,matter:12,mayb:[1,3,6],md:[3,6],me:[2,11],mean:[2,4,6,7,12,14],meaning:2,meant:[4,6],measur:4,mechan:[1,7,17],meet:4,meld:[2,6],memori:2,mental:7,mention:[1,2,3,6,7,8],menu:14,mercuri:11,merg:[0,7,8,9,10,11,13],mess:12,messag:[1,3,6,7,12,13,17],messi:11,met:7,mid:15,middl:[4,6,9,16],might:[0,3,4,8,9,10,12,14],mileston:[3,10],min:[1,2,3,4,9,10,11,12,14,16,17],mind:[2,3,9],minim:4,minor:4,minut:[1,6,7],miscellan:16,mistak:[7,11,12],mix:[2,6,16],mkdir:2,mnemonicprefix:0,mode:[2,7],model:[7,10,11,15,17],modif:[2,4,6,7,9,12,13,16],modifi:[1,2,4,7,9,16,17],modul:[7,8],modular:4,moment:[3,17],month:[3,4,16],more:[1,3,5,6,7,8,9,10,11,12,14,16],most:[0,4,7,8,9,12,13,16],mostli:8,motiv:[1,2,7,8,14],move:[2,3,4,6,7,12,14,16],much:[0,3,7,8,9,11],multipl:[2,7,11,14,16],muscl:2,mv:[2,6],my:[2,5,6,11,14],myfil:[2,6],mylib:11,myrecip:14,myusernam:0,n10:0,n:[1,4,6,16],name:[0,1,3,9,13,14,16],namespac:14,nano:[7,8],narr:3,navig:[1,6],ndpsoftwar:7,necessari:[2,8],need:[1,3,4,5,6,7,10,11,12,14,16,17],neighbor:[1,6],network:2,networkx:[1,6],never:[3,7,9,12,17],newcom:[7,11],newd:0,newdi:0,newer:1,newest:[2,13,16],newli:[6,12],next:[1,2,3,6,16],nice:[2,3,6,16],nicer:[0,3],nilakantha:[1,6],nobel:3,nobodi:[6,11,12],non:1,none:11,nordic:[8,14],norepli:2,notabug:14,note:6,notepad:8,noth:[2,3,4,6,17],notic:[3,4,6],now:[1,2,4,6,7,9,12,14,16,17],number:[1,2,4,6,8],numpi:2,o:0,oa:2,object:7,observ:[3,4,6],obsess:8,obviou:0,off:[3,6,9],offend:[1,6],offer:7,offici:2,offlin:11,often:[1,2,3,4,6,7,9,10,11,13,14,15,16],oh:5,ohmyz:5,ok:[1,6,10,11,12],old:[1,11,12],older:[1,12],oldest:12,onc:[1,4,6,7,10,12,14,15,16,17],one:[1,2,3,4,6,7,9,10,11,14,15,16],onelin:[0,1,2,3,6,12,13],ones:[0,7,16],onion:[2,3,4,6,12],onli:[1,2,3,4,6,10,12,14,16],onlin:[2,8],oop:2,open:[2,4,6,7,11,14,17],opendiff:[2,6],oper:[3,7],opposit:[6,9,12,16],optim:[4,7],option:[0,7,12,13,14,16],order:[2,6,9,16,17],org:[8,14],organ:16,origin:[2,13,14],other:[0,1,2,3,4,6,7,8,9,11,12,14,16,17],otherwis:10,our:[0,2,3,7,8,11,13],out:[0,2,3,4,6,7,11,13,14,16],outcom:2,output:[1,2,6],over:[2,7,16],overflow:12,overlap:3,overlook:9,overview:2,overwrit:4,own:[6,8,11,14],p:[0,9,10,12,16,17],pack:[14,16],page:[0,1,2,6,13,14],pager:0,pai:16,panda:2,panick:9,paper:11,paragraph:2,parallel:7,parent:[1,3,6,17],part:[0,2,3,4,14],parti:2,particip:[1,3,6,7,8,14,17],particular:[3,7],past:[0,6,12,14],patch:[0,6,9,10,16],path:[3,4,9,12],pattern:[2,13],paus:3,peepcod:15,peopl:[2,4,6,7,11,12,14],per:[0,2,15],perfect:[9,15],perform:2,perman:[12,13],permit:3,person:[1,4,6,7,11],philosophi:8,pi:[1,6],pick:[12,16],pictur:[3,11],pijul:11,place:[9,11,13,14,16],plain:11,plan:4,platform:[2,8,11,14],pleas:[1,2,4,6,7,11,14],plenti:0,plugin:4,point:[1,3,6,11,12,14],pointer:[3,13,17],poke:17,pollock:9,pop:[1,6,9],popular:[8,11,14],portion:[4,11,12],pose:7,posit:3,possibl:[0,1,2,3,5,6,11,12,14],postpon:[3,4],power:1,practic:[1,2,3,4,6,7,8,15],pre:4,precis:[1,6,7,11],prefer:[1,11],prefix:0,prepar:[14,16],present:[2,3,7,16,17],press:2,prevent:7,previou:[3,17],previous:17,principl:2,print:[1,3,6,9,16],prior:8,privat:14,pro:[3,15,17],probabl:[1,2,6,7,9,10,11],problem:[1,3,7,11,16],produc:[1,6,11],profil:14,program:[1,2,4],progress:16,project:[0,1,2,3,4,5,7,11,14,15,16],properli:14,protect:10,provid:[7,9,17],publish:[7,11,14,15],pull:[4,14],push:[4,6,7,8,12],put:[4,9,16],py:[1,6],pyc:2,python:[1,2,3,6],q:[1,2,16],queri:2,question:[1,6,7],quick:8,quickli:[1,2],quit:[1,2],radovan:2,rais:7,rare:[4,16],rather:[7,10,11,16],raw:17,rb:0,rbi:0,rdi:[1,6],re:[6,7,13,16],read:[2,10],readi:[2,3,7,16,17],readm:[1,3,6,14],real:[1,9],realiz:[1,3,4,7,12],realli:[3,7,9,10],reason:[2,8,9,10,11],rebas:[0,7,9,12],rec:0,reca:0,recapitul:3,recd:0,receipt:16,recent:[2,6,8,9,13],recip:[0,3,6,12,16],recommend:[1,2,6,7],record:[3,11,13,16,17],recov:[8,10],recoveri:12,recurs:[0,4,17],reduc:[3,4,6],ref:[6,9,17],refer:[2,6,7,11,14,16,17],referenc:17,regret:[6,16],regular:[1,3],reintegr:3,rel:2,relat:[2,4,6,7,16],releas:[1,2,6,11],relev:2,reload:14,rem:0,remain:12,rememb:[0,2,3,4,6,12],remot:[0,7,8,13],remov:[3,4,12,13,14,16],renam:14,repeat:[4,6,16],replac:[0,14],replai:[3,6],replic:17,repositori:[0,3,4,6,7,8,9,11,12,13,16,17],repres:3,represent:[3,6,7],reproduc:[1,7],request:2,requir:[2,3,4,6,8],research:[3,8,14],reset:[4,6,7,13,16],resolut:[8,12],resolv:[3,7,9,12],resourc:8,rest:14,restor:[3,12,16],result:[1,3,4,6,7,11],resum:9,retriev:[12,17],reus:[0,14],revers:2,revert:[7,13],review:2,revis:4,revisit:14,rewrit:4,right:[1,2,3,4,6,7,9,14,16,17],risk:4,rm:[2,6,12],roll:7,room:[1,6,16],root:2,roughli:13,rs:0,rst:1,ruin:9,run:[1,2,3,4,6,7,11,12,16],rw:17,s:[0,2,3,4,6,7,11,14,16],safe:[2,4,6,10,12],safer:[3,6],sake:14,salt:[2,3,4,6],same:[2,3,4,6,7,9,11,12,13,16],sampl:7,save:[0,2,6,9,11,14,16,17],scari:4,scene:2,scipi:2,scott:15,scratch:11,screen:[1,6],screencast:7,script:[1,6,11],scroll:[1,11],seal:16,search:[2,6,7,13],second:[2,4,14],secret:[6,12],section:[3,4,6,7,14],see:[0,1,2,3,4,6,7,8,11,12,13,14,16,17],seen:[1,2,6,12,14],select:[0,12,14,16],self:[2,6],selfish:4,semant:[3,4],send:[11,14],sens:[2,3,12],sensit:[6,12],separ:[2,3,6,8,9,16],sequenc:[3,16],seri:[1,6],serv:14,server:[11,13,14],servic:13,session:7,set:[0,3,7,11,14],settl:3,setup:13,sever:[2,3,4,6,9,11,16,17],sh:5,sha:17,share:[1,6,8,11,12],sheet:7,shell:[2,7],shoot:2,shop:16,shortcut:[0,3],shorter:1,shot:16,should:[0,1,2,3,4,6,7,8,12,14,16],show:[0,3,4,7,9,12,13],shown:[3,6],side:[6,11],sign:3,signal:7,silent:4,similar:[1,6,7,8,12,14],simpl:[0,2,7,8,14],simpler:11,simplest:16,simpli:[4,6,12],simplifi:11,simul:11,simultan:11,sinc:[1,3,4,6,7,11,12,16],singl:[3,6,11],singlekei:0,site:[1,11,14],situat:[3,6,12,16],size:10,skill:11,skip:[3,16],slightli:[4,6],small:[0,2,16],smith:2,smooth:4,snapshot:14,so:[0,1,2,3,6,7,9,10,11,14,16,17],social:11,soft:[13,16],softwar:[3,8,11,14],solv:[4,7,16],some:[0,1,2,3,4,7,11,12,13,16],somebodi:[4,11,14],somecod:11,somecode_11:11,somecode_15:11,somecode_17:11,somecode_19:11,somecode_cp_10:11,somecode_cp_17:11,somecode_cp_23:11,somecode_cp_24:11,somecode_cp_25:11,somecode_cp_29:11,somecode_cp_30:11,somecode_cp_6:11,somecode_cp_8:11,somecode_kt:11,somecode_pi1_2007:11,somecode_pi2_2007:11,somecode_pi_2007:11,somecode_pi_cp_18:11,somefil:[1,2],somehash:[1,6],somehow:16,someon:[2,4],sometext:1,someth:[2,4,6,7,9,12],sometim:[1,3,4,12,13],somewher:2,sort:16,sound:[6,9,11],sourc:[1,2,3,6,11,14],sourcetre:2,space:[0,1],special:3,specif:[0,2,3,6,7,12,13],specifi:[7,14],spell:4,spend:7,split:[13,16],spoiler:[1,6],spread:16,spree:9,squeez:[2,6],ssh:14,st:0,stack:[9,12],stage:[0,2,3,4,7,8,9,12,13],stand:16,standard:[0,7],star:3,start:[1,4,8,10,11,16,17],stash:[7,10],stat:[0,2,6],state:[1,2,3,4,5,6,7,8,9,12,13,16,17],statu:[0,1,2,3,4,6,7,9,12,13,14,16,17],steal:14,step:[1,2,3,4],stick:[8,16],sticki:[3,7],still:[2,4,6,7,9],stop:[4,6],store:[0,2,6,7,14,16,17],stori:[2,3],strang:1,strategi:[3,7,9],straub:15,strength:3,string:[0,1,17],structur:[2,3,7],stuck:[3,7],student:[7,8],stuff:[12,16],style:[2,9],su:0,sub:2,subject:3,sublimegeek:16,submodul:0,subset:6,subvers:11,success:[1,2,15],suffici:[4,8],suggest:[0,14],suitabl:11,summar:2,sure:[1,2,3,6,7,10,11,12,14,16],synchron:0,syntax:2,system:[2,4,7,8,11],t:[0,2,3,4,6,7,11,12,14,16,17],taa:14,tag:[1,6,10,14,17],tail:[1,6],take:[2,4,12,16],taken:[2,8],talk:[3,4],tape:3,target:14,task:[1,6,9],tast:14,tbsp:[3,4],teach:[1,2,3,4,6,8,9,10,11,12,14,16,17],technic:4,telescop:11,tell:[2,3,4,6],temporari:[4,6,9],temporarili:9,term:[1,2,6,7,15,17],termin:[1,3,7,14],test_weakly_connected_compon:1,text:[1,4,5,7,8,11,17],tgz:11,than:[1,2,3,6,10,11,12],thei:[0,2,3,6,7,10,12,16,17],them:[0,2,3,4,6,7,8,9,11,12,14,16],thi:[0,2,4,5,8,9,11,13,14,16,17],thing:[0,1,2,3,4,6,7,8,9,11,12,16],think:[2,3,4,6,7,14],third:2,those:[4,6,14],though:7,thread:2,three:[3,6,14,16],threshold:[1,2,6],through:[7,16],thu:2,tild:[1,6],time:[0,2,3,4,5,6,7,9,11,12,13,15,16,17],timestamp:3,tire:0,toe:7,togeth:[1,3,4,6,16],too:[1,2,3,7,10,11],tool:[1,4,7,11,16],toolbox:6,top:[2,3,4,6,9,11,14,16],topic:0,total:[14,17],touch:[2,6,9,12],track:[1,3,6,11,12,13,14],transfer:8,translat:0,tree:[2,3,7,17],tsp:[2,3,4,6],turn:[3,11],twice:[6,9],twitter:3,two:[0,1,2,3,4,9,12,17],txt:[2,3,4,6,16],type:[0,1,3,4,6,7,9,12,16,17],typic:10,typo:[6,12],u:14,un:3,uncommit:[2,3],under:[2,7,8,14],underli:17,understand:[4,17],understood:2,undo:[2,7,8,11],undon:12,unfinish:[3,10],unfortun:3,uniqu:[2,13],unit:3,univers:14,unless:[1,2,3,4,6,14],unlik:12,unmerg:[3,4],unmodifi:[6,7,16],unrel:[4,6,9,16],unsatisfactori:[6,12],unstag:[2,3,4,6,13,16],untest:10,until:[1,3,7,12],untrack:[2,7],up:[2,3,4,7,11,12,14,17],updat:[0,4,7],upload:14,upstream:[0,4],url:0,us:[3,8,9,10,11,12,14,17],usabl:0,user:[3,7,8,11,14,17],usernam:0,v1:3,v:[0,16],valu:[1,6,11],valuabl:7,variabl:1,variou:1,ve:[2,6,17],veri:[0,2,3,4,7,8,10,11,13,16,17],verifi:[3,4,17],versatil:[2,3],version:[1,2,3,4,6,7,12,13,14,16],via:2,video:[1,6],view:[3,4,6,7],vim:8,visit:[1,14],visual:[1,3,4,7],vs:[0,4],wa:[1,2,3,4,6,7,11,12,14],wai:[0,1,2,3,4,6,7,9,11,12,14,16],wait:[0,7],want:[0,1,2,4,6,10,11,12,14,16],we:[0,1,4,5,6,8,9,12,14,16,17],web:[2,8],websit:[2,11,14],wed:2,week:9,weight:2,welcom:[0,8],well:[2,3,4,6,8,16],went:12,were:[2,3,6,7,9,17],what:[0,3,4,6,7,9,12,14,16,17],whatthecommit:2,when:[2,3,7,9,11,12,13,16,17],where:[1,2,3,4,6,9,11,12,14,16],whether:[1,4,7],which:[0,1,2,4,6,7,8,9,11,12,13,16,17],whichev:9,who:[1,4,7,8],whole:[0,2,7,8],whom:[7,13],why:[1,2,3,6,8,14,17],wider:11,wild:3,window:[2,6,8],wip:16,wish:[3,7,9,12],within:[1,2,6],without:[3,4,7,9,11],won:[0,4],wonder:7,word:[0,11],wordregex:0,work:[1,2,4,7,8,11,12,13,14,16,17],workflow:[8,15],workshop:[0,1,2,6,7,11],workspac:13,world:9,worri:[2,14,17],worst:11,worth:11,would:[2,3,4,6,7,12,16],wouldn:16,wrap:1,write:[1,6,7,9,10,12,14],written:[2,15],wrongli:12,wrote:17,www:7,xkcd:[12,15],xour:4,xtheir:4,xyz:1,y:16,ye:[4,6,9],year:[2,7],yet:[2,6,7,11,12,14],you:[0,2,3,4,5,6,7,8,11,12,13,14,16,17],your:[0,1,4,5,8,9,10,11,14,16,17],your_git_repositori:0,yourself:11,z0:0,za:0,zero:1,zsh:5},titles:["Aliases and configuration","Inspecting history","Basics","Branching and merging","Conflict resolution","Customizing Git","List of exercises","Instructor guide","Introduction to version control with Git","Interrupted work","Practical advice: how much Git is necessary?","Motivation","Undoing and recovering","Quick reference","Sharing repositories online","Other resources","Using the Git staging area","Git under the hood"],titleterms:{"1":[1,2,3,4,6,9,12,16],"2":[1,2,3,4,6,9,12,16],"3":[2,3,4,6,12],"4":[2,3,6,12],"5":[2,6],"break":10,"do":3,"function":11,"new":14,A:11,On:3,The:[4,11,16],abort:4,about:10,accept:10,ad:12,address:17,advanc:[0,2],advic:10,after:12,alia:0,alias:0,along:[2,14],an:[6,16],annot:1,anoth:[4,6],ar:[3,4,10],archaeolog:[1,6],area:[6,16],avoid:4,b:1,back:11,bad:[1,6],basic:[1,2,6,17],befor:2,better:7,bisect:[1,6],board:7,branch:[3,4,6,9,10,11,12,17],broke:1,browser:1,chang:[1,2,4,6,10,12],cheatsheet:[7,13],checkout:[1,3],clone:14,code:1,collabor:11,command:[0,1,6,13,16],commit:[1,2,3,6,10,12,16],compar:[2,6,11],complex:10,configur:[0,2],conflict:[4,6,12],content:17,control:[8,11],core:8,creat:[3,4,6,7,9,14],custom:5,delet:3,demonstr:17,destroi:[6,12],diff:[2,6],differ:3,difficulti:11,discuss:[1,2,4,11,14,16,17],distribut:10,don:9,down:17,draw:7,drive:11,dropbox:11,each:10,editor:[5,7],environ:7,episod:[6,8,12],essenc:11,exampl:[0,11],exercis:[1,2,3,4,6,7,9,12,16],experi:17,experiment:[6,12],explor:[1,6],extern:0,fast:[3,6],few:10,file:[2,6],find:[1,6],first:7,follow:7,food:0,forward:[3,6],frequent:9,from:[7,12,14],full:6,get:9,git:[0,1,2,4,5,6,8,10,11,12,16,17],github:14,gitignor:2,glossari:13,good:4,googl:11,graph:[0,7],graphic:2,grep:1,guacamol:[2,14],guid:7,histori:[1,2,6,7,12,16],hole:17,hood:17,how:[1,7,10],human:4,ident:7,ignor:2,inspect:[1,6,7],instead:[3,6],instructor:[0,1,2,3,4,5,7,9,10,11,12,14,16,17],intend:7,interact:[6,16],interfac:2,interrupt:[6,9],introduct:8,junk:9,keypoint:[0,1,2,3,4,9,10,14,16],laptop:14,learn:7,lesson:7,level:10,life:11,like:11,list:[0,6],live:7,log:[1,2,7],make:[6,16],manual:4,materi:7,mean:3,merg:[3,4,6,12],mergetool:[4,6],messag:2,metadata:1,modifi:[6,12],more:2,motiv:[3,6,11],much:10,necessari:10,need:[2,9],note:[1,2,3,4,5,9,10,11,12,14,16,17],now:3,object:[0,1,2,3,4,9,11,12,14,16,17],onlin:14,option:[1,2,3,4,6,8,9],other:[10,13,15],our:[1,4,6,12,14],out:1,outcom:7,particip:2,past:1,path:2,perform:[3,6,16],person:10,point:7,practic:10,prepar:[1,4],prerequisit:8,preserv:12,previou:[6,12],project:10,prompt:5,pull:12,push:14,question:2,quick:13,rabbit:17,read:7,real:11,rebas:[3,4,6],recent:12,recip:[2,14],record:[2,6],recov:[6,12],refer:[8,13],releas:10,remot:14,remov:[2,6],renam:[2,6],repeat:7,repositori:[1,2,14],reproduc:11,reset:12,resolut:[4,6],resolv:[4,6],resourc:15,revert:[6,12],review:10,rewind:12,rid:9,roll:11,s:1,safe:3,search:1,separ:7,share:14,shell:5,show:[1,2,6],side:4,simpl:10,situat:9,slowli:7,snapshot:[2,11],solut:[1,2,3,4,6,9,11,12,16],solv:1,some:[6,9],someth:1,sometim:10,stage:[6,10,16],start:[2,7],stash:[6,9],step:[6,7,16],storag:17,store:9,stori:16,strategi:4,summari:[2,3,6],system:17,t:9,tag:3,take:7,teach:7,tell:16,test:[2,3,6,7,12],than:7,thei:4,theirs:4,thi:[1,3,6,7,12],thing:10,thought:0,through:1,tool:[2,6],toolbox:1,track:2,two:[6,16],type:[2,14],typic:[3,11],uncommit:[6,9,12],under:17,understand:[2,3,6,7,12],undo:[6,12],unstag:12,up:1,us:[0,1,2,4,6,7,13,16],user:2,variou:9,version:[8,11],visual:[2,6],want:[3,9],warm:1,we:[2,3,7,11,13],web:14,websit:7,what:[2,10,11],when:[0,1,4,6,10],which:3,why:[4,7,11],window:7,work:[3,6,9],workflow:3,would:1,write:2,wrong:12,you:[1,9,10],your:[2,3,6,7,12]}}) \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/staging-area/index.html b/branch/sphinx-book-theme-old-copybutton/staging-area/index.html new file mode 100644 index 00000000..ecc7f2a4 --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/staging-area/index.html @@ -0,0 +1,803 @@ + + + + + + + + + Using the Git staging area — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Using the Git staging area

    + +
    + +
    +
    +
    + +
    + +
    +

    Using the Git staging area#

    +
    +

    Objectives

    +
      +

    • Learn how to tell a story with your commit history.

      • +

    • Demystify the Git staging area.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 10 min teaching/type-along

      • +

    • 10 min exercise

      • +
    +
    +
    +

    Commit history is telling a story#

    +

    Your current code is very important, but the history can be just +as important - it tells a story about how your code came to be.

    +
      +

    • Each individual line of code rarely stands alone.

      • +

    • You often want to see all the related changes together.

      • +

    • But you also hardly ever do one thing at once.

      • +
    +

    Along with your code, Git creates a history for you, and if your +history is clear then you are a long way to organized code.

    +
    +

    Discussion

    +

    Here are five types of history. What are the advantages and +disadvantages of each, when you look at it later?

    +

    Example 1:

    +
    b135ec8 add features A, B, and C
+
    +
    +

    Example 2 (newest commit is on top):

    +
    6f0d49f implement feature C
+fee1807 implement feature B
+6fe2f23 implement feature A
+
    +
    +

    Example 3:

    +
    ab990f4 saving three months of miscellaneous work I forgot to commit
+
    +
    +

    Example 4 (newest commit is on top):

    +
    bf39f9d more work on feature B
+45831a5 removing debug prints for feature A and add new file
+bddb280 more work on feature B and make feature A compile again
+72d78e7 feature A did not work and started work on feature B
+b135ec8 now feature A should work
+72e0211 another fix to make it compile
+61dd3a3 forgot file and bugfix
+49dc419 wip (work in progress)
+
    +
    +

    Example 5 (newest commit is on top):

    +
    1949dc4 Work of 2020-04-07
+a361dd3 Work of 2020-04-06
+1172e02 Work of 2020-04-03
+e772d78 Work of 2020-04-02
+
    +
    +

    Discuss these examples. Can you anticipate problems?

    +
    +

    We want to have nice commits. But we also want to “save often” +(checkpointing) - how can we have both?

    +
      +

    • We will now learn to create nice commits using git commit --patch and/or the staging area.

      • +

    • Staging addresses the issue of having unrelated changes in the same +commit or having one logical change spread over several commits.

      • +

    • The staging area isn’t the only way to organize your history nicely, some alternatives are discussed at the end of the lesson.

      • +
    +
    +
    +

    Interactive commits#

    +
      +

    • The simplest ways to solve this is to do interactive commits: +the git commit --patch option (or git commit -p for short).

      • +

    • It will present you with every change you have made individually, +and you can decide which ones to commit right now.

      • +

    • Reference and key commands

      +
        +

      • git commit --patch to start the interactive commit

        • +

      • y to use the change

        • +

      • n to skip the change

        • +

      • s (split) if there are several changes grouped together, but +separated by a blank line, split them into separate choices.

        • +

      • q aborts everything.

        • +

      • ? for more options.

        • +
      +
      • +

    • The -p option is also available on commit, checkout, reset, and add.

      • +
    +
    +
    +

    Exercise: Interactive commits#

    +
    +

    Staging-1: Perform an interactive commit

    +

    One option to help us create nice logical commits is to stage interactively +with git commit --patch:

    +
      +

    1. Make two changes in instructions.txt, at the top and bottom +of the file. +Make sure that they are separated by at least several unmodified lines.

      2. +

    2. Run git commit --patch. Using the keystrokes above, commit one of +the changes.

      3. +

    3. Do it again for the other change.

      4. +

    4. When you’re done, inspect the situation with git log, git status, git diff and git diff --staged.

      5. +

    5. When would this be useful?

      6. +
    + +
    +
    +
    +

    The staging area#

    +
      +

    • The interactive commits above are great, but what if there are so +many changes that you can’t sort them out in one shot?

      • +

    • What if you make progress and want to record it somehow, but it’s +not ready to be committed?

      • +

    • The staging area is a place to record things before committing.

      • +
    +
    +

    Instructor note

    +

    We give two examples and the instructor can pick one or both:

    +
      +

    • Analogy using moving boxes

      • +

    • Analogy using shopping receipts

      • +
    +
    +
    +

    Discussion

    +

    Analogy using moving boxes

    +
      +

    • You’re moving and you have a box to pack your things in.

      • +

    • You can put stuff into the box, but you can also take stuff out of the box.

      • +

    • You wouldn’t want to mix items from the bathroom, kitchen, and living room +into the same box.

      • +

    • The box corresponds to the staging area of Git, where you can craft your commits.

      • +

    • Committing is like sealing the box and sticking a label on it.

      • +

    • You wouldn’t want to label your box with “stuff”, but rather give a more +descriptive label.

      • +

    • See also https://dev.to/sublimegeek/git-staging-area-explained-like-im-five-1anh

      • +
    +

    Analogy using shopping receipts

    +
      +

    • You need to go shopping and buy some stuff for work and for home. +You need two separate receipts.

      • +

    • Bad idea: go through the store get home stuff, pay, start at the +beginning and go through the store again. This is inefficient and +annoying.

      • +

    • What you actually do:

      +
        +

      • Go through the store and put everything you need in your shopping +basket.

        • +

      • Get to the checkout. Put your home stuff on the conveyor belt +(git add). Check both the belt (git diff --staged) and your +basket (git diff) to make sure you got all your home stuff.

        • +

      • Pay (git commit)

        • +

      • Repeat for work stuff.

        • +
      +
      • +
    +

    In order to keep organized, you have to use multiple locations to +stage things in sequence.

    +
    +
    +
    +

    Staging area commands#

    +

    The staging area is a middle ground between what you have done to your files +(the working directory) and what you have last committed (the HEAD commit). +Just like the name implies, it lets you prepare (stage) what the next commit will be and most importantly give you tools to easily know what is going on. +This adds some complexity but also adds more flexibility to selectively +prepare commits since you can modify and stage several times before committing.

    +

    git add stages/prepares for the next commit:

    +
                    git add
+ [project*]  <------------  project*
+                               ^
+                               | modify with editor
+                               |
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
    +
    +

    git commit creates a new commit:

    +
      HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+  HEAD~2          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
    +
    +

    git reset --soft HEAD~1 (move HEAD back by one but keep changes and stage +them) would do the opposite of git commit.

    +

    Going back to the last staged version:

    +
                  git restore
+ [project*]  ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
    +
    +

    Unstaging changes with git restore --staged:

    +
              git restore --staged
+             ------------>  project*
+
+
+
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
    +
    +

    Discarding unstaged changes:

    +
                                project*
+                               |
+                               | git restore
+                               v
+  HEAD            .         project
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
    +
    +

    Comparing:

    +
                    git diff
+ [project*]  <----------->  project*
+    ^                          ^
+    | git diff --staged        | git diff HEAD
+    v                          v
+  HEAD            .
+    |             .
+    |             .
+    |             .
+  HEAD~1          .
+    |             .
+    |             .
+    |             .
+                  .
+  .git            .     working directory
+(history)         .      (files we see)
+
    +
    +
    +Staging basics +
    +

    The different states of the repository and the commands to move from one to +another.#

    +
    +
    +
    +
    +

    Exercise: Using the staging area#

    +
    +

    Staging-2: Use the staging area to make a commit in two steps

    +
      +

    1. In your recipe example, make two different changes to +ingredients.txt and instructions.txt which do not go together.

      2. +

    2. Use git add to stage one of the changes.

      3. +

    3. Use git status to see what’s going on, and use git diff and git diff --staged to see the changes.

      4. +

    4. Feel some regret and unstage the staged change.

      5. +
    +
    +
    +

    Discussion

    +
      +

    • When is it better to “save” a change as commit, when is it better to “save” +it with git add?

      • +

    • Is it a problem to commit many small changes?

      • +
    +
    +
    +

    Keypoints

    +
      +

    • The staging area helps us to create well-defined commits.

      • +
    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme-old-copybutton/under-the-hood/index.html b/branch/sphinx-book-theme-old-copybutton/under-the-hood/index.html new file mode 100644 index 00000000..f035fefa --- /dev/null +++ b/branch/sphinx-book-theme-old-copybutton/under-the-hood/index.html @@ -0,0 +1,608 @@ + + + + + + + + + Git under the hood — Introduction to version control with Git documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + + + + + + + + + + +
    + +
    + +
    + + + + +
    +
    + + + + +
    +
    + + +
    + +
    + +
    +
    + + +
    +
    + + +
    +
    + Contents +
    + +
    +
    +
    +
    + +
    +

    Git under the hood

    + +
    + +
    +
    +
    + +
    + +
    +

    Git under the hood#

    +
    +

    Objectives

    +
      +

    • Verify that branches are pointers to commits.

      • +

    • Verify that branches are extremely lightweight.

      • +
    +
    +
    +

    Instructor note

    +
      +

    • 10 min teaching/type-along

      • +

    • 15 min exercise

      • +
    +
    +
    +Git under the hood +
    +
    +

    Down the rabbit hole#

    +

    When working with Git, you will never need to go inside .git, but in this +exercise we will, in order to learn about how branches are implemented in Git.

    +

    For this exercise create a new repository and commit a couple of changes.

    +

    Now that we’ve made a couple of commits let us look at what is happening under +the hood.

    +
    $ cd .git
+$ ls -l
+
+total 44
+-rw------- 1 bast users   36 May  7 11:47 COMMIT_EDITMSG
+-rw------- 1 bast users   21 May  7 11:47 HEAD
+drwx------ 2 bast users 4096 May  7 11:46 branches
+-rw------- 1 bast users   92 May  7 11:46 config
+-rw------- 1 bast users   73 May  7 11:46 description
+drwx------ 2 bast users 4096 May  7 11:46 hooks
+-rw------- 1 bast users  225 May  7 11:47 index
+drwx------ 2 bast users 4096 May  7 11:46 info
+drwx------ 3 bast users 4096 May  7 11:47 logs
+drwx------ 8 bast users 4096 May  7 11:47 objects
+drwx------ 4 bast users 4096 May  7 11:46 refs
+
    +
    +

    Git stores everything under the .git folder in your repository. In fact, the +.git directory is the Git repository.

    +

    Previously when you wrote the commit messages using your text editor, they +were in fact saved to COMMIT_EDITMSG.

    +

    Each commit in Git is stored as a “blob”. This blob contains information about +the author and the commit message. The blob references another blob that lists +the files present in the directory at the time and references blobs that record +the state of each file.

    +

    Commits are referenced by a SHA-1 hash (a 40-character hexadecimal string).

    +
    +A commit inside Git +
    +

    States of a Git file. Image from the Pro Git book. License CC BY 3.0.#

    +
    +
    +

    Once you have several commits, each commit blob also links to the hash of the +previous commit. The commits form a directed acyclic +graph (do not worry +if the term is not familiar).

    +
    +A commit and its parents +
    +

    A commit and its parents. Image from the Pro Git book. License CC BY 3.0.#

    +
    +
    +

    All branches and tags in Git are pointers to commits.

    +
    +
    +

    Git is basically a content-addressed storage system#

    + +

    Let us poke a bit into raw objects! Start with:

    +
    $ git cat-file -p HEAD
+
    +
    +

    Then explore the tree object, then the file object, etc. recursively using the hashes you see.

    +
    +
    +

    Demonstration: experimenting with branches#

    +

    Let us lift the hood and create few branches manually. The +goal of this exercise is to hopefully create an “aha” moment and provide us a +good understanding of the underlying model.

    +

    We are starting from the master branch and create an idea branch:

    +
    $ git status
+
+On branch master
+nothing to commit, working tree clean
+
    +
    +
    $ git checkout -b idea
+
+Switched to a new branch 'idea'
+
    +
    +
    $ git branch
+
+* idea
+  master
+
    +
    +

    Now let us go in:

    +
    $ cd .git
+$ cd refs/heads
+$ ls -l
+
+total 8
+-rw------- 1 bast users 41 May  7 11:47 idea
+-rw------- 1 bast users 41 May  7 11:47 master
+
    +
    +

    Let us check what the idea file looks like +(do not worry if the hash is different):

    +
    $ cat idea
+
+7f3582dfbad6539cfa60f5b21bfad41d1b58a618
+
    +
    +

    Now let us replicate this file:

    +
    $ cp idea idea-2
+$ cp idea idea-3
+$ cp idea idea-4
+$ cp idea idea-5
+
    +
    +

    Let us go up two levels and inspect the file HEAD:

    +
    $ cd ../..
+$ cat HEAD
+
+ref: refs/heads/idea
+
    +
    +

    Let us open this file and change it to:

    +
    ref: refs/heads/idea-3
+
    +
    +

    Now we are ready for the aha moment!

    +

    First let us go back to the working area:

    +
    $ cd ..
+
    +
    +

    Now - on which branch are we?

    +
    $ git branch
+
+  idea
+  idea-2
+* idea-3
+  idea-4
+  idea-5
+  master
+
    +
    +
    +

    Discussion

    +

    Discuss the findings with other course participants.

    +
    +
    +
    + + +
    + +
    + +
    +
    +
    +

    + + By CodeRefinery team
    + + © Copyright CodeRefinery team.
    +

    +
    +
    + +
    + + +
    +
    + + + + + + + \ No newline at end of file diff --git a/branch/sphinx-book-theme/.buildinfo b/branch/sphinx-book-theme/.buildinfo new file mode 100644 index 00000000..3c5661ba --- /dev/null +++ b/branch/sphinx-book-theme/.buildinfo @@ -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: c16f5bd64b66f26c070be58d14c6e7ee +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/branch/sphinx-book-theme/.nojekyll b/branch/sphinx-book-theme/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/branch/sphinx-book-theme/_images/cheat-sheet.jpg b/branch/sphinx-book-theme/_images/cheat-sheet.jpg new file mode 100644 index 00000000..69c947cb Binary files /dev/null and b/branch/sphinx-book-theme/_images/cheat-sheet.jpg differ diff --git a/branch/sphinx-book-theme/_images/commit-and-tree.png b/branch/sphinx-book-theme/_images/commit-and-tree.png new file mode 100644 index 00000000..57cdebfa Binary files /dev/null and b/branch/sphinx-book-theme/_images/commit-and-tree.png differ diff --git a/branch/sphinx-book-theme/_images/commits-and-parents.png b/branch/sphinx-book-theme/_images/commits-and-parents.png new file mode 100644 index 00000000..62336de2 Binary files /dev/null and b/branch/sphinx-book-theme/_images/commits-and-parents.png differ diff --git a/branch/sphinx-book-theme/_images/created.png b/branch/sphinx-book-theme/_images/created.png new file mode 100644 index 00000000..1d657d77 Binary files /dev/null and b/branch/sphinx-book-theme/_images/created.png differ diff --git a/branch/sphinx-book-theme/_images/creating.png b/branch/sphinx-book-theme/_images/creating.png new file mode 100644 index 00000000..ff61a75a Binary files /dev/null and b/branch/sphinx-book-theme/_images/creating.png differ diff --git a/branch/sphinx-book-theme/_images/git-branch-1.svg b/branch/sphinx-book-theme/_images/git-branch-1.svg new file mode 100644 index 00000000..aaaa8a04 --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-branch-1.svg @@ -0,0 +1,211 @@ + + + + + + + + + + + + + + + + + + + + m3 + + + m2 + + + m1 + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme/_images/git-branch-2.svg b/branch/sphinx-book-theme/_images/git-branch-2.svg new file mode 100644 index 00000000..af25bd2d --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-branch-2.svg @@ -0,0 +1,379 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + m3 + + + l1 + + + e1 + + + e2 + + + m2 + + + m1 + + + + + master + + + + + experiment + + + + + less-salt + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme/_images/git-branch-3.svg b/branch/sphinx-book-theme/_images/git-branch-3.svg new file mode 100644 index 00000000..ce525698 --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-branch-3.svg @@ -0,0 +1,411 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + e2 + + + m3 + + + m4 + + + l1 + + + e1 + + + + + experiment + + + + + less-salt + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme/_images/git-collaborative.svg b/branch/sphinx-book-theme/_images/git-collaborative.svg new file mode 100644 index 00000000..1e0755ed --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-collaborative.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + x1 + + + m1 + + + m2 + + + c2 + + + m3 + + + b1 + + + b2 + + + x3 + + + b3 + + + c1 + + + x2 + + + diff --git a/branch/sphinx-book-theme/_images/git-deleted-branches.svg b/branch/sphinx-book-theme/_images/git-deleted-branches.svg new file mode 100644 index 00000000..094c3a3d --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-deleted-branches.svg @@ -0,0 +1,419 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + l1 + + + m6 + + + e2 + + + m2 + + + m3 + + + e1 + + + m1 + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme/_images/git-merge-1.svg b/branch/sphinx-book-theme/_images/git-merge-1.svg new file mode 100644 index 00000000..f0ee336c --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-merge-1.svg @@ -0,0 +1,451 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m1 + + + m2 + + + m4 + + + m5 + + + m3 + + + l1 + + + e2 + + + e1 + + + + + less-salt + + + + + master + + + + + HEAD + + + + + experiment + + + diff --git a/branch/sphinx-book-theme/_images/git-merge-2.svg b/branch/sphinx-book-theme/_images/git-merge-2.svg new file mode 100644 index 00000000..45af4301 --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-merge-2.svg @@ -0,0 +1,491 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + m4 + + + m5 + + + l1 + + + m6 + + + e2 + + + m2 + + + m3 + + + e1 + + + m1 + + + + + experiment + + + + + less-salt + + + + + master + + + + + HEAD + + + diff --git a/branch/sphinx-book-theme/_images/git-pre-ff.svg b/branch/sphinx-book-theme/_images/git-pre-ff.svg new file mode 100644 index 00000000..13010951 --- /dev/null +++ b/branch/sphinx-book-theme/_images/git-pre-ff.svg @@ -0,0 +1,551 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + e2 + + + m5 + + + n2 + + + n3 + + + m3 + + + l1 + + + e1 + + + n1 + + + m4 + + + m2 + + + m6 + + + m1 + + + + + update-readme + + + + + HEAD + + + + + master + + + diff --git a/branch/sphinx-book-theme/_images/git_stage_commit.svg b/branch/sphinx-book-theme/_images/git_stage_commit.svg new file mode 100644 index 00000000..2cf638b9 --- /dev/null +++ b/branch/sphinx-book-theme/_images/git_stage_commit.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/sphinx-book-theme/_images/meld.png b/branch/sphinx-book-theme/_images/meld.png new file mode 100644 index 00000000..fee5e33a Binary files /dev/null and b/branch/sphinx-book-theme/_images/meld.png differ diff --git a/branch/sphinx-book-theme/_images/mergetool.png b/branch/sphinx-book-theme/_images/mergetool.png new file mode 100644 index 00000000..091aa720 Binary files /dev/null and b/branch/sphinx-book-theme/_images/mergetool.png differ diff --git a/branch/sphinx-book-theme/_images/new-top-left.png b/branch/sphinx-book-theme/_images/new-top-left.png new file mode 100644 index 00000000..80c5f16b Binary files /dev/null and b/branch/sphinx-book-theme/_images/new-top-left.png differ diff --git a/branch/sphinx-book-theme/_images/new-top-right.png b/branch/sphinx-book-theme/_images/new-top-right.png new file mode 100644 index 00000000..6dabf482 Binary files /dev/null and b/branch/sphinx-book-theme/_images/new-top-right.png differ diff --git a/branch/sphinx-book-theme/_images/octopus.jpeg b/branch/sphinx-book-theme/_images/octopus.jpeg new file mode 100644 index 00000000..b26dc37e Binary files /dev/null and b/branch/sphinx-book-theme/_images/octopus.jpeg differ diff --git a/branch/sphinx-book-theme/_images/staging-basics.svg b/branch/sphinx-book-theme/_images/staging-basics.svg new file mode 100644 index 00000000..6c7a2c3c --- /dev/null +++ b/branch/sphinx-book-theme/_images/staging-basics.svg @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + commit + + WORKING DIR + + + + COMMITTED + + + + STAGED + + + + + + checkout + add + commit + checkout + reset + + + + diff HEAD + diff + diff --staged + + diff --git a/branch/sphinx-book-theme/_images/stranger.jpg b/branch/sphinx-book-theme/_images/stranger.jpg new file mode 100644 index 00000000..bd3985d2 Binary files /dev/null and b/branch/sphinx-book-theme/_images/stranger.jpg differ diff --git a/branch/sphinx-book-theme/_sources/aliases.md b/branch/sphinx-book-theme/_sources/aliases.md new file mode 100644 index 00000000..15a24e6f --- /dev/null +++ b/branch/sphinx-book-theme/_sources/aliases.md @@ -0,0 +1,158 @@ +# Aliases and configuration + +```{objectives} +- Learn to use aliases for most common commands. +``` + +Are you getting tired of typing so much? In Git you can define aliases (shortcuts): +- These are great because they can save you time typing. +- But it's easy to forget them, get confused, or be inconsistent with your colleagues. + +There is plenty of other configuration for Git, that can make it nicer. + + +## Aliases + +- Aliases are a simple way to improve the usability of Git: for + example `git ci` instead of `git commit`. +- Aliases are based on simple string replacement in the command. +- Aliases can either be specific to a repository or global. + - Global aliases help you do the things you are used to across Git projects. + - Per-project aliases can also be created. +- Global aliases are stored in `~/.gitconfig`. + + +## Example alias: git graph + +A very useful shortcut which we use a lot in our workshops: + +```console +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ cd your_git_repository +$ git graph +``` + + +## Using external commands + +It is possible to call external commands using the exclamation mark character "!". +In this case we create a local alias which is +stored in `.git/config` and not synchronized with remotes: + +```console +$ cd your_git_repository +$ git config alias.hi '!echo hello' +$ git hi +``` + +```{discussion} Food for thought: When to alias? +- How many times should you wait before aliasing a command? +- Do you believe a list of generic two-letter acronyms for common commands will + save your time? +``` + + +## List of aliases the instructors use + +You are welcome to reuse, suggest, improve. +You can see your current aliases in `~/.gitconfig`. + +```console +$ git config --global alias.ap "add --patch" +$ git config --global alias.br branch +$ git config --global alias.ci "commit -v" +$ git config --global alias.cip "commit --patch -v" +$ git config --global alias.cl "clone --recursive" +$ git config --global alias.co checkout +$ git config --global alias.cop "checkout --patch" +$ git config --global alias.di diff +$ git config --global alias.dic "diff --staged --color-words" +$ git config --global alias.diw "diff --color-words" +$ git config --global alias.dis "!git --no-pager diff --stat" +$ git config --global alias.fe fetch +$ git config --global alias.graph "log --all --graph --decorate --oneline" +$ git config --global alias.rem remote +$ git config --global alias.st status +$ git config --global alias.su "submodule update --init --recursive" +``` + +Here is what they do: +- `ap`: add, selecting parts individually, interactively. +- `br`: branch (obvious) +- `ci`: commit (check in), with `-v` option for clarity +- `cip`: commit, selecting parts individually, interactively. +- `cl`: clone, init submodules (submodules are an advanced topic) +- `co`: checkout (obvious) +- `cop`: checkout, selecting parts individually, interactively. +- `di`: diff (obvious) +- `dic`: diff of staging area vs last commit (what is about to be committed) +- `diw`: a word diff, color. Useful for small changes. +- `dis`: a "diffstat": what files are changed, not contents +- `fe`: fetch (obvious) +- `graph`: show whole git graph (so useful, some of us call it `l`) +- `rem`: remote (obvious) +- `st`: status (obvious) +- `su`: submodule update (advanced) + +A useful setting for the `p` aliases: +```console +$ git config --global interactive.singlekey true +``` + + +## Advanced aliases + +These are advanced aliases and configuration options. We won't explain them, +but if you are bored, have some time, or want to go deeper, try to +figure out what they do. You might want to check the Git manual +pages! + +```console +$ git config --global alias.cif "commit -v -p --fixup" +$ git config --global alias.rb "rebase --autosquash" +$ git config --global alias.rbi "rebase --interactive --autosquash" +$ git config --global alias.rbis "rebase --interactive --autosquash --autostash" +$ git config --global alias.rbs "rebase --autosquash --autostash" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.ls-ignored "ls-files -o -i --exclude-standard" +$ git config --global alias.new "log HEAD..HEAD@{upstream}" +$ git config --global alias.news "log --stat HEAD..HEAD@{upstream}" +$ git config --global alias.newd "log --patch --color-words HEAD..HEAD@{upstream}" +$ git config --global alias.newdi "diff --color-words HEAD...HEAD@{upstream}" +$ git config --global alias.rec "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD" +$ git config --global alias.reca "!git --no-pager log --oneline --graph --decorate -n10 --all" +$ git config --global alias.recd "log --decorate --patch @{upstream}^^^..HEAD" +$ git config --global alias.recs "!git --no-pager log --oneline --graph --decorate @{upstream}^^^..HEAD --stat" +``` + +## Advanced Git configuration + +Besides aliases, you can do plenty of other configuration of `git`. +Here are some of the most common ones: + +```console +$ git config --global interactive.singlekey true +$ git config --global core.pager "less -RS" +$ git config --global core.excludesfile ~/.gitignore +$ git config --global merge.conflictstyle diff3 +$ git config --global diff.wordRegex "[a-zA-Z0-9_]+|[^[:space:]]" +$ git config --global diff.mnemonicPrefix true +``` + +Do you get tired of typing and copying and pasting your remote names +all the time, like `git@github.com:myusername`? You can create remote +aliases like this: + +```console +$ git config --global url.git@github.com:.insteadOf gh: +$ git config --global url.git@github.com:/username/.insteadOf ghu: +``` + +Then, when you add a remote `ghu:recipe`, it will automatically be +translated to `git@github.com:/username/recipe` using a simple prefix +matching. + + +```{keypoints} +- If you are frustrated about remembering a command, you should create an alias. +``` diff --git a/branch/sphinx-book-theme/_sources/archaeology.md b/branch/sphinx-book-theme/_sources/archaeology.md new file mode 100644 index 00000000..898acc21 --- /dev/null +++ b/branch/sphinx-book-theme/_sources/archaeology.md @@ -0,0 +1,324 @@ +# Inspecting history + +```{objectives} +- Quickly find a line of code, find out why it was introduced and when. +- Quickly find the commit that changed a behavior. +``` + +```{instructor-note} +- 15 min teaching/type-along +- 30 min exercise +``` + +````{prereq} Preparation +Please make sure that you do not clone repositories inside an already tracked folder: + +```console +$ git status +``` + +If you are inside an existing Git repository, step out of it. +You need to find a different location since we will clone a new repository. + +If you see this message, this is good in this case: + +```shell +fatal: not a git repository (or any of the parent directories): .git +``` +```` + + +## Our toolbox for history inspection + +```{instructor-note} +First the instructor demonstrates few commands on a real life example +repository (mentioned in the amazing site [The +Programming Historian](https://programminghistorian.org/)). +Later we will practice these in groups in an archaeology exercise (below). +After demonstrating the command line tools, the instructor can also demonstrate searching, "show" and "annotate" +in the GitHub browser for this example project. +``` + + +### Warm-up: ["Git History" browser](https://githistory.xyz/) + +As a warm-up we can try the ["Git History" browser](https://githistory.xyz/) +on the README.rst file of the [networkx](https://github.com/networkx/networkx) repository: + +- Visit and browse (use left/right keys). +- You can try this on some of your GitHub repositories, too! + + +### git grep: to search through the repository + +With `git grep` you can find all lines in a repository which contain some string or regular expression. +This is useful to find out where in the code some variable is used or some error message printed: + +```console +$ git grep sometext +$ git grep "some text with spaces" +``` + +In the [networkx](https://github.com/networkx/networkx) repository you can try: + +```console +$ git clone https://github.com/networkx/networkx +$ cd networkx +$ git grep -i fixme +``` + +While `git grep` searches the **current state** of the repository, +it is also possible to search through all changes with `git log -S sometext` +which can be useful to find where something got removed. + + +### git show: to inspect commits + +We have seen this one before already. Using `git show` we can inspect an individual commit if +we know its hash: + +```console +$ git show somehash +``` + +For instance: + +```console +$ git show 759d589bdfa61aff99e0535938f14f67b01c83f7 +``` + + +### git annotate: to annotate code with commit metadata + +Try it out on a file - with `git annotate` you can see line by line who and **when** the line was modified +last. It also prints the precise hash of the last change which modified each line. Incredibly useful +for reproducibility. + +```console +$ git annotate somefile +``` + +Example: + +```console +$ git annotate networkx/convert_matrix.py +``` + +If you annotate in a terminal and the file is longer than the screen, Git by default uses the program `less` to +scroll the output. +Use `/sometext` `` to find "sometext" and you can cycle through the results with `n` (next) and `N` (last). +You can also use page up/down to scroll. You can quit with `q`. + +```{discussion} +Discuss how these two affect the annotation: +- wrapping long lines of text/code into shorter lines +- autoformatting tools such as `black` +``` + + +### git checkout -b: to inspect code in the past + +We can create branches pointing to a commit in the past. +This is the recommended mechanism to inspect old code: + +```console +$ git checkout -b branchname somehash +``` + +Example (lines starting with "#" are only comments): + +```console +$ # create branch called "older-code" from hash 347e6292419b +$ git checkout -b older-code 347e6292419bd0e4bff077fe971f983932d7a0e9 + +$ # now you can navigate and inspect the code as it was back then +$ # ... + +$ # after we are done we can switch back to "main" +$ git checkout main + +$ # if we like we can delete the "older-code" branch +$ git branch -d older-code +``` + +On newer Git versions this is the preferred command: + +```console +$ git switch --create branchname somehash +``` + +(exercise-history)= + +## Exercise: Basic archaeology commands + +`````{exercise} History-1: Explore basic archaeology commands + Let us explore the value of these commands in an exercise. Future + exercises do not depend on this, so it is OK if you do not complete + it fully. + + Exercise steps: + - Clone this repository: + . + Then step into the new directory and create an exercise branch from the networkx-2.6.3 tag/release: + ```console + $ git clone https://github.com/networkx/networkx.git + $ cd networkx + $ git checkout -b exercise networkx-2.6.3 + ``` + + Then using the above toolbox try to: + 1. Find the code line which contains `"Logic error in degree_correlation"`. + 2. Find out when this line was last modified or added. Find the actual commit which modified that line. + 3. Inspect that commit with `git show`. + 4. Create a branch pointing to the past when that commit was created to be + able to browse and use the code as it was back then. + 5. How would you checkout the version of the code right before that line was last modified? + + ````{solution} + 1. We use `git grep`: + ```console + $ git grep "Logic error in degree_correlation" + ``` + This gives the output: + ``` + networkx/algorithms/threshold.py: print("Logic error in degree_correlation", i, rdi) + ``` + Maybe you also want to know the line number: + ```console + $ git grep -n "Logic error in degree_correlation" + ``` + 2. We use `git annotate`: + ```console + $ git annotate networkx/algorithms/threshold.py + ``` + Then search for "Logic error" by typing "/Logic error" followed by Enter. + The last commit that modified it was `90544b4fa` (unless that line changed since). + 3. We use `git show`: + ```console + $ git show 90544b4fa + ``` + 4. Create a branch pointing to that commit (here we called the branch "past-code"): + ```console + $ git branch past-code 90544b4fa + ``` + 5. This is a compact way to access the first parent of `90544b4fa` (here we + called the branch "just-before"): + ```console + $ git checkout -b just-before 90544b4fa~1 + ``` + ```` +````` + +--- + +## Finding out when something broke/changed with git bisect + +> *But I am sure it used to work! Strange.* + +- Sometimes you realize that something broke. +- You know that it used to work. +- You do not know when it broke. + +```{discussion} How would you solve this? +Before we go on first discuss how you would solve this problem: You know that it worked +500 commits ago but it does not work now. + +- How would you find the commit which changed it? +- Why could it be useful to know the commit that changed it? + +**Video workshops**: Write down ideas on how you would solve it in the collaborative +note and we will discuss various approaches. +``` + +We will probably arrive at a solution which is similar to `git bisect`: + +- First find out a commit in past when it worked. + ```console + $ git bisect start + $ git bisect good f0ea950 # this is a commit that worked + $ git bisect bad main # last commit is broken + ``` +- Now compile and/or run and/or test and decide whether "good" or "bad". +- This is how you can tell Git that this was a working commit: + ```console + $ git bisect good + ``` +- And this is how you can tell Git that this was not a working commit: + ```console + $ git bisect bad + ``` +- Then bisect/iterate your way until you find the commit that broke it. +- If you want to go back to start, type `git bisect reset`. +- This can even be automatized with `git bisect run +{% endmacro %} diff --git a/branch/sphinx-book-theme/_static/scripts/bootstrap.js b/branch/sphinx-book-theme/_static/scripts/bootstrap.js new file mode 100644 index 00000000..766173ab --- /dev/null +++ b/branch/sphinx-book-theme/_static/scripts/bootstrap.js @@ -0,0 +1,3 @@ +/*! For license information please see bootstrap.js.LICENSE.txt */ +(()=>{"use strict";var t={d:(e,i)=>{for(var n in i)t.o(i,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:i[n]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r:t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})}},e={};t.r(e),t.d(e,{afterMain:()=>w,afterRead:()=>b,afterWrite:()=>C,applyStyles:()=>$,arrow:()=>G,auto:()=>r,basePlacements:()=>a,beforeMain:()=>v,beforeRead:()=>m,beforeWrite:()=>A,bottom:()=>n,clippingParents:()=>h,computeStyles:()=>et,createPopper:()=>Dt,createPopperBase:()=>Lt,createPopperLite:()=>$t,detectOverflow:()=>mt,end:()=>c,eventListeners:()=>nt,flip:()=>_t,hide:()=>yt,left:()=>o,main:()=>y,modifierPhases:()=>T,offset:()=>wt,placements:()=>g,popper:()=>d,popperGenerator:()=>kt,popperOffsets:()=>At,preventOverflow:()=>Et,read:()=>_,reference:()=>f,right:()=>s,start:()=>l,top:()=>i,variationPlacements:()=>p,viewport:()=>u,write:()=>E});var i="top",n="bottom",s="right",o="left",r="auto",a=[i,n,s,o],l="start",c="end",h="clippingParents",u="viewport",d="popper",f="reference",p=a.reduce((function(t,e){return t.concat([e+"-"+l,e+"-"+c])}),[]),g=[].concat(a,[r]).reduce((function(t,e){return t.concat([e,e+"-"+l,e+"-"+c])}),[]),m="beforeRead",_="read",b="afterRead",v="beforeMain",y="main",w="afterMain",A="beforeWrite",E="write",C="afterWrite",T=[m,_,b,v,y,w,A,E,C];function O(t){return t?(t.nodeName||"").toLowerCase():null}function x(t){if(null==t)return window;if("[object Window]"!==t.toString()){var e=t.ownerDocument;return e&&e.defaultView||window}return t}function k(t){return t instanceof x(t).Element||t instanceof Element}function L(t){return t instanceof x(t).HTMLElement||t instanceof HTMLElement}function D(t){return"undefined"!=typeof ShadowRoot&&(t instanceof x(t).ShadowRoot||t instanceof ShadowRoot)}const $={name:"applyStyles",enabled:!0,phase:"write",fn:function(t){var e=t.state;Object.keys(e.elements).forEach((function(t){var i=e.styles[t]||{},n=e.attributes[t]||{},s=e.elements[t];L(s)&&O(s)&&(Object.assign(s.style,i),Object.keys(n).forEach((function(t){var e=n[t];!1===e?s.removeAttribute(t):s.setAttribute(t,!0===e?"":e)})))}))},effect:function(t){var e=t.state,i={popper:{position:e.options.strategy,left:"0",top:"0",margin:"0"},arrow:{position:"absolute"},reference:{}};return Object.assign(e.elements.popper.style,i.popper),e.styles=i,e.elements.arrow&&Object.assign(e.elements.arrow.style,i.arrow),function(){Object.keys(e.elements).forEach((function(t){var n=e.elements[t],s=e.attributes[t]||{},o=Object.keys(e.styles.hasOwnProperty(t)?e.styles[t]:i[t]).reduce((function(t,e){return t[e]="",t}),{});L(n)&&O(n)&&(Object.assign(n.style,o),Object.keys(s).forEach((function(t){n.removeAttribute(t)})))}))}},requires:["computeStyles"]};function S(t){return t.split("-")[0]}var I=Math.max,N=Math.min,P=Math.round;function j(){var t=navigator.userAgentData;return null!=t&&t.brands&&Array.isArray(t.brands)?t.brands.map((function(t){return t.brand+"/"+t.version})).join(" "):navigator.userAgent}function M(){return!/^((?!chrome|android).)*safari/i.test(j())}function H(t,e,i){void 0===e&&(e=!1),void 0===i&&(i=!1);var n=t.getBoundingClientRect(),s=1,o=1;e&&L(t)&&(s=t.offsetWidth>0&&P(n.width)/t.offsetWidth||1,o=t.offsetHeight>0&&P(n.height)/t.offsetHeight||1);var r=(k(t)?x(t):window).visualViewport,a=!M()&&i,l=(n.left+(a&&r?r.offsetLeft:0))/s,c=(n.top+(a&&r?r.offsetTop:0))/o,h=n.width/s,u=n.height/o;return{width:h,height:u,top:c,right:l+h,bottom:c+u,left:l,x:l,y:c}}function W(t){var e=H(t),i=t.offsetWidth,n=t.offsetHeight;return Math.abs(e.width-i)<=1&&(i=e.width),Math.abs(e.height-n)<=1&&(n=e.height),{x:t.offsetLeft,y:t.offsetTop,width:i,height:n}}function F(t,e){var i=e.getRootNode&&e.getRootNode();if(t.contains(e))return!0;if(i&&D(i)){var n=e;do{if(n&&t.isSameNode(n))return!0;n=n.parentNode||n.host}while(n)}return!1}function B(t){return x(t).getComputedStyle(t)}function z(t){return["table","td","th"].indexOf(O(t))>=0}function q(t){return((k(t)?t.ownerDocument:t.document)||window.document).documentElement}function R(t){return"html"===O(t)?t:t.assignedSlot||t.parentNode||(D(t)?t.host:null)||q(t)}function V(t){return L(t)&&"fixed"!==B(t).position?t.offsetParent:null}function K(t){for(var e=x(t),i=V(t);i&&z(i)&&"static"===B(i).position;)i=V(i);return i&&("html"===O(i)||"body"===O(i)&&"static"===B(i).position)?e:i||function(t){var e=/firefox/i.test(j());if(/Trident/i.test(j())&&L(t)&&"fixed"===B(t).position)return null;var i=R(t);for(D(i)&&(i=i.host);L(i)&&["html","body"].indexOf(O(i))<0;){var n=B(i);if("none"!==n.transform||"none"!==n.perspective||"paint"===n.contain||-1!==["transform","perspective"].indexOf(n.willChange)||e&&"filter"===n.willChange||e&&n.filter&&"none"!==n.filter)return i;i=i.parentNode}return null}(t)||e}function Q(t){return["top","bottom"].indexOf(t)>=0?"x":"y"}function X(t,e,i){return I(t,N(e,i))}function Y(t){return Object.assign({},{top:0,right:0,bottom:0,left:0},t)}function U(t,e){return e.reduce((function(e,i){return e[i]=t,e}),{})}const G={name:"arrow",enabled:!0,phase:"main",fn:function(t){var e,r=t.state,l=t.name,c=t.options,h=r.elements.arrow,u=r.modifiersData.popperOffsets,d=S(r.placement),f=Q(d),p=[o,s].indexOf(d)>=0?"height":"width";if(h&&u){var g=function(t,e){return Y("number"!=typeof(t="function"==typeof t?t(Object.assign({},e.rects,{placement:e.placement})):t)?t:U(t,a))}(c.padding,r),m=W(h),_="y"===f?i:o,b="y"===f?n:s,v=r.rects.reference[p]+r.rects.reference[f]-u[f]-r.rects.popper[p],y=u[f]-r.rects.reference[f],w=K(h),A=w?"y"===f?w.clientHeight||0:w.clientWidth||0:0,E=v/2-y/2,C=g[_],T=A-m[p]-g[b],O=A/2-m[p]/2+E,x=X(C,O,T),k=f;r.modifiersData[l]=((e={})[k]=x,e.centerOffset=x-O,e)}},effect:function(t){var e=t.state,i=t.options.element,n=void 0===i?"[data-popper-arrow]":i;null!=n&&("string"!=typeof n||(n=e.elements.popper.querySelector(n)))&&F(e.elements.popper,n)&&(e.elements.arrow=n)},requires:["popperOffsets"],requiresIfExists:["preventOverflow"]};function J(t){return t.split("-")[1]}var Z={top:"auto",right:"auto",bottom:"auto",left:"auto"};function tt(t){var e,r=t.popper,a=t.popperRect,l=t.placement,h=t.variation,u=t.offsets,d=t.position,f=t.gpuAcceleration,p=t.adaptive,g=t.roundOffsets,m=t.isFixed,_=u.x,b=void 0===_?0:_,v=u.y,y=void 0===v?0:v,w="function"==typeof g?g({x:b,y}):{x:b,y};b=w.x,y=w.y;var A=u.hasOwnProperty("x"),E=u.hasOwnProperty("y"),C=o,T=i,O=window;if(p){var k=K(r),L="clientHeight",D="clientWidth";k===x(r)&&"static"!==B(k=q(r)).position&&"absolute"===d&&(L="scrollHeight",D="scrollWidth"),(l===i||(l===o||l===s)&&h===c)&&(T=n,y-=(m&&k===O&&O.visualViewport?O.visualViewport.height:k[L])-a.height,y*=f?1:-1),l!==o&&(l!==i&&l!==n||h!==c)||(C=s,b-=(m&&k===O&&O.visualViewport?O.visualViewport.width:k[D])-a.width,b*=f?1:-1)}var $,S=Object.assign({position:d},p&&Z),I=!0===g?function(t,e){var i=t.x,n=t.y,s=e.devicePixelRatio||1;return{x:P(i*s)/s||0,y:P(n*s)/s||0}}({x:b,y},x(r)):{x:b,y};return b=I.x,y=I.y,f?Object.assign({},S,(($={})[T]=E?"0":"",$[C]=A?"0":"",$.transform=(O.devicePixelRatio||1)<=1?"translate("+b+"px, "+y+"px)":"translate3d("+b+"px, "+y+"px, 0)",$)):Object.assign({},S,((e={})[T]=E?y+"px":"",e[C]=A?b+"px":"",e.transform="",e))}const et={name:"computeStyles",enabled:!0,phase:"beforeWrite",fn:function(t){var e=t.state,i=t.options,n=i.gpuAcceleration,s=void 0===n||n,o=i.adaptive,r=void 0===o||o,a=i.roundOffsets,l=void 0===a||a,c={placement:S(e.placement),variation:J(e.placement),popper:e.elements.popper,popperRect:e.rects.popper,gpuAcceleration:s,isFixed:"fixed"===e.options.strategy};null!=e.modifiersData.popperOffsets&&(e.styles.popper=Object.assign({},e.styles.popper,tt(Object.assign({},c,{offsets:e.modifiersData.popperOffsets,position:e.options.strategy,adaptive:r,roundOffsets:l})))),null!=e.modifiersData.arrow&&(e.styles.arrow=Object.assign({},e.styles.arrow,tt(Object.assign({},c,{offsets:e.modifiersData.arrow,position:"absolute",adaptive:!1,roundOffsets:l})))),e.attributes.popper=Object.assign({},e.attributes.popper,{"data-popper-placement":e.placement})},data:{}};var it={passive:!0};const nt={name:"eventListeners",enabled:!0,phase:"write",fn:function(){},effect:function(t){var e=t.state,i=t.instance,n=t.options,s=n.scroll,o=void 0===s||s,r=n.resize,a=void 0===r||r,l=x(e.elements.popper),c=[].concat(e.scrollParents.reference,e.scrollParents.popper);return o&&c.forEach((function(t){t.addEventListener("scroll",i.update,it)})),a&&l.addEventListener("resize",i.update,it),function(){o&&c.forEach((function(t){t.removeEventListener("scroll",i.update,it)})),a&&l.removeEventListener("resize",i.update,it)}},data:{}};var st={left:"right",right:"left",bottom:"top",top:"bottom"};function ot(t){return t.replace(/left|right|bottom|top/g,(function(t){return st[t]}))}var rt={start:"end",end:"start"};function at(t){return t.replace(/start|end/g,(function(t){return rt[t]}))}function lt(t){var e=x(t);return{scrollLeft:e.pageXOffset,scrollTop:e.pageYOffset}}function ct(t){return H(q(t)).left+lt(t).scrollLeft}function ht(t){var e=B(t),i=e.overflow,n=e.overflowX,s=e.overflowY;return/auto|scroll|overlay|hidden/.test(i+s+n)}function ut(t){return["html","body","#document"].indexOf(O(t))>=0?t.ownerDocument.body:L(t)&&ht(t)?t:ut(R(t))}function dt(t,e){var i;void 0===e&&(e=[]);var n=ut(t),s=n===(null==(i=t.ownerDocument)?void 0:i.body),o=x(n),r=s?[o].concat(o.visualViewport||[],ht(n)?n:[]):n,a=e.concat(r);return s?a:a.concat(dt(R(r)))}function ft(t){return Object.assign({},t,{left:t.x,top:t.y,right:t.x+t.width,bottom:t.y+t.height})}function pt(t,e,i){return e===u?ft(function(t,e){var i=x(t),n=q(t),s=i.visualViewport,o=n.clientWidth,r=n.clientHeight,a=0,l=0;if(s){o=s.width,r=s.height;var c=M();(c||!c&&"fixed"===e)&&(a=s.offsetLeft,l=s.offsetTop)}return{width:o,height:r,x:a+ct(t),y:l}}(t,i)):k(e)?function(t,e){var i=H(t,!1,"fixed"===e);return i.top=i.top+t.clientTop,i.left=i.left+t.clientLeft,i.bottom=i.top+t.clientHeight,i.right=i.left+t.clientWidth,i.width=t.clientWidth,i.height=t.clientHeight,i.x=i.left,i.y=i.top,i}(e,i):ft(function(t){var e,i=q(t),n=lt(t),s=null==(e=t.ownerDocument)?void 0:e.body,o=I(i.scrollWidth,i.clientWidth,s?s.scrollWidth:0,s?s.clientWidth:0),r=I(i.scrollHeight,i.clientHeight,s?s.scrollHeight:0,s?s.clientHeight:0),a=-n.scrollLeft+ct(t),l=-n.scrollTop;return"rtl"===B(s||i).direction&&(a+=I(i.clientWidth,s?s.clientWidth:0)-o),{width:o,height:r,x:a,y:l}}(q(t)))}function gt(t){var e,r=t.reference,a=t.element,h=t.placement,u=h?S(h):null,d=h?J(h):null,f=r.x+r.width/2-a.width/2,p=r.y+r.height/2-a.height/2;switch(u){case i:e={x:f,y:r.y-a.height};break;case n:e={x:f,y:r.y+r.height};break;case s:e={x:r.x+r.width,y:p};break;case o:e={x:r.x-a.width,y:p};break;default:e={x:r.x,y:r.y}}var g=u?Q(u):null;if(null!=g){var m="y"===g?"height":"width";switch(d){case l:e[g]=e[g]-(r[m]/2-a[m]/2);break;case c:e[g]=e[g]+(r[m]/2-a[m]/2)}}return e}function mt(t,e){void 0===e&&(e={});var o=e,r=o.placement,l=void 0===r?t.placement:r,c=o.strategy,p=void 0===c?t.strategy:c,g=o.boundary,m=void 0===g?h:g,_=o.rootBoundary,b=void 0===_?u:_,v=o.elementContext,y=void 0===v?d:v,w=o.altBoundary,A=void 0!==w&&w,E=o.padding,C=void 0===E?0:E,T=Y("number"!=typeof C?C:U(C,a)),x=y===d?f:d,D=t.rects.popper,$=t.elements[A?x:y],S=function(t,e,i,n){var s="clippingParents"===e?function(t){var e=dt(R(t)),i=["absolute","fixed"].indexOf(B(t).position)>=0&&L(t)?K(t):t;return k(i)?e.filter((function(t){return k(t)&&F(t,i)&&"body"!==O(t)})):[]}(t):[].concat(e),o=[].concat(s,[i]),r=o[0],a=o.reduce((function(e,i){var s=pt(t,i,n);return e.top=I(s.top,e.top),e.right=N(s.right,e.right),e.bottom=N(s.bottom,e.bottom),e.left=I(s.left,e.left),e}),pt(t,r,n));return a.width=a.right-a.left,a.height=a.bottom-a.top,a.x=a.left,a.y=a.top,a}(k($)?$:$.contextElement||q(t.elements.popper),m,b,p),P=H(t.elements.reference),j=gt({reference:P,element:D,strategy:"absolute",placement:l}),M=ft(Object.assign({},D,j)),W=y===d?M:P,z={top:S.top-W.top+T.top,bottom:W.bottom-S.bottom+T.bottom,left:S.left-W.left+T.left,right:W.right-S.right+T.right},V=t.modifiersData.offset;if(y===d&&V){var Q=V[l];Object.keys(z).forEach((function(t){var e=[s,n].indexOf(t)>=0?1:-1,o=[i,n].indexOf(t)>=0?"y":"x";z[t]+=Q[o]*e}))}return z}const _t={name:"flip",enabled:!0,phase:"main",fn:function(t){var e=t.state,c=t.options,h=t.name;if(!e.modifiersData[h]._skip){for(var u=c.mainAxis,d=void 0===u||u,f=c.altAxis,m=void 0===f||f,_=c.fallbackPlacements,b=c.padding,v=c.boundary,y=c.rootBoundary,w=c.altBoundary,A=c.flipVariations,E=void 0===A||A,C=c.allowedAutoPlacements,T=e.options.placement,O=S(T),x=_||(O!==T&&E?function(t){if(S(t)===r)return[];var e=ot(t);return[at(t),e,at(e)]}(T):[ot(T)]),k=[T].concat(x).reduce((function(t,i){return t.concat(S(i)===r?function(t,e){void 0===e&&(e={});var i=e,n=i.placement,s=i.boundary,o=i.rootBoundary,r=i.padding,l=i.flipVariations,c=i.allowedAutoPlacements,h=void 0===c?g:c,u=J(n),d=u?l?p:p.filter((function(t){return J(t)===u})):a,f=d.filter((function(t){return h.indexOf(t)>=0}));0===f.length&&(f=d);var m=f.reduce((function(e,i){return e[i]=mt(t,{placement:i,boundary:s,rootBoundary:o,padding:r})[S(i)],e}),{});return Object.keys(m).sort((function(t,e){return m[t]-m[e]}))}(e,{placement:i,boundary:v,rootBoundary:y,padding:b,flipVariations:E,allowedAutoPlacements:C}):i)}),[]),L=e.rects.reference,D=e.rects.popper,$=new Map,I=!0,N=k[0],P=0;P=0,F=W?"width":"height",B=mt(e,{placement:j,boundary:v,rootBoundary:y,altBoundary:w,padding:b}),z=W?H?s:o:H?n:i;L[F]>D[F]&&(z=ot(z));var q=ot(z),R=[];if(d&&R.push(B[M]<=0),m&&R.push(B[z]<=0,B[q]<=0),R.every((function(t){return t}))){N=j,I=!1;break}$.set(j,R)}if(I)for(var V=function(t){var e=k.find((function(e){var i=$.get(e);if(i)return i.slice(0,t).every((function(t){return t}))}));if(e)return N=e,"break"},K=E?3:1;K>0&&"break"!==V(K);K--);e.placement!==N&&(e.modifiersData[h]._skip=!0,e.placement=N,e.reset=!0)}},requiresIfExists:["offset"],data:{_skip:!1}};function bt(t,e,i){return void 0===i&&(i={x:0,y:0}),{top:t.top-e.height-i.y,right:t.right-e.width+i.x,bottom:t.bottom-e.height+i.y,left:t.left-e.width-i.x}}function vt(t){return[i,s,n,o].some((function(e){return t[e]>=0}))}const yt={name:"hide",enabled:!0,phase:"main",requiresIfExists:["preventOverflow"],fn:function(t){var e=t.state,i=t.name,n=e.rects.reference,s=e.rects.popper,o=e.modifiersData.preventOverflow,r=mt(e,{elementContext:"reference"}),a=mt(e,{altBoundary:!0}),l=bt(r,n),c=bt(a,s,o),h=vt(l),u=vt(c);e.modifiersData[i]={referenceClippingOffsets:l,popperEscapeOffsets:c,isReferenceHidden:h,hasPopperEscaped:u},e.attributes.popper=Object.assign({},e.attributes.popper,{"data-popper-reference-hidden":h,"data-popper-escaped":u})}},wt={name:"offset",enabled:!0,phase:"main",requires:["popperOffsets"],fn:function(t){var e=t.state,n=t.options,r=t.name,a=n.offset,l=void 0===a?[0,0]:a,c=g.reduce((function(t,n){return t[n]=function(t,e,n){var r=S(t),a=[o,i].indexOf(r)>=0?-1:1,l="function"==typeof n?n(Object.assign({},e,{placement:t})):n,c=l[0],h=l[1];return c=c||0,h=(h||0)*a,[o,s].indexOf(r)>=0?{x:h,y:c}:{x:c,y:h}}(n,e.rects,l),t}),{}),h=c[e.placement],u=h.x,d=h.y;null!=e.modifiersData.popperOffsets&&(e.modifiersData.popperOffsets.x+=u,e.modifiersData.popperOffsets.y+=d),e.modifiersData[r]=c}},At={name:"popperOffsets",enabled:!0,phase:"read",fn:function(t){var e=t.state,i=t.name;e.modifiersData[i]=gt({reference:e.rects.reference,element:e.rects.popper,strategy:"absolute",placement:e.placement})},data:{}},Et={name:"preventOverflow",enabled:!0,phase:"main",fn:function(t){var e=t.state,r=t.options,a=t.name,c=r.mainAxis,h=void 0===c||c,u=r.altAxis,d=void 0!==u&&u,f=r.boundary,p=r.rootBoundary,g=r.altBoundary,m=r.padding,_=r.tether,b=void 0===_||_,v=r.tetherOffset,y=void 0===v?0:v,w=mt(e,{boundary:f,rootBoundary:p,padding:m,altBoundary:g}),A=S(e.placement),E=J(e.placement),C=!E,T=Q(A),O="x"===T?"y":"x",x=e.modifiersData.popperOffsets,k=e.rects.reference,L=e.rects.popper,D="function"==typeof y?y(Object.assign({},e.rects,{placement:e.placement})):y,$="number"==typeof D?{mainAxis:D,altAxis:D}:Object.assign({mainAxis:0,altAxis:0},D),P=e.modifiersData.offset?e.modifiersData.offset[e.placement]:null,j={x:0,y:0};if(x){if(h){var M,H="y"===T?i:o,F="y"===T?n:s,B="y"===T?"height":"width",z=x[T],q=z+w[H],R=z-w[F],V=b?-L[B]/2:0,Y=E===l?k[B]:L[B],U=E===l?-L[B]:-k[B],G=e.elements.arrow,Z=b&&G?W(G):{width:0,height:0},tt=e.modifiersData["arrow#persistent"]?e.modifiersData["arrow#persistent"].padding:{top:0,right:0,bottom:0,left:0},et=tt[H],it=tt[F],nt=X(0,k[B],Z[B]),st=C?k[B]/2-V-nt-et-$.mainAxis:Y-nt-et-$.mainAxis,ot=C?-k[B]/2+V+nt+it+$.mainAxis:U+nt+it+$.mainAxis,rt=e.elements.arrow&&K(e.elements.arrow),at=rt?"y"===T?rt.clientTop||0:rt.clientLeft||0:0,lt=null!=(M=null==P?void 0:P[T])?M:0,ct=z+ot-lt,ht=X(b?N(q,z+st-lt-at):q,z,b?I(R,ct):R);x[T]=ht,j[T]=ht-z}if(d){var ut,dt="x"===T?i:o,ft="x"===T?n:s,pt=x[O],gt="y"===O?"height":"width",_t=pt+w[dt],bt=pt-w[ft],vt=-1!==[i,o].indexOf(A),yt=null!=(ut=null==P?void 0:P[O])?ut:0,wt=vt?_t:pt-k[gt]-L[gt]-yt+$.altAxis,At=vt?pt+k[gt]+L[gt]-yt-$.altAxis:bt,Et=b&&vt?function(t,e,i){var n=X(t,e,i);return n>i?i:n}(wt,pt,At):X(b?wt:_t,pt,b?At:bt);x[O]=Et,j[O]=Et-pt}e.modifiersData[a]=j}},requiresIfExists:["offset"]};function Ct(t,e,i){void 0===i&&(i=!1);var n,s,o=L(e),r=L(e)&&function(t){var e=t.getBoundingClientRect(),i=P(e.width)/t.offsetWidth||1,n=P(e.height)/t.offsetHeight||1;return 1!==i||1!==n}(e),a=q(e),l=H(t,r,i),c={scrollLeft:0,scrollTop:0},h={x:0,y:0};return(o||!o&&!i)&&(("body"!==O(e)||ht(a))&&(c=(n=e)!==x(n)&&L(n)?{scrollLeft:(s=n).scrollLeft,scrollTop:s.scrollTop}:lt(n)),L(e)?((h=H(e,!0)).x+=e.clientLeft,h.y+=e.clientTop):a&&(h.x=ct(a))),{x:l.left+c.scrollLeft-h.x,y:l.top+c.scrollTop-h.y,width:l.width,height:l.height}}function Tt(t){var e=new Map,i=new Set,n=[];function s(t){i.add(t.name),[].concat(t.requires||[],t.requiresIfExists||[]).forEach((function(t){if(!i.has(t)){var n=e.get(t);n&&s(n)}})),n.push(t)}return t.forEach((function(t){e.set(t.name,t)})),t.forEach((function(t){i.has(t.name)||s(t)})),n}var Ot={placement:"bottom",modifiers:[],strategy:"absolute"};function xt(){for(var t=arguments.length,e=new Array(t),i=0;i{let e=t.getAttribute("data-bs-target");if(!e||"#"===e){let i=t.getAttribute("href");if(!i||!i.includes("#")&&!i.startsWith("."))return null;i.includes("#")&&!i.startsWith("#")&&(i=`#${i.split("#")[1]}`),e=i&&"#"!==i?i.trim():null}return e},Nt=t=>{const e=It(t);return e&&document.querySelector(e)?e:null},Pt=t=>{const e=It(t);return e?document.querySelector(e):null},jt=t=>{t.dispatchEvent(new Event(St))},Mt=t=>!(!t||"object"!=typeof t)&&(void 0!==t.jquery&&(t=t[0]),void 0!==t.nodeType),Ht=t=>Mt(t)?t.jquery?t[0]:t:"string"==typeof t&&t.length>0?document.querySelector(t):null,Wt=t=>{if(!Mt(t)||0===t.getClientRects().length)return!1;const e="visible"===getComputedStyle(t).getPropertyValue("visibility"),i=t.closest("details:not([open])");if(!i)return e;if(i!==t){const e=t.closest("summary");if(e&&e.parentNode!==i)return!1;if(null===e)return!1}return e},Ft=t=>!t||t.nodeType!==Node.ELEMENT_NODE||!!t.classList.contains("disabled")||(void 0!==t.disabled?t.disabled:t.hasAttribute("disabled")&&"false"!==t.getAttribute("disabled")),Bt=t=>{if(!document.documentElement.attachShadow)return null;if("function"==typeof t.getRootNode){const e=t.getRootNode();return e instanceof ShadowRoot?e:null}return t instanceof ShadowRoot?t:t.parentNode?Bt(t.parentNode):null},zt=()=>{},qt=t=>{t.offsetHeight},Rt=()=>window.jQuery&&!document.body.hasAttribute("data-bs-no-jquery")?window.jQuery:null,Vt=[],Kt=()=>"rtl"===document.documentElement.dir,Qt=t=>{var e;e=()=>{const e=Rt();if(e){const i=t.NAME,n=e.fn[i];e.fn[i]=t.jQueryInterface,e.fn[i].Constructor=t,e.fn[i].noConflict=()=>(e.fn[i]=n,t.jQueryInterface)}},"loading"===document.readyState?(Vt.length||document.addEventListener("DOMContentLoaded",(()=>{for(const t of Vt)t()})),Vt.push(e)):e()},Xt=t=>{"function"==typeof t&&t()},Yt=(t,e,i=!0)=>{if(!i)return void Xt(t);const n=(t=>{if(!t)return 0;let{transitionDuration:e,transitionDelay:i}=window.getComputedStyle(t);const n=Number.parseFloat(e),s=Number.parseFloat(i);return n||s?(e=e.split(",")[0],i=i.split(",")[0],1e3*(Number.parseFloat(e)+Number.parseFloat(i))):0})(e)+5;let s=!1;const o=({target:i})=>{i===e&&(s=!0,e.removeEventListener(St,o),Xt(t))};e.addEventListener(St,o),setTimeout((()=>{s||jt(e)}),n)},Ut=(t,e,i,n)=>{const s=t.length;let o=t.indexOf(e);return-1===o?!i&&n?t[s-1]:t[0]:(o+=i?1:-1,n&&(o=(o+s)%s),t[Math.max(0,Math.min(o,s-1))])},Gt=/[^.]*(?=\..*)\.|.*/,Jt=/\..*/,Zt=/::\d+$/,te={};let ee=1;const ie={mouseenter:"mouseover",mouseleave:"mouseout"},ne=new Set(["click","dblclick","mouseup","mousedown","contextmenu","mousewheel","DOMMouseScroll","mouseover","mouseout","mousemove","selectstart","selectend","keydown","keypress","keyup","orientationchange","touchstart","touchmove","touchend","touchcancel","pointerdown","pointermove","pointerup","pointerleave","pointercancel","gesturestart","gesturechange","gestureend","focus","blur","change","reset","select","submit","focusin","focusout","load","unload","beforeunload","resize","move","DOMContentLoaded","readystatechange","error","abort","scroll"]);function se(t,e){return e&&`${e}::${ee++}`||t.uidEvent||ee++}function oe(t){const e=se(t);return t.uidEvent=e,te[e]=te[e]||{},te[e]}function re(t,e,i=null){return Object.values(t).find((t=>t.callable===e&&t.delegationSelector===i))}function ae(t,e,i){const n="string"==typeof e,s=n?i:e||i;let o=ue(t);return ne.has(o)||(o=t),[n,s,o]}function le(t,e,i,n,s){if("string"!=typeof e||!t)return;let[o,r,a]=ae(e,i,n);if(e in ie){const t=t=>function(e){if(!e.relatedTarget||e.relatedTarget!==e.delegateTarget&&!e.delegateTarget.contains(e.relatedTarget))return t.call(this,e)};r=t(r)}const l=oe(t),c=l[a]||(l[a]={}),h=re(c,r,o?i:null);if(h)return void(h.oneOff=h.oneOff&&s);const u=se(r,e.replace(Gt,"")),d=o?function(t,e,i){return function n(s){const o=t.querySelectorAll(e);for(let{target:r}=s;r&&r!==this;r=r.parentNode)for(const a of o)if(a===r)return fe(s,{delegateTarget:r}),n.oneOff&&de.off(t,s.type,e,i),i.apply(r,[s])}}(t,i,r):function(t,e){return function i(n){return fe(n,{delegateTarget:t}),i.oneOff&&de.off(t,n.type,e),e.apply(t,[n])}}(t,r);d.delegationSelector=o?i:null,d.callable=r,d.oneOff=s,d.uidEvent=u,c[u]=d,t.addEventListener(a,d,o)}function ce(t,e,i,n,s){const o=re(e[i],n,s);o&&(t.removeEventListener(i,o,Boolean(s)),delete e[i][o.uidEvent])}function he(t,e,i,n){const s=e[i]||{};for(const o of Object.keys(s))if(o.includes(n)){const n=s[o];ce(t,e,i,n.callable,n.delegationSelector)}}function ue(t){return t=t.replace(Jt,""),ie[t]||t}const de={on(t,e,i,n){le(t,e,i,n,!1)},one(t,e,i,n){le(t,e,i,n,!0)},off(t,e,i,n){if("string"!=typeof e||!t)return;const[s,o,r]=ae(e,i,n),a=r!==e,l=oe(t),c=l[r]||{},h=e.startsWith(".");if(void 0===o){if(h)for(const i of Object.keys(l))he(t,l,i,e.slice(1));for(const i of Object.keys(c)){const n=i.replace(Zt,"");if(!a||e.includes(n)){const e=c[i];ce(t,l,r,e.callable,e.delegationSelector)}}}else{if(!Object.keys(c).length)return;ce(t,l,r,o,s?i:null)}},trigger(t,e,i){if("string"!=typeof e||!t)return null;const n=Rt();let s=null,o=!0,r=!0,a=!1;e!==ue(e)&&n&&(s=n.Event(e,i),n(t).trigger(s),o=!s.isPropagationStopped(),r=!s.isImmediatePropagationStopped(),a=s.isDefaultPrevented());let l=new Event(e,{bubbles:o,cancelable:!0});return l=fe(l,i),a&&l.preventDefault(),r&&t.dispatchEvent(l),l.defaultPrevented&&s&&s.preventDefault(),l}};function fe(t,e){for(const[i,n]of Object.entries(e||{}))try{t[i]=n}catch(e){Object.defineProperty(t,i,{configurable:!0,get:()=>n})}return t}const pe=new Map,ge={set(t,e,i){pe.has(t)||pe.set(t,new Map);const n=pe.get(t);n.has(e)||0===n.size?n.set(e,i):console.error(`Bootstrap doesn't allow more than one instance per element. Bound instance: ${Array.from(n.keys())[0]}.`)},get:(t,e)=>pe.has(t)&&pe.get(t).get(e)||null,remove(t,e){if(!pe.has(t))return;const i=pe.get(t);i.delete(e),0===i.size&&pe.delete(t)}};function me(t){if("true"===t)return!0;if("false"===t)return!1;if(t===Number(t).toString())return Number(t);if(""===t||"null"===t)return null;if("string"!=typeof t)return t;try{return JSON.parse(decodeURIComponent(t))}catch(e){return t}}function _e(t){return t.replace(/[A-Z]/g,(t=>`-${t.toLowerCase()}`))}const be={setDataAttribute(t,e,i){t.setAttribute(`data-bs-${_e(e)}`,i)},removeDataAttribute(t,e){t.removeAttribute(`data-bs-${_e(e)}`)},getDataAttributes(t){if(!t)return{};const e={},i=Object.keys(t.dataset).filter((t=>t.startsWith("bs")&&!t.startsWith("bsConfig")));for(const n of i){let i=n.replace(/^bs/,"");i=i.charAt(0).toLowerCase()+i.slice(1,i.length),e[i]=me(t.dataset[n])}return e},getDataAttribute:(t,e)=>me(t.getAttribute(`data-bs-${_e(e)}`))};class ve{static get Default(){return{}}static get DefaultType(){return{}}static get NAME(){throw new Error('You have to implement the static method "NAME", for each component!')}_getConfig(t){return t=this._mergeConfigObj(t),t=this._configAfterMerge(t),this._typeCheckConfig(t),t}_configAfterMerge(t){return t}_mergeConfigObj(t,e){const i=Mt(e)?be.getDataAttribute(e,"config"):{};return{...this.constructor.Default,..."object"==typeof i?i:{},...Mt(e)?be.getDataAttributes(e):{},..."object"==typeof t?t:{}}}_typeCheckConfig(t,e=this.constructor.DefaultType){for(const n of Object.keys(e)){const s=e[n],o=t[n],r=Mt(o)?"element":null==(i=o)?`${i}`:Object.prototype.toString.call(i).match(/\s([a-z]+)/i)[1].toLowerCase();if(!new RegExp(s).test(r))throw new TypeError(`${this.constructor.NAME.toUpperCase()}: Option "${n}" provided type "${r}" but expected type "${s}".`)}var i}}class ye extends ve{constructor(t,e){super(),(t=Ht(t))&&(this._element=t,this._config=this._getConfig(e),ge.set(this._element,this.constructor.DATA_KEY,this))}dispose(){ge.remove(this._element,this.constructor.DATA_KEY),de.off(this._element,this.constructor.EVENT_KEY);for(const t of Object.getOwnPropertyNames(this))this[t]=null}_queueCallback(t,e,i=!0){Yt(t,e,i)}_getConfig(t){return t=this._mergeConfigObj(t,this._element),t=this._configAfterMerge(t),this._typeCheckConfig(t),t}static getInstance(t){return ge.get(Ht(t),this.DATA_KEY)}static getOrCreateInstance(t,e={}){return this.getInstance(t)||new this(t,"object"==typeof e?e:null)}static get VERSION(){return"5.2.3"}static get DATA_KEY(){return`bs.${this.NAME}`}static get EVENT_KEY(){return`.${this.DATA_KEY}`}static eventName(t){return`${t}${this.EVENT_KEY}`}}const we=(t,e="hide")=>{const i=`click.dismiss${t.EVENT_KEY}`,n=t.NAME;de.on(document,i,`[data-bs-dismiss="${n}"]`,(function(i){if(["A","AREA"].includes(this.tagName)&&i.preventDefault(),Ft(this))return;const s=Pt(this)||this.closest(`.${n}`);t.getOrCreateInstance(s)[e]()}))},Ae=".bs.alert",Ee=`close${Ae}`,Ce=`closed${Ae}`;class Te extends ye{static get NAME(){return"alert"}close(){if(de.trigger(this._element,Ee).defaultPrevented)return;this._element.classList.remove("show");const t=this._element.classList.contains("fade");this._queueCallback((()=>this._destroyElement()),this._element,t)}_destroyElement(){this._element.remove(),de.trigger(this._element,Ce),this.dispose()}static jQueryInterface(t){return this.each((function(){const e=Te.getOrCreateInstance(this);if("string"==typeof t){if(void 0===e[t]||t.startsWith("_")||"constructor"===t)throw new TypeError(`No method named "${t}"`);e[t](this)}}))}}we(Te,"close"),Qt(Te);const Oe='[data-bs-toggle="button"]';class xe extends ye{static get NAME(){return"button"}toggle(){this._element.setAttribute("aria-pressed",this._element.classList.toggle("active"))}static jQueryInterface(t){return this.each((function(){const e=xe.getOrCreateInstance(this);"toggle"===t&&e[t]()}))}}de.on(document,"click.bs.button.data-api",Oe,(t=>{t.preventDefault();const e=t.target.closest(Oe);xe.getOrCreateInstance(e).toggle()})),Qt(xe);const ke={find:(t,e=document.documentElement)=>[].concat(...Element.prototype.querySelectorAll.call(e,t)),findOne:(t,e=document.documentElement)=>Element.prototype.querySelector.call(e,t),children:(t,e)=>[].concat(...t.children).filter((t=>t.matches(e))),parents(t,e){const i=[];let n=t.parentNode.closest(e);for(;n;)i.push(n),n=n.parentNode.closest(e);return i},prev(t,e){let i=t.previousElementSibling;for(;i;){if(i.matches(e))return[i];i=i.previousElementSibling}return[]},next(t,e){let i=t.nextElementSibling;for(;i;){if(i.matches(e))return[i];i=i.nextElementSibling}return[]},focusableChildren(t){const e=["a","button","input","textarea","select","details","[tabindex]",'[contenteditable="true"]'].map((t=>`${t}:not([tabindex^="-"])`)).join(",");return this.find(e,t).filter((t=>!Ft(t)&&Wt(t)))}},Le=".bs.swipe",De=`touchstart${Le}`,$e=`touchmove${Le}`,Se=`touchend${Le}`,Ie=`pointerdown${Le}`,Ne=`pointerup${Le}`,Pe={endCallback:null,leftCallback:null,rightCallback:null},je={endCallback:"(function|null)",leftCallback:"(function|null)",rightCallback:"(function|null)"};class Me extends ve{constructor(t,e){super(),this._element=t,t&&Me.isSupported()&&(this._config=this._getConfig(e),this._deltaX=0,this._supportPointerEvents=Boolean(window.PointerEvent),this._initEvents())}static get Default(){return Pe}static get DefaultType(){return je}static get NAME(){return"swipe"}dispose(){de.off(this._element,Le)}_start(t){this._supportPointerEvents?this._eventIsPointerPenTouch(t)&&(this._deltaX=t.clientX):this._deltaX=t.touches[0].clientX}_end(t){this._eventIsPointerPenTouch(t)&&(this._deltaX=t.clientX-this._deltaX),this._handleSwipe(),Xt(this._config.endCallback)}_move(t){this._deltaX=t.touches&&t.touches.length>1?0:t.touches[0].clientX-this._deltaX}_handleSwipe(){const t=Math.abs(this._deltaX);if(t<=40)return;const e=t/this._deltaX;this._deltaX=0,e&&Xt(e>0?this._config.rightCallback:this._config.leftCallback)}_initEvents(){this._supportPointerEvents?(de.on(this._element,Ie,(t=>this._start(t))),de.on(this._element,Ne,(t=>this._end(t))),this._element.classList.add("pointer-event")):(de.on(this._element,De,(t=>this._start(t))),de.on(this._element,$e,(t=>this._move(t))),de.on(this._element,Se,(t=>this._end(t))))}_eventIsPointerPenTouch(t){return this._supportPointerEvents&&("pen"===t.pointerType||"touch"===t.pointerType)}static isSupported(){return"ontouchstart"in document.documentElement||navigator.maxTouchPoints>0}}const He=".bs.carousel",We=".data-api",Fe="next",Be="prev",ze="left",qe="right",Re=`slide${He}`,Ve=`slid${He}`,Ke=`keydown${He}`,Qe=`mouseenter${He}`,Xe=`mouseleave${He}`,Ye=`dragstart${He}`,Ue=`load${He}${We}`,Ge=`click${He}${We}`,Je="carousel",Ze="active",ti=".active",ei=".carousel-item",ii=ti+ei,ni={ArrowLeft:qe,ArrowRight:ze},si={interval:5e3,keyboard:!0,pause:"hover",ride:!1,touch:!0,wrap:!0},oi={interval:"(number|boolean)",keyboard:"boolean",pause:"(string|boolean)",ride:"(boolean|string)",touch:"boolean",wrap:"boolean"};class ri extends ye{constructor(t,e){super(t,e),this._interval=null,this._activeElement=null,this._isSliding=!1,this.touchTimeout=null,this._swipeHelper=null,this._indicatorsElement=ke.findOne(".carousel-indicators",this._element),this._addEventListeners(),this._config.ride===Je&&this.cycle()}static get Default(){return si}static get DefaultType(){return oi}static get NAME(){return"carousel"}next(){this._slide(Fe)}nextWhenVisible(){!document.hidden&&Wt(this._element)&&this.next()}prev(){this._slide(Be)}pause(){this._isSliding&&jt(this._element),this._clearInterval()}cycle(){this._clearInterval(),this._updateInterval(),this._interval=setInterval((()=>this.nextWhenVisible()),this._config.interval)}_maybeEnableCycle(){this._config.ride&&(this._isSliding?de.one(this._element,Ve,(()=>this.cycle())):this.cycle())}to(t){const e=this._getItems();if(t>e.length-1||t<0)return;if(this._isSliding)return void de.one(this._element,Ve,(()=>this.to(t)));const i=this._getItemIndex(this._getActive());if(i===t)return;const n=t>i?Fe:Be;this._slide(n,e[t])}dispose(){this._swipeHelper&&this._swipeHelper.dispose(),super.dispose()}_configAfterMerge(t){return t.defaultInterval=t.interval,t}_addEventListeners(){this._config.keyboard&&de.on(this._element,Ke,(t=>this._keydown(t))),"hover"===this._config.pause&&(de.on(this._element,Qe,(()=>this.pause())),de.on(this._element,Xe,(()=>this._maybeEnableCycle()))),this._config.touch&&Me.isSupported()&&this._addTouchEventListeners()}_addTouchEventListeners(){for(const t of ke.find(".carousel-item img",this._element))de.on(t,Ye,(t=>t.preventDefault()));const t={leftCallback:()=>this._slide(this._directionToOrder(ze)),rightCallback:()=>this._slide(this._directionToOrder(qe)),endCallback:()=>{"hover"===this._config.pause&&(this.pause(),this.touchTimeout&&clearTimeout(this.touchTimeout),this.touchTimeout=setTimeout((()=>this._maybeEnableCycle()),500+this._config.interval))}};this._swipeHelper=new Me(this._element,t)}_keydown(t){if(/input|textarea/i.test(t.target.tagName))return;const e=ni[t.key];e&&(t.preventDefault(),this._slide(this._directionToOrder(e)))}_getItemIndex(t){return this._getItems().indexOf(t)}_setActiveIndicatorElement(t){if(!this._indicatorsElement)return;const e=ke.findOne(ti,this._indicatorsElement);e.classList.remove(Ze),e.removeAttribute("aria-current");const i=ke.findOne(`[data-bs-slide-to="${t}"]`,this._indicatorsElement);i&&(i.classList.add(Ze),i.setAttribute("aria-current","true"))}_updateInterval(){const t=this._activeElement||this._getActive();if(!t)return;const e=Number.parseInt(t.getAttribute("data-bs-interval"),10);this._config.interval=e||this._config.defaultInterval}_slide(t,e=null){if(this._isSliding)return;const i=this._getActive(),n=t===Fe,s=e||Ut(this._getItems(),i,n,this._config.wrap);if(s===i)return;const o=this._getItemIndex(s),r=e=>de.trigger(this._element,e,{relatedTarget:s,direction:this._orderToDirection(t),from:this._getItemIndex(i),to:o});if(r(Re).defaultPrevented)return;if(!i||!s)return;const a=Boolean(this._interval);this.pause(),this._isSliding=!0,this._setActiveIndicatorElement(o),this._activeElement=s;const l=n?"carousel-item-start":"carousel-item-end",c=n?"carousel-item-next":"carousel-item-prev";s.classList.add(c),qt(s),i.classList.add(l),s.classList.add(l),this._queueCallback((()=>{s.classList.remove(l,c),s.classList.add(Ze),i.classList.remove(Ze,c,l),this._isSliding=!1,r(Ve)}),i,this._isAnimated()),a&&this.cycle()}_isAnimated(){return this._element.classList.contains("slide")}_getActive(){return ke.findOne(ii,this._element)}_getItems(){return ke.find(ei,this._element)}_clearInterval(){this._interval&&(clearInterval(this._interval),this._interval=null)}_directionToOrder(t){return Kt()?t===ze?Be:Fe:t===ze?Fe:Be}_orderToDirection(t){return Kt()?t===Be?ze:qe:t===Be?qe:ze}static jQueryInterface(t){return this.each((function(){const e=ri.getOrCreateInstance(this,t);if("number"!=typeof t){if("string"==typeof t){if(void 0===e[t]||t.startsWith("_")||"constructor"===t)throw new TypeError(`No method named "${t}"`);e[t]()}}else e.to(t)}))}}de.on(document,Ge,"[data-bs-slide], [data-bs-slide-to]",(function(t){const e=Pt(this);if(!e||!e.classList.contains(Je))return;t.preventDefault();const i=ri.getOrCreateInstance(e),n=this.getAttribute("data-bs-slide-to");return n?(i.to(n),void i._maybeEnableCycle()):"next"===be.getDataAttribute(this,"slide")?(i.next(),void i._maybeEnableCycle()):(i.prev(),void i._maybeEnableCycle())})),de.on(window,Ue,(()=>{const t=ke.find('[data-bs-ride="carousel"]');for(const e of t)ri.getOrCreateInstance(e)})),Qt(ri);const ai=".bs.collapse",li=`show${ai}`,ci=`shown${ai}`,hi=`hide${ai}`,ui=`hidden${ai}`,di=`click${ai}.data-api`,fi="show",pi="collapse",gi="collapsing",mi=`:scope .${pi} .${pi}`,_i='[data-bs-toggle="collapse"]',bi={parent:null,toggle:!0},vi={parent:"(null|element)",toggle:"boolean"};class yi extends ye{constructor(t,e){super(t,e),this._isTransitioning=!1,this._triggerArray=[];const i=ke.find(_i);for(const t of i){const e=Nt(t),i=ke.find(e).filter((t=>t===this._element));null!==e&&i.length&&this._triggerArray.push(t)}this._initializeChildren(),this._config.parent||this._addAriaAndCollapsedClass(this._triggerArray,this._isShown()),this._config.toggle&&this.toggle()}static get Default(){return bi}static get DefaultType(){return vi}static get NAME(){return"collapse"}toggle(){this._isShown()?this.hide():this.show()}show(){if(this._isTransitioning||this._isShown())return;let t=[];if(this._config.parent&&(t=this._getFirstLevelChildren(".collapse.show, .collapse.collapsing").filter((t=>t!==this._element)).map((t=>yi.getOrCreateInstance(t,{toggle:!1})))),t.length&&t[0]._isTransitioning)return;if(de.trigger(this._element,li).defaultPrevented)return;for(const e of t)e.hide();const e=this._getDimension();this._element.classList.remove(pi),this._element.classList.add(gi),this._element.style[e]=0,this._addAriaAndCollapsedClass(this._triggerArray,!0),this._isTransitioning=!0;const i=`scroll${e[0].toUpperCase()+e.slice(1)}`;this._queueCallback((()=>{this._isTransitioning=!1,this._element.classList.remove(gi),this._element.classList.add(pi,fi),this._element.style[e]="",de.trigger(this._element,ci)}),this._element,!0),this._element.style[e]=`${this._element[i]}px`}hide(){if(this._isTransitioning||!this._isShown())return;if(de.trigger(this._element,hi).defaultPrevented)return;const t=this._getDimension();this._element.style[t]=`${this._element.getBoundingClientRect()[t]}px`,qt(this._element),this._element.classList.add(gi),this._element.classList.remove(pi,fi);for(const t of this._triggerArray){const e=Pt(t);e&&!this._isShown(e)&&this._addAriaAndCollapsedClass([t],!1)}this._isTransitioning=!0,this._element.style[t]="",this._queueCallback((()=>{this._isTransitioning=!1,this._element.classList.remove(gi),this._element.classList.add(pi),de.trigger(this._element,ui)}),this._element,!0)}_isShown(t=this._element){return t.classList.contains(fi)}_configAfterMerge(t){return t.toggle=Boolean(t.toggle),t.parent=Ht(t.parent),t}_getDimension(){return this._element.classList.contains("collapse-horizontal")?"width":"height"}_initializeChildren(){if(!this._config.parent)return;const t=this._getFirstLevelChildren(_i);for(const e of t){const t=Pt(e);t&&this._addAriaAndCollapsedClass([e],this._isShown(t))}}_getFirstLevelChildren(t){const e=ke.find(mi,this._config.parent);return ke.find(t,this._config.parent).filter((t=>!e.includes(t)))}_addAriaAndCollapsedClass(t,e){if(t.length)for(const i of t)i.classList.toggle("collapsed",!e),i.setAttribute("aria-expanded",e)}static jQueryInterface(t){const e={};return"string"==typeof t&&/show|hide/.test(t)&&(e.toggle=!1),this.each((function(){const i=yi.getOrCreateInstance(this,e);if("string"==typeof t){if(void 0===i[t])throw new TypeError(`No method named "${t}"`);i[t]()}}))}}de.on(document,di,_i,(function(t){("A"===t.target.tagName||t.delegateTarget&&"A"===t.delegateTarget.tagName)&&t.preventDefault();const e=Nt(this),i=ke.find(e);for(const t of i)yi.getOrCreateInstance(t,{toggle:!1}).toggle()})),Qt(yi);const wi="dropdown",Ai=".bs.dropdown",Ei=".data-api",Ci="ArrowUp",Ti="ArrowDown",Oi=`hide${Ai}`,xi=`hidden${Ai}`,ki=`show${Ai}`,Li=`shown${Ai}`,Di=`click${Ai}${Ei}`,$i=`keydown${Ai}${Ei}`,Si=`keyup${Ai}${Ei}`,Ii="show",Ni='[data-bs-toggle="dropdown"]:not(.disabled):not(:disabled)',Pi=`${Ni}.${Ii}`,ji=".dropdown-menu",Mi=Kt()?"top-end":"top-start",Hi=Kt()?"top-start":"top-end",Wi=Kt()?"bottom-end":"bottom-start",Fi=Kt()?"bottom-start":"bottom-end",Bi=Kt()?"left-start":"right-start",zi=Kt()?"right-start":"left-start",qi={autoClose:!0,boundary:"clippingParents",display:"dynamic",offset:[0,2],popperConfig:null,reference:"toggle"},Ri={autoClose:"(boolean|string)",boundary:"(string|element)",display:"string",offset:"(array|string|function)",popperConfig:"(null|object|function)",reference:"(string|element|object)"};class Vi extends ye{constructor(t,e){super(t,e),this._popper=null,this._parent=this._element.parentNode,this._menu=ke.next(this._element,ji)[0]||ke.prev(this._element,ji)[0]||ke.findOne(ji,this._parent),this._inNavbar=this._detectNavbar()}static get Default(){return qi}static get DefaultType(){return Ri}static get NAME(){return wi}toggle(){return this._isShown()?this.hide():this.show()}show(){if(Ft(this._element)||this._isShown())return;const t={relatedTarget:this._element};if(!de.trigger(this._element,ki,t).defaultPrevented){if(this._createPopper(),"ontouchstart"in document.documentElement&&!this._parent.closest(".navbar-nav"))for(const t of[].concat(...document.body.children))de.on(t,"mouseover",zt);this._element.focus(),this._element.setAttribute("aria-expanded",!0),this._menu.classList.add(Ii),this._element.classList.add(Ii),de.trigger(this._element,Li,t)}}hide(){if(Ft(this._element)||!this._isShown())return;const t={relatedTarget:this._element};this._completeHide(t)}dispose(){this._popper&&this._popper.destroy(),super.dispose()}update(){this._inNavbar=this._detectNavbar(),this._popper&&this._popper.update()}_completeHide(t){if(!de.trigger(this._element,Oi,t).defaultPrevented){if("ontouchstart"in document.documentElement)for(const t of[].concat(...document.body.children))de.off(t,"mouseover",zt);this._popper&&this._popper.destroy(),this._menu.classList.remove(Ii),this._element.classList.remove(Ii),this._element.setAttribute("aria-expanded","false"),be.removeDataAttribute(this._menu,"popper"),de.trigger(this._element,xi,t)}}_getConfig(t){if("object"==typeof(t=super._getConfig(t)).reference&&!Mt(t.reference)&&"function"!=typeof t.reference.getBoundingClientRect)throw new TypeError(`${wi.toUpperCase()}: Option "reference" provided type "object" without a required "getBoundingClientRect" method.`);return t}_createPopper(){if(void 0===e)throw new TypeError("Bootstrap's dropdowns require Popper (https://popper.js.org)");let t=this._element;"parent"===this._config.reference?t=this._parent:Mt(this._config.reference)?t=Ht(this._config.reference):"object"==typeof this._config.reference&&(t=this._config.reference);const i=this._getPopperConfig();this._popper=Dt(t,this._menu,i)}_isShown(){return this._menu.classList.contains(Ii)}_getPlacement(){const t=this._parent;if(t.classList.contains("dropend"))return Bi;if(t.classList.contains("dropstart"))return zi;if(t.classList.contains("dropup-center"))return"top";if(t.classList.contains("dropdown-center"))return"bottom";const e="end"===getComputedStyle(this._menu).getPropertyValue("--bs-position").trim();return t.classList.contains("dropup")?e?Hi:Mi:e?Fi:Wi}_detectNavbar(){return null!==this._element.closest(".navbar")}_getOffset(){const{offset:t}=this._config;return"string"==typeof t?t.split(",").map((t=>Number.parseInt(t,10))):"function"==typeof t?e=>t(e,this._element):t}_getPopperConfig(){const t={placement:this._getPlacement(),modifiers:[{name:"preventOverflow",options:{boundary:this._config.boundary}},{name:"offset",options:{offset:this._getOffset()}}]};return(this._inNavbar||"static"===this._config.display)&&(be.setDataAttribute(this._menu,"popper","static"),t.modifiers=[{name:"applyStyles",enabled:!1}]),{...t,..."function"==typeof this._config.popperConfig?this._config.popperConfig(t):this._config.popperConfig}}_selectMenuItem({key:t,target:e}){const i=ke.find(".dropdown-menu .dropdown-item:not(.disabled):not(:disabled)",this._menu).filter((t=>Wt(t)));i.length&&Ut(i,e,t===Ti,!i.includes(e)).focus()}static jQueryInterface(t){return this.each((function(){const e=Vi.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===e[t])throw new TypeError(`No method named "${t}"`);e[t]()}}))}static clearMenus(t){if(2===t.button||"keyup"===t.type&&"Tab"!==t.key)return;const e=ke.find(Pi);for(const i of e){const e=Vi.getInstance(i);if(!e||!1===e._config.autoClose)continue;const n=t.composedPath(),s=n.includes(e._menu);if(n.includes(e._element)||"inside"===e._config.autoClose&&!s||"outside"===e._config.autoClose&&s)continue;if(e._menu.contains(t.target)&&("keyup"===t.type&&"Tab"===t.key||/input|select|option|textarea|form/i.test(t.target.tagName)))continue;const o={relatedTarget:e._element};"click"===t.type&&(o.clickEvent=t),e._completeHide(o)}}static dataApiKeydownHandler(t){const e=/input|textarea/i.test(t.target.tagName),i="Escape"===t.key,n=[Ci,Ti].includes(t.key);if(!n&&!i)return;if(e&&!i)return;t.preventDefault();const s=this.matches(Ni)?this:ke.prev(this,Ni)[0]||ke.next(this,Ni)[0]||ke.findOne(Ni,t.delegateTarget.parentNode),o=Vi.getOrCreateInstance(s);if(n)return t.stopPropagation(),o.show(),void o._selectMenuItem(t);o._isShown()&&(t.stopPropagation(),o.hide(),s.focus())}}de.on(document,$i,Ni,Vi.dataApiKeydownHandler),de.on(document,$i,ji,Vi.dataApiKeydownHandler),de.on(document,Di,Vi.clearMenus),de.on(document,Si,Vi.clearMenus),de.on(document,Di,Ni,(function(t){t.preventDefault(),Vi.getOrCreateInstance(this).toggle()})),Qt(Vi);const Ki=".fixed-top, .fixed-bottom, .is-fixed, .sticky-top",Qi=".sticky-top",Xi="padding-right",Yi="margin-right";class Ui{constructor(){this._element=document.body}getWidth(){const t=document.documentElement.clientWidth;return Math.abs(window.innerWidth-t)}hide(){const t=this.getWidth();this._disableOverFlow(),this._setElementAttributes(this._element,Xi,(e=>e+t)),this._setElementAttributes(Ki,Xi,(e=>e+t)),this._setElementAttributes(Qi,Yi,(e=>e-t))}reset(){this._resetElementAttributes(this._element,"overflow"),this._resetElementAttributes(this._element,Xi),this._resetElementAttributes(Ki,Xi),this._resetElementAttributes(Qi,Yi)}isOverflowing(){return this.getWidth()>0}_disableOverFlow(){this._saveInitialAttribute(this._element,"overflow"),this._element.style.overflow="hidden"}_setElementAttributes(t,e,i){const n=this.getWidth();this._applyManipulationCallback(t,(t=>{if(t!==this._element&&window.innerWidth>t.clientWidth+n)return;this._saveInitialAttribute(t,e);const s=window.getComputedStyle(t).getPropertyValue(e);t.style.setProperty(e,`${i(Number.parseFloat(s))}px`)}))}_saveInitialAttribute(t,e){const i=t.style.getPropertyValue(e);i&&be.setDataAttribute(t,e,i)}_resetElementAttributes(t,e){this._applyManipulationCallback(t,(t=>{const i=be.getDataAttribute(t,e);null!==i?(be.removeDataAttribute(t,e),t.style.setProperty(e,i)):t.style.removeProperty(e)}))}_applyManipulationCallback(t,e){if(Mt(t))e(t);else for(const i of ke.find(t,this._element))e(i)}}const Gi="backdrop",Ji="show",Zi=`mousedown.bs.${Gi}`,tn={className:"modal-backdrop",clickCallback:null,isAnimated:!1,isVisible:!0,rootElement:"body"},en={className:"string",clickCallback:"(function|null)",isAnimated:"boolean",isVisible:"boolean",rootElement:"(element|string)"};class nn extends ve{constructor(t){super(),this._config=this._getConfig(t),this._isAppended=!1,this._element=null}static get Default(){return tn}static get DefaultType(){return en}static get NAME(){return Gi}show(t){if(!this._config.isVisible)return void Xt(t);this._append();const e=this._getElement();this._config.isAnimated&&qt(e),e.classList.add(Ji),this._emulateAnimation((()=>{Xt(t)}))}hide(t){this._config.isVisible?(this._getElement().classList.remove(Ji),this._emulateAnimation((()=>{this.dispose(),Xt(t)}))):Xt(t)}dispose(){this._isAppended&&(de.off(this._element,Zi),this._element.remove(),this._isAppended=!1)}_getElement(){if(!this._element){const t=document.createElement("div");t.className=this._config.className,this._config.isAnimated&&t.classList.add("fade"),this._element=t}return this._element}_configAfterMerge(t){return t.rootElement=Ht(t.rootElement),t}_append(){if(this._isAppended)return;const t=this._getElement();this._config.rootElement.append(t),de.on(t,Zi,(()=>{Xt(this._config.clickCallback)})),this._isAppended=!0}_emulateAnimation(t){Yt(t,this._getElement(),this._config.isAnimated)}}const sn=".bs.focustrap",on=`focusin${sn}`,rn=`keydown.tab${sn}`,an="backward",ln={autofocus:!0,trapElement:null},cn={autofocus:"boolean",trapElement:"element"};class hn extends ve{constructor(t){super(),this._config=this._getConfig(t),this._isActive=!1,this._lastTabNavDirection=null}static get Default(){return ln}static get DefaultType(){return cn}static get NAME(){return"focustrap"}activate(){this._isActive||(this._config.autofocus&&this._config.trapElement.focus(),de.off(document,sn),de.on(document,on,(t=>this._handleFocusin(t))),de.on(document,rn,(t=>this._handleKeydown(t))),this._isActive=!0)}deactivate(){this._isActive&&(this._isActive=!1,de.off(document,sn))}_handleFocusin(t){const{trapElement:e}=this._config;if(t.target===document||t.target===e||e.contains(t.target))return;const i=ke.focusableChildren(e);0===i.length?e.focus():this._lastTabNavDirection===an?i[i.length-1].focus():i[0].focus()}_handleKeydown(t){"Tab"===t.key&&(this._lastTabNavDirection=t.shiftKey?an:"forward")}}const un=".bs.modal",dn=`hide${un}`,fn=`hidePrevented${un}`,pn=`hidden${un}`,gn=`show${un}`,mn=`shown${un}`,_n=`resize${un}`,bn=`click.dismiss${un}`,vn=`mousedown.dismiss${un}`,yn=`keydown.dismiss${un}`,wn=`click${un}.data-api`,An="modal-open",En="show",Cn="modal-static",Tn={backdrop:!0,focus:!0,keyboard:!0},On={backdrop:"(boolean|string)",focus:"boolean",keyboard:"boolean"};class xn extends ye{constructor(t,e){super(t,e),this._dialog=ke.findOne(".modal-dialog",this._element),this._backdrop=this._initializeBackDrop(),this._focustrap=this._initializeFocusTrap(),this._isShown=!1,this._isTransitioning=!1,this._scrollBar=new Ui,this._addEventListeners()}static get Default(){return Tn}static get DefaultType(){return On}static get NAME(){return"modal"}toggle(t){return this._isShown?this.hide():this.show(t)}show(t){this._isShown||this._isTransitioning||de.trigger(this._element,gn,{relatedTarget:t}).defaultPrevented||(this._isShown=!0,this._isTransitioning=!0,this._scrollBar.hide(),document.body.classList.add(An),this._adjustDialog(),this._backdrop.show((()=>this._showElement(t))))}hide(){this._isShown&&!this._isTransitioning&&(de.trigger(this._element,dn).defaultPrevented||(this._isShown=!1,this._isTransitioning=!0,this._focustrap.deactivate(),this._element.classList.remove(En),this._queueCallback((()=>this._hideModal()),this._element,this._isAnimated())))}dispose(){for(const t of[window,this._dialog])de.off(t,un);this._backdrop.dispose(),this._focustrap.deactivate(),super.dispose()}handleUpdate(){this._adjustDialog()}_initializeBackDrop(){return new nn({isVisible:Boolean(this._config.backdrop),isAnimated:this._isAnimated()})}_initializeFocusTrap(){return new hn({trapElement:this._element})}_showElement(t){document.body.contains(this._element)||document.body.append(this._element),this._element.style.display="block",this._element.removeAttribute("aria-hidden"),this._element.setAttribute("aria-modal",!0),this._element.setAttribute("role","dialog"),this._element.scrollTop=0;const e=ke.findOne(".modal-body",this._dialog);e&&(e.scrollTop=0),qt(this._element),this._element.classList.add(En),this._queueCallback((()=>{this._config.focus&&this._focustrap.activate(),this._isTransitioning=!1,de.trigger(this._element,mn,{relatedTarget:t})}),this._dialog,this._isAnimated())}_addEventListeners(){de.on(this._element,yn,(t=>{if("Escape"===t.key)return this._config.keyboard?(t.preventDefault(),void this.hide()):void this._triggerBackdropTransition()})),de.on(window,_n,(()=>{this._isShown&&!this._isTransitioning&&this._adjustDialog()})),de.on(this._element,vn,(t=>{de.one(this._element,bn,(e=>{this._element===t.target&&this._element===e.target&&("static"!==this._config.backdrop?this._config.backdrop&&this.hide():this._triggerBackdropTransition())}))}))}_hideModal(){this._element.style.display="none",this._element.setAttribute("aria-hidden",!0),this._element.removeAttribute("aria-modal"),this._element.removeAttribute("role"),this._isTransitioning=!1,this._backdrop.hide((()=>{document.body.classList.remove(An),this._resetAdjustments(),this._scrollBar.reset(),de.trigger(this._element,pn)}))}_isAnimated(){return this._element.classList.contains("fade")}_triggerBackdropTransition(){if(de.trigger(this._element,fn).defaultPrevented)return;const t=this._element.scrollHeight>document.documentElement.clientHeight,e=this._element.style.overflowY;"hidden"===e||this._element.classList.contains(Cn)||(t||(this._element.style.overflowY="hidden"),this._element.classList.add(Cn),this._queueCallback((()=>{this._element.classList.remove(Cn),this._queueCallback((()=>{this._element.style.overflowY=e}),this._dialog)}),this._dialog),this._element.focus())}_adjustDialog(){const t=this._element.scrollHeight>document.documentElement.clientHeight,e=this._scrollBar.getWidth(),i=e>0;if(i&&!t){const t=Kt()?"paddingLeft":"paddingRight";this._element.style[t]=`${e}px`}if(!i&&t){const t=Kt()?"paddingRight":"paddingLeft";this._element.style[t]=`${e}px`}}_resetAdjustments(){this._element.style.paddingLeft="",this._element.style.paddingRight=""}static jQueryInterface(t,e){return this.each((function(){const i=xn.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===i[t])throw new TypeError(`No method named "${t}"`);i[t](e)}}))}}de.on(document,wn,'[data-bs-toggle="modal"]',(function(t){const e=Pt(this);["A","AREA"].includes(this.tagName)&&t.preventDefault(),de.one(e,gn,(t=>{t.defaultPrevented||de.one(e,pn,(()=>{Wt(this)&&this.focus()}))}));const i=ke.findOne(".modal.show");i&&xn.getInstance(i).hide(),xn.getOrCreateInstance(e).toggle(this)})),we(xn),Qt(xn);const kn=".bs.offcanvas",Ln=".data-api",Dn=`load${kn}${Ln}`,$n="show",Sn="showing",In="hiding",Nn=".offcanvas.show",Pn=`show${kn}`,jn=`shown${kn}`,Mn=`hide${kn}`,Hn=`hidePrevented${kn}`,Wn=`hidden${kn}`,Fn=`resize${kn}`,Bn=`click${kn}${Ln}`,zn=`keydown.dismiss${kn}`,qn={backdrop:!0,keyboard:!0,scroll:!1},Rn={backdrop:"(boolean|string)",keyboard:"boolean",scroll:"boolean"};class Vn extends ye{constructor(t,e){super(t,e),this._isShown=!1,this._backdrop=this._initializeBackDrop(),this._focustrap=this._initializeFocusTrap(),this._addEventListeners()}static get Default(){return qn}static get DefaultType(){return Rn}static get NAME(){return"offcanvas"}toggle(t){return this._isShown?this.hide():this.show(t)}show(t){this._isShown||de.trigger(this._element,Pn,{relatedTarget:t}).defaultPrevented||(this._isShown=!0,this._backdrop.show(),this._config.scroll||(new Ui).hide(),this._element.setAttribute("aria-modal",!0),this._element.setAttribute("role","dialog"),this._element.classList.add(Sn),this._queueCallback((()=>{this._config.scroll&&!this._config.backdrop||this._focustrap.activate(),this._element.classList.add($n),this._element.classList.remove(Sn),de.trigger(this._element,jn,{relatedTarget:t})}),this._element,!0))}hide(){this._isShown&&(de.trigger(this._element,Mn).defaultPrevented||(this._focustrap.deactivate(),this._element.blur(),this._isShown=!1,this._element.classList.add(In),this._backdrop.hide(),this._queueCallback((()=>{this._element.classList.remove($n,In),this._element.removeAttribute("aria-modal"),this._element.removeAttribute("role"),this._config.scroll||(new Ui).reset(),de.trigger(this._element,Wn)}),this._element,!0)))}dispose(){this._backdrop.dispose(),this._focustrap.deactivate(),super.dispose()}_initializeBackDrop(){const t=Boolean(this._config.backdrop);return new nn({className:"offcanvas-backdrop",isVisible:t,isAnimated:!0,rootElement:this._element.parentNode,clickCallback:t?()=>{"static"!==this._config.backdrop?this.hide():de.trigger(this._element,Hn)}:null})}_initializeFocusTrap(){return new hn({trapElement:this._element})}_addEventListeners(){de.on(this._element,zn,(t=>{"Escape"===t.key&&(this._config.keyboard?this.hide():de.trigger(this._element,Hn))}))}static jQueryInterface(t){return this.each((function(){const e=Vn.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===e[t]||t.startsWith("_")||"constructor"===t)throw new TypeError(`No method named "${t}"`);e[t](this)}}))}}de.on(document,Bn,'[data-bs-toggle="offcanvas"]',(function(t){const e=Pt(this);if(["A","AREA"].includes(this.tagName)&&t.preventDefault(),Ft(this))return;de.one(e,Wn,(()=>{Wt(this)&&this.focus()}));const i=ke.findOne(Nn);i&&i!==e&&Vn.getInstance(i).hide(),Vn.getOrCreateInstance(e).toggle(this)})),de.on(window,Dn,(()=>{for(const t of ke.find(Nn))Vn.getOrCreateInstance(t).show()})),de.on(window,Fn,(()=>{for(const t of ke.find("[aria-modal][class*=show][class*=offcanvas-]"))"fixed"!==getComputedStyle(t).position&&Vn.getOrCreateInstance(t).hide()})),we(Vn),Qt(Vn);const Kn=new Set(["background","cite","href","itemtype","longdesc","poster","src","xlink:href"]),Qn=/^(?:(?:https?|mailto|ftp|tel|file|sms):|[^#&/:?]*(?:[#/?]|$))/i,Xn=/^data:(?:image\/(?:bmp|gif|jpeg|jpg|png|tiff|webp)|video\/(?:mpeg|mp4|ogg|webm)|audio\/(?:mp3|oga|ogg|opus));base64,[\d+/a-z]+=*$/i,Yn=(t,e)=>{const i=t.nodeName.toLowerCase();return e.includes(i)?!Kn.has(i)||Boolean(Qn.test(t.nodeValue)||Xn.test(t.nodeValue)):e.filter((t=>t instanceof RegExp)).some((t=>t.test(i)))},Un={"*":["class","dir","id","lang","role",/^aria-[\w-]*$/i],a:["target","href","title","rel"],area:[],b:[],br:[],col:[],code:[],div:[],em:[],hr:[],h1:[],h2:[],h3:[],h4:[],h5:[],h6:[],i:[],img:["src","srcset","alt","title","width","height"],li:[],ol:[],p:[],pre:[],s:[],small:[],span:[],sub:[],sup:[],strong:[],u:[],ul:[]},Gn={allowList:Un,content:{},extraClass:"",html:!1,sanitize:!0,sanitizeFn:null,template:"
    "},Jn={allowList:"object",content:"object",extraClass:"(string|function)",html:"boolean",sanitize:"boolean",sanitizeFn:"(null|function)",template:"string"},Zn={entry:"(string|element|function|null)",selector:"(string|element)"};class ts extends ve{constructor(t){super(),this._config=this._getConfig(t)}static get Default(){return Gn}static get DefaultType(){return Jn}static get NAME(){return"TemplateFactory"}getContent(){return Object.values(this._config.content).map((t=>this._resolvePossibleFunction(t))).filter(Boolean)}hasContent(){return this.getContent().length>0}changeContent(t){return this._checkContent(t),this._config.content={...this._config.content,...t},this}toHtml(){const t=document.createElement("div");t.innerHTML=this._maybeSanitize(this._config.template);for(const[e,i]of Object.entries(this._config.content))this._setContent(t,i,e);const e=t.children[0],i=this._resolvePossibleFunction(this._config.extraClass);return i&&e.classList.add(...i.split(" ")),e}_typeCheckConfig(t){super._typeCheckConfig(t),this._checkContent(t.content)}_checkContent(t){for(const[e,i]of Object.entries(t))super._typeCheckConfig({selector:e,entry:i},Zn)}_setContent(t,e,i){const n=ke.findOne(i,t);n&&((e=this._resolvePossibleFunction(e))?Mt(e)?this._putElementInTemplate(Ht(e),n):this._config.html?n.innerHTML=this._maybeSanitize(e):n.textContent=e:n.remove())}_maybeSanitize(t){return this._config.sanitize?function(t,e,i){if(!t.length)return t;if(i&&"function"==typeof i)return i(t);const n=(new window.DOMParser).parseFromString(t,"text/html"),s=[].concat(...n.body.querySelectorAll("*"));for(const t of s){const i=t.nodeName.toLowerCase();if(!Object.keys(e).includes(i)){t.remove();continue}const n=[].concat(...t.attributes),s=[].concat(e["*"]||[],e[i]||[]);for(const e of n)Yn(e,s)||t.removeAttribute(e.nodeName)}return n.body.innerHTML}(t,this._config.allowList,this._config.sanitizeFn):t}_resolvePossibleFunction(t){return"function"==typeof t?t(this):t}_putElementInTemplate(t,e){if(this._config.html)return e.innerHTML="",void e.append(t);e.textContent=t.textContent}}const es=new Set(["sanitize","allowList","sanitizeFn"]),is="fade",ns="show",ss=".modal",os="hide.bs.modal",rs="hover",as="focus",ls={AUTO:"auto",TOP:"top",RIGHT:Kt()?"left":"right",BOTTOM:"bottom",LEFT:Kt()?"right":"left"},cs={allowList:Un,animation:!0,boundary:"clippingParents",container:!1,customClass:"",delay:0,fallbackPlacements:["top","right","bottom","left"],html:!1,offset:[0,0],placement:"top",popperConfig:null,sanitize:!0,sanitizeFn:null,selector:!1,template:'',title:"",trigger:"hover focus"},hs={allowList:"object",animation:"boolean",boundary:"(string|element)",container:"(string|element|boolean)",customClass:"(string|function)",delay:"(number|object)",fallbackPlacements:"array",html:"boolean",offset:"(array|string|function)",placement:"(string|function)",popperConfig:"(null|object|function)",sanitize:"boolean",sanitizeFn:"(null|function)",selector:"(string|boolean)",template:"string",title:"(string|element|function)",trigger:"string"};class us extends ye{constructor(t,i){if(void 0===e)throw new TypeError("Bootstrap's tooltips require Popper (https://popper.js.org)");super(t,i),this._isEnabled=!0,this._timeout=0,this._isHovered=null,this._activeTrigger={},this._popper=null,this._templateFactory=null,this._newContent=null,this.tip=null,this._setListeners(),this._config.selector||this._fixTitle()}static get Default(){return cs}static get DefaultType(){return hs}static get NAME(){return"tooltip"}enable(){this._isEnabled=!0}disable(){this._isEnabled=!1}toggleEnabled(){this._isEnabled=!this._isEnabled}toggle(){this._isEnabled&&(this._activeTrigger.click=!this._activeTrigger.click,this._isShown()?this._leave():this._enter())}dispose(){clearTimeout(this._timeout),de.off(this._element.closest(ss),os,this._hideModalHandler),this._element.getAttribute("data-bs-original-title")&&this._element.setAttribute("title",this._element.getAttribute("data-bs-original-title")),this._disposePopper(),super.dispose()}show(){if("none"===this._element.style.display)throw new Error("Please use show on visible elements");if(!this._isWithContent()||!this._isEnabled)return;const t=de.trigger(this._element,this.constructor.eventName("show")),e=(Bt(this._element)||this._element.ownerDocument.documentElement).contains(this._element);if(t.defaultPrevented||!e)return;this._disposePopper();const i=this._getTipElement();this._element.setAttribute("aria-describedby",i.getAttribute("id"));const{container:n}=this._config;if(this._element.ownerDocument.documentElement.contains(this.tip)||(n.append(i),de.trigger(this._element,this.constructor.eventName("inserted"))),this._popper=this._createPopper(i),i.classList.add(ns),"ontouchstart"in document.documentElement)for(const t of[].concat(...document.body.children))de.on(t,"mouseover",zt);this._queueCallback((()=>{de.trigger(this._element,this.constructor.eventName("shown")),!1===this._isHovered&&this._leave(),this._isHovered=!1}),this.tip,this._isAnimated())}hide(){if(this._isShown()&&!de.trigger(this._element,this.constructor.eventName("hide")).defaultPrevented){if(this._getTipElement().classList.remove(ns),"ontouchstart"in document.documentElement)for(const t of[].concat(...document.body.children))de.off(t,"mouseover",zt);this._activeTrigger.click=!1,this._activeTrigger[as]=!1,this._activeTrigger[rs]=!1,this._isHovered=null,this._queueCallback((()=>{this._isWithActiveTrigger()||(this._isHovered||this._disposePopper(),this._element.removeAttribute("aria-describedby"),de.trigger(this._element,this.constructor.eventName("hidden")))}),this.tip,this._isAnimated())}}update(){this._popper&&this._popper.update()}_isWithContent(){return Boolean(this._getTitle())}_getTipElement(){return this.tip||(this.tip=this._createTipElement(this._newContent||this._getContentForTemplate())),this.tip}_createTipElement(t){const e=this._getTemplateFactory(t).toHtml();if(!e)return null;e.classList.remove(is,ns),e.classList.add(`bs-${this.constructor.NAME}-auto`);const i=(t=>{do{t+=Math.floor(1e6*Math.random())}while(document.getElementById(t));return t})(this.constructor.NAME).toString();return e.setAttribute("id",i),this._isAnimated()&&e.classList.add(is),e}setContent(t){this._newContent=t,this._isShown()&&(this._disposePopper(),this.show())}_getTemplateFactory(t){return this._templateFactory?this._templateFactory.changeContent(t):this._templateFactory=new ts({...this._config,content:t,extraClass:this._resolvePossibleFunction(this._config.customClass)}),this._templateFactory}_getContentForTemplate(){return{".tooltip-inner":this._getTitle()}}_getTitle(){return this._resolvePossibleFunction(this._config.title)||this._element.getAttribute("data-bs-original-title")}_initializeOnDelegatedTarget(t){return this.constructor.getOrCreateInstance(t.delegateTarget,this._getDelegateConfig())}_isAnimated(){return this._config.animation||this.tip&&this.tip.classList.contains(is)}_isShown(){return this.tip&&this.tip.classList.contains(ns)}_createPopper(t){const e="function"==typeof this._config.placement?this._config.placement.call(this,t,this._element):this._config.placement,i=ls[e.toUpperCase()];return Dt(this._element,t,this._getPopperConfig(i))}_getOffset(){const{offset:t}=this._config;return"string"==typeof t?t.split(",").map((t=>Number.parseInt(t,10))):"function"==typeof t?e=>t(e,this._element):t}_resolvePossibleFunction(t){return"function"==typeof t?t.call(this._element):t}_getPopperConfig(t){const e={placement:t,modifiers:[{name:"flip",options:{fallbackPlacements:this._config.fallbackPlacements}},{name:"offset",options:{offset:this._getOffset()}},{name:"preventOverflow",options:{boundary:this._config.boundary}},{name:"arrow",options:{element:`.${this.constructor.NAME}-arrow`}},{name:"preSetPlacement",enabled:!0,phase:"beforeMain",fn:t=>{this._getTipElement().setAttribute("data-popper-placement",t.state.placement)}}]};return{...e,..."function"==typeof this._config.popperConfig?this._config.popperConfig(e):this._config.popperConfig}}_setListeners(){const t=this._config.trigger.split(" ");for(const e of t)if("click"===e)de.on(this._element,this.constructor.eventName("click"),this._config.selector,(t=>{this._initializeOnDelegatedTarget(t).toggle()}));else if("manual"!==e){const t=e===rs?this.constructor.eventName("mouseenter"):this.constructor.eventName("focusin"),i=e===rs?this.constructor.eventName("mouseleave"):this.constructor.eventName("focusout");de.on(this._element,t,this._config.selector,(t=>{const e=this._initializeOnDelegatedTarget(t);e._activeTrigger["focusin"===t.type?as:rs]=!0,e._enter()})),de.on(this._element,i,this._config.selector,(t=>{const e=this._initializeOnDelegatedTarget(t);e._activeTrigger["focusout"===t.type?as:rs]=e._element.contains(t.relatedTarget),e._leave()}))}this._hideModalHandler=()=>{this._element&&this.hide()},de.on(this._element.closest(ss),os,this._hideModalHandler)}_fixTitle(){const t=this._element.getAttribute("title");t&&(this._element.getAttribute("aria-label")||this._element.textContent.trim()||this._element.setAttribute("aria-label",t),this._element.setAttribute("data-bs-original-title",t),this._element.removeAttribute("title"))}_enter(){this._isShown()||this._isHovered?this._isHovered=!0:(this._isHovered=!0,this._setTimeout((()=>{this._isHovered&&this.show()}),this._config.delay.show))}_leave(){this._isWithActiveTrigger()||(this._isHovered=!1,this._setTimeout((()=>{this._isHovered||this.hide()}),this._config.delay.hide))}_setTimeout(t,e){clearTimeout(this._timeout),this._timeout=setTimeout(t,e)}_isWithActiveTrigger(){return Object.values(this._activeTrigger).includes(!0)}_getConfig(t){const e=be.getDataAttributes(this._element);for(const t of Object.keys(e))es.has(t)&&delete e[t];return t={...e,..."object"==typeof t&&t?t:{}},t=this._mergeConfigObj(t),t=this._configAfterMerge(t),this._typeCheckConfig(t),t}_configAfterMerge(t){return t.container=!1===t.container?document.body:Ht(t.container),"number"==typeof t.delay&&(t.delay={show:t.delay,hide:t.delay}),"number"==typeof t.title&&(t.title=t.title.toString()),"number"==typeof t.content&&(t.content=t.content.toString()),t}_getDelegateConfig(){const t={};for(const e in this._config)this.constructor.Default[e]!==this._config[e]&&(t[e]=this._config[e]);return t.selector=!1,t.trigger="manual",t}_disposePopper(){this._popper&&(this._popper.destroy(),this._popper=null),this.tip&&(this.tip.remove(),this.tip=null)}static jQueryInterface(t){return this.each((function(){const e=us.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===e[t])throw new TypeError(`No method named "${t}"`);e[t]()}}))}}Qt(us);const ds={...us.Default,content:"",offset:[0,8],placement:"right",template:'',trigger:"click"},fs={...us.DefaultType,content:"(null|string|element|function)"};class ps extends us{static get Default(){return ds}static get DefaultType(){return fs}static get NAME(){return"popover"}_isWithContent(){return this._getTitle()||this._getContent()}_getContentForTemplate(){return{".popover-header":this._getTitle(),".popover-body":this._getContent()}}_getContent(){return this._resolvePossibleFunction(this._config.content)}static jQueryInterface(t){return this.each((function(){const e=ps.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===e[t])throw new TypeError(`No method named "${t}"`);e[t]()}}))}}Qt(ps);const gs=".bs.scrollspy",ms=`activate${gs}`,_s=`click${gs}`,bs=`load${gs}.data-api`,vs="active",ys="[href]",ws=".nav-link",As=`${ws}, .nav-item > ${ws}, .list-group-item`,Es={offset:null,rootMargin:"0px 0px -25%",smoothScroll:!1,target:null,threshold:[.1,.5,1]},Cs={offset:"(number|null)",rootMargin:"string",smoothScroll:"boolean",target:"element",threshold:"array"};class Ts extends ye{constructor(t,e){super(t,e),this._targetLinks=new Map,this._observableSections=new Map,this._rootElement="visible"===getComputedStyle(this._element).overflowY?null:this._element,this._activeTarget=null,this._observer=null,this._previousScrollData={visibleEntryTop:0,parentScrollTop:0},this.refresh()}static get Default(){return Es}static get DefaultType(){return Cs}static get NAME(){return"scrollspy"}refresh(){this._initializeTargetsAndObservables(),this._maybeEnableSmoothScroll(),this._observer?this._observer.disconnect():this._observer=this._getNewObserver();for(const t of this._observableSections.values())this._observer.observe(t)}dispose(){this._observer.disconnect(),super.dispose()}_configAfterMerge(t){return t.target=Ht(t.target)||document.body,t.rootMargin=t.offset?`${t.offset}px 0px -30%`:t.rootMargin,"string"==typeof t.threshold&&(t.threshold=t.threshold.split(",").map((t=>Number.parseFloat(t)))),t}_maybeEnableSmoothScroll(){this._config.smoothScroll&&(de.off(this._config.target,_s),de.on(this._config.target,_s,ys,(t=>{const e=this._observableSections.get(t.target.hash);if(e){t.preventDefault();const i=this._rootElement||window,n=e.offsetTop-this._element.offsetTop;if(i.scrollTo)return void i.scrollTo({top:n,behavior:"smooth"});i.scrollTop=n}})))}_getNewObserver(){const t={root:this._rootElement,threshold:this._config.threshold,rootMargin:this._config.rootMargin};return new IntersectionObserver((t=>this._observerCallback(t)),t)}_observerCallback(t){const e=t=>this._targetLinks.get(`#${t.target.id}`),i=t=>{this._previousScrollData.visibleEntryTop=t.target.offsetTop,this._process(e(t))},n=(this._rootElement||document.documentElement).scrollTop,s=n>=this._previousScrollData.parentScrollTop;this._previousScrollData.parentScrollTop=n;for(const o of t){if(!o.isIntersecting){this._activeTarget=null,this._clearActiveClass(e(o));continue}const t=o.target.offsetTop>=this._previousScrollData.visibleEntryTop;if(s&&t){if(i(o),!n)return}else s||t||i(o)}}_initializeTargetsAndObservables(){this._targetLinks=new Map,this._observableSections=new Map;const t=ke.find(ys,this._config.target);for(const e of t){if(!e.hash||Ft(e))continue;const t=ke.findOne(e.hash,this._element);Wt(t)&&(this._targetLinks.set(e.hash,e),this._observableSections.set(e.hash,t))}}_process(t){this._activeTarget!==t&&(this._clearActiveClass(this._config.target),this._activeTarget=t,t.classList.add(vs),this._activateParents(t),de.trigger(this._element,ms,{relatedTarget:t}))}_activateParents(t){if(t.classList.contains("dropdown-item"))ke.findOne(".dropdown-toggle",t.closest(".dropdown")).classList.add(vs);else for(const e of ke.parents(t,".nav, .list-group"))for(const t of ke.prev(e,As))t.classList.add(vs)}_clearActiveClass(t){t.classList.remove(vs);const e=ke.find(`${ys}.${vs}`,t);for(const t of e)t.classList.remove(vs)}static jQueryInterface(t){return this.each((function(){const e=Ts.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===e[t]||t.startsWith("_")||"constructor"===t)throw new TypeError(`No method named "${t}"`);e[t]()}}))}}de.on(window,bs,(()=>{for(const t of ke.find('[data-bs-spy="scroll"]'))Ts.getOrCreateInstance(t)})),Qt(Ts);const Os=".bs.tab",xs=`hide${Os}`,ks=`hidden${Os}`,Ls=`show${Os}`,Ds=`shown${Os}`,$s=`click${Os}`,Ss=`keydown${Os}`,Is=`load${Os}`,Ns="ArrowLeft",Ps="ArrowRight",js="ArrowUp",Ms="ArrowDown",Hs="active",Ws="fade",Fs="show",Bs=":not(.dropdown-toggle)",zs='[data-bs-toggle="tab"], [data-bs-toggle="pill"], [data-bs-toggle="list"]',qs=`.nav-link${Bs}, .list-group-item${Bs}, [role="tab"]${Bs}, ${zs}`,Rs=`.${Hs}[data-bs-toggle="tab"], .${Hs}[data-bs-toggle="pill"], .${Hs}[data-bs-toggle="list"]`;class Vs extends ye{constructor(t){super(t),this._parent=this._element.closest('.list-group, .nav, [role="tablist"]'),this._parent&&(this._setInitialAttributes(this._parent,this._getChildren()),de.on(this._element,Ss,(t=>this._keydown(t))))}static get NAME(){return"tab"}show(){const t=this._element;if(this._elemIsActive(t))return;const e=this._getActiveElem(),i=e?de.trigger(e,xs,{relatedTarget:t}):null;de.trigger(t,Ls,{relatedTarget:e}).defaultPrevented||i&&i.defaultPrevented||(this._deactivate(e,t),this._activate(t,e))}_activate(t,e){t&&(t.classList.add(Hs),this._activate(Pt(t)),this._queueCallback((()=>{"tab"===t.getAttribute("role")?(t.removeAttribute("tabindex"),t.setAttribute("aria-selected",!0),this._toggleDropDown(t,!0),de.trigger(t,Ds,{relatedTarget:e})):t.classList.add(Fs)}),t,t.classList.contains(Ws)))}_deactivate(t,e){t&&(t.classList.remove(Hs),t.blur(),this._deactivate(Pt(t)),this._queueCallback((()=>{"tab"===t.getAttribute("role")?(t.setAttribute("aria-selected",!1),t.setAttribute("tabindex","-1"),this._toggleDropDown(t,!1),de.trigger(t,ks,{relatedTarget:e})):t.classList.remove(Fs)}),t,t.classList.contains(Ws)))}_keydown(t){if(![Ns,Ps,js,Ms].includes(t.key))return;t.stopPropagation(),t.preventDefault();const e=[Ps,Ms].includes(t.key),i=Ut(this._getChildren().filter((t=>!Ft(t))),t.target,e,!0);i&&(i.focus({preventScroll:!0}),Vs.getOrCreateInstance(i).show())}_getChildren(){return ke.find(qs,this._parent)}_getActiveElem(){return this._getChildren().find((t=>this._elemIsActive(t)))||null}_setInitialAttributes(t,e){this._setAttributeIfNotExists(t,"role","tablist");for(const t of e)this._setInitialAttributesOnChild(t)}_setInitialAttributesOnChild(t){t=this._getInnerElement(t);const e=this._elemIsActive(t),i=this._getOuterElement(t);t.setAttribute("aria-selected",e),i!==t&&this._setAttributeIfNotExists(i,"role","presentation"),e||t.setAttribute("tabindex","-1"),this._setAttributeIfNotExists(t,"role","tab"),this._setInitialAttributesOnTargetPanel(t)}_setInitialAttributesOnTargetPanel(t){const e=Pt(t);e&&(this._setAttributeIfNotExists(e,"role","tabpanel"),t.id&&this._setAttributeIfNotExists(e,"aria-labelledby",`#${t.id}`))}_toggleDropDown(t,e){const i=this._getOuterElement(t);if(!i.classList.contains("dropdown"))return;const n=(t,n)=>{const s=ke.findOne(t,i);s&&s.classList.toggle(n,e)};n(".dropdown-toggle",Hs),n(".dropdown-menu",Fs),i.setAttribute("aria-expanded",e)}_setAttributeIfNotExists(t,e,i){t.hasAttribute(e)||t.setAttribute(e,i)}_elemIsActive(t){return t.classList.contains(Hs)}_getInnerElement(t){return t.matches(qs)?t:ke.findOne(qs,t)}_getOuterElement(t){return t.closest(".nav-item, .list-group-item")||t}static jQueryInterface(t){return this.each((function(){const e=Vs.getOrCreateInstance(this);if("string"==typeof t){if(void 0===e[t]||t.startsWith("_")||"constructor"===t)throw new TypeError(`No method named "${t}"`);e[t]()}}))}}de.on(document,$s,zs,(function(t){["A","AREA"].includes(this.tagName)&&t.preventDefault(),Ft(this)||Vs.getOrCreateInstance(this).show()})),de.on(window,Is,(()=>{for(const t of ke.find(Rs))Vs.getOrCreateInstance(t)})),Qt(Vs);const Ks=".bs.toast",Qs=`mouseover${Ks}`,Xs=`mouseout${Ks}`,Ys=`focusin${Ks}`,Us=`focusout${Ks}`,Gs=`hide${Ks}`,Js=`hidden${Ks}`,Zs=`show${Ks}`,to=`shown${Ks}`,eo="hide",io="show",no="showing",so={animation:"boolean",autohide:"boolean",delay:"number"},oo={animation:!0,autohide:!0,delay:5e3};class ro extends ye{constructor(t,e){super(t,e),this._timeout=null,this._hasMouseInteraction=!1,this._hasKeyboardInteraction=!1,this._setListeners()}static get Default(){return oo}static get DefaultType(){return so}static get NAME(){return"toast"}show(){de.trigger(this._element,Zs).defaultPrevented||(this._clearTimeout(),this._config.animation&&this._element.classList.add("fade"),this._element.classList.remove(eo),qt(this._element),this._element.classList.add(io,no),this._queueCallback((()=>{this._element.classList.remove(no),de.trigger(this._element,to),this._maybeScheduleHide()}),this._element,this._config.animation))}hide(){this.isShown()&&(de.trigger(this._element,Gs).defaultPrevented||(this._element.classList.add(no),this._queueCallback((()=>{this._element.classList.add(eo),this._element.classList.remove(no,io),de.trigger(this._element,Js)}),this._element,this._config.animation)))}dispose(){this._clearTimeout(),this.isShown()&&this._element.classList.remove(io),super.dispose()}isShown(){return this._element.classList.contains(io)}_maybeScheduleHide(){this._config.autohide&&(this._hasMouseInteraction||this._hasKeyboardInteraction||(this._timeout=setTimeout((()=>{this.hide()}),this._config.delay)))}_onInteraction(t,e){switch(t.type){case"mouseover":case"mouseout":this._hasMouseInteraction=e;break;case"focusin":case"focusout":this._hasKeyboardInteraction=e}if(e)return void this._clearTimeout();const i=t.relatedTarget;this._element===i||this._element.contains(i)||this._maybeScheduleHide()}_setListeners(){de.on(this._element,Qs,(t=>this._onInteraction(t,!0))),de.on(this._element,Xs,(t=>this._onInteraction(t,!1))),de.on(this._element,Ys,(t=>this._onInteraction(t,!0))),de.on(this._element,Us,(t=>this._onInteraction(t,!1)))}_clearTimeout(){clearTimeout(this._timeout),this._timeout=null}static jQueryInterface(t){return this.each((function(){const e=ro.getOrCreateInstance(this,t);if("string"==typeof t){if(void 0===e[t])throw new TypeError(`No method named "${t}"`);e[t](this)}}))}}var ao;we(ro),Qt(ro),ao=function(){[].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]')).map((function(t){return new us(t,{delay:{show:500,hide:100}})}))},"loading"!=document.readyState?ao():document.addEventListener("DOMContentLoaded",ao)})(); +//# sourceMappingURL=bootstrap.js.map \ No newline at end of file diff --git a/branch/sphinx-book-theme/_static/scripts/bootstrap.js.LICENSE.txt b/branch/sphinx-book-theme/_static/scripts/bootstrap.js.LICENSE.txt new file mode 100644 index 00000000..91ad10aa --- /dev/null +++ b/branch/sphinx-book-theme/_static/scripts/bootstrap.js.LICENSE.txt @@ -0,0 +1,5 @@ +/*! + * Bootstrap v5.2.3 (https://getbootstrap.com/) + * Copyright 2011-2022 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors) + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) + */ diff --git a/branch/sphinx-book-theme/_static/scripts/bootstrap.js.map b/branch/sphinx-book-theme/_static/scripts/bootstrap.js.map new file mode 100644 index 00000000..d83e2f7c --- /dev/null +++ b/branch/sphinx-book-theme/_static/scripts/bootstrap.js.map @@ -0,0 +1 @@ +{"version":3,"file":"scripts/bootstrap.js","mappings":";mBACA,IAAIA,EAAsB,CCA1BA,EAAwB,CAACC,EAASC,KACjC,IAAI,IAAIC,KAAOD,EACXF,EAAoBI,EAAEF,EAAYC,KAASH,EAAoBI,EAAEH,EAASE,IAC5EE,OAAOC,eAAeL,EAASE,EAAK,CAAEI,YAAY,EAAMC,IAAKN,EAAWC,IAE1E,ECNDH,EAAwB,CAACS,EAAKC,IAAUL,OAAOM,UAAUC,eAAeC,KAAKJ,EAAKC,GCClFV,EAAyBC,IACH,oBAAXa,QAA0BA,OAAOC,aAC1CV,OAAOC,eAAeL,EAASa,OAAOC,YAAa,CAAEC,MAAO,WAE7DX,OAAOC,eAAeL,EAAS,aAAc,CAAEe,OAAO,GAAO,ipBCLvD,IAAI,EAAM,MACNC,EAAS,SACTC,EAAQ,QACRC,EAAO,OACPC,EAAO,OACPC,EAAiB,CAAC,EAAKJ,EAAQC,EAAOC,GACtCG,EAAQ,QACRC,EAAM,MACNC,EAAkB,kBAClBC,EAAW,WACXC,EAAS,SACTC,EAAY,YACZC,EAAmCP,EAAeQ,QAAO,SAAUC,EAAKC,GACjF,OAAOD,EAAIE,OAAO,CAACD,EAAY,IAAMT,EAAOS,EAAY,IAAMR,GAChE,GAAG,IACQ,EAA0B,GAAGS,OAAOX,EAAgB,CAACD,IAAOS,QAAO,SAAUC,EAAKC,GAC3F,OAAOD,EAAIE,OAAO,CAACD,EAAWA,EAAY,IAAMT,EAAOS,EAAY,IAAMR,GAC3E,GAAG,IAEQU,EAAa,aACbC,EAAO,OACPC,EAAY,YAEZC,EAAa,aACbC,EAAO,OACPC,EAAY,YAEZC,EAAc,cACdC,EAAQ,QACRC,EAAa,aACbC,EAAiB,CAACT,EAAYC,EAAMC,EAAWC,EAAYC,EAAMC,EAAWC,EAAaC,EAAOC,GC9B5F,SAASE,EAAYC,GAClC,OAAOA,GAAWA,EAAQC,UAAY,IAAIC,cAAgB,IAC5D,CCFe,SAASC,EAAUC,GAChC,GAAY,MAARA,EACF,OAAOC,OAGT,GAAwB,oBAApBD,EAAKE,WAAkC,CACzC,IAAIC,EAAgBH,EAAKG,cACzB,OAAOA,GAAgBA,EAAcC,aAAwBH,MAC/D,CAEA,OAAOD,CACT,CCTA,SAASK,EAAUL,GAEjB,OAAOA,aADUD,EAAUC,GAAMM,SACIN,aAAgBM,OACvD,CAEA,SAASC,EAAcP,GAErB,OAAOA,aADUD,EAAUC,GAAMQ,aACIR,aAAgBQ,WACvD,CAEA,SAASC,EAAaT,GAEpB,MAA0B,oBAAfU,aAKJV,aADUD,EAAUC,GAAMU,YACIV,aAAgBU,WACvD,CCwDA,SACEC,KAAM,cACNC,SAAS,EACTC,MAAO,QACPC,GA5EF,SAAqBC,GACnB,IAAIC,EAAQD,EAAKC,MACjB3D,OAAO4D,KAAKD,EAAME,UAAUC,SAAQ,SAAUR,GAC5C,IAAIS,EAAQJ,EAAMK,OAAOV,IAAS,CAAC,EAC/BW,EAAaN,EAAMM,WAAWX,IAAS,CAAC,EACxCf,EAAUoB,EAAME,SAASP,GAExBJ,EAAcX,IAAaD,EAAYC,KAO5CvC,OAAOkE,OAAO3B,EAAQwB,MAAOA,GAC7B/D,OAAO4D,KAAKK,GAAYH,SAAQ,SAAUR,GACxC,IAAI3C,EAAQsD,EAAWX,IAET,IAAV3C,EACF4B,EAAQ4B,gBAAgBb,GAExBf,EAAQ6B,aAAad,GAAgB,IAAV3C,EAAiB,GAAKA,EAErD,IACF,GACF,EAoDE0D,OAlDF,SAAgBC,GACd,IAAIX,EAAQW,EAAMX,MACdY,EAAgB,CAClBlD,OAAQ,CACNmD,SAAUb,EAAMc,QAAQC,SACxB5D,KAAM,IACN6D,IAAK,IACLC,OAAQ,KAEVC,MAAO,CACLL,SAAU,YAEZlD,UAAW,CAAC,GASd,OAPAtB,OAAOkE,OAAOP,EAAME,SAASxC,OAAO0C,MAAOQ,EAAclD,QACzDsC,EAAMK,OAASO,EAEXZ,EAAME,SAASgB,OACjB7E,OAAOkE,OAAOP,EAAME,SAASgB,MAAMd,MAAOQ,EAAcM,OAGnD,WACL7E,OAAO4D,KAAKD,EAAME,UAAUC,SAAQ,SAAUR,GAC5C,IAAIf,EAAUoB,EAAME,SAASP,GACzBW,EAAaN,EAAMM,WAAWX,IAAS,CAAC,EAGxCS,EAFkB/D,OAAO4D,KAAKD,EAAMK,OAAOzD,eAAe+C,GAAQK,EAAMK,OAAOV,GAAQiB,EAAcjB,IAE7E9B,QAAO,SAAUuC,EAAOe,GAElD,OADAf,EAAMe,GAAY,GACXf,CACT,GAAG,CAAC,GAECb,EAAcX,IAAaD,EAAYC,KAI5CvC,OAAOkE,OAAO3B,EAAQwB,MAAOA,GAC7B/D,OAAO4D,KAAKK,GAAYH,SAAQ,SAAUiB,GACxCxC,EAAQ4B,gBAAgBY,EAC1B,IACF,GACF,CACF,EASEC,SAAU,CAAC,kBCjFE,SAASC,EAAiBvD,GACvC,OAAOA,EAAUwD,MAAM,KAAK,EAC9B,CCHO,IAAI,EAAMC,KAAKC,IACX,EAAMD,KAAKE,IACXC,EAAQH,KAAKG,MCFT,SAASC,IACtB,IAAIC,EAASC,UAAUC,cAEvB,OAAc,MAAVF,GAAkBA,EAAOG,QAAUC,MAAMC,QAAQL,EAAOG,QACnDH,EAAOG,OAAOG,KAAI,SAAUC,GACjC,OAAOA,EAAKC,MAAQ,IAAMD,EAAKE,OACjC,IAAGC,KAAK,KAGHT,UAAUU,SACnB,CCTe,SAASC,IACtB,OAAQ,iCAAiCC,KAAKd,IAChD,CCCe,SAASe,EAAsB/D,EAASgE,EAAcC,QAC9C,IAAjBD,IACFA,GAAe,QAGO,IAApBC,IACFA,GAAkB,GAGpB,IAAIC,EAAalE,EAAQ+D,wBACrBI,EAAS,EACTC,EAAS,EAETJ,GAAgBrD,EAAcX,KAChCmE,EAASnE,EAAQqE,YAAc,GAAItB,EAAMmB,EAAWI,OAAStE,EAAQqE,aAAmB,EACxFD,EAASpE,EAAQuE,aAAe,GAAIxB,EAAMmB,EAAWM,QAAUxE,EAAQuE,cAAoB,GAG7F,IACIE,GADOhE,EAAUT,GAAWG,EAAUH,GAAWK,QAC3BoE,eAEtBC,GAAoBb,KAAsBI,EAC1CU,GAAKT,EAAW3F,MAAQmG,GAAoBD,EAAiBA,EAAeG,WAAa,IAAMT,EAC/FU,GAAKX,EAAW9B,KAAOsC,GAAoBD,EAAiBA,EAAeK,UAAY,IAAMV,EAC7FE,EAAQJ,EAAWI,MAAQH,EAC3BK,EAASN,EAAWM,OAASJ,EACjC,MAAO,CACLE,MAAOA,EACPE,OAAQA,EACRpC,IAAKyC,EACLvG,MAAOqG,EAAIL,EACXjG,OAAQwG,EAAIL,EACZjG,KAAMoG,EACNA,EAAGA,EACHE,EAAGA,EAEP,CCrCe,SAASE,EAAc/E,GACpC,IAAIkE,EAAaH,EAAsB/D,GAGnCsE,EAAQtE,EAAQqE,YAChBG,EAASxE,EAAQuE,aAUrB,OARI3B,KAAKoC,IAAId,EAAWI,MAAQA,IAAU,IACxCA,EAAQJ,EAAWI,OAGjB1B,KAAKoC,IAAId,EAAWM,OAASA,IAAW,IAC1CA,EAASN,EAAWM,QAGf,CACLG,EAAG3E,EAAQ4E,WACXC,EAAG7E,EAAQ8E,UACXR,MAAOA,EACPE,OAAQA,EAEZ,CCvBe,SAASS,EAASC,EAAQC,GACvC,IAAIC,EAAWD,EAAME,aAAeF,EAAME,cAE1C,GAAIH,EAAOD,SAASE,GAClB,OAAO,EAEJ,GAAIC,GAAYvE,EAAauE,GAAW,CACzC,IAAIE,EAAOH,EAEX,EAAG,CACD,GAAIG,GAAQJ,EAAOK,WAAWD,GAC5B,OAAO,EAITA,EAAOA,EAAKE,YAAcF,EAAKG,IACjC,OAASH,EACX,CAGF,OAAO,CACT,CCrBe,SAAS,EAAiBtF,GACvC,OAAOG,EAAUH,GAAS0F,iBAAiB1F,EAC7C,CCFe,SAAS2F,EAAe3F,GACrC,MAAO,CAAC,QAAS,KAAM,MAAM4F,QAAQ7F,EAAYC,KAAa,CAChE,CCFe,SAAS6F,EAAmB7F,GAEzC,QAASS,EAAUT,GAAWA,EAAQO,cACtCP,EAAQ8F,WAAazF,OAAOyF,UAAUC,eACxC,CCFe,SAASC,EAAchG,GACpC,MAA6B,SAAzBD,EAAYC,GACPA,EAMPA,EAAQiG,cACRjG,EAAQwF,aACR3E,EAAab,GAAWA,EAAQyF,KAAO,OAEvCI,EAAmB7F,EAGvB,CCVA,SAASkG,EAAoBlG,GAC3B,OAAKW,EAAcX,IACoB,UAAvC,EAAiBA,GAASiC,SAInBjC,EAAQmG,aAHN,IAIX,CAwCe,SAASC,EAAgBpG,GAItC,IAHA,IAAIK,EAASF,EAAUH,GACnBmG,EAAeD,EAAoBlG,GAEhCmG,GAAgBR,EAAeQ,IAA6D,WAA5C,EAAiBA,GAAclE,UACpFkE,EAAeD,EAAoBC,GAGrC,OAAIA,IAA+C,SAA9BpG,EAAYoG,IAA0D,SAA9BpG,EAAYoG,IAAwE,WAA5C,EAAiBA,GAAclE,UAC3H5B,EAGF8F,GAhDT,SAA4BnG,GAC1B,IAAIqG,EAAY,WAAWvC,KAAKd,KAGhC,GAFW,WAAWc,KAAKd,MAEfrC,EAAcX,IAII,UAFX,EAAiBA,GAEnBiC,SACb,OAAO,KAIX,IAAIqE,EAAcN,EAAchG,GAMhC,IAJIa,EAAayF,KACfA,EAAcA,EAAYb,MAGrB9E,EAAc2F,IAAgB,CAAC,OAAQ,QAAQV,QAAQ7F,EAAYuG,IAAgB,GAAG,CAC3F,IAAIC,EAAM,EAAiBD,GAI3B,GAAsB,SAAlBC,EAAIC,WAA4C,SAApBD,EAAIE,aAA0C,UAAhBF,EAAIG,UAAiF,IAA1D,CAAC,YAAa,eAAed,QAAQW,EAAII,aAAsBN,GAAgC,WAAnBE,EAAII,YAA2BN,GAAaE,EAAIK,QAAyB,SAAfL,EAAIK,OACjO,OAAON,EAEPA,EAAcA,EAAYd,UAE9B,CAEA,OAAO,IACT,CAgByBqB,CAAmB7G,IAAYK,CACxD,CCpEe,SAASyG,EAAyB3H,GAC/C,MAAO,CAAC,MAAO,UAAUyG,QAAQzG,IAAc,EAAI,IAAM,GAC3D,CCDO,SAAS4H,EAAOjE,EAAK1E,EAAOyE,GACjC,OAAO,EAAQC,EAAK,EAAQ1E,EAAOyE,GACrC,CCFe,SAASmE,EAAmBC,GACzC,OAAOxJ,OAAOkE,OAAO,CAAC,ECDf,CACLS,IAAK,EACL9D,MAAO,EACPD,OAAQ,EACRE,KAAM,GDHuC0I,EACjD,CEHe,SAASC,EAAgB9I,EAAOiD,GAC7C,OAAOA,EAAKpC,QAAO,SAAUkI,EAAS5J,GAEpC,OADA4J,EAAQ5J,GAAOa,EACR+I,CACT,GAAG,CAAC,EACN,CCuFA,SACEpG,KAAM,QACNC,SAAS,EACTC,MAAO,OACPC,GA9EF,SAAeC,GACb,IAAIiG,EAEAhG,EAAQD,EAAKC,MACbL,EAAOI,EAAKJ,KACZmB,EAAUf,EAAKe,QACfmF,EAAejG,EAAME,SAASgB,MAC9BgF,EAAgBlG,EAAMmG,cAAcD,cACpCE,EAAgB9E,EAAiBtB,EAAMjC,WACvCsI,EAAOX,EAAyBU,GAEhCE,EADa,CAACnJ,EAAMD,GAAOsH,QAAQ4B,IAAkB,EAClC,SAAW,QAElC,GAAKH,GAAiBC,EAAtB,CAIA,IAAIL,EAxBgB,SAAyBU,EAASvG,GAItD,OAAO4F,EAAsC,iBAH7CW,EAA6B,mBAAZA,EAAyBA,EAAQlK,OAAOkE,OAAO,CAAC,EAAGP,EAAMwG,MAAO,CAC/EzI,UAAWiC,EAAMjC,aACbwI,GACkDA,EAAUT,EAAgBS,EAASlJ,GAC7F,CAmBsBoJ,CAAgB3F,EAAQyF,QAASvG,GACjD0G,EAAY/C,EAAcsC,GAC1BU,EAAmB,MAATN,EAAe,EAAMlJ,EAC/ByJ,EAAmB,MAATP,EAAepJ,EAASC,EAClC2J,EAAU7G,EAAMwG,MAAM7I,UAAU2I,GAAOtG,EAAMwG,MAAM7I,UAAU0I,GAAQH,EAAcG,GAAQrG,EAAMwG,MAAM9I,OAAO4I,GAC9GQ,EAAYZ,EAAcG,GAAQrG,EAAMwG,MAAM7I,UAAU0I,GACxDU,EAAoB/B,EAAgBiB,GACpCe,EAAaD,EAA6B,MAATV,EAAeU,EAAkBE,cAAgB,EAAIF,EAAkBG,aAAe,EAAI,EAC3HC,EAAoBN,EAAU,EAAIC,EAAY,EAG9CpF,EAAMmE,EAAcc,GACpBlF,EAAMuF,EAAaN,EAAUJ,GAAOT,EAAce,GAClDQ,EAASJ,EAAa,EAAIN,EAAUJ,GAAO,EAAIa,EAC/CE,EAAS1B,EAAOjE,EAAK0F,EAAQ3F,GAE7B6F,EAAWjB,EACfrG,EAAMmG,cAAcxG,KAASqG,EAAwB,CAAC,GAAyBsB,GAAYD,EAAQrB,EAAsBuB,aAAeF,EAASD,EAAQpB,EAnBzJ,CAoBF,EA4CEtF,OA1CF,SAAgBC,GACd,IAAIX,EAAQW,EAAMX,MAEdwH,EADU7G,EAAMG,QACWlC,QAC3BqH,OAAoC,IAArBuB,EAA8B,sBAAwBA,EAErD,MAAhBvB,IAKwB,iBAAjBA,IACTA,EAAejG,EAAME,SAASxC,OAAO+J,cAAcxB,MAahDpC,EAAS7D,EAAME,SAASxC,OAAQuI,KAQrCjG,EAAME,SAASgB,MAAQ+E,EACzB,EASE5E,SAAU,CAAC,iBACXqG,iBAAkB,CAAC,oBCnGN,SAASC,EAAa5J,GACnC,OAAOA,EAAUwD,MAAM,KAAK,EAC9B,CCOA,IAAIqG,EAAa,CACf5G,IAAK,OACL9D,MAAO,OACPD,OAAQ,OACRE,KAAM,QAeD,SAAS0K,GAAYlH,GAC1B,IAAImH,EAEApK,EAASiD,EAAMjD,OACfqK,EAAapH,EAAMoH,WACnBhK,EAAY4C,EAAM5C,UAClBiK,EAAYrH,EAAMqH,UAClBC,EAAUtH,EAAMsH,QAChBpH,EAAWF,EAAME,SACjBqH,EAAkBvH,EAAMuH,gBACxBC,EAAWxH,EAAMwH,SACjBC,EAAezH,EAAMyH,aACrBC,EAAU1H,EAAM0H,QAChBC,EAAaL,EAAQ1E,EACrBA,OAAmB,IAAf+E,EAAwB,EAAIA,EAChCC,EAAaN,EAAQxE,EACrBA,OAAmB,IAAf8E,EAAwB,EAAIA,EAEhCC,EAAgC,mBAAjBJ,EAA8BA,EAAa,CAC5D7E,EAAGA,EACHE,IACG,CACHF,EAAGA,EACHE,GAGFF,EAAIiF,EAAMjF,EACVE,EAAI+E,EAAM/E,EACV,IAAIgF,EAAOR,EAAQrL,eAAe,KAC9B8L,EAAOT,EAAQrL,eAAe,KAC9B+L,EAAQxL,EACRyL,EAAQ,EACRC,EAAM5J,OAEV,GAAIkJ,EAAU,CACZ,IAAIpD,EAAeC,EAAgBtH,GAC/BoL,EAAa,eACbC,EAAY,cAEZhE,IAAiBhG,EAAUrB,IAGmB,WAA5C,EAFJqH,EAAeN,EAAmB/G,IAECmD,UAAsC,aAAbA,IAC1DiI,EAAa,eACbC,EAAY,gBAOZhL,IAAc,IAAQA,IAAcZ,GAAQY,IAAcb,IAAU8K,IAAczK,KACpFqL,EAAQ3L,EAGRwG,IAFc4E,GAAWtD,IAAiB8D,GAAOA,EAAIxF,eAAiBwF,EAAIxF,eAAeD,OACzF2B,EAAa+D,IACEf,EAAW3E,OAC1BK,GAAKyE,EAAkB,GAAK,GAG1BnK,IAAcZ,IAASY,IAAc,GAAOA,IAAcd,GAAW+K,IAAczK,KACrFoL,EAAQzL,EAGRqG,IAFc8E,GAAWtD,IAAiB8D,GAAOA,EAAIxF,eAAiBwF,EAAIxF,eAAeH,MACzF6B,EAAagE,IACEhB,EAAW7E,MAC1BK,GAAK2E,EAAkB,GAAK,EAEhC,CAEA,IAgBMc,EAhBFC,EAAe5M,OAAOkE,OAAO,CAC/BM,SAAUA,GACTsH,GAAYP,GAEXsB,GAAyB,IAAjBd,EAlFd,SAA2BrI,EAAM8I,GAC/B,IAAItF,EAAIxD,EAAKwD,EACTE,EAAI1D,EAAK0D,EACT0F,EAAMN,EAAIO,kBAAoB,EAClC,MAAO,CACL7F,EAAG5B,EAAM4B,EAAI4F,GAAOA,GAAO,EAC3B1F,EAAG9B,EAAM8B,EAAI0F,GAAOA,GAAO,EAE/B,CA0EsCE,CAAkB,CACpD9F,EAAGA,EACHE,GACC1E,EAAUrB,IAAW,CACtB6F,EAAGA,EACHE,GAMF,OAHAF,EAAI2F,EAAM3F,EACVE,EAAIyF,EAAMzF,EAENyE,EAGK7L,OAAOkE,OAAO,CAAC,EAAG0I,IAAeD,EAAiB,CAAC,GAAkBJ,GAASF,EAAO,IAAM,GAAIM,EAAeL,GAASF,EAAO,IAAM,GAAIO,EAAe5D,WAAayD,EAAIO,kBAAoB,IAAM,EAAI,aAAe7F,EAAI,OAASE,EAAI,MAAQ,eAAiBF,EAAI,OAASE,EAAI,SAAUuF,IAG5R3M,OAAOkE,OAAO,CAAC,EAAG0I,IAAenB,EAAkB,CAAC,GAAmBc,GAASF,EAAOjF,EAAI,KAAO,GAAIqE,EAAgBa,GAASF,EAAOlF,EAAI,KAAO,GAAIuE,EAAgB1C,UAAY,GAAI0C,GAC9L,CAuDA,UACEnI,KAAM,gBACNC,SAAS,EACTC,MAAO,cACPC,GAzDF,SAAuBwJ,GACrB,IAAItJ,EAAQsJ,EAAMtJ,MACdc,EAAUwI,EAAMxI,QAChByI,EAAwBzI,EAAQoH,gBAChCA,OAA4C,IAA1BqB,GAA0CA,EAC5DC,EAAoB1I,EAAQqH,SAC5BA,OAAiC,IAAtBqB,GAAsCA,EACjDC,EAAwB3I,EAAQsH,aAChCA,OAAyC,IAA1BqB,GAA0CA,EAYzDR,EAAe,CACjBlL,UAAWuD,EAAiBtB,EAAMjC,WAClCiK,UAAWL,EAAa3H,EAAMjC,WAC9BL,OAAQsC,EAAME,SAASxC,OACvBqK,WAAY/H,EAAMwG,MAAM9I,OACxBwK,gBAAiBA,EACjBG,QAAoC,UAA3BrI,EAAMc,QAAQC,UAGgB,MAArCf,EAAMmG,cAAcD,gBACtBlG,EAAMK,OAAO3C,OAASrB,OAAOkE,OAAO,CAAC,EAAGP,EAAMK,OAAO3C,OAAQmK,GAAYxL,OAAOkE,OAAO,CAAC,EAAG0I,EAAc,CACvGhB,QAASjI,EAAMmG,cAAcD,cAC7BrF,SAAUb,EAAMc,QAAQC,SACxBoH,SAAUA,EACVC,aAAcA,OAIe,MAA7BpI,EAAMmG,cAAcjF,QACtBlB,EAAMK,OAAOa,MAAQ7E,OAAOkE,OAAO,CAAC,EAAGP,EAAMK,OAAOa,MAAO2G,GAAYxL,OAAOkE,OAAO,CAAC,EAAG0I,EAAc,CACrGhB,QAASjI,EAAMmG,cAAcjF,MAC7BL,SAAU,WACVsH,UAAU,EACVC,aAAcA,OAIlBpI,EAAMM,WAAW5C,OAASrB,OAAOkE,OAAO,CAAC,EAAGP,EAAMM,WAAW5C,OAAQ,CACnE,wBAAyBsC,EAAMjC,WAEnC,EAQE2L,KAAM,CAAC,GChLT,IAAIC,GAAU,CACZA,SAAS,GAsCX,UACEhK,KAAM,iBACNC,SAAS,EACTC,MAAO,QACPC,GAAI,WAAe,EACnBY,OAxCF,SAAgBX,GACd,IAAIC,EAAQD,EAAKC,MACb4J,EAAW7J,EAAK6J,SAChB9I,EAAUf,EAAKe,QACf+I,EAAkB/I,EAAQgJ,OAC1BA,OAA6B,IAApBD,GAAoCA,EAC7CE,EAAkBjJ,EAAQkJ,OAC1BA,OAA6B,IAApBD,GAAoCA,EAC7C9K,EAASF,EAAUiB,EAAME,SAASxC,QAClCuM,EAAgB,GAAGjM,OAAOgC,EAAMiK,cAActM,UAAWqC,EAAMiK,cAAcvM,QAYjF,OAVIoM,GACFG,EAAc9J,SAAQ,SAAU+J,GAC9BA,EAAaC,iBAAiB,SAAUP,EAASQ,OAAQT,GAC3D,IAGEK,GACF/K,EAAOkL,iBAAiB,SAAUP,EAASQ,OAAQT,IAG9C,WACDG,GACFG,EAAc9J,SAAQ,SAAU+J,GAC9BA,EAAaG,oBAAoB,SAAUT,EAASQ,OAAQT,GAC9D,IAGEK,GACF/K,EAAOoL,oBAAoB,SAAUT,EAASQ,OAAQT,GAE1D,CACF,EASED,KAAM,CAAC,GC/CT,IAAIY,GAAO,CACTnN,KAAM,QACND,MAAO,OACPD,OAAQ,MACR+D,IAAK,UAEQ,SAASuJ,GAAqBxM,GAC3C,OAAOA,EAAUyM,QAAQ,0BAA0B,SAAUC,GAC3D,OAAOH,GAAKG,EACd,GACF,CCVA,IAAI,GAAO,CACTnN,MAAO,MACPC,IAAK,SAEQ,SAASmN,GAA8B3M,GACpD,OAAOA,EAAUyM,QAAQ,cAAc,SAAUC,GAC/C,OAAO,GAAKA,EACd,GACF,CCPe,SAASE,GAAgB3L,GACtC,IAAI6J,EAAM9J,EAAUC,GAGpB,MAAO,CACL4L,WAHe/B,EAAIgC,YAInBC,UAHcjC,EAAIkC,YAKtB,CCNe,SAASC,GAAoBpM,GAQ1C,OAAO+D,EAAsB8B,EAAmB7F,IAAUzB,KAAOwN,GAAgB/L,GAASgM,UAC5F,CCXe,SAASK,GAAerM,GAErC,IAAIsM,EAAoB,EAAiBtM,GACrCuM,EAAWD,EAAkBC,SAC7BC,EAAYF,EAAkBE,UAC9BC,EAAYH,EAAkBG,UAElC,MAAO,6BAA6B3I,KAAKyI,EAAWE,EAAYD,EAClE,CCLe,SAASE,GAAgBtM,GACtC,MAAI,CAAC,OAAQ,OAAQ,aAAawF,QAAQ7F,EAAYK,KAAU,EAEvDA,EAAKG,cAAcoM,KAGxBhM,EAAcP,IAASiM,GAAejM,GACjCA,EAGFsM,GAAgB1G,EAAc5F,GACvC,CCJe,SAASwM,GAAkB5M,EAAS6M,GACjD,IAAIC,OAES,IAATD,IACFA,EAAO,IAGT,IAAIvB,EAAeoB,GAAgB1M,GAC/B+M,EAASzB,KAAqE,OAAlDwB,EAAwB9M,EAAQO,oBAAyB,EAASuM,EAAsBH,MACpH1C,EAAM9J,EAAUmL,GAChB0B,EAASD,EAAS,CAAC9C,GAAK7K,OAAO6K,EAAIxF,gBAAkB,GAAI4H,GAAef,GAAgBA,EAAe,IAAMA,EAC7G2B,EAAcJ,EAAKzN,OAAO4N,GAC9B,OAAOD,EAASE,EAChBA,EAAY7N,OAAOwN,GAAkB5G,EAAcgH,IACrD,CCzBe,SAASE,GAAiBC,GACvC,OAAO1P,OAAOkE,OAAO,CAAC,EAAGwL,EAAM,CAC7B5O,KAAM4O,EAAKxI,EACXvC,IAAK+K,EAAKtI,EACVvG,MAAO6O,EAAKxI,EAAIwI,EAAK7I,MACrBjG,OAAQ8O,EAAKtI,EAAIsI,EAAK3I,QAE1B,CCqBA,SAAS4I,GAA2BpN,EAASqN,EAAgBlL,GAC3D,OAAOkL,IAAmBxO,EAAWqO,GCzBxB,SAAyBlN,EAASmC,GAC/C,IAAI8H,EAAM9J,EAAUH,GAChBsN,EAAOzH,EAAmB7F,GAC1ByE,EAAiBwF,EAAIxF,eACrBH,EAAQgJ,EAAKhF,YACb9D,EAAS8I,EAAKjF,aACd1D,EAAI,EACJE,EAAI,EAER,GAAIJ,EAAgB,CAClBH,EAAQG,EAAeH,MACvBE,EAASC,EAAeD,OACxB,IAAI+I,EAAiB1J,KAEjB0J,IAAmBA,GAA+B,UAAbpL,KACvCwC,EAAIF,EAAeG,WACnBC,EAAIJ,EAAeK,UAEvB,CAEA,MAAO,CACLR,MAAOA,EACPE,OAAQA,EACRG,EAAGA,EAAIyH,GAAoBpM,GAC3B6E,EAAGA,EAEP,CDDwD2I,CAAgBxN,EAASmC,IAAa1B,EAAU4M,GAdxG,SAAoCrN,EAASmC,GAC3C,IAAIgL,EAAOpJ,EAAsB/D,GAAS,EAAoB,UAAbmC,GASjD,OARAgL,EAAK/K,IAAM+K,EAAK/K,IAAMpC,EAAQyN,UAC9BN,EAAK5O,KAAO4O,EAAK5O,KAAOyB,EAAQ0N,WAChCP,EAAK9O,OAAS8O,EAAK/K,IAAMpC,EAAQqI,aACjC8E,EAAK7O,MAAQ6O,EAAK5O,KAAOyB,EAAQsI,YACjC6E,EAAK7I,MAAQtE,EAAQsI,YACrB6E,EAAK3I,OAASxE,EAAQqI,aACtB8E,EAAKxI,EAAIwI,EAAK5O,KACd4O,EAAKtI,EAAIsI,EAAK/K,IACP+K,CACT,CAG0HQ,CAA2BN,EAAgBlL,GAAY+K,GEtBlK,SAAyBlN,GACtC,IAAI8M,EAEAQ,EAAOzH,EAAmB7F,GAC1B4N,EAAY7B,GAAgB/L,GAC5B2M,EAA0D,OAAlDG,EAAwB9M,EAAQO,oBAAyB,EAASuM,EAAsBH,KAChGrI,EAAQ,EAAIgJ,EAAKO,YAAaP,EAAKhF,YAAaqE,EAAOA,EAAKkB,YAAc,EAAGlB,EAAOA,EAAKrE,YAAc,GACvG9D,EAAS,EAAI8I,EAAKQ,aAAcR,EAAKjF,aAAcsE,EAAOA,EAAKmB,aAAe,EAAGnB,EAAOA,EAAKtE,aAAe,GAC5G1D,GAAKiJ,EAAU5B,WAAaI,GAAoBpM,GAChD6E,GAAK+I,EAAU1B,UAMnB,MAJiD,QAA7C,EAAiBS,GAAQW,GAAMS,YACjCpJ,GAAK,EAAI2I,EAAKhF,YAAaqE,EAAOA,EAAKrE,YAAc,GAAKhE,GAGrD,CACLA,MAAOA,EACPE,OAAQA,EACRG,EAAGA,EACHE,EAAGA,EAEP,CFCkMmJ,CAAgBnI,EAAmB7F,IACrO,CG1Be,SAASiO,GAAe9M,GACrC,IAOIkI,EAPAtK,EAAYoC,EAAKpC,UACjBiB,EAAUmB,EAAKnB,QACfb,EAAYgC,EAAKhC,UACjBqI,EAAgBrI,EAAYuD,EAAiBvD,GAAa,KAC1DiK,EAAYjK,EAAY4J,EAAa5J,GAAa,KAClD+O,EAAUnP,EAAU4F,EAAI5F,EAAUuF,MAAQ,EAAItE,EAAQsE,MAAQ,EAC9D6J,EAAUpP,EAAU8F,EAAI9F,EAAUyF,OAAS,EAAIxE,EAAQwE,OAAS,EAGpE,OAAQgD,GACN,KAAK,EACH6B,EAAU,CACR1E,EAAGuJ,EACHrJ,EAAG9F,EAAU8F,EAAI7E,EAAQwE,QAE3B,MAEF,KAAKnG,EACHgL,EAAU,CACR1E,EAAGuJ,EACHrJ,EAAG9F,EAAU8F,EAAI9F,EAAUyF,QAE7B,MAEF,KAAKlG,EACH+K,EAAU,CACR1E,EAAG5F,EAAU4F,EAAI5F,EAAUuF,MAC3BO,EAAGsJ,GAEL,MAEF,KAAK5P,EACH8K,EAAU,CACR1E,EAAG5F,EAAU4F,EAAI3E,EAAQsE,MACzBO,EAAGsJ,GAEL,MAEF,QACE9E,EAAU,CACR1E,EAAG5F,EAAU4F,EACbE,EAAG9F,EAAU8F,GAInB,IAAIuJ,EAAW5G,EAAgBV,EAAyBU,GAAiB,KAEzE,GAAgB,MAAZ4G,EAAkB,CACpB,IAAI1G,EAAmB,MAAb0G,EAAmB,SAAW,QAExC,OAAQhF,GACN,KAAK1K,EACH2K,EAAQ+E,GAAY/E,EAAQ+E,IAAarP,EAAU2I,GAAO,EAAI1H,EAAQ0H,GAAO,GAC7E,MAEF,KAAK/I,EACH0K,EAAQ+E,GAAY/E,EAAQ+E,IAAarP,EAAU2I,GAAO,EAAI1H,EAAQ0H,GAAO,GAKnF,CAEA,OAAO2B,CACT,CC3De,SAASgF,GAAejN,EAAOc,QAC5B,IAAZA,IACFA,EAAU,CAAC,GAGb,IAAIoM,EAAWpM,EACXqM,EAAqBD,EAASnP,UAC9BA,OAAmC,IAAvBoP,EAAgCnN,EAAMjC,UAAYoP,EAC9DC,EAAoBF,EAASnM,SAC7BA,OAAiC,IAAtBqM,EAA+BpN,EAAMe,SAAWqM,EAC3DC,EAAoBH,EAASI,SAC7BA,OAAiC,IAAtBD,EAA+B7P,EAAkB6P,EAC5DE,EAAwBL,EAASM,aACjCA,OAAyC,IAA1BD,EAAmC9P,EAAW8P,EAC7DE,EAAwBP,EAASQ,eACjCA,OAA2C,IAA1BD,EAAmC/P,EAAS+P,EAC7DE,EAAuBT,EAASU,YAChCA,OAAuC,IAAzBD,GAA0CA,EACxDE,EAAmBX,EAAS3G,QAC5BA,OAA+B,IAArBsH,EAA8B,EAAIA,EAC5ChI,EAAgBD,EAAsC,iBAAZW,EAAuBA,EAAUT,EAAgBS,EAASlJ,IACpGyQ,EAAaJ,IAAmBhQ,EAASC,EAAYD,EACrDqK,EAAa/H,EAAMwG,MAAM9I,OACzBkB,EAAUoB,EAAME,SAAS0N,EAAcE,EAAaJ,GACpDK,EJkBS,SAAyBnP,EAAS0O,EAAUE,EAAczM,GACvE,IAAIiN,EAAmC,oBAAbV,EAlB5B,SAA4B1O,GAC1B,IAAIpB,EAAkBgO,GAAkB5G,EAAchG,IAElDqP,EADoB,CAAC,WAAY,SAASzJ,QAAQ,EAAiB5F,GAASiC,WAAa,GACnDtB,EAAcX,GAAWoG,EAAgBpG,GAAWA,EAE9F,OAAKS,EAAU4O,GAKRzQ,EAAgBgI,QAAO,SAAUyG,GACtC,OAAO5M,EAAU4M,IAAmBpI,EAASoI,EAAgBgC,IAAmD,SAAhCtP,EAAYsN,EAC9F,IANS,EAOX,CAK6DiC,CAAmBtP,GAAW,GAAGZ,OAAOsP,GAC/F9P,EAAkB,GAAGQ,OAAOgQ,EAAqB,CAACR,IAClDW,EAAsB3Q,EAAgB,GACtC4Q,EAAe5Q,EAAgBK,QAAO,SAAUwQ,EAASpC,GAC3D,IAAIF,EAAOC,GAA2BpN,EAASqN,EAAgBlL,GAK/D,OAJAsN,EAAQrN,IAAM,EAAI+K,EAAK/K,IAAKqN,EAAQrN,KACpCqN,EAAQnR,MAAQ,EAAI6O,EAAK7O,MAAOmR,EAAQnR,OACxCmR,EAAQpR,OAAS,EAAI8O,EAAK9O,OAAQoR,EAAQpR,QAC1CoR,EAAQlR,KAAO,EAAI4O,EAAK5O,KAAMkR,EAAQlR,MAC/BkR,CACT,GAAGrC,GAA2BpN,EAASuP,EAAqBpN,IAK5D,OAJAqN,EAAalL,MAAQkL,EAAalR,MAAQkR,EAAajR,KACvDiR,EAAahL,OAASgL,EAAanR,OAASmR,EAAapN,IACzDoN,EAAa7K,EAAI6K,EAAajR,KAC9BiR,EAAa3K,EAAI2K,EAAapN,IACvBoN,CACT,CInC2BE,CAAgBjP,EAAUT,GAAWA,EAAUA,EAAQ2P,gBAAkB9J,EAAmBzE,EAAME,SAASxC,QAAS4P,EAAUE,EAAczM,GACjKyN,EAAsB7L,EAAsB3C,EAAME,SAASvC,WAC3DuI,EAAgB2G,GAAe,CACjClP,UAAW6Q,EACX5P,QAASmJ,EACThH,SAAU,WACVhD,UAAWA,IAET0Q,EAAmB3C,GAAiBzP,OAAOkE,OAAO,CAAC,EAAGwH,EAAY7B,IAClEwI,EAAoBhB,IAAmBhQ,EAAS+Q,EAAmBD,EAGnEG,EAAkB,CACpB3N,IAAK+M,EAAmB/M,IAAM0N,EAAkB1N,IAAM6E,EAAc7E,IACpE/D,OAAQyR,EAAkBzR,OAAS8Q,EAAmB9Q,OAAS4I,EAAc5I,OAC7EE,KAAM4Q,EAAmB5Q,KAAOuR,EAAkBvR,KAAO0I,EAAc1I,KACvED,MAAOwR,EAAkBxR,MAAQ6Q,EAAmB7Q,MAAQ2I,EAAc3I,OAExE0R,EAAa5O,EAAMmG,cAAckB,OAErC,GAAIqG,IAAmBhQ,GAAUkR,EAAY,CAC3C,IAAIvH,EAASuH,EAAW7Q,GACxB1B,OAAO4D,KAAK0O,GAAiBxO,SAAQ,SAAUhE,GAC7C,IAAI0S,EAAW,CAAC3R,EAAOD,GAAQuH,QAAQrI,IAAQ,EAAI,GAAK,EACpDkK,EAAO,CAAC,EAAKpJ,GAAQuH,QAAQrI,IAAQ,EAAI,IAAM,IACnDwS,EAAgBxS,IAAQkL,EAAOhB,GAAQwI,CACzC,GACF,CAEA,OAAOF,CACT,CCyEA,UACEhP,KAAM,OACNC,SAAS,EACTC,MAAO,OACPC,GA5HF,SAAcC,GACZ,IAAIC,EAAQD,EAAKC,MACbc,EAAUf,EAAKe,QACfnB,EAAOI,EAAKJ,KAEhB,IAAIK,EAAMmG,cAAcxG,GAAMmP,MAA9B,CAoCA,IAhCA,IAAIC,EAAoBjO,EAAQkM,SAC5BgC,OAAsC,IAAtBD,GAAsCA,EACtDE,EAAmBnO,EAAQoO,QAC3BC,OAAoC,IAArBF,GAAqCA,EACpDG,EAA8BtO,EAAQuO,mBACtC9I,EAAUzF,EAAQyF,QAClB+G,EAAWxM,EAAQwM,SACnBE,EAAe1M,EAAQ0M,aACvBI,EAAc9M,EAAQ8M,YACtB0B,EAAwBxO,EAAQyO,eAChCA,OAA2C,IAA1BD,GAA0CA,EAC3DE,EAAwB1O,EAAQ0O,sBAChCC,EAAqBzP,EAAMc,QAAQ/C,UACnCqI,EAAgB9E,EAAiBmO,GAEjCJ,EAAqBD,IADHhJ,IAAkBqJ,GACqCF,EAjC/E,SAAuCxR,GACrC,GAAIuD,EAAiBvD,KAAeX,EAClC,MAAO,GAGT,IAAIsS,EAAoBnF,GAAqBxM,GAC7C,MAAO,CAAC2M,GAA8B3M,GAAY2R,EAAmBhF,GAA8BgF,GACrG,CA0B6IC,CAA8BF,GAA3E,CAAClF,GAAqBkF,KAChHG,EAAa,CAACH,GAAoBzR,OAAOqR,GAAoBxR,QAAO,SAAUC,EAAKC,GACrF,OAAOD,EAAIE,OAAOsD,EAAiBvD,KAAeX,ECvCvC,SAA8B4C,EAAOc,QAClC,IAAZA,IACFA,EAAU,CAAC,GAGb,IAAIoM,EAAWpM,EACX/C,EAAYmP,EAASnP,UACrBuP,EAAWJ,EAASI,SACpBE,EAAeN,EAASM,aACxBjH,EAAU2G,EAAS3G,QACnBgJ,EAAiBrC,EAASqC,eAC1BM,EAAwB3C,EAASsC,sBACjCA,OAAkD,IAA1BK,EAAmC,EAAgBA,EAC3E7H,EAAYL,EAAa5J,GACzB6R,EAAa5H,EAAYuH,EAAiB3R,EAAsBA,EAAoB4H,QAAO,SAAUzH,GACvG,OAAO4J,EAAa5J,KAAeiK,CACrC,IAAK3K,EACDyS,EAAoBF,EAAWpK,QAAO,SAAUzH,GAClD,OAAOyR,EAAsBhL,QAAQzG,IAAc,CACrD,IAEiC,IAA7B+R,EAAkBC,SACpBD,EAAoBF,GAQtB,IAAII,EAAYF,EAAkBjS,QAAO,SAAUC,EAAKC,GAOtD,OANAD,EAAIC,GAAakP,GAAejN,EAAO,CACrCjC,UAAWA,EACXuP,SAAUA,EACVE,aAAcA,EACdjH,QAASA,IACRjF,EAAiBvD,IACbD,CACT,GAAG,CAAC,GACJ,OAAOzB,OAAO4D,KAAK+P,GAAWC,MAAK,SAAUC,EAAGC,GAC9C,OAAOH,EAAUE,GAAKF,EAAUG,EAClC,GACF,CDH6DC,CAAqBpQ,EAAO,CACnFjC,UAAWA,EACXuP,SAAUA,EACVE,aAAcA,EACdjH,QAASA,EACTgJ,eAAgBA,EAChBC,sBAAuBA,IACpBzR,EACP,GAAG,IACCsS,EAAgBrQ,EAAMwG,MAAM7I,UAC5BoK,EAAa/H,EAAMwG,MAAM9I,OACzB4S,EAAY,IAAIC,IAChBC,GAAqB,EACrBC,EAAwBb,EAAW,GAE9Bc,EAAI,EAAGA,EAAId,EAAWG,OAAQW,IAAK,CAC1C,IAAI3S,EAAY6R,EAAWc,GAEvBC,EAAiBrP,EAAiBvD,GAElC6S,EAAmBjJ,EAAa5J,KAAeT,EAC/CuT,EAAa,CAAC,EAAK5T,GAAQuH,QAAQmM,IAAmB,EACtDrK,EAAMuK,EAAa,QAAU,SAC7B1F,EAAW8B,GAAejN,EAAO,CACnCjC,UAAWA,EACXuP,SAAUA,EACVE,aAAcA,EACdI,YAAaA,EACbrH,QAASA,IAEPuK,EAAoBD,EAAaD,EAAmB1T,EAAQC,EAAOyT,EAAmB3T,EAAS,EAE/FoT,EAAc/J,GAAOyB,EAAWzB,KAClCwK,EAAoBvG,GAAqBuG,IAG3C,IAAIC,EAAmBxG,GAAqBuG,GACxCE,EAAS,GAUb,GARIhC,GACFgC,EAAOC,KAAK9F,EAASwF,IAAmB,GAGtCxB,GACF6B,EAAOC,KAAK9F,EAAS2F,IAAsB,EAAG3F,EAAS4F,IAAqB,GAG1EC,EAAOE,OAAM,SAAUC,GACzB,OAAOA,CACT,IAAI,CACFV,EAAwB1S,EACxByS,GAAqB,EACrB,KACF,CAEAF,EAAUc,IAAIrT,EAAWiT,EAC3B,CAEA,GAAIR,EAqBF,IAnBA,IAEIa,EAAQ,SAAeC,GACzB,IAAIC,EAAmB3B,EAAW4B,MAAK,SAAUzT,GAC/C,IAAIiT,EAASV,EAAU9T,IAAIuB,GAE3B,GAAIiT,EACF,OAAOA,EAAOS,MAAM,EAAGH,GAAIJ,OAAM,SAAUC,GACzC,OAAOA,CACT,GAEJ,IAEA,GAAII,EAEF,OADAd,EAAwBc,EACjB,OAEX,EAESD,EAnBY/B,EAAiB,EAAI,EAmBZ+B,EAAK,GAGpB,UAFFD,EAAMC,GADmBA,KAOpCtR,EAAMjC,YAAc0S,IACtBzQ,EAAMmG,cAAcxG,GAAMmP,OAAQ,EAClC9O,EAAMjC,UAAY0S,EAClBzQ,EAAM0R,OAAQ,EA5GhB,CA8GF,EAQEhK,iBAAkB,CAAC,UACnBgC,KAAM,CACJoF,OAAO,IE7IX,SAAS6C,GAAexG,EAAUY,EAAM6F,GAQtC,YAPyB,IAArBA,IACFA,EAAmB,CACjBrO,EAAG,EACHE,EAAG,IAIA,CACLzC,IAAKmK,EAASnK,IAAM+K,EAAK3I,OAASwO,EAAiBnO,EACnDvG,MAAOiO,EAASjO,MAAQ6O,EAAK7I,MAAQ0O,EAAiBrO,EACtDtG,OAAQkO,EAASlO,OAAS8O,EAAK3I,OAASwO,EAAiBnO,EACzDtG,KAAMgO,EAAShO,KAAO4O,EAAK7I,MAAQ0O,EAAiBrO,EAExD,CAEA,SAASsO,GAAsB1G,GAC7B,MAAO,CAAC,EAAKjO,EAAOD,EAAQE,GAAM2U,MAAK,SAAUC,GAC/C,OAAO5G,EAAS4G,IAAS,CAC3B,GACF,CA+BA,UACEpS,KAAM,OACNC,SAAS,EACTC,MAAO,OACP6H,iBAAkB,CAAC,mBACnB5H,GAlCF,SAAcC,GACZ,IAAIC,EAAQD,EAAKC,MACbL,EAAOI,EAAKJ,KACZ0Q,EAAgBrQ,EAAMwG,MAAM7I,UAC5BoK,EAAa/H,EAAMwG,MAAM9I,OACzBkU,EAAmB5R,EAAMmG,cAAc6L,gBACvCC,EAAoBhF,GAAejN,EAAO,CAC5C0N,eAAgB,cAEdwE,EAAoBjF,GAAejN,EAAO,CAC5C4N,aAAa,IAEXuE,EAA2BR,GAAeM,EAAmB5B,GAC7D+B,EAAsBT,GAAeO,EAAmBnK,EAAY6J,GACpES,EAAoBR,GAAsBM,GAC1CG,EAAmBT,GAAsBO,GAC7CpS,EAAMmG,cAAcxG,GAAQ,CAC1BwS,yBAA0BA,EAC1BC,oBAAqBA,EACrBC,kBAAmBA,EACnBC,iBAAkBA,GAEpBtS,EAAMM,WAAW5C,OAASrB,OAAOkE,OAAO,CAAC,EAAGP,EAAMM,WAAW5C,OAAQ,CACnE,+BAAgC2U,EAChC,sBAAuBC,GAE3B,GCJA,IACE3S,KAAM,SACNC,SAAS,EACTC,MAAO,OACPwB,SAAU,CAAC,iBACXvB,GA5BF,SAAgBa,GACd,IAAIX,EAAQW,EAAMX,MACdc,EAAUH,EAAMG,QAChBnB,EAAOgB,EAAMhB,KACb4S,EAAkBzR,EAAQuG,OAC1BA,OAA6B,IAApBkL,EAA6B,CAAC,EAAG,GAAKA,EAC/C7I,EAAO,UAAkB,SAAU5L,EAAKC,GAE1C,OADAD,EAAIC,GA5BD,SAAiCA,EAAWyI,EAAOa,GACxD,IAAIjB,EAAgB9E,EAAiBvD,GACjCyU,EAAiB,CAACrV,EAAM,GAAKqH,QAAQ4B,IAAkB,GAAK,EAAI,EAEhErG,EAAyB,mBAAXsH,EAAwBA,EAAOhL,OAAOkE,OAAO,CAAC,EAAGiG,EAAO,CACxEzI,UAAWA,KACPsJ,EACFoL,EAAW1S,EAAK,GAChB2S,EAAW3S,EAAK,GAIpB,OAFA0S,EAAWA,GAAY,EACvBC,GAAYA,GAAY,GAAKF,EACtB,CAACrV,EAAMD,GAAOsH,QAAQ4B,IAAkB,EAAI,CACjD7C,EAAGmP,EACHjP,EAAGgP,GACD,CACFlP,EAAGkP,EACHhP,EAAGiP,EAEP,CASqBC,CAAwB5U,EAAWiC,EAAMwG,MAAOa,GAC1DvJ,CACT,GAAG,CAAC,GACA8U,EAAwBlJ,EAAK1J,EAAMjC,WACnCwF,EAAIqP,EAAsBrP,EAC1BE,EAAImP,EAAsBnP,EAEW,MAArCzD,EAAMmG,cAAcD,gBACtBlG,EAAMmG,cAAcD,cAAc3C,GAAKA,EACvCvD,EAAMmG,cAAcD,cAAczC,GAAKA,GAGzCzD,EAAMmG,cAAcxG,GAAQ+J,CAC9B,GC1BA,IACE/J,KAAM,gBACNC,SAAS,EACTC,MAAO,OACPC,GApBF,SAAuBC,GACrB,IAAIC,EAAQD,EAAKC,MACbL,EAAOI,EAAKJ,KAKhBK,EAAMmG,cAAcxG,GAAQkN,GAAe,CACzClP,UAAWqC,EAAMwG,MAAM7I,UACvBiB,QAASoB,EAAMwG,MAAM9I,OACrBqD,SAAU,WACVhD,UAAWiC,EAAMjC,WAErB,EAQE2L,KAAM,CAAC,GCgHT,IACE/J,KAAM,kBACNC,SAAS,EACTC,MAAO,OACPC,GA/HF,SAAyBC,GACvB,IAAIC,EAAQD,EAAKC,MACbc,EAAUf,EAAKe,QACfnB,EAAOI,EAAKJ,KACZoP,EAAoBjO,EAAQkM,SAC5BgC,OAAsC,IAAtBD,GAAsCA,EACtDE,EAAmBnO,EAAQoO,QAC3BC,OAAoC,IAArBF,GAAsCA,EACrD3B,EAAWxM,EAAQwM,SACnBE,EAAe1M,EAAQ0M,aACvBI,EAAc9M,EAAQ8M,YACtBrH,EAAUzF,EAAQyF,QAClBsM,EAAkB/R,EAAQgS,OAC1BA,OAA6B,IAApBD,GAAoCA,EAC7CE,EAAwBjS,EAAQkS,aAChCA,OAAyC,IAA1BD,EAAmC,EAAIA,EACtD5H,EAAW8B,GAAejN,EAAO,CACnCsN,SAAUA,EACVE,aAAcA,EACdjH,QAASA,EACTqH,YAAaA,IAEXxH,EAAgB9E,EAAiBtB,EAAMjC,WACvCiK,EAAYL,EAAa3H,EAAMjC,WAC/BkV,GAAmBjL,EACnBgF,EAAWtH,EAAyBU,GACpC8I,ECrCY,MDqCSlC,ECrCH,IAAM,IDsCxB9G,EAAgBlG,EAAMmG,cAAcD,cACpCmK,EAAgBrQ,EAAMwG,MAAM7I,UAC5BoK,EAAa/H,EAAMwG,MAAM9I,OACzBwV,EAA4C,mBAAjBF,EAA8BA,EAAa3W,OAAOkE,OAAO,CAAC,EAAGP,EAAMwG,MAAO,CACvGzI,UAAWiC,EAAMjC,aACbiV,EACFG,EAA2D,iBAAtBD,EAAiC,CACxElG,SAAUkG,EACVhE,QAASgE,GACP7W,OAAOkE,OAAO,CAChByM,SAAU,EACVkC,QAAS,GACRgE,GACCE,EAAsBpT,EAAMmG,cAAckB,OAASrH,EAAMmG,cAAckB,OAAOrH,EAAMjC,WAAa,KACjG2L,EAAO,CACTnG,EAAG,EACHE,EAAG,GAGL,GAAKyC,EAAL,CAIA,GAAI8I,EAAe,CACjB,IAAIqE,EAEAC,EAAwB,MAAbtG,EAAmB,EAAM7P,EACpCoW,EAAuB,MAAbvG,EAAmB/P,EAASC,EACtCoJ,EAAmB,MAAb0G,EAAmB,SAAW,QACpC3F,EAASnB,EAAc8G,GACvBtL,EAAM2F,EAAS8D,EAASmI,GACxB7R,EAAM4F,EAAS8D,EAASoI,GACxBC,EAAWV,GAAU/K,EAAWzB,GAAO,EAAI,EAC3CmN,EAASzL,IAAc1K,EAAQ+S,EAAc/J,GAAOyB,EAAWzB,GAC/DoN,EAAS1L,IAAc1K,GAASyK,EAAWzB,IAAQ+J,EAAc/J,GAGjEL,EAAejG,EAAME,SAASgB,MAC9BwF,EAAYoM,GAAU7M,EAAetC,EAAcsC,GAAgB,CACrE/C,MAAO,EACPE,OAAQ,GAENuQ,GAAqB3T,EAAMmG,cAAc,oBAAsBnG,EAAMmG,cAAc,oBAAoBI,QxBhFtG,CACLvF,IAAK,EACL9D,MAAO,EACPD,OAAQ,EACRE,KAAM,GwB6EFyW,GAAkBD,GAAmBL,GACrCO,GAAkBF,GAAmBJ,GAMrCO,GAAWnO,EAAO,EAAG0K,EAAc/J,GAAMI,EAAUJ,IACnDyN,GAAYd,EAAkB5C,EAAc/J,GAAO,EAAIkN,EAAWM,GAAWF,GAAkBT,EAA4BnG,SAAWyG,EAASK,GAAWF,GAAkBT,EAA4BnG,SACxMgH,GAAYf,GAAmB5C,EAAc/J,GAAO,EAAIkN,EAAWM,GAAWD,GAAkBV,EAA4BnG,SAAW0G,EAASI,GAAWD,GAAkBV,EAA4BnG,SACzMjG,GAAoB/G,EAAME,SAASgB,OAAS8D,EAAgBhF,EAAME,SAASgB,OAC3E+S,GAAelN,GAAiC,MAAbiG,EAAmBjG,GAAkBsF,WAAa,EAAItF,GAAkBuF,YAAc,EAAI,EAC7H4H,GAAwH,OAAjGb,EAA+C,MAAvBD,OAA8B,EAASA,EAAoBpG,IAAqBqG,EAAwB,EAEvJc,GAAY9M,EAAS2M,GAAYE,GACjCE,GAAkBzO,EAAOmN,EAAS,EAAQpR,EAF9B2F,EAAS0M,GAAYG,GAAsBD,IAEKvS,EAAK2F,EAAQyL,EAAS,EAAQrR,EAAK0S,IAAa1S,GAChHyE,EAAc8G,GAAYoH,GAC1B1K,EAAKsD,GAAYoH,GAAkB/M,CACrC,CAEA,GAAI8H,EAAc,CAChB,IAAIkF,GAEAC,GAAyB,MAAbtH,EAAmB,EAAM7P,EAErCoX,GAAwB,MAAbvH,EAAmB/P,EAASC,EAEvCsX,GAAUtO,EAAcgJ,GAExBuF,GAAmB,MAAZvF,EAAkB,SAAW,QAEpCwF,GAAOF,GAAUrJ,EAASmJ,IAE1BK,GAAOH,GAAUrJ,EAASoJ,IAE1BK,IAAuD,IAAxC,CAAC,EAAKzX,GAAMqH,QAAQ4B,GAEnCyO,GAAyH,OAAjGR,GAAgD,MAAvBjB,OAA8B,EAASA,EAAoBlE,IAAoBmF,GAAyB,EAEzJS,GAAaF,GAAeF,GAAOF,GAAUnE,EAAcoE,IAAQ1M,EAAW0M,IAAQI,GAAuB1B,EAA4BjE,QAEzI6F,GAAaH,GAAeJ,GAAUnE,EAAcoE,IAAQ1M,EAAW0M,IAAQI,GAAuB1B,EAA4BjE,QAAUyF,GAE5IK,GAAmBlC,GAAU8B,G1BzH9B,SAAwBlT,EAAK1E,EAAOyE,GACzC,IAAIwT,EAAItP,EAAOjE,EAAK1E,EAAOyE,GAC3B,OAAOwT,EAAIxT,EAAMA,EAAMwT,CACzB,C0BsHoDC,CAAeJ,GAAYN,GAASO,IAAcpP,EAAOmN,EAASgC,GAAaJ,GAAMF,GAAS1B,EAASiC,GAAaJ,IAEpKzO,EAAcgJ,GAAW8F,GACzBtL,EAAKwF,GAAW8F,GAAmBR,EACrC,CAEAxU,EAAMmG,cAAcxG,GAAQ+J,CAvE5B,CAwEF,EAQEhC,iBAAkB,CAAC,WE1HN,SAASyN,GAAiBC,EAAyBrQ,EAAcsD,QAC9D,IAAZA,IACFA,GAAU,GAGZ,ICnBoCrJ,ECJOJ,EFuBvCyW,EAA0B9V,EAAcwF,GACxCuQ,EAAuB/V,EAAcwF,IAf3C,SAAyBnG,GACvB,IAAImN,EAAOnN,EAAQ+D,wBACfI,EAASpB,EAAMoK,EAAK7I,OAAStE,EAAQqE,aAAe,EACpDD,EAASrB,EAAMoK,EAAK3I,QAAUxE,EAAQuE,cAAgB,EAC1D,OAAkB,IAAXJ,GAA2B,IAAXC,CACzB,CAU4DuS,CAAgBxQ,GACtEJ,EAAkBF,EAAmBM,GACrCgH,EAAOpJ,EAAsByS,EAAyBE,EAAsBjN,GAC5EyB,EAAS,CACXc,WAAY,EACZE,UAAW,GAET7C,EAAU,CACZ1E,EAAG,EACHE,EAAG,GAkBL,OAfI4R,IAA4BA,IAA4BhN,MACxB,SAA9B1J,EAAYoG,IAChBkG,GAAetG,MACbmF,GCnCgC9K,EDmCT+F,KClCdhG,EAAUC,IAAUO,EAAcP,GCJxC,CACL4L,YAFyChM,EDQbI,GCNR4L,WACpBE,UAAWlM,EAAQkM,WDGZH,GAAgB3L,IDoCnBO,EAAcwF,KAChBkD,EAAUtF,EAAsBoC,GAAc,IACtCxB,GAAKwB,EAAauH,WAC1BrE,EAAQxE,GAAKsB,EAAasH,WACjB1H,IACTsD,EAAQ1E,EAAIyH,GAAoBrG,KAI7B,CACLpB,EAAGwI,EAAK5O,KAAO2M,EAAOc,WAAa3C,EAAQ1E,EAC3CE,EAAGsI,EAAK/K,IAAM8I,EAAOgB,UAAY7C,EAAQxE,EACzCP,MAAO6I,EAAK7I,MACZE,OAAQ2I,EAAK3I,OAEjB,CGvDA,SAASoS,GAAMC,GACb,IAAItT,EAAM,IAAIoO,IACVmF,EAAU,IAAIC,IACdC,EAAS,GAKb,SAAS3F,EAAK4F,GACZH,EAAQI,IAAID,EAASlW,MACN,GAAG3B,OAAO6X,EAASxU,UAAY,GAAIwU,EAASnO,kBAAoB,IACtEvH,SAAQ,SAAU4V,GACzB,IAAKL,EAAQM,IAAID,GAAM,CACrB,IAAIE,EAAc9T,EAAI3F,IAAIuZ,GAEtBE,GACFhG,EAAKgG,EAET,CACF,IACAL,EAAO3E,KAAK4E,EACd,CAQA,OAzBAJ,EAAUtV,SAAQ,SAAU0V,GAC1B1T,EAAIiP,IAAIyE,EAASlW,KAAMkW,EACzB,IAiBAJ,EAAUtV,SAAQ,SAAU0V,GACrBH,EAAQM,IAAIH,EAASlW,OAExBsQ,EAAK4F,EAET,IACOD,CACT,CClBA,IAEIM,GAAkB,CACpBnY,UAAW,SACX0X,UAAW,GACX1U,SAAU,YAGZ,SAASoV,KACP,IAAK,IAAI1B,EAAO2B,UAAUrG,OAAQsG,EAAO,IAAIpU,MAAMwS,GAAO6B,EAAO,EAAGA,EAAO7B,EAAM6B,IAC/ED,EAAKC,GAAQF,UAAUE,GAGzB,OAAQD,EAAKvE,MAAK,SAAUlT,GAC1B,QAASA,GAAoD,mBAAlCA,EAAQ+D,sBACrC,GACF,CAEO,SAAS4T,GAAgBC,QACL,IAArBA,IACFA,EAAmB,CAAC,GAGtB,IAAIC,EAAoBD,EACpBE,EAAwBD,EAAkBE,iBAC1CA,OAA6C,IAA1BD,EAAmC,GAAKA,EAC3DE,EAAyBH,EAAkBI,eAC3CA,OAA4C,IAA3BD,EAAoCV,GAAkBU,EAC3E,OAAO,SAAsBjZ,EAAWD,EAAQoD,QAC9B,IAAZA,IACFA,EAAU+V,GAGZ,IC/C6B/W,EAC3BgX,ED8CE9W,EAAQ,CACVjC,UAAW,SACXgZ,iBAAkB,GAClBjW,QAASzE,OAAOkE,OAAO,CAAC,EAAG2V,GAAiBW,GAC5C1Q,cAAe,CAAC,EAChBjG,SAAU,CACRvC,UAAWA,EACXD,OAAQA,GAEV4C,WAAY,CAAC,EACbD,OAAQ,CAAC,GAEP2W,EAAmB,GACnBC,GAAc,EACdrN,EAAW,CACb5J,MAAOA,EACPkX,WAAY,SAAoBC,GAC9B,IAAIrW,EAAsC,mBAArBqW,EAAkCA,EAAiBnX,EAAMc,SAAWqW,EACzFC,IACApX,EAAMc,QAAUzE,OAAOkE,OAAO,CAAC,EAAGsW,EAAgB7W,EAAMc,QAASA,GACjEd,EAAMiK,cAAgB,CACpBtM,UAAW0B,EAAU1B,GAAa6N,GAAkB7N,GAAaA,EAAU4Q,eAAiB/C,GAAkB7N,EAAU4Q,gBAAkB,GAC1I7Q,OAAQ8N,GAAkB9N,IAI5B,IEzE4B+X,EAC9B4B,EFwEMN,EDvCG,SAAwBtB,GAErC,IAAIsB,EAAmBvB,GAAMC,GAE7B,OAAO/W,EAAeb,QAAO,SAAUC,EAAK+B,GAC1C,OAAO/B,EAAIE,OAAO+Y,EAAiBvR,QAAO,SAAUqQ,GAClD,OAAOA,EAAShW,QAAUA,CAC5B,IACF,GAAG,GACL,CC8B+ByX,EEzEK7B,EFyEsB,GAAGzX,OAAO2Y,EAAkB3W,EAAMc,QAAQ2U,WExE9F4B,EAAS5B,EAAU5X,QAAO,SAAUwZ,EAAQE,GAC9C,IAAIC,EAAWH,EAAOE,EAAQ5X,MAK9B,OAJA0X,EAAOE,EAAQ5X,MAAQ6X,EAAWnb,OAAOkE,OAAO,CAAC,EAAGiX,EAAUD,EAAS,CACrEzW,QAASzE,OAAOkE,OAAO,CAAC,EAAGiX,EAAS1W,QAASyW,EAAQzW,SACrD4I,KAAMrN,OAAOkE,OAAO,CAAC,EAAGiX,EAAS9N,KAAM6N,EAAQ7N,QAC5C6N,EACEF,CACT,GAAG,CAAC,GAEGhb,OAAO4D,KAAKoX,GAAQlV,KAAI,SAAUhG,GACvC,OAAOkb,EAAOlb,EAChB,MFsGM,OAvCA6D,EAAM+W,iBAAmBA,EAAiBvR,QAAO,SAAUiS,GACzD,OAAOA,EAAE7X,OACX,IAoJFI,EAAM+W,iBAAiB5W,SAAQ,SAAUqI,GACvC,IAAI7I,EAAO6I,EAAM7I,KACb+X,EAAgBlP,EAAM1H,QACtBA,OAA4B,IAAlB4W,EAA2B,CAAC,EAAIA,EAC1ChX,EAAS8H,EAAM9H,OAEnB,GAAsB,mBAAXA,EAAuB,CAChC,IAAIiX,EAAYjX,EAAO,CACrBV,MAAOA,EACPL,KAAMA,EACNiK,SAAUA,EACV9I,QAASA,IAKXkW,EAAiB/F,KAAK0G,GAFT,WAAmB,EAGlC,CACF,IAjIS/N,EAASQ,QAClB,EAMAwN,YAAa,WACX,IAAIX,EAAJ,CAIA,IAAIY,EAAkB7X,EAAME,SACxBvC,EAAYka,EAAgBla,UAC5BD,EAASma,EAAgBna,OAG7B,GAAKyY,GAAiBxY,EAAWD,GAAjC,CASAsC,EAAMwG,MAAQ,CACZ7I,UAAWwX,GAAiBxX,EAAWqH,EAAgBtH,GAAoC,UAA3BsC,EAAMc,QAAQC,UAC9ErD,OAAQiG,EAAcjG,IAOxBsC,EAAM0R,OAAQ,EACd1R,EAAMjC,UAAYiC,EAAMc,QAAQ/C,UAKhCiC,EAAM+W,iBAAiB5W,SAAQ,SAAU0V,GACvC,OAAO7V,EAAMmG,cAAc0P,EAASlW,MAAQtD,OAAOkE,OAAO,CAAC,EAAGsV,EAASnM,KACzE,IAGA,IAFA,IAESoO,EAAQ,EAAGA,EAAQ9X,EAAM+W,iBAAiBhH,OAAQ+H,IAUzD,IAAoB,IAAhB9X,EAAM0R,MAAV,CAMA,IAAIqG,EAAwB/X,EAAM+W,iBAAiBe,GAC/ChY,EAAKiY,EAAsBjY,GAC3BkY,EAAyBD,EAAsBjX,QAC/CoM,OAAsC,IAA3B8K,EAAoC,CAAC,EAAIA,EACpDrY,EAAOoY,EAAsBpY,KAEf,mBAAPG,IACTE,EAAQF,EAAG,CACTE,MAAOA,EACPc,QAASoM,EACTvN,KAAMA,EACNiK,SAAUA,KACN5J,EAdR,MAHEA,EAAM0R,OAAQ,EACdoG,GAAS,CAnCb,CAbA,CAmEF,EAGA1N,QClM2BtK,EDkMV,WACf,OAAO,IAAImY,SAAQ,SAAUC,GAC3BtO,EAASgO,cACTM,EAAQlY,EACV,GACF,ECrMG,WAUL,OATK8W,IACHA,EAAU,IAAImB,SAAQ,SAAUC,GAC9BD,QAAQC,UAAUC,MAAK,WACrBrB,OAAUsB,EACVF,EAAQpY,IACV,GACF,KAGKgX,CACT,GD2LIuB,QAAS,WACPjB,IACAH,GAAc,CAChB,GAGF,IAAKd,GAAiBxY,EAAWD,GAK/B,OAAOkM,EAmCT,SAASwN,IACPJ,EAAiB7W,SAAQ,SAAUL,GACjC,OAAOA,GACT,IACAkX,EAAmB,EACrB,CAEA,OAvCApN,EAASsN,WAAWpW,GAASqX,MAAK,SAAUnY,IACrCiX,GAAenW,EAAQwX,eAC1BxX,EAAQwX,cAActY,EAE1B,IAmCO4J,CACT,CACF,CACO,IAAI2O,GAA4BhC,KGrPnC,GAA4BA,GAAgB,CAC9CI,iBAFqB,CAAC6B,GAAgB,GAAe,GAAe,EAAa,GAAQ,GAAM,GAAiB,EAAO,MCJrH,GAA4BjC,GAAgB,CAC9CI,iBAFqB,CAAC6B,GAAgB,GAAe,GAAe,KCQtE,MAEMC,GAAiB,gBAsBjBC,GAAc9Z,IAClB,IAAI+Z,EAAW/Z,EAAQga,aAAa,kBAEpC,IAAKD,GAAyB,MAAbA,EAAkB,CACjC,IAAIE,EAAgBja,EAAQga,aAAa,QAKzC,IAAKC,IAAkBA,EAAcC,SAAS,OAASD,EAAcE,WAAW,KAC9E,OAAO,KAILF,EAAcC,SAAS,OAASD,EAAcE,WAAW,OAC3DF,EAAgB,IAAIA,EAActX,MAAM,KAAK,MAG/CoX,EAAWE,GAAmC,MAAlBA,EAAwBA,EAAcG,OAAS,IAC7E,CAEA,OAAOL,CAAQ,EAGXM,GAAyBra,IAC7B,MAAM+Z,EAAWD,GAAY9Z,GAE7B,OAAI+Z,GACKjU,SAAS+C,cAAckR,GAAYA,EAGrC,IAAI,EAGPO,GAAyBta,IAC7B,MAAM+Z,EAAWD,GAAY9Z,GAC7B,OAAO+Z,EAAWjU,SAAS+C,cAAckR,GAAY,IAAI,EA0BrDQ,GAAuBva,IAC3BA,EAAQwa,cAAc,IAAIC,MAAMZ,IAAgB,EAG5C,GAAYa,MACXA,GAA4B,iBAAXA,UAIO,IAAlBA,EAAOC,SAChBD,EAASA,EAAO,SAGgB,IAApBA,EAAOE,UAGjBC,GAAaH,GAEb,GAAUA,GACLA,EAAOC,OAASD,EAAO,GAAKA,EAGf,iBAAXA,GAAuBA,EAAOvJ,OAAS,EACzCrL,SAAS+C,cAAc6R,GAGzB,KAGHI,GAAY9a,IAChB,IAAK,GAAUA,IAAgD,IAApCA,EAAQ+a,iBAAiB5J,OAClD,OAAO,EAGT,MAAM6J,EAAgF,YAA7DtV,iBAAiB1F,GAASib,iBAAiB,cAE9DC,EAAgBlb,EAAQmb,QAAQ,uBAEtC,IAAKD,EACH,OAAOF,EAGT,GAAIE,IAAkBlb,EAAS,CAC7B,MAAMob,EAAUpb,EAAQmb,QAAQ,WAEhC,GAAIC,GAAWA,EAAQ5V,aAAe0V,EACpC,OAAO,EAGT,GAAgB,OAAZE,EACF,OAAO,CAEX,CAEA,OAAOJ,CAAgB,EAGnBK,GAAarb,IACZA,GAAWA,EAAQ4a,WAAaU,KAAKC,gBAItCvb,EAAQwb,UAAUvW,SAAS,mBAIC,IAArBjF,EAAQyb,SACVzb,EAAQyb,SAGVzb,EAAQ0b,aAAa,aAAoD,UAArC1b,EAAQga,aAAa,aAG5D2B,GAAiB3b,IACrB,IAAK8F,SAASC,gBAAgB6V,aAC5B,OAAO,KAIT,GAAmC,mBAAxB5b,EAAQqF,YAA4B,CAC7C,MAAMwW,EAAO7b,EAAQqF,cACrB,OAAOwW,aAAgB/a,WAAa+a,EAAO,IAC7C,CAEA,OAAI7b,aAAmBc,WACdd,EAIJA,EAAQwF,WAINmW,GAAe3b,EAAQwF,YAHrB,IAGgC,EAGrCsW,GAAO,OAWPC,GAAS/b,IACbA,EAAQuE,YAAY,EAGhByX,GAAY,IACZ3b,OAAO4b,SAAWnW,SAAS6G,KAAK+O,aAAa,qBACxCrb,OAAO4b,OAGT,KAGHC,GAA4B,GAmB5BC,GAAQ,IAAuC,QAAjCrW,SAASC,gBAAgBqW,IAEvCC,GAAqBC,IAnBAC,QAoBN,KACjB,MAAMC,EAAIR,KAGV,GAAIQ,EAAG,CACL,MAAMzb,EAAOub,EAAOG,KACdC,EAAqBF,EAAEtb,GAAGH,GAChCyb,EAAEtb,GAAGH,GAAQub,EAAOK,gBACpBH,EAAEtb,GAAGH,GAAM6b,YAAcN,EAEzBE,EAAEtb,GAAGH,GAAM8b,WAAa,KACtBL,EAAEtb,GAAGH,GAAQ2b,EACNJ,EAAOK,gBAElB,GAjC0B,YAAxB7W,SAASgX,YAENZ,GAA0B/K,QAC7BrL,SAASyF,iBAAiB,oBAAoB,KAC5C,IAAK,MAAMgR,KAAYL,GACrBK,GACF,IAIJL,GAA0B7J,KAAKkK,IAE/BA,GAsBA,EAGEQ,GAAUR,IACU,mBAAbA,GACTA,GACF,EAGIS,GAAyB,CAACT,EAAUU,EAAmBC,GAAoB,KAC/E,IAAKA,EAEH,YADAH,GAAQR,GAIV,MACMY,EAnMiCnd,KACvC,IAAKA,EACH,OAAO,EAIT,IAAI,mBACFod,EAAkB,gBAClBC,GACEhd,OAAOqF,iBAAiB1F,GAC5B,MAAMsd,EAA0BC,OAAOC,WAAWJ,GAC5CK,EAAuBF,OAAOC,WAAWH,GAE/C,OAAKC,GAA4BG,GAKjCL,EAAqBA,EAAmBza,MAAM,KAAK,GACnD0a,EAAkBA,EAAgB1a,MAAM,KAAK,GAjFf,KAkFtB4a,OAAOC,WAAWJ,GAAsBG,OAAOC,WAAWH,KANzD,CAMoG,EA+KpFK,CAAiCT,GADlC,EAExB,IAAIU,GAAS,EAEb,MAAMC,EAAU,EACd5Q,aAEIA,IAAWiQ,IAIfU,GAAS,EACTV,EAAkBxR,oBAAoBoO,GAAgB+D,GACtDb,GAAQR,GAAS,EAGnBU,EAAkB1R,iBAAiBsO,GAAgB+D,GACnDC,YAAW,KACJF,GACHpD,GAAqB0C,EACvB,GACCE,EAAiB,EAahBW,GAAuB,CAACjR,EAAMkR,EAAeC,EAAeC,KAChE,MAAMC,EAAarR,EAAKsE,OACxB,IAAI+H,EAAQrM,EAAKjH,QAAQmY,GAGzB,OAAe,IAAX7E,GACM8E,GAAiBC,EAAiBpR,EAAKqR,EAAa,GAAKrR,EAAK,IAGxEqM,GAAS8E,EAAgB,GAAK,EAE1BC,IACF/E,GAASA,EAAQgF,GAAcA,GAG1BrR,EAAKjK,KAAKC,IAAI,EAAGD,KAAKE,IAAIoW,EAAOgF,EAAa,KAAI,EAarDC,GAAiB,qBACjBC,GAAiB,OACjBC,GAAgB,SAChBC,GAAgB,CAAC,EAEvB,IAAIC,GAAW,EACf,MAAMC,GAAe,CACnBC,WAAY,YACZC,WAAY,YAERC,GAAe,IAAI5H,IAAI,CAAC,QAAS,WAAY,UAAW,YAAa,cAAe,aAAc,iBAAkB,YAAa,WAAY,YAAa,cAAe,YAAa,UAAW,WAAY,QAAS,oBAAqB,aAAc,YAAa,WAAY,cAAe,cAAe,cAAe,YAAa,eAAgB,gBAAiB,eAAgB,gBAAiB,aAAc,QAAS,OAAQ,SAAU,QAAS,SAAU,SAAU,UAAW,WAAY,OAAQ,SAAU,eAAgB,SAAU,OAAQ,mBAAoB,mBAAoB,QAAS,QAAS,WAK/lB,SAAS6H,GAAa5e,EAAS6e,GAC7B,OAAOA,GAAO,GAAGA,MAAQN,QAAgBve,EAAQue,UAAYA,IAC/D,CAEA,SAASO,GAAiB9e,GACxB,MAAM6e,EAAMD,GAAa5e,GAGzB,OAFAA,EAAQue,SAAWM,EACnBP,GAAcO,GAAOP,GAAcO,IAAQ,CAAC,EACrCP,GAAcO,EACvB,CA0CA,SAASE,GAAYC,EAAQC,EAAUC,EAAqB,MAC1D,OAAOzhB,OAAO0hB,OAAOH,GAAQpM,MAAKwM,GAASA,EAAMH,WAAaA,GAAYG,EAAMF,qBAAuBA,GACzG,CAEA,SAASG,GAAoBC,EAAmB1B,EAAS2B,GACvD,MAAMC,EAAiC,iBAAZ5B,EAErBqB,EAAWO,EAAcD,EAAqB3B,GAAW2B,EAC/D,IAAIE,EAAYC,GAAaJ,GAM7B,OAJKX,GAAavH,IAAIqI,KACpBA,EAAYH,GAGP,CAACE,EAAaP,EAAUQ,EACjC,CAEA,SAASE,GAAW3f,EAASsf,EAAmB1B,EAAS2B,EAAoBK,GAC3E,GAAiC,iBAAtBN,IAAmCtf,EAC5C,OAGF,IAAKwf,EAAaP,EAAUQ,GAAaJ,GAAoBC,EAAmB1B,EAAS2B,GAGzF,GAAID,KAAqBd,GAAc,CACrC,MAAMqB,EAAe3e,GACZ,SAAUke,GACf,IAAKA,EAAMU,eAAiBV,EAAMU,gBAAkBV,EAAMW,iBAAmBX,EAAMW,eAAe9a,SAASma,EAAMU,eAC/G,OAAO5e,EAAGjD,KAAK+hB,KAAMZ,EAEzB,EAGFH,EAAWY,EAAaZ,EAC1B,CAEA,MAAMD,EAASF,GAAiB9e,GAC1BigB,EAAWjB,EAAOS,KAAeT,EAAOS,GAAa,CAAC,GACtDS,EAAmBnB,GAAYkB,EAAUhB,EAAUO,EAAc5B,EAAU,MAEjF,GAAIsC,EAEF,YADAA,EAAiBN,OAASM,EAAiBN,QAAUA,GAIvD,MAAMf,EAAMD,GAAaK,EAAUK,EAAkB1T,QAAQuS,GAAgB,KACvEjd,EAAKse,EAzEb,SAAoCxf,EAAS+Z,EAAU7Y,GACrD,OAAO,SAAS0c,EAAQwB,GACtB,MAAMe,EAAcngB,EAAQogB,iBAAiBrG,GAE7C,IAAK,IAAI,OACP/M,GACEoS,EAAOpS,GAAUA,IAAWgT,KAAMhT,EAASA,EAAOxH,WACpD,IAAK,MAAM6a,KAAcF,EACvB,GAAIE,IAAerT,EAYnB,OARAsT,GAAWlB,EAAO,CAChBW,eAAgB/S,IAGd4Q,EAAQgC,QACVW,GAAaC,IAAIxgB,EAASof,EAAMqB,KAAM1G,EAAU7Y,GAG3CA,EAAGwf,MAAM1T,EAAQ,CAACoS,GAG/B,CACF,CAiD2BuB,CAA2B3gB,EAAS4d,EAASqB,GAvFxE,SAA0Bjf,EAASkB,GACjC,OAAO,SAAS0c,EAAQwB,GAStB,OARAkB,GAAWlB,EAAO,CAChBW,eAAgB/f,IAGd4d,EAAQgC,QACVW,GAAaC,IAAIxgB,EAASof,EAAMqB,KAAMvf,GAGjCA,EAAGwf,MAAM1gB,EAAS,CAACof,GAC5B,CACF,CA2EoFwB,CAAiB5gB,EAASif,GAC5G/d,EAAGge,mBAAqBM,EAAc5B,EAAU,KAChD1c,EAAG+d,SAAWA,EACd/d,EAAG0e,OAASA,EACZ1e,EAAGqd,SAAWM,EACdoB,EAASpB,GAAO3d,EAChBlB,EAAQuL,iBAAiBkU,EAAWve,EAAIse,EAC1C,CAEA,SAASqB,GAAc7gB,EAASgf,EAAQS,EAAW7B,EAASsB,GAC1D,MAAMhe,EAAK6d,GAAYC,EAAOS,GAAY7B,EAASsB,GAE9Che,IAILlB,EAAQyL,oBAAoBgU,EAAWve,EAAI4f,QAAQ5B,WAC5CF,EAAOS,GAAWve,EAAGqd,UAC9B,CAEA,SAASwC,GAAyB/gB,EAASgf,EAAQS,EAAWuB,GAC5D,MAAMC,EAAoBjC,EAAOS,IAAc,CAAC,EAEhD,IAAK,MAAMyB,KAAczjB,OAAO4D,KAAK4f,GACnC,GAAIC,EAAWhH,SAAS8G,GAAY,CAClC,MAAM5B,EAAQ6B,EAAkBC,GAChCL,GAAc7gB,EAASgf,EAAQS,EAAWL,EAAMH,SAAUG,EAAMF,mBAClE,CAEJ,CAEA,SAASQ,GAAaN,GAGpB,OADAA,EAAQA,EAAMxT,QAAQwS,GAAgB,IAC/BI,GAAaY,IAAUA,CAChC,CAEA,MAAMmB,GAAe,CACnBY,GAAGnhB,EAASof,EAAOxB,EAAS2B,GAC1BI,GAAW3f,EAASof,EAAOxB,EAAS2B,GAAoB,EAC1D,EAEA6B,IAAIphB,EAASof,EAAOxB,EAAS2B,GAC3BI,GAAW3f,EAASof,EAAOxB,EAAS2B,GAAoB,EAC1D,EAEAiB,IAAIxgB,EAASsf,EAAmB1B,EAAS2B,GACvC,GAAiC,iBAAtBD,IAAmCtf,EAC5C,OAGF,MAAOwf,EAAaP,EAAUQ,GAAaJ,GAAoBC,EAAmB1B,EAAS2B,GACrF8B,EAAc5B,IAAcH,EAC5BN,EAASF,GAAiB9e,GAC1BihB,EAAoBjC,EAAOS,IAAc,CAAC,EAC1C6B,EAAchC,EAAkBnF,WAAW,KAEjD,QAAwB,IAAb8E,EAAX,CAUA,GAAIqC,EACF,IAAK,MAAMC,KAAgB9jB,OAAO4D,KAAK2d,GACrC+B,GAAyB/gB,EAASgf,EAAQuC,EAAcjC,EAAkBzM,MAAM,IAIpF,IAAK,MAAM2O,KAAe/jB,OAAO4D,KAAK4f,GAAoB,CACxD,MAAMC,EAAaM,EAAY5V,QAAQyS,GAAe,IAEtD,IAAKgD,GAAe/B,EAAkBpF,SAASgH,GAAa,CAC1D,MAAM9B,EAAQ6B,EAAkBO,GAChCX,GAAc7gB,EAASgf,EAAQS,EAAWL,EAAMH,SAAUG,EAAMF,mBAClE,CACF,CAfA,KARA,CAEE,IAAKzhB,OAAO4D,KAAK4f,GAAmB9P,OAClC,OAGF0P,GAAc7gB,EAASgf,EAAQS,EAAWR,EAAUO,EAAc5B,EAAU,KAE9E,CAgBF,EAEA6D,QAAQzhB,EAASof,EAAO3H,GACtB,GAAqB,iBAAV2H,IAAuBpf,EAChC,OAAO,KAGT,MAAMwc,EAAIR,KAGV,IAAI0F,EAAc,KACdC,GAAU,EACVC,GAAiB,EACjBC,GAAmB,EAJHzC,IADFM,GAAaN,IAOZ5C,IACjBkF,EAAclF,EAAE/B,MAAM2E,EAAO3H,GAC7B+E,EAAExc,GAASyhB,QAAQC,GACnBC,GAAWD,EAAYI,uBACvBF,GAAkBF,EAAYK,gCAC9BF,EAAmBH,EAAYM,sBAGjC,IAAIC,EAAM,IAAIxH,MAAM2E,EAAO,CACzBuC,UACAO,YAAY,IAgBd,OAdAD,EAAM3B,GAAW2B,EAAKxK,GAElBoK,GACFI,EAAIE,iBAGFP,GACF5hB,EAAQwa,cAAcyH,GAGpBA,EAAIJ,kBAAoBH,GAC1BA,EAAYS,iBAGPF,CACT,GAIF,SAAS3B,GAAWziB,EAAKukB,GACvB,IAAK,MAAO7kB,EAAKa,KAAUX,OAAO4kB,QAAQD,GAAQ,CAAC,GACjD,IACEvkB,EAAIN,GAAOa,CACb,CAAE,MAAOkkB,GACP7kB,OAAOC,eAAeG,EAAKN,EAAK,CAC9BglB,cAAc,EAEd3kB,IAAG,IACMQ,GAIb,CAGF,OAAOP,CACT,CAYA,MAAM2kB,GAAa,IAAI7Q,IACjB8Q,GAAO,CACXjQ,IAAIxS,EAASzC,EAAKyN,GACXwX,GAAWpL,IAAIpX,IAClBwiB,GAAWhQ,IAAIxS,EAAS,IAAI2R,KAG9B,MAAM+Q,EAAcF,GAAW5kB,IAAIoC,GAG9B0iB,EAAYtL,IAAI7Z,IAA6B,IAArBmlB,EAAYC,KAMzCD,EAAYlQ,IAAIjV,EAAKyN,GAJnB4X,QAAQC,MAAM,+EAA+Exf,MAAMyf,KAAKJ,EAAYrhB,QAAQ,MAKhI,EAEAzD,IAAG,CAACoC,EAASzC,IACPilB,GAAWpL,IAAIpX,IACVwiB,GAAW5kB,IAAIoC,GAASpC,IAAIL,IAG9B,KAGTwlB,OAAO/iB,EAASzC,GACd,IAAKilB,GAAWpL,IAAIpX,GAClB,OAGF,MAAM0iB,EAAcF,GAAW5kB,IAAIoC,GACnC0iB,EAAYM,OAAOzlB,GAEM,IAArBmlB,EAAYC,MACdH,GAAWQ,OAAOhjB,EAEtB,GAUF,SAASijB,GAAc7kB,GACrB,GAAc,SAAVA,EACF,OAAO,EAGT,GAAc,UAAVA,EACF,OAAO,EAGT,GAAIA,IAAUmf,OAAOnf,GAAOkC,WAC1B,OAAOid,OAAOnf,GAGhB,GAAc,KAAVA,GAA0B,SAAVA,EAClB,OAAO,KAGT,GAAqB,iBAAVA,EACT,OAAOA,EAGT,IACE,OAAO8kB,KAAKC,MAAMC,mBAAmBhlB,GACvC,CAAE,MAAOkkB,GACP,OAAOlkB,CACT,CACF,CAEA,SAASilB,GAAiB9lB,GACxB,OAAOA,EAAIqO,QAAQ,UAAU0X,GAAO,IAAIA,EAAIpjB,iBAC9C,CAEA,MAAMqjB,GAAc,CAClBC,iBAAiBxjB,EAASzC,EAAKa,GAC7B4B,EAAQ6B,aAAa,WAAWwhB,GAAiB9lB,KAAQa,EAC3D,EAEAqlB,oBAAoBzjB,EAASzC,GAC3ByC,EAAQ4B,gBAAgB,WAAWyhB,GAAiB9lB,KACtD,EAEAmmB,kBAAkB1jB,GAChB,IAAKA,EACH,MAAO,CAAC,EAGV,MAAM0B,EAAa,CAAC,EACdiiB,EAASlmB,OAAO4D,KAAKrB,EAAQ4jB,SAAShd,QAAOrJ,GAAOA,EAAI4c,WAAW,QAAU5c,EAAI4c,WAAW,cAElG,IAAK,MAAM5c,KAAOomB,EAAQ,CACxB,IAAIE,EAAUtmB,EAAIqO,QAAQ,MAAO,IACjCiY,EAAUA,EAAQC,OAAO,GAAG5jB,cAAgB2jB,EAAQhR,MAAM,EAAGgR,EAAQ1S,QACrEzP,EAAWmiB,GAAWZ,GAAcjjB,EAAQ4jB,QAAQrmB,GACtD,CAEA,OAAOmE,CACT,EAEAqiB,iBAAgB,CAAC/jB,EAASzC,IACjB0lB,GAAcjjB,EAAQga,aAAa,WAAWqJ,GAAiB9lB,QAe1E,MAAMymB,GAEOC,qBACT,MAAO,CAAC,CACV,CAEWC,yBACT,MAAO,CAAC,CACV,CAEWzH,kBACT,MAAM,IAAI0H,MAAM,sEAClB,CAEAC,WAAWC,GAMT,OALAA,EAASrE,KAAKsE,gBAAgBD,GAC9BA,EAASrE,KAAKuE,kBAAkBF,GAEhCrE,KAAKwE,iBAAiBH,GAEfA,CACT,CAEAE,kBAAkBF,GAChB,OAAOA,CACT,CAEAC,gBAAgBD,EAAQrkB,GACtB,MAAMykB,EAAa,GAAUzkB,GAAWujB,GAAYQ,iBAAiB/jB,EAAS,UAAY,CAAC,EAE3F,MAAO,IAAKggB,KAAK0E,YAAYT,WACD,iBAAfQ,EAA0BA,EAAa,CAAC,KAC/C,GAAUzkB,GAAWujB,GAAYG,kBAAkB1jB,GAAW,CAAC,KAC7C,iBAAXqkB,EAAsBA,EAAS,CAAC,EAE/C,CAEAG,iBAAiBH,EAAQM,EAAc3E,KAAK0E,YAAYR,aACtD,IAAK,MAAM3hB,KAAY9E,OAAO4D,KAAKsjB,GAAc,CAC/C,MAAMC,EAAgBD,EAAYpiB,GAC5BnE,EAAQimB,EAAO9hB,GACfsiB,EAAY,GAAUzmB,GAAS,UA1uBrCsc,OADSA,EA2uB+Ctc,GAzuBnD,GAAGsc,IAGLjd,OAAOM,UAAUuC,SAASrC,KAAKyc,GAAQoK,MAAM,eAAe,GAAG5kB,cAwuBlE,IAAK,IAAI6kB,OAAOH,GAAe9gB,KAAK+gB,GAClC,MAAM,IAAIG,UAAU,GAAGhF,KAAK0E,YAAYjI,KAAKwI,0BAA0B1iB,qBAA4BsiB,yBAAiCD,MAExI,CAhvBWlK,KAivBb,EAmBF,MAAMwK,WAAsBlB,GAC1BU,YAAY1kB,EAASqkB,GACnBc,SACAnlB,EAAU6a,GAAW7a,MAMrBggB,KAAKoF,SAAWplB,EAChBggB,KAAKqF,QAAUrF,KAAKoE,WAAWC,GAC/B5B,GAAKjQ,IAAIwN,KAAKoF,SAAUpF,KAAK0E,YAAYY,SAAUtF,MACrD,CAGAuF,UACE9C,GAAKM,OAAO/C,KAAKoF,SAAUpF,KAAK0E,YAAYY,UAC5C/E,GAAaC,IAAIR,KAAKoF,SAAUpF,KAAK0E,YAAYc,WAEjD,IAAK,MAAMC,KAAgBhoB,OAAOioB,oBAAoB1F,MACpDA,KAAKyF,GAAgB,IAEzB,CAEAE,eAAepJ,EAAUvc,EAAS4lB,GAAa,GAC7C5I,GAAuBT,EAAUvc,EAAS4lB,EAC5C,CAEAxB,WAAWC,GAMT,OALAA,EAASrE,KAAKsE,gBAAgBD,EAAQrE,KAAKoF,UAC3Cf,EAASrE,KAAKuE,kBAAkBF,GAEhCrE,KAAKwE,iBAAiBH,GAEfA,CACT,CAGAwB,mBAAmB7lB,GACjB,OAAOyiB,GAAK7kB,IAAIid,GAAW7a,GAAUggB,KAAKsF,SAC5C,CAEAO,2BAA2B7lB,EAASqkB,EAAS,CAAC,GAC5C,OAAOrE,KAAK8F,YAAY9lB,IAAY,IAAIggB,KAAKhgB,EAA2B,iBAAXqkB,EAAsBA,EAAS,KAC9F,CAEW0B,qBACT,MApDY,OAqDd,CAEWT,sBACT,MAAO,MAAMtF,KAAKvD,MACpB,CAEW+I,uBACT,MAAO,IAAIxF,KAAKsF,UAClB,CAEAO,iBAAiB9kB,GACf,MAAO,GAAGA,IAAOif,KAAKwF,WACxB,EAWF,MAAMQ,GAAuB,CAACC,EAAWC,EAAS,UAChD,MAAMC,EAAa,gBAAgBF,EAAUT,YACvCzkB,EAAOklB,EAAUxJ,KACvB8D,GAAaY,GAAGrb,SAAUqgB,EAAY,qBAAqBplB,OAAU,SAAUqe,GAK7E,GAJI,CAAC,IAAK,QAAQlF,SAAS8F,KAAKoG,UAC9BhH,EAAM+C,iBAGJ9G,GAAW2E,MACb,OAGF,MAAMhT,EAASsN,GAAuB0F,OAASA,KAAK7E,QAAQ,IAAIpa,KAC/CklB,EAAUI,oBAAoBrZ,GAEtCkZ,IACX,GAAE,EAeEI,GAAc,YACdC,GAAc,QAAQD,KACtBE,GAAe,SAASF,KAO9B,MAAMG,WAAcvB,GAEPzI,kBACT,MAdW,OAeb,CAGAiK,QAGE,GAFmBnG,GAAakB,QAAQzB,KAAKoF,SAAUmB,IAExC1E,iBACb,OAGF7B,KAAKoF,SAAS5J,UAAUuH,OAnBF,QAqBtB,MAAM6C,EAAa5F,KAAKoF,SAAS5J,UAAUvW,SAtBrB,QAwBtB+a,KAAK2F,gBAAe,IAAM3F,KAAK2G,mBAAmB3G,KAAKoF,SAAUQ,EACnE,CAGAe,kBACE3G,KAAKoF,SAASrC,SAEdxC,GAAakB,QAAQzB,KAAKoF,SAAUoB,IACpCxG,KAAKuF,SACP,CAGAM,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAO2b,GAAMJ,oBAAoBrG,MAEvC,GAAsB,iBAAXqE,EAAX,CAIA,QAAqB7K,IAAjB1O,EAAKuZ,IAAyBA,EAAOlK,WAAW,MAAmB,gBAAXkK,EAC1D,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,GAAQrE,KANb,CAOF,GACF,EAQFgG,GAAqBS,GAAO,SAK5BpK,GAAmBoK,IAYnB,MAKMI,GAAyB,4BAM/B,MAAMC,WAAe5B,GAERzI,kBACT,MAdW,QAeb,CAGAsK,SAEE/G,KAAKoF,SAASvjB,aAAa,eAAgBme,KAAKoF,SAAS5J,UAAUuL,OAhB3C,UAiB1B,CAGAlB,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAOgc,GAAOT,oBAAoBrG,MAEzB,WAAXqE,GACFvZ,EAAKuZ,IAET,GACF,EAQF9D,GAAaY,GAAGrb,SAlCe,2BAkCmB+gB,IAAwBzH,IACxEA,EAAM+C,iBACN,MAAM6E,EAAS5H,EAAMpS,OAAOmO,QAAQ0L,IACvBC,GAAOT,oBAAoBW,GACnCD,QAAQ,IAMf1K,GAAmByK,IAYnB,MAAMG,GAAiB,CACrBrU,KAAI,CAACmH,EAAU/Z,EAAU8F,SAASC,kBACzB,GAAG3G,UAAUsB,QAAQ3C,UAAUqiB,iBAAiBniB,KAAK+B,EAAS+Z,IAGvEmN,QAAO,CAACnN,EAAU/Z,EAAU8F,SAASC,kBAC5BrF,QAAQ3C,UAAU8K,cAAc5K,KAAK+B,EAAS+Z,GAGvDoN,SAAQ,CAACnnB,EAAS+Z,IACT,GAAG3a,UAAUY,EAAQmnB,UAAUvgB,QAAOzB,GAASA,EAAMiiB,QAAQrN,KAGtEsN,QAAQrnB,EAAS+Z,GACf,MAAMsN,EAAU,GAChB,IAAIC,EAAWtnB,EAAQwF,WAAW2V,QAAQpB,GAE1C,KAAOuN,GACLD,EAAQhV,KAAKiV,GACbA,EAAWA,EAAS9hB,WAAW2V,QAAQpB,GAGzC,OAAOsN,CACT,EAEAE,KAAKvnB,EAAS+Z,GACZ,IAAIyN,EAAWxnB,EAAQynB,uBAEvB,KAAOD,GAAU,CACf,GAAIA,EAASJ,QAAQrN,GACnB,MAAO,CAACyN,GAGVA,EAAWA,EAASC,sBACtB,CAEA,MAAO,EACT,EAGAniB,KAAKtF,EAAS+Z,GACZ,IAAIzU,EAAOtF,EAAQ0nB,mBAEnB,KAAOpiB,GAAM,CACX,GAAIA,EAAK8hB,QAAQrN,GACf,MAAO,CAACzU,GAGVA,EAAOA,EAAKoiB,kBACd,CAEA,MAAO,EACT,EAEAC,kBAAkB3nB,GAChB,MAAM4nB,EAAa,CAAC,IAAK,SAAU,QAAS,WAAY,SAAU,UAAW,aAAc,4BAA4BrkB,KAAIwW,GAAY,GAAGA,2BAAiCpW,KAAK,KAChL,OAAOqc,KAAKpN,KAAKgV,EAAY5nB,GAAS4G,QAAOihB,IAAOxM,GAAWwM,IAAO/M,GAAU+M,IAClF,GAeIC,GAAc,YACdC,GAAmB,aAAaD,KAChCE,GAAkB,YAAYF,KAC9BG,GAAiB,WAAWH,KAC5BI,GAAoB,cAAcJ,KAClCK,GAAkB,YAAYL,KAK9BM,GAAY,CAChBC,YAAa,KACbC,aAAc,KACdC,cAAe,MAEXC,GAAgB,CACpBH,YAAa,kBACbC,aAAc,kBACdC,cAAe,mBAMjB,MAAME,WAAczE,GAClBU,YAAY1kB,EAASqkB,GACnBc,QACAnF,KAAKoF,SAAWplB,EAEXA,GAAYyoB,GAAMC,gBAIvB1I,KAAKqF,QAAUrF,KAAKoE,WAAWC,GAC/BrE,KAAK2I,QAAU,EACf3I,KAAK4I,sBAAwB9H,QAAQzgB,OAAOwoB,cAE5C7I,KAAK8I,cACP,CAGW7E,qBACT,OAAOmE,EACT,CAEWlE,yBACT,OAAOsE,EACT,CAEW/L,kBACT,MAnDW,OAoDb,CAGA8I,UACEhF,GAAaC,IAAIR,KAAKoF,SAAU0C,GAClC,CAGAiB,OAAO3J,GACAY,KAAK4I,sBAKN5I,KAAKgJ,wBAAwB5J,KAC/BY,KAAK2I,QAAUvJ,EAAM6J,SALrBjJ,KAAK2I,QAAUvJ,EAAM8J,QAAQ,GAAGD,OAOpC,CAEAE,KAAK/J,GACCY,KAAKgJ,wBAAwB5J,KAC/BY,KAAK2I,QAAUvJ,EAAM6J,QAAUjJ,KAAK2I,SAGtC3I,KAAKoJ,eAELrM,GAAQiD,KAAKqF,QAAQgD,YACvB,CAEAgB,MAAMjK,GACJY,KAAK2I,QAAUvJ,EAAM8J,SAAW9J,EAAM8J,QAAQ/X,OAAS,EAAI,EAAIiO,EAAM8J,QAAQ,GAAGD,QAAUjJ,KAAK2I,OACjG,CAEAS,eACE,MAAME,EAAY1mB,KAAKoC,IAAIgb,KAAK2I,SAEhC,GAAIW,GA9EgB,GA+ElB,OAGF,MAAMvb,EAAYub,EAAYtJ,KAAK2I,QACnC3I,KAAK2I,QAAU,EAEV5a,GAILgP,GAAQhP,EAAY,EAAIiS,KAAKqF,QAAQkD,cAAgBvI,KAAKqF,QAAQiD,aACpE,CAEAQ,cACM9I,KAAK4I,uBACPrI,GAAaY,GAAGnB,KAAKoF,SAAU8C,IAAmB9I,GAASY,KAAK+I,OAAO3J,KACvEmB,GAAaY,GAAGnB,KAAKoF,SAAU+C,IAAiB/I,GAASY,KAAKmJ,KAAK/J,KAEnEY,KAAKoF,SAAS5J,UAAUtE,IAlGG,mBAoG3BqJ,GAAaY,GAAGnB,KAAKoF,SAAU2C,IAAkB3I,GAASY,KAAK+I,OAAO3J,KACtEmB,GAAaY,GAAGnB,KAAKoF,SAAU4C,IAAiB5I,GAASY,KAAKqJ,MAAMjK,KACpEmB,GAAaY,GAAGnB,KAAKoF,SAAU6C,IAAgB7I,GAASY,KAAKmJ,KAAK/J,KAEtE,CAEA4J,wBAAwB5J,GACtB,OAAOY,KAAK4I,wBA5GS,QA4GiBxJ,EAAMmK,aA7GrB,UA6GyDnK,EAAMmK,YACxF,CAGA1D,qBACE,MAAO,iBAAkB/f,SAASC,iBAAmB7C,UAAUsmB,eAAiB,CAClF,EAcF,MAEMC,GAAc,eACdC,GAAiB,YAKjBC,GAAa,OACbC,GAAa,OACbC,GAAiB,OACjBC,GAAkB,QAClBC,GAAc,QAAQN,KACtBO,GAAa,OAAOP,KACpBQ,GAAkB,UAAUR,KAC5BS,GAAqB,aAAaT,KAClCU,GAAqB,aAAaV,KAClCW,GAAmB,YAAYX,KAC/BY,GAAwB,OAAOZ,KAAcC,KAC7CY,GAAyB,QAAQb,KAAcC,KAC/Ca,GAAsB,WACtBC,GAAsB,SAMtBC,GAAkB,UAClBC,GAAgB,iBAChBC,GAAuBF,GAAkBC,GAKzCE,GAAmB,CACvB,UAAoBd,GACpB,WAAqBD,IAEjBgB,GAAY,CAChBC,SAAU,IACVC,UAAU,EACVC,MAAO,QACPC,MAAM,EACNC,OAAO,EACPC,MAAM,GAEFC,GAAgB,CACpBN,SAAU,mBAEVC,SAAU,UACVC,MAAO,mBACPC,KAAM,mBACNC,MAAO,UACPC,KAAM,WAMR,MAAME,WAAiBnG,GACrBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GACfrE,KAAKsL,UAAY,KACjBtL,KAAKuL,eAAiB,KACtBvL,KAAKwL,YAAa,EAClBxL,KAAKyL,aAAe,KACpBzL,KAAK0L,aAAe,KACpB1L,KAAK2L,mBAAqB1E,GAAeC,QApCjB,uBAoC8ClH,KAAKoF,UAE3EpF,KAAK4L,qBAED5L,KAAKqF,QAAQ4F,OAASV,IACxBvK,KAAK6L,OAET,CAGW5H,qBACT,OAAO4G,EACT,CAEW3G,yBACT,OAAOkH,EACT,CAEW3O,kBACT,MAtFW,UAuFb,CAGAnX,OACE0a,KAAK8L,OAAOnC,GACd,CAEAoC,mBAIOjmB,SAASkmB,QAAUlR,GAAUkF,KAAKoF,WACrCpF,KAAK1a,MAET,CAEAiiB,OACEvH,KAAK8L,OAAOlC,GACd,CAEAoB,QACMhL,KAAKwL,YACPjR,GAAqByF,KAAKoF,UAG5BpF,KAAKiM,gBACP,CAEAJ,QACE7L,KAAKiM,iBAELjM,KAAKkM,kBAELlM,KAAKsL,UAAYa,aAAY,IAAMnM,KAAK+L,mBAAmB/L,KAAKqF,QAAQyF,SAC1E,CAEAsB,oBACOpM,KAAKqF,QAAQ4F,OAIdjL,KAAKwL,WACPjL,GAAaa,IAAIpB,KAAKoF,SAAU4E,IAAY,IAAMhK,KAAK6L,UAIzD7L,KAAK6L,QACP,CAEAQ,GAAGnT,GACD,MAAMoT,EAAQtM,KAAKuM,YAEnB,GAAIrT,EAAQoT,EAAMnb,OAAS,GAAK+H,EAAQ,EACtC,OAGF,GAAI8G,KAAKwL,WAEP,YADAjL,GAAaa,IAAIpB,KAAKoF,SAAU4E,IAAY,IAAMhK,KAAKqM,GAAGnT,KAI5D,MAAMsT,EAAcxM,KAAKyM,cAAczM,KAAK0M,cAE5C,GAAIF,IAAgBtT,EAClB,OAGF,MAAMtC,EAAQsC,EAAQsT,EAAc7C,GAAaC,GAEjD5J,KAAK8L,OAAOlV,EAAO0V,EAAMpT,GAC3B,CAEAqM,UACMvF,KAAK0L,cACP1L,KAAK0L,aAAanG,UAGpBJ,MAAMI,SACR,CAGAhB,kBAAkBF,GAEhB,OADAA,EAAOsI,gBAAkBtI,EAAOyG,SACzBzG,CACT,CAEAuH,qBACM5L,KAAKqF,QAAQ0F,UACfxK,GAAaY,GAAGnB,KAAKoF,SAAU6E,IAAiB7K,GAASY,KAAK4M,SAASxN,KAG9C,UAAvBY,KAAKqF,QAAQ2F,QACfzK,GAAaY,GAAGnB,KAAKoF,SAAU8E,IAAoB,IAAMlK,KAAKgL,UAC9DzK,GAAaY,GAAGnB,KAAKoF,SAAU+E,IAAoB,IAAMnK,KAAKoM,uBAG5DpM,KAAKqF,QAAQ6F,OAASzC,GAAMC,eAC9B1I,KAAK6M,yBAET,CAEAA,0BACE,IAAK,MAAMC,KAAO7F,GAAerU,KA/JX,qBA+JmCoN,KAAKoF,UAC5D7E,GAAaY,GAAG2L,EAAK1C,IAAkBhL,GAASA,EAAM+C,mBAGxD,MAqBM4K,EAAc,CAClBzE,aAAc,IAAMtI,KAAK8L,OAAO9L,KAAKgN,kBAAkBnD,KACvDtB,cAAe,IAAMvI,KAAK8L,OAAO9L,KAAKgN,kBAAkBlD,KACxDzB,YAxBkB,KACS,UAAvBrI,KAAKqF,QAAQ2F,QAWjBhL,KAAKgL,QAEDhL,KAAKyL,cACPwB,aAAajN,KAAKyL,cAGpBzL,KAAKyL,aAAe5N,YAAW,IAAMmC,KAAKoM,qBA7MjB,IA6M+DpM,KAAKqF,QAAQyF,UAAS,GAQhH9K,KAAK0L,aAAe,IAAIjD,GAAMzI,KAAKoF,SAAU2H,EAC/C,CAEAH,SAASxN,GACP,GAAI,kBAAkBtb,KAAKsb,EAAMpS,OAAOoZ,SACtC,OAGF,MAAMrY,EAAY6c,GAAiBxL,EAAM7hB,KAErCwQ,IACFqR,EAAM+C,iBAENnC,KAAK8L,OAAO9L,KAAKgN,kBAAkBjf,IAEvC,CAEA0e,cAAczsB,GACZ,OAAOggB,KAAKuM,YAAY3mB,QAAQ5F,EAClC,CAEAktB,2BAA2BhU,GACzB,IAAK8G,KAAK2L,mBACR,OAGF,MAAMwB,EAAkBlG,GAAeC,QAAQuD,GAAiBzK,KAAK2L,oBACrEwB,EAAgB3R,UAAUuH,OAAOyH,IACjC2C,EAAgBvrB,gBAAgB,gBAChC,MAAMwrB,EAAqBnG,GAAeC,QAAQ,sBAAsBhO,MAAW8G,KAAK2L,oBAEpFyB,IACFA,EAAmB5R,UAAUtE,IAAIsT,IACjC4C,EAAmBvrB,aAAa,eAAgB,QAEpD,CAEAqqB,kBACE,MAAMlsB,EAAUggB,KAAKuL,gBAAkBvL,KAAK0M,aAE5C,IAAK1sB,EACH,OAGF,MAAMqtB,EAAkB9P,OAAO+P,SAASttB,EAAQga,aAAa,oBAAqB,IAClFgG,KAAKqF,QAAQyF,SAAWuC,GAAmBrN,KAAKqF,QAAQsH,eAC1D,CAEAb,OAAOlV,EAAO5W,EAAU,MACtB,GAAIggB,KAAKwL,WACP,OAGF,MAAMzN,EAAgBiC,KAAK0M,aAErBa,EAAS3W,IAAU+S,GACnB6D,EAAcxtB,GAAW8d,GAAqBkC,KAAKuM,YAAaxO,EAAewP,EAAQvN,KAAKqF,QAAQ8F,MAE1G,GAAIqC,IAAgBzP,EAClB,OAGF,MAAM0P,EAAmBzN,KAAKyM,cAAce,GAEtCE,EAAeC,GACZpN,GAAakB,QAAQzB,KAAKoF,SAAUuI,EAAW,CACpD7N,cAAe0N,EACfzf,UAAWiS,KAAK4N,kBAAkBhX,GAClCkM,KAAM9C,KAAKyM,cAAc1O,GACzBsO,GAAIoB,IAMR,GAFmBC,EAAa3D,IAEjBlI,iBACb,OAGF,IAAK9D,IAAkByP,EAGrB,OAGF,MAAMK,EAAY/M,QAAQd,KAAKsL,WAC/BtL,KAAKgL,QACLhL,KAAKwL,YAAa,EAElBxL,KAAKkN,2BAA2BO,GAEhCzN,KAAKuL,eAAiBiC,EACtB,MAAMM,EAAuBP,EA/RR,sBADF,oBAiSbQ,EAAiBR,EA/RH,qBACA,qBA+RpBC,EAAYhS,UAAUtE,IAAI6W,GAC1BhS,GAAOyR,GACPzP,EAAcvC,UAAUtE,IAAI4W,GAC5BN,EAAYhS,UAAUtE,IAAI4W,GAU1B9N,KAAK2F,gBARoB,KACvB6H,EAAYhS,UAAUuH,OAAO+K,EAAsBC,GACnDP,EAAYhS,UAAUtE,IAAIsT,IAC1BzM,EAAcvC,UAAUuH,OAAOyH,GAAqBuD,EAAgBD,GACpE9N,KAAKwL,YAAa,EAClBkC,EAAa1D,GAAW,GAGYjM,EAAeiC,KAAKgO,eAEtDH,GACF7N,KAAK6L,OAET,CAEAmC,cACE,OAAOhO,KAAKoF,SAAS5J,UAAUvW,SAxTV,QAyTvB,CAEAynB,aACE,OAAOzF,GAAeC,QAAQyD,GAAsB3K,KAAKoF,SAC3D,CAEAmH,YACE,OAAOtF,GAAerU,KAAK8X,GAAe1K,KAAKoF,SACjD,CAEA6G,iBACMjM,KAAKsL,YACP2C,cAAcjO,KAAKsL,WACnBtL,KAAKsL,UAAY,KAErB,CAEA0B,kBAAkBjf,GAChB,OAAIoO,KACKpO,IAAc8b,GAAiBD,GAAaD,GAG9C5b,IAAc8b,GAAiBF,GAAaC,EACrD,CAEAgE,kBAAkBhX,GAChB,OAAIuF,KACKvF,IAAUgT,GAAaC,GAAiBC,GAG1ClT,IAAUgT,GAAaE,GAAkBD,EAClD,CAGAhE,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAOugB,GAAShF,oBAAoBrG,KAAMqE,GAEhD,GAAsB,iBAAXA,GAKX,GAAsB,iBAAXA,EAAqB,CAC9B,QAAqB7K,IAAjB1O,EAAKuZ,IAAyBA,EAAOlK,WAAW,MAAmB,gBAAXkK,EAC1D,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IACP,OAVEvZ,EAAKuhB,GAAGhI,EAWZ,GACF,EAQF9D,GAAaY,GAAGrb,SAAUwkB,GA1WE,uCA0W2C,SAAUlL,GAC/E,MAAMpS,EAASsN,GAAuB0F,MAEtC,IAAKhT,IAAWA,EAAOwO,UAAUvW,SAASslB,IACxC,OAGFnL,EAAM+C,iBACN,MAAM+L,EAAW7C,GAAShF,oBAAoBrZ,GACxCmhB,EAAanO,KAAKhG,aAAa,oBAErC,OAAImU,GACFD,EAAS7B,GAAG8B,QAEZD,EAAS9B,qBAKyC,SAAhD7I,GAAYQ,iBAAiB/D,KAAM,UACrCkO,EAAS5oB,YAET4oB,EAAS9B,sBAKX8B,EAAS3G,YAET2G,EAAS9B,oBACX,IACA7L,GAAaY,GAAG9gB,OAAQgqB,IAAuB,KAC7C,MAAM+D,EAAYnH,GAAerU,KAzYR,6BA2YzB,IAAK,MAAMsb,KAAYE,EACrB/C,GAAShF,oBAAoB6H,EAC/B,IAMF7R,GAAmBgP,IAYnB,MAEMgD,GAAc,eAEdC,GAAe,OAAOD,KACtBE,GAAgB,QAAQF,KACxBG,GAAe,OAAOH,KACtBI,GAAiB,SAASJ,KAC1BK,GAAyB,QAAQL,cACjCM,GAAoB,OACpBC,GAAsB,WACtBC,GAAwB,aAExBC,GAA6B,WAAWF,OAAwBA,KAKhEG,GAAyB,8BACzBC,GAAY,CAChB9pB,OAAQ,KACR6hB,QAAQ,GAEJkI,GAAgB,CACpB/pB,OAAQ,iBACR6hB,OAAQ,WAMV,MAAMmI,WAAiBhK,GACrBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GACfrE,KAAKmP,kBAAmB,EACxBnP,KAAKoP,cAAgB,GACrB,MAAMC,EAAapI,GAAerU,KAAKmc,IAEvC,IAAK,MAAMO,KAAQD,EAAY,CAC7B,MAAMtV,EAAWM,GAAuBiV,GAClCC,EAAgBtI,GAAerU,KAAKmH,GAAUnT,QAAO4oB,GAAgBA,IAAiBxP,KAAKoF,WAEhF,OAAbrL,GAAqBwV,EAAcpe,QACrC6O,KAAKoP,cAAc/c,KAAKid,EAE5B,CAEAtP,KAAKyP,sBAEAzP,KAAKqF,QAAQngB,QAChB8a,KAAK0P,0BAA0B1P,KAAKoP,cAAepP,KAAK2P,YAGtD3P,KAAKqF,QAAQ0B,QACf/G,KAAK+G,QAET,CAGW9C,qBACT,OAAO+K,EACT,CAEW9K,yBACT,OAAO+K,EACT,CAEWxS,kBACT,MApEW,UAqEb,CAGAsK,SACM/G,KAAK2P,WACP3P,KAAK4P,OAEL5P,KAAK6P,MAET,CAEAA,OACE,GAAI7P,KAAKmP,kBAAoBnP,KAAK2P,WAChC,OAGF,IAAIG,EAAiB,GAQrB,GANI9P,KAAKqF,QAAQngB,SACf4qB,EAAiB9P,KAAK+P,uBAvEH,wCAuE4CnpB,QAAO5G,GAAWA,IAAYggB,KAAKoF,WAAU7hB,KAAIvD,GAAWkvB,GAAS7I,oBAAoBrmB,EAAS,CAC/J+mB,QAAQ,OAIR+I,EAAe3e,QAAU2e,EAAe,GAAGX,iBAC7C,OAKF,GAFmB5O,GAAakB,QAAQzB,KAAKoF,SAAUkJ,IAExCzM,iBACb,OAGF,IAAK,MAAMmO,KAAkBF,EAC3BE,EAAeJ,OAGjB,MAAMK,EAAYjQ,KAAKkQ,gBAEvBlQ,KAAKoF,SAAS5J,UAAUuH,OAAO6L,IAE/B5O,KAAKoF,SAAS5J,UAAUtE,IAAI2X,IAE5B7O,KAAKoF,SAAS5jB,MAAMyuB,GAAa,EAEjCjQ,KAAK0P,0BAA0B1P,KAAKoP,eAAe,GAEnDpP,KAAKmP,kBAAmB,EAExB,MAYMgB,EAAa,SADUF,EAAU,GAAGhL,cAAgBgL,EAAUpd,MAAM,KAG1EmN,KAAK2F,gBAdY,KACf3F,KAAKmP,kBAAmB,EAExBnP,KAAKoF,SAAS5J,UAAUuH,OAAO8L,IAE/B7O,KAAKoF,SAAS5J,UAAUtE,IAAI0X,GAAqBD,IAEjD3O,KAAKoF,SAAS5jB,MAAMyuB,GAAa,GACjC1P,GAAakB,QAAQzB,KAAKoF,SAAUmJ,GAAc,GAMtBvO,KAAKoF,UAAU,GAE7CpF,KAAKoF,SAAS5jB,MAAMyuB,GAAa,GAAGjQ,KAAKoF,SAAS+K,MACpD,CAEAP,OACE,GAAI5P,KAAKmP,mBAAqBnP,KAAK2P,WACjC,OAKF,GAFmBpP,GAAakB,QAAQzB,KAAKoF,SAAUoJ,IAExC3M,iBACb,OAGF,MAAMoO,EAAYjQ,KAAKkQ,gBAEvBlQ,KAAKoF,SAAS5jB,MAAMyuB,GAAa,GAAGjQ,KAAKoF,SAASrhB,wBAAwBksB,OAC1ElU,GAAOiE,KAAKoF,UAEZpF,KAAKoF,SAAS5J,UAAUtE,IAAI2X,IAE5B7O,KAAKoF,SAAS5J,UAAUuH,OAAO6L,GAAqBD,IAEpD,IAAK,MAAMlN,KAAWzB,KAAKoP,cAAe,CACxC,MAAMpvB,EAAUsa,GAAuBmH,GAEnCzhB,IAAYggB,KAAK2P,SAAS3vB,IAC5BggB,KAAK0P,0BAA0B,CAACjO,IAAU,EAE9C,CAEAzB,KAAKmP,kBAAmB,EAYxBnP,KAAKoF,SAAS5jB,MAAMyuB,GAAa,GAEjCjQ,KAAK2F,gBAZY,KACf3F,KAAKmP,kBAAmB,EAExBnP,KAAKoF,SAAS5J,UAAUuH,OAAO8L,IAE/B7O,KAAKoF,SAAS5J,UAAUtE,IAAI0X,IAE5BrO,GAAakB,QAAQzB,KAAKoF,SAAUqJ,GAAe,GAKvBzO,KAAKoF,UAAU,EAC/C,CAEAuK,SAAS3vB,EAAUggB,KAAKoF,UACtB,OAAOplB,EAAQwb,UAAUvW,SAAS0pB,GACpC,CAGApK,kBAAkBF,GAIhB,OAHAA,EAAO0C,OAASjG,QAAQuD,EAAO0C,QAE/B1C,EAAOnf,OAAS2V,GAAWwJ,EAAOnf,QAC3Bmf,CACT,CAEA6L,gBACE,OAAOlQ,KAAKoF,SAAS5J,UAAUvW,SAtLL,uBAChB,QACC,QAqLb,CAEAwqB,sBACE,IAAKzP,KAAKqF,QAAQngB,OAChB,OAGF,MAAMiiB,EAAWnH,KAAK+P,uBAAuBhB,IAE7C,IAAK,MAAM/uB,KAAWmnB,EAAU,CAC9B,MAAMiJ,EAAW9V,GAAuBta,GAEpCowB,GACFpQ,KAAK0P,0BAA0B,CAAC1vB,GAAUggB,KAAK2P,SAASS,GAE5D,CACF,CAEAL,uBAAuBhW,GACrB,MAAMoN,EAAWF,GAAerU,KAAKkc,GAA4B9O,KAAKqF,QAAQngB,QAE9E,OAAO+hB,GAAerU,KAAKmH,EAAUiG,KAAKqF,QAAQngB,QAAQ0B,QAAO5G,IAAYmnB,EAASjN,SAASla,IACjG,CAEA0vB,0BAA0BW,EAAcC,GACtC,GAAKD,EAAalf,OAIlB,IAAK,MAAMnR,KAAWqwB,EACpBrwB,EAAQwb,UAAUuL,OAvNK,aAuNyBuJ,GAChDtwB,EAAQ6B,aAAa,gBAAiByuB,EAE1C,CAGAzK,uBAAuBxB,GACrB,MAAMgB,EAAU,CAAC,EAMjB,MAJsB,iBAAXhB,GAAuB,YAAYvgB,KAAKugB,KACjDgB,EAAQ0B,QAAS,GAGZ/G,KAAK4G,MAAK,WACf,MAAM9b,EAAOokB,GAAS7I,oBAAoBrG,KAAMqF,GAEhD,GAAsB,iBAAXhB,EAAqB,CAC9B,QAA4B,IAAjBvZ,EAAKuZ,GACd,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IACP,CACF,GACF,EAQF9D,GAAaY,GAAGrb,SAAU4oB,GAAwBK,IAAwB,SAAU3P,IAErD,MAAzBA,EAAMpS,OAAOoZ,SAAmBhH,EAAMW,gBAAmD,MAAjCX,EAAMW,eAAeqG,UAC/EhH,EAAM+C,iBAGR,MAAMpI,EAAWM,GAAuB2F,MAClCuQ,EAAmBtJ,GAAerU,KAAKmH,GAE7C,IAAK,MAAM/Z,KAAWuwB,EACpBrB,GAAS7I,oBAAoBrmB,EAAS,CACpC+mB,QAAQ,IACPA,QAEP,IAKA1K,GAAmB6S,IAYnB,MAAMsB,GAAS,WAETC,GAAc,eACdC,GAAiB,YAGjBC,GAAiB,UACjBC,GAAmB,YAGnBC,GAAe,OAAOJ,KACtBK,GAAiB,SAASL,KAC1BM,GAAe,OAAON,KACtBO,GAAgB,QAAQP,KACxBQ,GAAyB,QAAQR,KAAcC,KAC/CQ,GAAyB,UAAUT,KAAcC,KACjDS,GAAuB,QAAQV,KAAcC,KAC7CU,GAAoB,OAMpBC,GAAyB,4DACzBC,GAA6B,GAAGD,MAA0BD,KAC1DG,GAAgB,iBAIhBC,GAAgBrV,KAAU,UAAY,YACtCsV,GAAmBtV,KAAU,YAAc,UAC3CuV,GAAmBvV,KAAU,aAAe,eAC5CwV,GAAsBxV,KAAU,eAAiB,aACjDyV,GAAkBzV,KAAU,aAAe,cAC3C0V,GAAiB1V,KAAU,cAAgB,aAG3C2V,GAAY,CAChBC,WAAW,EACXrjB,SAAU,kBACVsjB,QAAS,UACTvpB,OAAQ,CAAC,EAAG,GACZwpB,aAAc,KACdlzB,UAAW,UAEPmzB,GAAgB,CACpBH,UAAW,mBACXrjB,SAAU,mBACVsjB,QAAS,SACTvpB,OAAQ,0BACRwpB,aAAc,yBACdlzB,UAAW,2BAMb,MAAMozB,WAAiBjN,GACrBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GACfrE,KAAKoS,QAAU,KACfpS,KAAKqS,QAAUrS,KAAKoF,SAAS5f,WAG7Bwa,KAAKsS,MAAQrL,GAAe3hB,KAAK0a,KAAKoF,SAAUmM,IAAe,IAAMtK,GAAeM,KAAKvH,KAAKoF,SAAUmM,IAAe,IAAMtK,GAAeC,QAAQqK,GAAevR,KAAKqS,SACxKrS,KAAKuS,UAAYvS,KAAKwS,eACxB,CAGWvO,qBACT,OAAO6N,EACT,CAEW5N,yBACT,OAAOgO,EACT,CAEWzV,kBACT,OAAO+T,EACT,CAGAzJ,SACE,OAAO/G,KAAK2P,WAAa3P,KAAK4P,OAAS5P,KAAK6P,MAC9C,CAEAA,OACE,GAAIxU,GAAW2E,KAAKoF,WAAapF,KAAK2P,WACpC,OAGF,MAAM7P,EAAgB,CACpBA,cAAeE,KAAKoF,UAItB,IAFkB7E,GAAakB,QAAQzB,KAAKoF,SAAU2L,GAAcjR,GAEtD+B,iBAAd,CAUA,GANA7B,KAAKyS,gBAMD,iBAAkB3sB,SAASC,kBAAoBia,KAAKqS,QAAQlX,QA/ExC,eAgFtB,IAAK,MAAMnb,IAAW,GAAGZ,UAAU0G,SAAS6G,KAAKwa,UAC/C5G,GAAaY,GAAGnhB,EAAS,YAAa8b,IAI1CkE,KAAKoF,SAASsN,QAEd1S,KAAKoF,SAASvjB,aAAa,iBAAiB,GAE5Cme,KAAKsS,MAAM9W,UAAUtE,IAAIka,IAEzBpR,KAAKoF,SAAS5J,UAAUtE,IAAIka,IAE5B7Q,GAAakB,QAAQzB,KAAKoF,SAAU4L,GAAelR,EAtBnD,CAuBF,CAEA8P,OACE,GAAIvU,GAAW2E,KAAKoF,YAAcpF,KAAK2P,WACrC,OAGF,MAAM7P,EAAgB,CACpBA,cAAeE,KAAKoF,UAGtBpF,KAAK2S,cAAc7S,EACrB,CAEAyF,UACMvF,KAAKoS,SACPpS,KAAKoS,QAAQ3Y,UAGf0L,MAAMI,SACR,CAEA/Z,SACEwU,KAAKuS,UAAYvS,KAAKwS,gBAElBxS,KAAKoS,SACPpS,KAAKoS,QAAQ5mB,QAEjB,CAGAmnB,cAAc7S,GAGZ,IAFkBS,GAAakB,QAAQzB,KAAKoF,SAAUyL,GAAc/Q,GAEtD+B,iBAAd,CAMA,GAAI,iBAAkB/b,SAASC,gBAC7B,IAAK,MAAM/F,IAAW,GAAGZ,UAAU0G,SAAS6G,KAAKwa,UAC/C5G,GAAaC,IAAIxgB,EAAS,YAAa8b,IAIvCkE,KAAKoS,SACPpS,KAAKoS,QAAQ3Y,UAGfuG,KAAKsS,MAAM9W,UAAUuH,OAAOqO,IAE5BpR,KAAKoF,SAAS5J,UAAUuH,OAAOqO,IAE/BpR,KAAKoF,SAASvjB,aAAa,gBAAiB,SAE5C0hB,GAAYE,oBAAoBzD,KAAKsS,MAAO,UAC5C/R,GAAakB,QAAQzB,KAAKoF,SAAU0L,GAAgBhR,EArBpD,CAsBF,CAEAsE,WAAWC,GAGT,GAAgC,iBAFhCA,EAASc,MAAMf,WAAWC,IAERtlB,YAA2B,GAAUslB,EAAOtlB,YAAgE,mBAA3CslB,EAAOtlB,UAAUgF,sBAElG,MAAM,IAAIihB,UAAU,GAAGwL,GAAOvL,+GAGhC,OAAOZ,CACT,CAEAoO,gBACE,QAAsB,IAAX,EACT,MAAM,IAAIzN,UAAU,gEAGtB,IAAI4N,EAAmB5S,KAAKoF,SAEG,WAA3BpF,KAAKqF,QAAQtmB,UACf6zB,EAAmB5S,KAAKqS,QACf,GAAUrS,KAAKqF,QAAQtmB,WAChC6zB,EAAmB/X,GAAWmF,KAAKqF,QAAQtmB,WACA,iBAA3BihB,KAAKqF,QAAQtmB,YAC7B6zB,EAAmB5S,KAAKqF,QAAQtmB,WAGlC,MAAMkzB,EAAejS,KAAK6S,mBAE1B7S,KAAKoS,QAAU,GAAoBQ,EAAkB5S,KAAKsS,MAAOL,EACnE,CAEAtC,WACE,OAAO3P,KAAKsS,MAAM9W,UAAUvW,SAASmsB,GACvC,CAEA0B,gBACE,MAAMC,EAAiB/S,KAAKqS,QAE5B,GAAIU,EAAevX,UAAUvW,SAxMN,WAyMrB,OAAO2sB,GAGT,GAAImB,EAAevX,UAAUvW,SA3MJ,aA4MvB,OAAO4sB,GAGT,GAAIkB,EAAevX,UAAUvW,SA9MA,iBA+M3B,MAjMsB,MAoMxB,GAAI8tB,EAAevX,UAAUvW,SAjNE,mBAkN7B,MApMyB,SAwM3B,MAAM+tB,EAAkF,QAA1EttB,iBAAiBsa,KAAKsS,OAAOrX,iBAAiB,iBAAiBb,OAE7E,OAAI2Y,EAAevX,UAAUvW,SA5NP,UA6Nb+tB,EAAQvB,GAAmBD,GAG7BwB,EAAQrB,GAAsBD,EACvC,CAEAc,gBACE,OAAkD,OAA3CxS,KAAKoF,SAASjK,QA5ND,UA6NtB,CAEA8X,aACE,MAAM,OACJxqB,GACEuX,KAAKqF,QAET,MAAsB,iBAAX5c,EACFA,EAAO9F,MAAM,KAAKY,KAAInF,GAASmf,OAAO+P,SAASlvB,EAAO,MAGzC,mBAAXqK,EACFyqB,GAAczqB,EAAOyqB,EAAYlT,KAAKoF,UAGxC3c,CACT,CAEAoqB,mBACE,MAAMM,EAAwB,CAC5Bh0B,UAAW6gB,KAAK8S,gBAChBjc,UAAW,CAAC,CACV9V,KAAM,kBACNmB,QAAS,CACPwM,SAAUsR,KAAKqF,QAAQ3W,WAExB,CACD3N,KAAM,SACNmB,QAAS,CACPuG,OAAQuX,KAAKiT,iBAcnB,OATIjT,KAAKuS,WAAsC,WAAzBvS,KAAKqF,QAAQ2M,WACjCzO,GAAYC,iBAAiBxD,KAAKsS,MAAO,SAAU,UAEnDa,EAAsBtc,UAAY,CAAC,CACjC9V,KAAM,cACNC,SAAS,KAIN,IAAKmyB,KAC+B,mBAA9BnT,KAAKqF,QAAQ4M,aAA8BjS,KAAKqF,QAAQ4M,aAAakB,GAAyBnT,KAAKqF,QAAQ4M,aAE1H,CAEAmB,iBAAgB,IACd71B,EAAG,OACHyP,IAEA,MAAMsf,EAAQrF,GAAerU,KA/QF,8DA+Q+BoN,KAAKsS,OAAO1rB,QAAO5G,GAAW8a,GAAU9a,KAE7FssB,EAAMnb,QAMX2M,GAAqBwO,EAAOtf,EAAQzP,IAAQqzB,IAAmBtE,EAAMpS,SAASlN,IAAS0lB,OACzF,CAGA7M,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAOqnB,GAAS9L,oBAAoBrG,KAAMqE,GAEhD,GAAsB,iBAAXA,EAAX,CAIA,QAA4B,IAAjBvZ,EAAKuZ,GACd,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IANL,CAOF,GACF,CAEAwB,kBAAkBzG,GAChB,GAhUuB,IAgUnBA,EAAM4H,QAAgD,UAAf5H,EAAMqB,MAnUnC,QAmUuDrB,EAAM7hB,IACzE,OAGF,MAAM81B,EAAcpM,GAAerU,KAAK0e,IAExC,IAAK,MAAMvK,KAAUsM,EAAa,CAChC,MAAMC,EAAUnB,GAASrM,YAAYiB,GAErC,IAAKuM,IAAyC,IAA9BA,EAAQjO,QAAQ0M,UAC9B,SAGF,MAAMwB,EAAenU,EAAMmU,eACrBC,EAAeD,EAAarZ,SAASoZ,EAAQhB,OAEnD,GAAIiB,EAAarZ,SAASoZ,EAAQlO,WAA2C,WAA9BkO,EAAQjO,QAAQ0M,YAA2ByB,GAA8C,YAA9BF,EAAQjO,QAAQ0M,WAA2ByB,EACnJ,SAIF,GAAIF,EAAQhB,MAAMrtB,SAASma,EAAMpS,UAA2B,UAAfoS,EAAMqB,MAxVvC,QAwV2DrB,EAAM7hB,KAAqB,qCAAqCuG,KAAKsb,EAAMpS,OAAOoZ,UACvJ,SAGF,MAAMtG,EAAgB,CACpBA,cAAewT,EAAQlO,UAGN,UAAfhG,EAAMqB,OACRX,EAAcqG,WAAa/G,GAG7BkU,EAAQX,cAAc7S,EACxB,CACF,CAEA+F,6BAA6BzG,GAG3B,MAAMqU,EAAU,kBAAkB3vB,KAAKsb,EAAMpS,OAAOoZ,SAC9CsN,EA7WW,WA6WKtU,EAAM7hB,IACtBo2B,EAAkB,CAAChD,GAAgBC,IAAkB1W,SAASkF,EAAM7hB,KAE1E,IAAKo2B,IAAoBD,EACvB,OAGF,GAAID,IAAYC,EACd,OAGFtU,EAAM+C,iBAEN,MAAMyR,EAAkB5T,KAAKoH,QAAQiK,IAA0BrR,KAAOiH,GAAeM,KAAKvH,KAAMqR,IAAwB,IAAMpK,GAAe3hB,KAAK0a,KAAMqR,IAAwB,IAAMpK,GAAeC,QAAQmK,GAAwBjS,EAAMW,eAAeva,YACpPwF,EAAWmnB,GAAS9L,oBAAoBuN,GAE9C,GAAID,EAMF,OALAvU,EAAMyU,kBACN7oB,EAAS6kB,YAET7kB,EAASooB,gBAAgBhU,GAKvBpU,EAAS2kB,aAEXvQ,EAAMyU,kBACN7oB,EAAS4kB,OACTgE,EAAgBlB,QAEpB,EAQFnS,GAAaY,GAAGrb,SAAUorB,GAAwBG,GAAwBc,GAAS2B,uBACnFvT,GAAaY,GAAGrb,SAAUorB,GAAwBK,GAAeY,GAAS2B,uBAC1EvT,GAAaY,GAAGrb,SAAUmrB,GAAwBkB,GAAS4B,YAC3DxT,GAAaY,GAAGrb,SAAUqrB,GAAsBgB,GAAS4B,YACzDxT,GAAaY,GAAGrb,SAAUmrB,GAAwBI,IAAwB,SAAUjS,GAClFA,EAAM+C,iBACNgQ,GAAS9L,oBAAoBrG,MAAM+G,QACrC,IAKA1K,GAAmB8V,IAYnB,MAAM6B,GAAyB,oDACzBC,GAA0B,cAC1BC,GAAmB,gBACnBC,GAAkB,eAKxB,MAAMC,GACJ1P,cACE1E,KAAKoF,SAAWtf,SAAS6G,IAC3B,CAGA0nB,WAEE,MAAMC,EAAgBxuB,SAASC,gBAAgBuC,YAC/C,OAAO1F,KAAKoC,IAAI3E,OAAOk0B,WAAaD,EACtC,CAEA1E,OACE,MAAMtrB,EAAQ0b,KAAKqU,WAEnBrU,KAAKwU,mBAGLxU,KAAKyU,sBAAsBzU,KAAKoF,SAAU8O,IAAkBQ,GAAmBA,EAAkBpwB,IAGjG0b,KAAKyU,sBAAsBT,GAAwBE,IAAkBQ,GAAmBA,EAAkBpwB,IAE1G0b,KAAKyU,sBAAsBR,GAAyBE,IAAiBO,GAAmBA,EAAkBpwB,GAC5G,CAEAwO,QACEkN,KAAK2U,wBAAwB3U,KAAKoF,SAAU,YAE5CpF,KAAK2U,wBAAwB3U,KAAKoF,SAAU8O,IAE5ClU,KAAK2U,wBAAwBX,GAAwBE,IAErDlU,KAAK2U,wBAAwBV,GAAyBE,GACxD,CAEAS,gBACE,OAAO5U,KAAKqU,WAAa,CAC3B,CAGAG,mBACExU,KAAK6U,sBAAsB7U,KAAKoF,SAAU,YAE1CpF,KAAKoF,SAAS5jB,MAAM+K,SAAW,QACjC,CAEAkoB,sBAAsB1a,EAAU+a,EAAevY,GAC7C,MAAMwY,EAAiB/U,KAAKqU,WAa5BrU,KAAKgV,2BAA2Bjb,GAXH/Z,IAC3B,GAAIA,IAAYggB,KAAKoF,UAAY/kB,OAAOk0B,WAAav0B,EAAQsI,YAAcysB,EACzE,OAGF/U,KAAK6U,sBAAsB70B,EAAS80B,GAEpC,MAAMJ,EAAkBr0B,OAAOqF,iBAAiB1F,GAASib,iBAAiB6Z,GAC1E90B,EAAQwB,MAAMyzB,YAAYH,EAAe,GAAGvY,EAASgB,OAAOC,WAAWkX,QAAsB,GAIjG,CAEAG,sBAAsB70B,EAAS80B,GAC7B,MAAMI,EAAcl1B,EAAQwB,MAAMyZ,iBAAiB6Z,GAE/CI,GACF3R,GAAYC,iBAAiBxjB,EAAS80B,EAAeI,EAEzD,CAEAP,wBAAwB5a,EAAU+a,GAahC9U,KAAKgV,2BAA2Bjb,GAZH/Z,IAC3B,MAAM5B,EAAQmlB,GAAYQ,iBAAiB/jB,EAAS80B,GAEtC,OAAV12B,GAKJmlB,GAAYE,oBAAoBzjB,EAAS80B,GACzC90B,EAAQwB,MAAMyzB,YAAYH,EAAe12B,IALvC4B,EAAQwB,MAAM2zB,eAAeL,EAKgB,GAInD,CAEAE,2BAA2Bjb,EAAUqb,GACnC,GAAI,GAAUrb,GACZqb,EAASrb,QAIX,IAAK,MAAMsb,KAAOpO,GAAerU,KAAKmH,EAAUiG,KAAKoF,UACnDgQ,EAASC,EAEb,EAcF,MAAMC,GAAS,WAETC,GAAoB,OACpBC,GAAkB,gBAAgBF,KAClCG,GAAY,CAChBC,UAAW,iBACXC,cAAe,KACf/P,YAAY,EACZ9K,WAAW,EAEX8a,YAAa,QAGTC,GAAgB,CACpBH,UAAW,SACXC,cAAe,kBACf/P,WAAY,UACZ9K,UAAW,UACX8a,YAAa,oBAMf,MAAME,WAAiB9R,GACrBU,YAAYL,GACVc,QACAnF,KAAKqF,QAAUrF,KAAKoE,WAAWC,GAC/BrE,KAAK+V,aAAc,EACnB/V,KAAKoF,SAAW,IAClB,CAGWnB,qBACT,OAAOwR,EACT,CAEWvR,yBACT,OAAO2R,EACT,CAEWpZ,kBACT,OAAO6Y,EACT,CAGAzF,KAAKtT,GACH,IAAKyD,KAAKqF,QAAQvK,UAEhB,YADAiC,GAAQR,GAIVyD,KAAKgW,UAEL,MAAMh2B,EAAUggB,KAAKiW,cAEjBjW,KAAKqF,QAAQO,YACf7J,GAAO/b,GAGTA,EAAQwb,UAAUtE,IAAIqe,IAEtBvV,KAAKkW,mBAAkB,KACrBnZ,GAAQR,EAAS,GAErB,CAEAqT,KAAKrT,GACEyD,KAAKqF,QAAQvK,WAKlBkF,KAAKiW,cAAcza,UAAUuH,OAAOwS,IAEpCvV,KAAKkW,mBAAkB,KACrBlW,KAAKuF,UACLxI,GAAQR,EAAS,KARjBQ,GAAQR,EAUZ,CAEAgJ,UACOvF,KAAK+V,cAIVxV,GAAaC,IAAIR,KAAKoF,SAAUoQ,IAEhCxV,KAAKoF,SAASrC,SAEd/C,KAAK+V,aAAc,EACrB,CAGAE,cACE,IAAKjW,KAAKoF,SAAU,CAClB,MAAM+Q,EAAWrwB,SAASswB,cAAc,OACxCD,EAAST,UAAY1V,KAAKqF,QAAQqQ,UAE9B1V,KAAKqF,QAAQO,YACfuQ,EAAS3a,UAAUtE,IAnGD,QAsGpB8I,KAAKoF,SAAW+Q,CAClB,CAEA,OAAOnW,KAAKoF,QACd,CAEAb,kBAAkBF,GAGhB,OADAA,EAAOuR,YAAc/a,GAAWwJ,EAAOuR,aAChCvR,CACT,CAEA2R,UACE,GAAIhW,KAAK+V,YACP,OAGF,MAAM/1B,EAAUggB,KAAKiW,cAErBjW,KAAKqF,QAAQuQ,YAAYS,OAAOr2B,GAEhCugB,GAAaY,GAAGnhB,EAASw1B,IAAiB,KACxCzY,GAAQiD,KAAKqF,QAAQsQ,cAAc,IAErC3V,KAAK+V,aAAc,CACrB,CAEAG,kBAAkB3Z,GAChBS,GAAuBT,EAAUyD,KAAKiW,cAAejW,KAAKqF,QAAQO,WACpE,EAcF,MAEM0Q,GAAc,gBACdC,GAAkB,UAAUD,KAC5BE,GAAoB,cAAcF,KAGlCG,GAAmB,WACnBC,GAAY,CAChBC,WAAW,EACXC,YAAa,MAGTC,GAAgB,CACpBF,UAAW,UACXC,YAAa,WAMf,MAAME,WAAkB9S,GACtBU,YAAYL,GACVc,QACAnF,KAAKqF,QAAUrF,KAAKoE,WAAWC,GAC/BrE,KAAK+W,WAAY,EACjB/W,KAAKgX,qBAAuB,IAC9B,CAGW/S,qBACT,OAAOyS,EACT,CAEWxS,yBACT,OAAO2S,EACT,CAEWpa,kBACT,MAvCW,WAwCb,CAGAwa,WACMjX,KAAK+W,YAIL/W,KAAKqF,QAAQsR,WACf3W,KAAKqF,QAAQuR,YAAYlE,QAG3BnS,GAAaC,IAAI1a,SAAUwwB,IAE3B/V,GAAaY,GAAGrb,SAAUywB,IAAiBnX,GAASY,KAAKkX,eAAe9X,KACxEmB,GAAaY,GAAGrb,SAAU0wB,IAAmBpX,GAASY,KAAKmX,eAAe/X,KAC1EY,KAAK+W,WAAY,EACnB,CAEAK,aACOpX,KAAK+W,YAIV/W,KAAK+W,WAAY,EACjBxW,GAAaC,IAAI1a,SAAUwwB,IAC7B,CAGAY,eAAe9X,GACb,MAAM,YACJwX,GACE5W,KAAKqF,QAET,GAAIjG,EAAMpS,SAAWlH,UAAYsZ,EAAMpS,SAAW4pB,GAAeA,EAAY3xB,SAASma,EAAMpS,QAC1F,OAGF,MAAM1L,EAAW2lB,GAAeU,kBAAkBiP,GAE1B,IAApBt1B,EAAS6P,OACXylB,EAAYlE,QACH1S,KAAKgX,uBAAyBP,GACvCn1B,EAASA,EAAS6P,OAAS,GAAGuhB,QAE9BpxB,EAAS,GAAGoxB,OAEhB,CAEAyE,eAAe/X,GApFD,QAqFRA,EAAM7hB,MAIVyiB,KAAKgX,qBAAuB5X,EAAMiY,SAAWZ,GAxFzB,UAyFtB,EAcF,MAEMa,GAAc,YAGdC,GAAe,OAAOD,KACtBE,GAAyB,gBAAgBF,KACzCG,GAAiB,SAASH,KAC1BI,GAAe,OAAOJ,KACtBK,GAAgB,QAAQL,KACxBM,GAAiB,SAASN,KAC1BO,GAAsB,gBAAgBP,KACtCQ,GAA0B,oBAAoBR,KAC9CS,GAA0B,kBAAkBT,KAC5CU,GAAyB,QAAQV,cACjCW,GAAkB,aAElBC,GAAoB,OACpBC,GAAoB,eAKpBC,GAAY,CAChBjC,UAAU,EACVzD,OAAO,EACP3H,UAAU,GAENsN,GAAgB,CACpBlC,SAAU,mBACVzD,MAAO,UACP3H,SAAU,WAMZ,MAAMuN,WAAcpT,GAClBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GACfrE,KAAKuY,QAAUtR,GAAeC,QApBV,gBAoBmClH,KAAKoF,UAC5DpF,KAAKwY,UAAYxY,KAAKyY,sBACtBzY,KAAK0Y,WAAa1Y,KAAK2Y,uBACvB3Y,KAAK2P,UAAW,EAChB3P,KAAKmP,kBAAmB,EACxBnP,KAAK4Y,WAAa,IAAIxE,GAEtBpU,KAAK4L,oBACP,CAGW3H,qBACT,OAAOmU,EACT,CAEWlU,yBACT,OAAOmU,EACT,CAEW5b,kBACT,MA5DW,OA6Db,CAGAsK,OAAOjH,GACL,OAAOE,KAAK2P,SAAW3P,KAAK4P,OAAS5P,KAAK6P,KAAK/P,EACjD,CAEA+P,KAAK/P,GACCE,KAAK2P,UAAY3P,KAAKmP,kBAIR5O,GAAakB,QAAQzB,KAAKoF,SAAUsS,GAAc,CAClE5X,kBAGY+B,mBAId7B,KAAK2P,UAAW,EAChB3P,KAAKmP,kBAAmB,EAExBnP,KAAK4Y,WAAWhJ,OAEhB9pB,SAAS6G,KAAK6O,UAAUtE,IAAI+gB,IAE5BjY,KAAK6Y,gBAEL7Y,KAAKwY,UAAU3I,MAAK,IAAM7P,KAAK8Y,aAAahZ,KAC9C,CAEA8P,OACO5P,KAAK2P,WAAY3P,KAAKmP,mBAIT5O,GAAakB,QAAQzB,KAAKoF,SAAUmS,IAExC1V,mBAId7B,KAAK2P,UAAW,EAChB3P,KAAKmP,kBAAmB,EAExBnP,KAAK0Y,WAAWtB,aAEhBpX,KAAKoF,SAAS5J,UAAUuH,OAAOmV,IAE/BlY,KAAK2F,gBAAe,IAAM3F,KAAK+Y,cAAc/Y,KAAKoF,SAAUpF,KAAKgO,gBACnE,CAEAzI,UACE,IAAK,MAAMyT,IAAe,CAAC34B,OAAQ2f,KAAKuY,SACtChY,GAAaC,IAAIwY,EAAa1B,IAGhCtX,KAAKwY,UAAUjT,UAEfvF,KAAK0Y,WAAWtB,aAEhBjS,MAAMI,SACR,CAEA0T,eACEjZ,KAAK6Y,eACP,CAGAJ,sBACE,OAAO,IAAI3C,GAAS,CAClBhb,UAAWgG,QAAQd,KAAKqF,QAAQ8Q,UAEhCvQ,WAAY5F,KAAKgO,eAErB,CAEA2K,uBACE,OAAO,IAAI7B,GAAU,CACnBF,YAAa5W,KAAKoF,UAEtB,CAEA0T,aAAahZ,GAENha,SAAS6G,KAAK1H,SAAS+a,KAAKoF,WAC/Btf,SAAS6G,KAAK0pB,OAAOrW,KAAKoF,UAG5BpF,KAAKoF,SAAS5jB,MAAMwwB,QAAU,QAE9BhS,KAAKoF,SAASxjB,gBAAgB,eAE9Boe,KAAKoF,SAASvjB,aAAa,cAAc,GAEzCme,KAAKoF,SAASvjB,aAAa,OAAQ,UAEnCme,KAAKoF,SAASlZ,UAAY,EAC1B,MAAMgtB,EAAYjS,GAAeC,QA3IT,cA2IsClH,KAAKuY,SAE/DW,IACFA,EAAUhtB,UAAY,GAGxB6P,GAAOiE,KAAKoF,UAEZpF,KAAKoF,SAAS5J,UAAUtE,IAAIghB,IAa5BlY,KAAK2F,gBAXsB,KACrB3F,KAAKqF,QAAQqN,OACf1S,KAAK0Y,WAAWzB,WAGlBjX,KAAKmP,kBAAmB,EACxB5O,GAAakB,QAAQzB,KAAKoF,SAAUuS,GAAe,CACjD7X,iBACA,GAGoCE,KAAKuY,QAASvY,KAAKgO,cAC7D,CAEApC,qBACErL,GAAaY,GAAGnB,KAAKoF,SAAU2S,IAAyB3Y,IACtD,GAtLe,WAsLXA,EAAM7hB,IAIV,OAAIyiB,KAAKqF,QAAQ0F,UACf3L,EAAM+C,sBACNnC,KAAK4P,aAIP5P,KAAKmZ,4BAA4B,IAEnC5Y,GAAaY,GAAG9gB,OAAQu3B,IAAgB,KAClC5X,KAAK2P,WAAa3P,KAAKmP,kBACzBnP,KAAK6Y,eACP,IAEFtY,GAAaY,GAAGnB,KAAKoF,SAAU0S,IAAyB1Y,IAEtDmB,GAAaa,IAAIpB,KAAKoF,SAAUyS,IAAqBuB,IAC/CpZ,KAAKoF,WAAahG,EAAMpS,QAAUgT,KAAKoF,WAAagU,EAAOpsB,SAIjC,WAA1BgT,KAAKqF,QAAQ8Q,SAMbnW,KAAKqF,QAAQ8Q,UACfnW,KAAK4P,OANL5P,KAAKmZ,6BAOP,GACA,GAEN,CAEAJ,aACE/Y,KAAKoF,SAAS5jB,MAAMwwB,QAAU,OAE9BhS,KAAKoF,SAASvjB,aAAa,eAAe,GAE1Cme,KAAKoF,SAASxjB,gBAAgB,cAE9Boe,KAAKoF,SAASxjB,gBAAgB,QAE9Boe,KAAKmP,kBAAmB,EAExBnP,KAAKwY,UAAU5I,MAAK,KAClB9pB,SAAS6G,KAAK6O,UAAUuH,OAAOkV,IAE/BjY,KAAKqZ,oBAELrZ,KAAK4Y,WAAW9lB,QAEhByN,GAAakB,QAAQzB,KAAKoF,SAAUqS,GAAe,GAEvD,CAEAzJ,cACE,OAAOhO,KAAKoF,SAAS5J,UAAUvW,SAtOT,OAuOxB,CAEAk0B,6BAGE,GAFkB5Y,GAAakB,QAAQzB,KAAKoF,SAAUoS,IAExC3V,iBACZ,OAGF,MAAMyX,EAAqBtZ,KAAKoF,SAAStX,aAAehI,SAASC,gBAAgBsC,aAC3EkxB,EAAmBvZ,KAAKoF,SAAS5jB,MAAMiL,UAEpB,WAArB8sB,GAAiCvZ,KAAKoF,SAAS5J,UAAUvW,SAASkzB,MAIjEmB,IACHtZ,KAAKoF,SAAS5jB,MAAMiL,UAAY,UAGlCuT,KAAKoF,SAAS5J,UAAUtE,IAAIihB,IAE5BnY,KAAK2F,gBAAe,KAClB3F,KAAKoF,SAAS5J,UAAUuH,OAAOoV,IAE/BnY,KAAK2F,gBAAe,KAClB3F,KAAKoF,SAAS5jB,MAAMiL,UAAY8sB,CAAgB,GAC/CvZ,KAAKuY,QAAQ,GACfvY,KAAKuY,SAERvY,KAAKoF,SAASsN,QAChB,CAMAmG,gBACE,MAAMS,EAAqBtZ,KAAKoF,SAAStX,aAAehI,SAASC,gBAAgBsC,aAE3E0sB,EAAiB/U,KAAK4Y,WAAWvE,WAEjCmF,EAAoBzE,EAAiB,EAE3C,GAAIyE,IAAsBF,EAAoB,CAC5C,MAAM/2B,EAAW4Z,KAAU,cAAgB,eAC3C6D,KAAKoF,SAAS5jB,MAAMe,GAAY,GAAGwyB,KACrC,CAEA,IAAKyE,GAAqBF,EAAoB,CAC5C,MAAM/2B,EAAW4Z,KAAU,eAAiB,cAC5C6D,KAAKoF,SAAS5jB,MAAMe,GAAY,GAAGwyB,KACrC,CACF,CAEAsE,oBACErZ,KAAKoF,SAAS5jB,MAAMi4B,YAAc,GAClCzZ,KAAKoF,SAAS5jB,MAAMk4B,aAAe,EACrC,CAGA7T,uBAAuBxB,EAAQvE,GAC7B,OAAOE,KAAK4G,MAAK,WACf,MAAM9b,EAAOwtB,GAAMjS,oBAAoBrG,KAAMqE,GAE7C,GAAsB,iBAAXA,EAAX,CAIA,QAA4B,IAAjBvZ,EAAKuZ,GACd,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,GAAQvE,EANb,CAOF,GACF,EAQFS,GAAaY,GAAGrb,SAAUkyB,GApTK,4BAoT2C,SAAU5Y,GAClF,MAAMpS,EAASsN,GAAuB0F,MAElC,CAAC,IAAK,QAAQ9F,SAAS8F,KAAKoG,UAC9BhH,EAAM+C,iBAGR5B,GAAaa,IAAIpU,EAAQ0qB,IAAciC,IACjCA,EAAU9X,kBAKdtB,GAAaa,IAAIpU,EAAQyqB,IAAgB,KACnC3c,GAAUkF,OACZA,KAAK0S,OACP,GACA,IAGJ,MAAMkH,EAAc3S,GAAeC,QA3Ub,eA6UlB0S,GACFtB,GAAMxS,YAAY8T,GAAahK,OAGpB0I,GAAMjS,oBAAoBrZ,GAClC+Z,OAAO/G,KACd,IACAgG,GAAqBsS,IAKrBjc,GAAmBic,IAYnB,MAEMuB,GAAc,gBACdC,GAAiB,YACjBC,GAAwB,OAAOF,KAAcC,KAE7CE,GAAoB,OACpBC,GAAuB,UACvBC,GAAoB,SAEpBC,GAAgB,kBAChBC,GAAe,OAAOP,KACtBQ,GAAgB,QAAQR,KACxBS,GAAe,OAAOT,KACtBU,GAAuB,gBAAgBV,KACvCW,GAAiB,SAASX,KAC1BY,GAAe,SAASZ,KACxBa,GAAyB,QAAQb,KAAcC,KAC/Ca,GAAwB,kBAAkBd,KAE1Ce,GAAY,CAChBzE,UAAU,EACVpL,UAAU,EACV7f,QAAQ,GAEJ2vB,GAAgB,CACpB1E,SAAU,mBACVpL,SAAU,UACV7f,OAAQ,WAMV,MAAM4vB,WAAkB5V,GACtBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GACfrE,KAAK2P,UAAW,EAChB3P,KAAKwY,UAAYxY,KAAKyY,sBACtBzY,KAAK0Y,WAAa1Y,KAAK2Y,uBAEvB3Y,KAAK4L,oBACP,CAGW3H,qBACT,OAAO2W,EACT,CAEW1W,yBACT,OAAO2W,EACT,CAEWpe,kBACT,MAtDW,WAuDb,CAGAsK,OAAOjH,GACL,OAAOE,KAAK2P,SAAW3P,KAAK4P,OAAS5P,KAAK6P,KAAK/P,EACjD,CAEA+P,KAAK/P,GACCE,KAAK2P,UAISpP,GAAakB,QAAQzB,KAAKoF,SAAUgV,GAAc,CAClEta,kBAGY+B,mBAId7B,KAAK2P,UAAW,EAEhB3P,KAAKwY,UAAU3I,OAEV7P,KAAKqF,QAAQna,SAChB,IAAIkpB,IAAkBxE,OAGxB5P,KAAKoF,SAASvjB,aAAa,cAAc,GAEzCme,KAAKoF,SAASvjB,aAAa,OAAQ,UAEnCme,KAAKoF,SAAS5J,UAAUtE,IAAI+iB,IAgB5Bja,KAAK2F,gBAdoB,KAClB3F,KAAKqF,QAAQna,SAAU8U,KAAKqF,QAAQ8Q,UACvCnW,KAAK0Y,WAAWzB,WAGlBjX,KAAKoF,SAAS5J,UAAUtE,IAAI8iB,IAE5Bha,KAAKoF,SAAS5J,UAAUuH,OAAOkX,IAE/B1Z,GAAakB,QAAQzB,KAAKoF,SAAUiV,GAAe,CACjDva,iBACA,GAGkCE,KAAKoF,UAAU,GACvD,CAEAwK,OACO5P,KAAK2P,WAIQpP,GAAakB,QAAQzB,KAAKoF,SAAUkV,IAExCzY,mBAId7B,KAAK0Y,WAAWtB,aAEhBpX,KAAKoF,SAAS2V,OAEd/a,KAAK2P,UAAW,EAEhB3P,KAAKoF,SAAS5J,UAAUtE,IAAIgjB,IAE5Bla,KAAKwY,UAAU5I,OAgBf5P,KAAK2F,gBAdoB,KACvB3F,KAAKoF,SAAS5J,UAAUuH,OAAOiX,GAAmBE,IAElDla,KAAKoF,SAASxjB,gBAAgB,cAE9Boe,KAAKoF,SAASxjB,gBAAgB,QAEzBoe,KAAKqF,QAAQna,SAChB,IAAIkpB,IAAkBthB,QAGxByN,GAAakB,QAAQzB,KAAKoF,SAAUoV,GAAe,GAGfxa,KAAKoF,UAAU,IACvD,CAEAG,UACEvF,KAAKwY,UAAUjT,UAEfvF,KAAK0Y,WAAWtB,aAEhBjS,MAAMI,SACR,CAGAkT,sBACE,MAUM3d,EAAYgG,QAAQd,KAAKqF,QAAQ8Q,UACvC,OAAO,IAAIL,GAAS,CAClBJ,UA7JsB,qBA8JtB5a,YACA8K,YAAY,EACZgQ,YAAa5V,KAAKoF,SAAS5f,WAC3BmwB,cAAe7a,EAhBK,KACU,WAA1BkF,KAAKqF,QAAQ8Q,SAKjBnW,KAAK4P,OAJHrP,GAAakB,QAAQzB,KAAKoF,SAAUmV,GAI3B,EAUgC,MAE/C,CAEA5B,uBACE,OAAO,IAAI7B,GAAU,CACnBF,YAAa5W,KAAKoF,UAEtB,CAEAwG,qBACErL,GAAaY,GAAGnB,KAAKoF,SAAUuV,IAAuBvb,IAhLvC,WAiLTA,EAAM7hB,MAILyiB,KAAKqF,QAAQ0F,SAKlB/K,KAAK4P,OAJHrP,GAAakB,QAAQzB,KAAKoF,SAAUmV,IAI3B,GAEf,CAGA1U,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAOgwB,GAAUzU,oBAAoBrG,KAAMqE,GAEjD,GAAsB,iBAAXA,EAAX,CAIA,QAAqB7K,IAAjB1O,EAAKuZ,IAAyBA,EAAOlK,WAAW,MAAmB,gBAAXkK,EAC1D,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,GAAQrE,KANb,CAOF,GACF,EAQFO,GAAaY,GAAGrb,SAAU40B,GAvMK,gCAuM2C,SAAUtb,GAClF,MAAMpS,EAASsN,GAAuB0F,MAMtC,GAJI,CAAC,IAAK,QAAQ9F,SAAS8F,KAAKoG,UAC9BhH,EAAM+C,iBAGJ9G,GAAW2E,MACb,OAGFO,GAAaa,IAAIpU,EAAQwtB,IAAgB,KAEnC1f,GAAUkF,OACZA,KAAK0S,OACP,IAGF,MAAMkH,EAAc3S,GAAeC,QAAQiT,IAEvCP,GAAeA,IAAgB5sB,GACjC8tB,GAAUhV,YAAY8T,GAAahK,OAGxBkL,GAAUzU,oBAAoBrZ,GACtC+Z,OAAO/G,KACd,IACAO,GAAaY,GAAG9gB,OAAQ05B,IAAuB,KAC7C,IAAK,MAAMhgB,KAAYkN,GAAerU,KAAKunB,IACzCW,GAAUzU,oBAAoBtM,GAAU8V,MAC1C,IAEFtP,GAAaY,GAAG9gB,OAAQo6B,IAAc,KACpC,IAAK,MAAMz6B,KAAWinB,GAAerU,KAAK,gDACG,UAAvClN,iBAAiB1F,GAASiC,UAC5B64B,GAAUzU,oBAAoBrmB,GAAS4vB,MAE3C,IAEF5J,GAAqB8U,IAKrBze,GAAmBye,IAQnB,MAAME,GAAgB,IAAIjkB,IAAI,CAAC,aAAc,OAAQ,OAAQ,WAAY,WAAY,SAAU,MAAO,eAQhGkkB,GAAmB,iEAOnBC,GAAmB,qIAEnBC,GAAmB,CAAC34B,EAAW44B,KACnC,MAAMC,EAAgB74B,EAAUvC,SAASC,cAEzC,OAAIk7B,EAAqBlhB,SAASmhB,IAC5BL,GAAc5jB,IAAIikB,IACbva,QAAQma,GAAiBn3B,KAAKtB,EAAU84B,YAAcJ,GAAiBp3B,KAAKtB,EAAU84B,YAO1FF,EAAqBx0B,QAAO20B,GAAkBA,aAA0BxW,SAAQ7R,MAAKsoB,GAASA,EAAM13B,KAAKu3B,IAAe,EAG3HI,GAAmB,CAEvB,IAAK,CAAC,QAAS,MAAO,KAAM,OAAQ,OAjCP,kBAkC7BnqB,EAAG,CAAC,SAAU,OAAQ,QAAS,OAC/BoqB,KAAM,GACNnqB,EAAG,GACHoqB,GAAI,GACJC,IAAK,GACLC,KAAM,GACNC,IAAK,GACLC,GAAI,GACJC,GAAI,GACJC,GAAI,GACJC,GAAI,GACJC,GAAI,GACJC,GAAI,GACJC,GAAI,GACJC,GAAI,GACJxqB,EAAG,GACHgb,IAAK,CAAC,MAAO,SAAU,MAAO,QAAS,QAAS,UAChDyP,GAAI,GACJC,GAAI,GACJC,EAAG,GACHC,IAAK,GACLC,EAAG,GACHC,MAAO,GACPC,KAAM,GACNC,IAAK,GACLC,IAAK,GACLC,OAAQ,GACRC,EAAG,GACHC,GAAI,IA+CAC,GAAY,CAChBC,UAAW3B,GACX4B,QAAS,CAAC,EAEVC,WAAY,GACZhwB,MAAM,EACNiwB,UAAU,EACVC,WAAY,KACZC,SAAU,eAENC,GAAgB,CACpBN,UAAW,SACXC,QAAS,SACTC,WAAY,oBACZhwB,KAAM,UACNiwB,SAAU,UACVC,WAAY,kBACZC,SAAU,UAENE,GAAqB,CACzBC,MAAO,iCACP7jB,SAAU,oBAMZ,MAAM8jB,WAAwB7Z,GAC5BU,YAAYL,GACVc,QACAnF,KAAKqF,QAAUrF,KAAKoE,WAAWC,EACjC,CAGWJ,qBACT,OAAOkZ,EACT,CAEWjZ,yBACT,OAAOwZ,EACT,CAEWjhB,kBACT,MA5CW,iBA6Cb,CAGAqhB,aACE,OAAOrgC,OAAO0hB,OAAOa,KAAKqF,QAAQgY,SAAS95B,KAAI8gB,GAAUrE,KAAK+d,yBAAyB1Z,KAASzd,OAAOka,QACzG,CAEAkd,aACE,OAAOhe,KAAK8d,aAAa3sB,OAAS,CACpC,CAEA8sB,cAAcZ,GAMZ,OALArd,KAAKke,cAAcb,GAEnBrd,KAAKqF,QAAQgY,QAAU,IAAKrd,KAAKqF,QAAQgY,WACpCA,GAEErd,IACT,CAEAme,SACE,MAAMC,EAAkBt4B,SAASswB,cAAc,OAC/CgI,EAAgBC,UAAYre,KAAKse,eAAete,KAAKqF,QAAQoY,UAE7D,IAAK,MAAO1jB,EAAUwkB,KAAS9gC,OAAO4kB,QAAQrC,KAAKqF,QAAQgY,SACzDrd,KAAKwe,YAAYJ,EAAiBG,EAAMxkB,GAG1C,MAAM0jB,EAAWW,EAAgBjX,SAAS,GAEpCmW,EAAatd,KAAK+d,yBAAyB/d,KAAKqF,QAAQiY,YAM9D,OAJIA,GACFG,EAASjiB,UAAUtE,OAAOomB,EAAW36B,MAAM,MAGtC86B,CACT,CAGAjZ,iBAAiBH,GACfc,MAAMX,iBAAiBH,GAEvBrE,KAAKke,cAAc7Z,EAAOgZ,QAC5B,CAEAa,cAAcO,GACZ,IAAK,MAAO1kB,EAAUsjB,KAAY5/B,OAAO4kB,QAAQoc,GAC/CtZ,MAAMX,iBAAiB,CACrBzK,WACA6jB,MAAOP,GACNM,GAEP,CAEAa,YAAYf,EAAUJ,EAAStjB,GAC7B,MAAM2kB,EAAkBzX,GAAeC,QAAQnN,EAAU0jB,GAEpDiB,KAILrB,EAAUrd,KAAK+d,yBAAyBV,IAOpC,GAAUA,GACZrd,KAAK2e,sBAAsB9jB,GAAWwiB,GAAUqB,GAK9C1e,KAAKqF,QAAQ/X,KACfoxB,EAAgBL,UAAYre,KAAKse,eAAejB,GAIlDqB,EAAgBE,YAAcvB,EAf5BqB,EAAgB3b,SAgBpB,CAEAub,eAAeG,GACb,OAAOze,KAAKqF,QAAQkY,SA7KxB,SAAsBsB,EAAYzB,EAAW0B,GAC3C,IAAKD,EAAW1tB,OACd,OAAO0tB,EAGT,GAAIC,GAAgD,mBAArBA,EAC7B,OAAOA,EAAiBD,GAG1B,MACME,GADY,IAAI1+B,OAAO2+B,WACKC,gBAAgBJ,EAAY,aACxDv9B,EAAW,GAAGlC,UAAU2/B,EAAgBpyB,KAAKyT,iBAAiB,MAEpE,IAAK,MAAMpgB,KAAWsB,EAAU,CAC9B,MAAM49B,EAAcl/B,EAAQC,SAASC,cAErC,IAAKzC,OAAO4D,KAAK+7B,GAAWljB,SAASglB,GAAc,CACjDl/B,EAAQ+iB,SACR,QACF,CAEA,MAAMoc,EAAgB,GAAG//B,UAAUY,EAAQ0B,YACrC09B,EAAoB,GAAGhgC,OAAOg+B,EAAU,MAAQ,GAAIA,EAAU8B,IAAgB,IAEpF,IAAK,MAAM18B,KAAa28B,EACjBhE,GAAiB34B,EAAW48B,IAC/Bp/B,EAAQ4B,gBAAgBY,EAAUvC,SAGxC,CAEA,OAAO8+B,EAAgBpyB,KAAK0xB,SAC9B,CA6ImCgB,CAAaZ,EAAKze,KAAKqF,QAAQ+X,UAAWpd,KAAKqF,QAAQmY,YAAciB,CACtG,CAEAV,yBAAyBU,GACvB,MAAsB,mBAARA,EAAqBA,EAAIze,MAAQye,CACjD,CAEAE,sBAAsB3+B,EAAS0+B,GAC7B,GAAI1e,KAAKqF,QAAQ/X,KAGf,OAFAoxB,EAAgBL,UAAY,QAC5BK,EAAgBrI,OAAOr2B,GAIzB0+B,EAAgBE,YAAc5+B,EAAQ4+B,WACxC,EAcF,MACMU,GAAwB,IAAIvoB,IAAI,CAAC,WAAY,YAAa,eAC1DwoB,GAAoB,OAEpBC,GAAoB,OAEpBC,GAAiB,SACjBC,GAAmB,gBACnBC,GAAgB,QAChBC,GAAgB,QAahBC,GAAgB,CACpBC,KAAM,OACNC,IAAK,MACLC,MAAO7jB,KAAU,OAAS,QAC1B8jB,OAAQ,SACRC,KAAM/jB,KAAU,QAAU,QAEtBgkB,GAAY,CAChB/C,UAAW3B,GACX2E,WAAW,EACX1xB,SAAU,kBACV2xB,WAAW,EACXC,YAAa,GACbC,MAAO,EACP9vB,mBAAoB,CAAC,MAAO,QAAS,SAAU,QAC/CnD,MAAM,EACN7E,OAAQ,CAAC,EAAG,GACZtJ,UAAW,MACX8yB,aAAc,KACdsL,UAAU,EACVC,WAAY,KACZzjB,UAAU,EACV0jB,SAAU,+GACV+C,MAAO,GACP/e,QAAS,eAELgf,GAAgB,CACpBrD,UAAW,SACXgD,UAAW,UACX1xB,SAAU,mBACV2xB,UAAW,2BACXC,YAAa,oBACbC,MAAO,kBACP9vB,mBAAoB,QACpBnD,KAAM,UACN7E,OAAQ,0BACRtJ,UAAW,oBACX8yB,aAAc,yBACdsL,SAAU,UACVC,WAAY,kBACZzjB,SAAU,mBACV0jB,SAAU,SACV+C,MAAO,4BACP/e,QAAS,UAMX,MAAMif,WAAgBxb,GACpBR,YAAY1kB,EAASqkB,GACnB,QAAsB,IAAX,EACT,MAAM,IAAIW,UAAU,+DAGtBG,MAAMnlB,EAASqkB,GAEfrE,KAAK2gB,YAAa,EAClB3gB,KAAK4gB,SAAW,EAChB5gB,KAAK6gB,WAAa,KAClB7gB,KAAK8gB,eAAiB,CAAC,EACvB9gB,KAAKoS,QAAU,KACfpS,KAAK+gB,iBAAmB,KACxB/gB,KAAKghB,YAAc,KAEnBhhB,KAAKihB,IAAM,KAEXjhB,KAAKkhB,gBAEAlhB,KAAKqF,QAAQtL,UAChBiG,KAAKmhB,WAET,CAGWld,qBACT,OAAOkc,EACT,CAEWjc,yBACT,OAAOuc,EACT,CAEWhkB,kBACT,MA1GW,SA2Gb,CAGA2kB,SACEphB,KAAK2gB,YAAa,CACpB,CAEAU,UACErhB,KAAK2gB,YAAa,CACpB,CAEAW,gBACEthB,KAAK2gB,YAAc3gB,KAAK2gB,UAC1B,CAEA5Z,SACO/G,KAAK2gB,aAIV3gB,KAAK8gB,eAAeS,OAASvhB,KAAK8gB,eAAeS,MAE7CvhB,KAAK2P,WACP3P,KAAKwhB,SAKPxhB,KAAKyhB,SACP,CAEAlc,UACE0H,aAAajN,KAAK4gB,UAClBrgB,GAAaC,IAAIR,KAAKoF,SAASjK,QAAQskB,IAAiBC,GAAkB1f,KAAK0hB,mBAE3E1hB,KAAKoF,SAASpL,aAAa,2BAC7BgG,KAAKoF,SAASvjB,aAAa,QAASme,KAAKoF,SAASpL,aAAa,2BAGjEgG,KAAK2hB,iBAELxc,MAAMI,SACR,CAEAsK,OACE,GAAoC,SAAhC7P,KAAKoF,SAAS5jB,MAAMwwB,QACtB,MAAM,IAAI7N,MAAM,uCAGlB,IAAMnE,KAAK4hB,mBAAoB5hB,KAAK2gB,WAClC,OAGF,MAAMhH,EAAYpZ,GAAakB,QAAQzB,KAAKoF,SAAUpF,KAAK0E,YAAYiJ,UAlJtD,SAqJXkU,GAFalmB,GAAeqE,KAAKoF,WAELpF,KAAKoF,SAAS7kB,cAAcwF,iBAAiBd,SAAS+a,KAAKoF,UAE7F,GAAIuU,EAAU9X,mBAAqBggB,EACjC,OAIF7hB,KAAK2hB,iBAEL,MAAMV,EAAMjhB,KAAK8hB,iBAEjB9hB,KAAKoF,SAASvjB,aAAa,mBAAoBo/B,EAAIjnB,aAAa,OAEhE,MAAM,UACJqmB,GACErgB,KAAKqF,QAaT,GAXKrF,KAAKoF,SAAS7kB,cAAcwF,gBAAgBd,SAAS+a,KAAKihB,OAC7DZ,EAAUhK,OAAO4K,GACjB1gB,GAAakB,QAAQzB,KAAKoF,SAAUpF,KAAK0E,YAAYiJ,UAtKpC,cAyKnB3N,KAAKoS,QAAUpS,KAAKyS,cAAcwO,GAClCA,EAAIzlB,UAAUtE,IAAIsoB,IAKd,iBAAkB15B,SAASC,gBAC7B,IAAK,MAAM/F,IAAW,GAAGZ,UAAU0G,SAAS6G,KAAKwa,UAC/C5G,GAAaY,GAAGnhB,EAAS,YAAa8b,IAc1CkE,KAAK2F,gBAVY,KACfpF,GAAakB,QAAQzB,KAAKoF,SAAUpF,KAAK0E,YAAYiJ,UAvLrC,WAyLQ,IAApB3N,KAAK6gB,YACP7gB,KAAKwhB,SAGPxhB,KAAK6gB,YAAa,CAAK,GAGK7gB,KAAKihB,IAAKjhB,KAAKgO,cAC/C,CAEA4B,OACE,GAAK5P,KAAK2P,aAIQpP,GAAakB,QAAQzB,KAAKoF,SAAUpF,KAAK0E,YAAYiJ,UA3MtD,SA6MH9L,iBAAd,CASA,GALY7B,KAAK8hB,iBAEbtmB,UAAUuH,OAAOyc,IAGjB,iBAAkB15B,SAASC,gBAC7B,IAAK,MAAM/F,IAAW,GAAGZ,UAAU0G,SAAS6G,KAAKwa,UAC/C5G,GAAaC,IAAIxgB,EAAS,YAAa8b,IAI3CkE,KAAK8gB,eAA4B,OAAI,EACrC9gB,KAAK8gB,eAAelB,KAAiB,EACrC5f,KAAK8gB,eAAenB,KAAiB,EACrC3f,KAAK6gB,WAAa,KAgBlB7gB,KAAK2F,gBAdY,KACX3F,KAAK+hB,yBAIJ/hB,KAAK6gB,YACR7gB,KAAK2hB,iBAGP3hB,KAAKoF,SAASxjB,gBAAgB,oBAE9B2e,GAAakB,QAAQzB,KAAKoF,SAAUpF,KAAK0E,YAAYiJ,UA3OpC,WA2O8D,GAGnD3N,KAAKihB,IAAKjhB,KAAKgO,cAhC7C,CAiCF,CAEAxiB,SACMwU,KAAKoS,SACPpS,KAAKoS,QAAQ5mB,QAEjB,CAGAo2B,iBACE,OAAO9gB,QAAQd,KAAKgiB,YACtB,CAEAF,iBAKE,OAJK9hB,KAAKihB,MACRjhB,KAAKihB,IAAMjhB,KAAKiiB,kBAAkBjiB,KAAKghB,aAAehhB,KAAKkiB,2BAGtDliB,KAAKihB,GACd,CAEAgB,kBAAkB5E,GAChB,MAAM4D,EAAMjhB,KAAKmiB,oBAAoB9E,GAASc,SAG9C,IAAK8C,EACH,OAAO,KAGTA,EAAIzlB,UAAUuH,OAAOwc,GAAmBC,IAExCyB,EAAIzlB,UAAUtE,IAAI,MAAM8I,KAAK0E,YAAYjI,aACzC,MAAM2lB,EA92HKC,KACb,GACEA,GAAUz/B,KAAK0/B,MAlBH,IAkBS1/B,KAAK2/B,gBACnBz8B,SAAS08B,eAAeH,IAEjC,OAAOA,CAAM,EAy2HGI,CAAOziB,KAAK0E,YAAYjI,MAAMnc,WAO5C,OANA2gC,EAAIp/B,aAAa,KAAMugC,GAEnBpiB,KAAKgO,eACPiT,EAAIzlB,UAAUtE,IAAIqoB,IAGb0B,CACT,CAEAyB,WAAWrF,GACTrd,KAAKghB,YAAc3D,EAEfrd,KAAK2P,aACP3P,KAAK2hB,iBAEL3hB,KAAK6P,OAET,CAEAsS,oBAAoB9E,GAYlB,OAXIrd,KAAK+gB,iBACP/gB,KAAK+gB,iBAAiB9C,cAAcZ,GAEpCrd,KAAK+gB,iBAAmB,IAAIlD,GAAgB,IAAK7d,KAAKqF,QAGpDgY,UACAC,WAAYtd,KAAK+d,yBAAyB/d,KAAKqF,QAAQib,eAIpDtgB,KAAK+gB,gBACd,CAEAmB,yBACE,MAAO,CACL,iBAA0BliB,KAAKgiB,YAEnC,CAEAA,YACE,OAAOhiB,KAAK+d,yBAAyB/d,KAAKqF,QAAQmb,QAAUxgB,KAAKoF,SAASpL,aAAa,yBACzF,CAGA2oB,6BAA6BvjB,GAC3B,OAAOY,KAAK0E,YAAY2B,oBAAoBjH,EAAMW,eAAgBC,KAAK4iB,qBACzE,CAEA5U,cACE,OAAOhO,KAAKqF,QAAQ+a,WAAapgB,KAAKihB,KAAOjhB,KAAKihB,IAAIzlB,UAAUvW,SAASs6B,GAC3E,CAEA5P,WACE,OAAO3P,KAAKihB,KAAOjhB,KAAKihB,IAAIzlB,UAAUvW,SAASu6B,GACjD,CAEA/M,cAAcwO,GACZ,MAAM9hC,EAA8C,mBAA3B6gB,KAAKqF,QAAQlmB,UAA2B6gB,KAAKqF,QAAQlmB,UAAUlB,KAAK+hB,KAAMihB,EAAKjhB,KAAKoF,UAAYpF,KAAKqF,QAAQlmB,UAChI0jC,EAAahD,GAAc1gC,EAAU8lB,eAC3C,OAAO,GAAoBjF,KAAKoF,SAAU6b,EAAKjhB,KAAK6S,iBAAiBgQ,GACvE,CAEA5P,aACE,MAAM,OACJxqB,GACEuX,KAAKqF,QAET,MAAsB,iBAAX5c,EACFA,EAAO9F,MAAM,KAAKY,KAAInF,GAASmf,OAAO+P,SAASlvB,EAAO,MAGzC,mBAAXqK,EACFyqB,GAAczqB,EAAOyqB,EAAYlT,KAAKoF,UAGxC3c,CACT,CAEAs1B,yBAAyBU,GACvB,MAAsB,mBAARA,EAAqBA,EAAIxgC,KAAK+hB,KAAKoF,UAAYqZ,CAC/D,CAEA5L,iBAAiBgQ,GACf,MAAM1P,EAAwB,CAC5Bh0B,UAAW0jC,EACXhsB,UAAW,CAAC,CACV9V,KAAM,OACNmB,QAAS,CACPuO,mBAAoBuP,KAAKqF,QAAQ5U,qBAElC,CACD1P,KAAM,SACNmB,QAAS,CACPuG,OAAQuX,KAAKiT,eAEd,CACDlyB,KAAM,kBACNmB,QAAS,CACPwM,SAAUsR,KAAKqF,QAAQ3W,WAExB,CACD3N,KAAM,QACNmB,QAAS,CACPlC,QAAS,IAAIggB,KAAK0E,YAAYjI,eAE/B,CACD1b,KAAM,kBACNC,SAAS,EACTC,MAAO,aACPC,GAAI4J,IAGFkV,KAAK8hB,iBAAiBjgC,aAAa,wBAAyBiJ,EAAK1J,MAAMjC,UAAU,KAIvF,MAAO,IAAKg0B,KAC+B,mBAA9BnT,KAAKqF,QAAQ4M,aAA8BjS,KAAKqF,QAAQ4M,aAAakB,GAAyBnT,KAAKqF,QAAQ4M,aAE1H,CAEAiP,gBACE,MAAM4B,EAAW9iB,KAAKqF,QAAQ5D,QAAQ9e,MAAM,KAE5C,IAAK,MAAM8e,KAAWqhB,EACpB,GAAgB,UAAZrhB,EACFlB,GAAaY,GAAGnB,KAAKoF,SAAUpF,KAAK0E,YAAYiJ,UA3YlC,SA2Y4D3N,KAAKqF,QAAQtL,UAAUqF,IAC/EY,KAAK2iB,6BAA6BvjB,GAE1C2H,QAAQ,SAEb,GAtZU,WAsZNtF,EAA4B,CACrC,MAAMshB,EAAUthB,IAAYke,GAAgB3f,KAAK0E,YAAYiJ,UA9Y5C,cA8Y0E3N,KAAK0E,YAAYiJ,UAhZ5F,WAiZVqV,EAAWvhB,IAAYke,GAAgB3f,KAAK0E,YAAYiJ,UA9Y7C,cA8Y2E3N,KAAK0E,YAAYiJ,UAhZ5F,YAiZjBpN,GAAaY,GAAGnB,KAAKoF,SAAU2d,EAAS/iB,KAAKqF,QAAQtL,UAAUqF,IAC7D,MAAMkU,EAAUtT,KAAK2iB,6BAA6BvjB,GAElDkU,EAAQwN,eAA8B,YAAf1hB,EAAMqB,KAAqBmf,GAAgBD,KAAiB,EAEnFrM,EAAQmO,QAAQ,IAElBlhB,GAAaY,GAAGnB,KAAKoF,SAAU4d,EAAUhjB,KAAKqF,QAAQtL,UAAUqF,IAC9D,MAAMkU,EAAUtT,KAAK2iB,6BAA6BvjB,GAElDkU,EAAQwN,eAA8B,aAAf1hB,EAAMqB,KAAsBmf,GAAgBD,IAAiBrM,EAAQlO,SAASngB,SAASma,EAAMU,eAEpHwT,EAAQkO,QAAQ,GAEpB,CAGFxhB,KAAK0hB,kBAAoB,KACnB1hB,KAAKoF,UACPpF,KAAK4P,MACP,EAGFrP,GAAaY,GAAGnB,KAAKoF,SAASjK,QAAQskB,IAAiBC,GAAkB1f,KAAK0hB,kBAChF,CAEAP,YACE,MAAMX,EAAQxgB,KAAKoF,SAASpL,aAAa,SAEpCwmB,IAIAxgB,KAAKoF,SAASpL,aAAa,eAAkBgG,KAAKoF,SAASwZ,YAAYxkB,QAC1E4F,KAAKoF,SAASvjB,aAAa,aAAc2+B,GAG3CxgB,KAAKoF,SAASvjB,aAAa,yBAA0B2+B,GAGrDxgB,KAAKoF,SAASxjB,gBAAgB,SAChC,CAEA6/B,SACMzhB,KAAK2P,YAAc3P,KAAK6gB,WAC1B7gB,KAAK6gB,YAAa,GAIpB7gB,KAAK6gB,YAAa,EAElB7gB,KAAKijB,aAAY,KACXjjB,KAAK6gB,YACP7gB,KAAK6P,MACP,GACC7P,KAAKqF,QAAQkb,MAAM1Q,MACxB,CAEA2R,SACMxhB,KAAK+hB,yBAIT/hB,KAAK6gB,YAAa,EAElB7gB,KAAKijB,aAAY,KACVjjB,KAAK6gB,YACR7gB,KAAK4P,MACP,GACC5P,KAAKqF,QAAQkb,MAAM3Q,MACxB,CAEAqT,YAAYrlB,EAASslB,GACnBjW,aAAajN,KAAK4gB,UAClB5gB,KAAK4gB,SAAW/iB,WAAWD,EAASslB,EACtC,CAEAnB,uBACE,OAAOtkC,OAAO0hB,OAAOa,KAAK8gB,gBAAgB5mB,UAAS,EACrD,CAEAkK,WAAWC,GACT,MAAM8e,EAAiB5f,GAAYG,kBAAkB1D,KAAKoF,UAE1D,IAAK,MAAMge,KAAiB3lC,OAAO4D,KAAK8hC,GAClC7D,GAAsBloB,IAAIgsB,WACrBD,EAAeC,GAY1B,OARA/e,EAAS,IAAK8e,KACU,iBAAX9e,GAAuBA,EAASA,EAAS,CAAC,GAEvDA,EAASrE,KAAKsE,gBAAgBD,GAC9BA,EAASrE,KAAKuE,kBAAkBF,GAEhCrE,KAAKwE,iBAAiBH,GAEfA,CACT,CAEAE,kBAAkBF,GAkBhB,OAjBAA,EAAOgc,WAAiC,IAArBhc,EAAOgc,UAAsBv6B,SAAS6G,KAAOkO,GAAWwJ,EAAOgc,WAEtD,iBAAjBhc,EAAOkc,QAChBlc,EAAOkc,MAAQ,CACb1Q,KAAMxL,EAAOkc,MACb3Q,KAAMvL,EAAOkc,QAIW,iBAAjBlc,EAAOmc,QAChBnc,EAAOmc,MAAQnc,EAAOmc,MAAMlgC,YAGA,iBAAnB+jB,EAAOgZ,UAChBhZ,EAAOgZ,QAAUhZ,EAAOgZ,QAAQ/8B,YAG3B+jB,CACT,CAEAue,qBACE,MAAMve,EAAS,CAAC,EAEhB,IAAK,MAAM9mB,KAAOyiB,KAAKqF,QACjBrF,KAAK0E,YAAYT,QAAQ1mB,KAASyiB,KAAKqF,QAAQ9nB,KACjD8mB,EAAO9mB,GAAOyiB,KAAKqF,QAAQ9nB,IAS/B,OALA8mB,EAAOtK,UAAW,EAClBsK,EAAO5C,QAAU,SAIV4C,CACT,CAEAsd,iBACM3hB,KAAKoS,UACPpS,KAAKoS,QAAQ3Y,UAEbuG,KAAKoS,QAAU,MAGbpS,KAAKihB,MACPjhB,KAAKihB,IAAIle,SACT/C,KAAKihB,IAAM,KAEf,CAGApb,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAO41B,GAAQra,oBAAoBrG,KAAMqE,GAE/C,GAAsB,iBAAXA,EAAX,CAIA,QAA4B,IAAjBvZ,EAAKuZ,GACd,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IANL,CAOF,GACF,EAQFhI,GAAmBqkB,IAYnB,MAGM2C,GAAY,IAAK3C,GAAQzc,QAC7BoZ,QAAS,GACT50B,OAAQ,CAAC,EAAG,GACZtJ,UAAW,QACXs+B,SAAU,8IACVhc,QAAS,SAEL6hB,GAAgB,IAAK5C,GAAQxc,YACjCmZ,QAAS,kCAMX,MAAMkG,WAAgB7C,GAETzc,qBACT,OAAOof,EACT,CAEWnf,yBACT,OAAOof,EACT,CAEW7mB,kBACT,MA5BW,SA6Bb,CAGAmlB,iBACE,OAAO5hB,KAAKgiB,aAAehiB,KAAKwjB,aAClC,CAGAtB,yBACE,MAAO,CACL,kBAAkBliB,KAAKgiB,YACvB,gBAAoBhiB,KAAKwjB,cAE7B,CAEAA,cACE,OAAOxjB,KAAK+d,yBAAyB/d,KAAKqF,QAAQgY,QACpD,CAGAxX,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAOy4B,GAAQld,oBAAoBrG,KAAMqE,GAE/C,GAAsB,iBAAXA,EAAX,CAIA,QAA4B,IAAjBvZ,EAAKuZ,GACd,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IANL,CAOF,GACF,EAQFhI,GAAmBknB,IAYnB,MAEME,GAAc,gBAEdC,GAAiB,WAAWD,KAC5BE,GAAc,QAAQF,KACtBG,GAAwB,OAAOH,cAE/BI,GAAsB,SAEtBC,GAAwB,SAExBC,GAAqB,YAGrBC,GAAsB,GAAGD,mBAA+CA,uBAGxEE,GAAY,CAChBx7B,OAAQ,KAERy7B,WAAY,eACZC,cAAc,EACdn3B,OAAQ,KACRo3B,UAAW,CAAC,GAAK,GAAK,IAElBC,GAAgB,CACpB57B,OAAQ,gBAERy7B,WAAY,SACZC,aAAc,UACdn3B,OAAQ,UACRo3B,UAAW,SAMb,MAAME,WAAkBpf,GACtBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GAEfrE,KAAKukB,aAAe,IAAI5yB,IACxBqO,KAAKwkB,oBAAsB,IAAI7yB,IAC/BqO,KAAKykB,aAA6D,YAA9C/+B,iBAAiBsa,KAAKoF,UAAU3Y,UAA0B,KAAOuT,KAAKoF,SAC1FpF,KAAK0kB,cAAgB,KACrB1kB,KAAK2kB,UAAY,KACjB3kB,KAAK4kB,oBAAsB,CACzBC,gBAAiB,EACjBC,gBAAiB,GAEnB9kB,KAAK+kB,SACP,CAGW9gB,qBACT,OAAOggB,EACT,CAEW/f,yBACT,OAAOmgB,EACT,CAEW5nB,kBACT,MAhEW,WAiEb,CAGAsoB,UACE/kB,KAAKglB,mCAELhlB,KAAKilB,2BAEDjlB,KAAK2kB,UACP3kB,KAAK2kB,UAAUO,aAEfllB,KAAK2kB,UAAY3kB,KAAKmlB,kBAGxB,IAAK,MAAMC,KAAWplB,KAAKwkB,oBAAoBrlB,SAC7Ca,KAAK2kB,UAAUU,QAAQD,EAE3B,CAEA7f,UACEvF,KAAK2kB,UAAUO,aAEf/f,MAAMI,SACR,CAGAhB,kBAAkBF,GAUhB,OARAA,EAAOrX,OAAS6N,GAAWwJ,EAAOrX,SAAWlH,SAAS6G,KAEtD0X,EAAO6f,WAAa7f,EAAO5b,OAAS,GAAG4b,EAAO5b,oBAAsB4b,EAAO6f,WAE3C,iBAArB7f,EAAO+f,YAChB/f,EAAO+f,UAAY/f,EAAO+f,UAAUzhC,MAAM,KAAKY,KAAInF,GAASmf,OAAOC,WAAWpf,MAGzEimB,CACT,CAEA4gB,2BACOjlB,KAAKqF,QAAQ8e,eAKlB5jB,GAAaC,IAAIR,KAAKqF,QAAQrY,OAAQ22B,IACtCpjB,GAAaY,GAAGnB,KAAKqF,QAAQrY,OAAQ22B,GAAaG,IAAuB1kB,IACvE,MAAMkmB,EAAoBtlB,KAAKwkB,oBAAoB5mC,IAAIwhB,EAAMpS,OAAOtB,MAEpE,GAAI45B,EAAmB,CACrBlmB,EAAM+C,iBACN,MAAMtG,EAAOmE,KAAKykB,cAAgBpkC,OAC5BmE,EAAS8gC,EAAkBxgC,UAAYkb,KAAKoF,SAAStgB,UAE3D,GAAI+W,EAAK0pB,SAKP,YAJA1pB,EAAK0pB,SAAS,CACZnjC,IAAKoC,EACLghC,SAAU,WAMd3pB,EAAK3P,UAAY1H,CACnB,KAEJ,CAEA2gC,kBACE,MAAMjjC,EAAU,CACd2Z,KAAMmE,KAAKykB,aACXL,UAAWpkB,KAAKqF,QAAQ+e,UACxBF,WAAYlkB,KAAKqF,QAAQ6e,YAE3B,OAAO,IAAIuB,sBAAqBpjB,GAAWrC,KAAK0lB,kBAAkBrjB,IAAUngB,EAC9E,CAGAwjC,kBAAkBrjB,GAChB,MAAMsjB,EAAgB/H,GAAS5d,KAAKukB,aAAa3mC,IAAI,IAAIggC,EAAM5wB,OAAO44B,MAEhE3O,EAAW2G,IACf5d,KAAK4kB,oBAAoBC,gBAAkBjH,EAAM5wB,OAAOlI,UAExDkb,KAAK6lB,SAASF,EAAc/H,GAAO,EAG/BkH,GAAmB9kB,KAAKykB,cAAgB3+B,SAASC,iBAAiBmG,UAClE45B,EAAkBhB,GAAmB9kB,KAAK4kB,oBAAoBE,gBACpE9kB,KAAK4kB,oBAAoBE,gBAAkBA,EAE3C,IAAK,MAAMlH,KAASvb,EAAS,CAC3B,IAAKub,EAAMmI,eAAgB,CACzB/lB,KAAK0kB,cAAgB,KAErB1kB,KAAKgmB,kBAAkBL,EAAc/H,IAErC,QACF,CAEA,MAAMqI,EAA2BrI,EAAM5wB,OAAOlI,WAAakb,KAAK4kB,oBAAoBC,gBAEpF,GAAIiB,GAAmBG,GAGrB,GAFAhP,EAAS2G,IAEJkH,EACH,YAOCgB,GAAoBG,GACvBhP,EAAS2G,EAEb,CACF,CAEAoH,mCACEhlB,KAAKukB,aAAe,IAAI5yB,IACxBqO,KAAKwkB,oBAAsB,IAAI7yB,IAC/B,MAAMu0B,EAAcjf,GAAerU,KAAKkxB,GAAuB9jB,KAAKqF,QAAQrY,QAE5E,IAAK,MAAMm5B,KAAUD,EAAa,CAEhC,IAAKC,EAAOz6B,MAAQ2P,GAAW8qB,GAC7B,SAGF,MAAMb,EAAoBre,GAAeC,QAAQif,EAAOz6B,KAAMsU,KAAKoF,UAE/DtK,GAAUwqB,KACZtlB,KAAKukB,aAAa/xB,IAAI2zB,EAAOz6B,KAAMy6B,GAEnCnmB,KAAKwkB,oBAAoBhyB,IAAI2zB,EAAOz6B,KAAM45B,GAE9C,CACF,CAEAO,SAAS74B,GACHgT,KAAK0kB,gBAAkB13B,IAI3BgT,KAAKgmB,kBAAkBhmB,KAAKqF,QAAQrY,QAEpCgT,KAAK0kB,cAAgB13B,EACrBA,EAAOwO,UAAUtE,IAAI2sB,IAErB7jB,KAAKomB,iBAAiBp5B,GAEtBuT,GAAakB,QAAQzB,KAAKoF,SAAUse,GAAgB,CAClD5jB,cAAe9S,IAEnB,CAEAo5B,iBAAiBp5B,GAEf,GAAIA,EAAOwO,UAAUvW,SAzNQ,iBA0N3BgiB,GAAeC,QAhNc,mBAgNsBla,EAAOmO,QAjNtC,cAiNkEK,UAAUtE,IAAI2sB,SAItG,IAAK,MAAMwC,KAAapf,GAAeI,QAAQra,EA1NnB,qBA6N1B,IAAK,MAAMxJ,KAAQyjB,GAAeM,KAAK8e,EAAWrC,IAChDxgC,EAAKgY,UAAUtE,IAAI2sB,GAGzB,CAEAmC,kBAAkB9gC,GAChBA,EAAOsW,UAAUuH,OAAO8gB,IACxB,MAAMyC,EAAcrf,GAAerU,KAAK,GAAGkxB,MAAyBD,KAAuB3+B,GAE3F,IAAK,MAAM9E,KAAQkmC,EACjBlmC,EAAKob,UAAUuH,OAAO8gB,GAE1B,CAGAhe,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAOw5B,GAAUje,oBAAoBrG,KAAMqE,GAEjD,GAAsB,iBAAXA,EAAX,CAIA,QAAqB7K,IAAjB1O,EAAKuZ,IAAyBA,EAAOlK,WAAW,MAAmB,gBAAXkK,EAC1D,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IANL,CAOF,GACF,EAQF9D,GAAaY,GAAG9gB,OAAQujC,IAAuB,KAC7C,IAAK,MAAM2C,KAAOtf,GAAerU,KAtQT,0BAuQtB0xB,GAAUje,oBAAoBkgB,EAChC,IAMFlqB,GAAmBioB,IAYnB,MAEMkC,GAAc,UACdC,GAAe,OAAOD,KACtBE,GAAiB,SAASF,KAC1BG,GAAe,OAAOH,KACtBI,GAAgB,QAAQJ,KACxBK,GAAuB,QAAQL,KAC/BM,GAAgB,UAAUN,KAC1BO,GAAsB,OAAOP,KAC7BQ,GAAiB,YACjBC,GAAkB,aAClBC,GAAe,UACfC,GAAiB,YACjBC,GAAoB,SACpBC,GAAoB,OACpBC,GAAoB,OAIpBC,GAA+B,yBAI/BC,GAAuB,2EAEvBC,GAAsB,YAHOF,uBAAiDA,mBAA6CA,OAG/EC,KAC5CE,GAA8B,IAAIN,8BAA6CA,+BAA8CA,4BAKnI,MAAMO,WAAYziB,GAChBR,YAAY1kB,GACVmlB,MAAMnlB,GACNggB,KAAKqS,QAAUrS,KAAKoF,SAASjK,QAdN,uCAgBlB6E,KAAKqS,UAMVrS,KAAK4nB,sBAAsB5nB,KAAKqS,QAASrS,KAAK6nB,gBAE9CtnB,GAAaY,GAAGnB,KAAKoF,SAAU0hB,IAAe1nB,GAASY,KAAK4M,SAASxN,KACvE,CAGW3C,kBACT,MAlDW,KAmDb,CAGAoT,OAEE,MAAMiY,EAAY9nB,KAAKoF,SAEvB,GAAIpF,KAAK+nB,cAAcD,GACrB,OAIF,MAAME,EAAShoB,KAAKioB,iBAEdC,EAAYF,EAASznB,GAAakB,QAAQumB,EAAQvB,GAAc,CACpE3mB,cAAegoB,IACZ,KACavnB,GAAakB,QAAQqmB,EAAWnB,GAAc,CAC9D7mB,cAAekoB,IAGHnmB,kBAAoBqmB,GAAaA,EAAUrmB,mBAIzD7B,KAAKmoB,YAAYH,EAAQF,GAEzB9nB,KAAKooB,UAAUN,EAAWE,GAC5B,CAGAI,UAAUpoC,EAASqoC,GACZroC,IAILA,EAAQwb,UAAUtE,IAAIkwB,IAEtBpnB,KAAKooB,UAAU9tB,GAAuBta,IAmBtCggB,KAAK2F,gBAhBY,KACsB,QAAjC3lB,EAAQga,aAAa,SAKzBha,EAAQ4B,gBAAgB,YACxB5B,EAAQ6B,aAAa,iBAAiB,GAEtCme,KAAKsoB,gBAAgBtoC,GAAS,GAE9BugB,GAAakB,QAAQzhB,EAAS4mC,GAAe,CAC3C9mB,cAAeuoB,KAVfroC,EAAQwb,UAAUtE,IAAIowB,GAWtB,GAG0BtnC,EAASA,EAAQwb,UAAUvW,SAASoiC,KACpE,CAEAc,YAAYnoC,EAASqoC,GACdroC,IAILA,EAAQwb,UAAUuH,OAAOqkB,IACzBpnC,EAAQ+6B,OAER/a,KAAKmoB,YAAY7tB,GAAuBta,IAmBxCggB,KAAK2F,gBAhBY,KACsB,QAAjC3lB,EAAQga,aAAa,SAKzBha,EAAQ6B,aAAa,iBAAiB,GACtC7B,EAAQ6B,aAAa,WAAY,MAEjCme,KAAKsoB,gBAAgBtoC,GAAS,GAE9BugB,GAAakB,QAAQzhB,EAAS0mC,GAAgB,CAC5C5mB,cAAeuoB,KAVfroC,EAAQwb,UAAUuH,OAAOukB,GAWzB,GAG0BtnC,EAASA,EAAQwb,UAAUvW,SAASoiC,KACpE,CAEAza,SAASxN,GACP,IAAK,CAAC4nB,GAAgBC,GAAiBC,GAAcC,IAAgBjtB,SAASkF,EAAM7hB,KAClF,OAGF6hB,EAAMyU,kBAENzU,EAAM+C,iBACN,MAAMoL,EAAS,CAAC0Z,GAAiBE,IAAgBjtB,SAASkF,EAAM7hB,KAC1DgrC,EAAoBzqB,GAAqBkC,KAAK6nB,eAAejhC,QAAO5G,IAAYqb,GAAWrb,KAAWof,EAAMpS,OAAQugB,GAAQ,GAE9Hgb,IACFA,EAAkB7V,MAAM,CACtB8V,eAAe,IAEjBb,GAAIthB,oBAAoBkiB,GAAmB1Y,OAE/C,CAEAgY,eAEE,OAAO5gB,GAAerU,KAAK60B,GAAqBznB,KAAKqS,QACvD,CAEA4V,iBACE,OAAOjoB,KAAK6nB,eAAej1B,MAAKzN,GAAS6a,KAAK+nB,cAAc5iC,MAAW,IACzE,CAEAyiC,sBAAsB1iC,EAAQiiB,GAC5BnH,KAAKyoB,yBAAyBvjC,EAAQ,OAAQ,WAE9C,IAAK,MAAMC,KAASgiB,EAClBnH,KAAK0oB,6BAA6BvjC,EAEtC,CAEAujC,6BAA6BvjC,GAC3BA,EAAQ6a,KAAK2oB,iBAAiBxjC,GAE9B,MAAMyjC,EAAW5oB,KAAK+nB,cAAc5iC,GAE9B0jC,EAAY7oB,KAAK8oB,iBAAiB3jC,GAExCA,EAAMtD,aAAa,gBAAiB+mC,GAEhCC,IAAc1jC,GAChB6a,KAAKyoB,yBAAyBI,EAAW,OAAQ,gBAG9CD,GACHzjC,EAAMtD,aAAa,WAAY,MAGjCme,KAAKyoB,yBAAyBtjC,EAAO,OAAQ,OAG7C6a,KAAK+oB,mCAAmC5jC,EAC1C,CAEA4jC,mCAAmC5jC,GACjC,MAAM6H,EAASsN,GAAuBnV,GAEjC6H,IAILgT,KAAKyoB,yBAAyBz7B,EAAQ,OAAQ,YAE1C7H,EAAMygC,IACR5lB,KAAKyoB,yBAAyBz7B,EAAQ,kBAAmB,IAAI7H,EAAMygC,MAEvE,CAEA0C,gBAAgBtoC,EAASgpC,GACvB,MAAMH,EAAY7oB,KAAK8oB,iBAAiB9oC,GAExC,IAAK6oC,EAAUrtB,UAAUvW,SAxMN,YAyMjB,OAGF,MAAM8hB,EAAS,CAAChN,EAAU2b,KACxB,MAAM11B,EAAUinB,GAAeC,QAAQnN,EAAU8uB,GAE7C7oC,GACFA,EAAQwb,UAAUuL,OAAO2O,EAAWsT,EACtC,EAGFjiB,EAnN6B,mBAmNIqgB,IACjCrgB,EAnN2B,iBAmNIugB,IAC/BuB,EAAUhnC,aAAa,gBAAiBmnC,EAC1C,CAEAP,yBAAyBzoC,EAASwC,EAAWpE,GACtC4B,EAAQ0b,aAAalZ,IACxBxC,EAAQ6B,aAAaW,EAAWpE,EAEpC,CAEA2pC,cAAczY,GACZ,OAAOA,EAAK9T,UAAUvW,SAASmiC,GACjC,CAGAuB,iBAAiBrZ,GACf,OAAOA,EAAKlI,QAAQqgB,IAAuBnY,EAAOrI,GAAeC,QAAQugB,GAAqBnY,EAChG,CAGAwZ,iBAAiBxZ,GACf,OAAOA,EAAKnU,QArOO,gCAqOoBmU,CACzC,CAGAzJ,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAO68B,GAAIthB,oBAAoBrG,MAErC,GAAsB,iBAAXqE,EAAX,CAIA,QAAqB7K,IAAjB1O,EAAKuZ,IAAyBA,EAAOlK,WAAW,MAAmB,gBAAXkK,EAC1D,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,IANL,CAOF,GACF,EAQF9D,GAAaY,GAAGrb,SAAU+gC,GAAsBW,IAAsB,SAAUpoB,GAC1E,CAAC,IAAK,QAAQlF,SAAS8F,KAAKoG,UAC9BhH,EAAM+C,iBAGJ9G,GAAW2E,OAIf2nB,GAAIthB,oBAAoBrG,MAAM6P,MAChC,IAKAtP,GAAaY,GAAG9gB,OAAQ0mC,IAAqB,KAC3C,IAAK,MAAM/mC,KAAWinB,GAAerU,KAAK80B,IACxCC,GAAIthB,oBAAoBrmB,EAC1B,IAMFqc,GAAmBsrB,IAYnB,MAEMniB,GAAY,YACZyjB,GAAkB,YAAYzjB,KAC9B0jB,GAAiB,WAAW1jB,KAC5B2jB,GAAgB,UAAU3jB,KAC1B4jB,GAAiB,WAAW5jB,KAC5B6jB,GAAa,OAAO7jB,KACpB8jB,GAAe,SAAS9jB,KACxB+jB,GAAa,OAAO/jB,KACpBgkB,GAAc,QAAQhkB,KAEtBikB,GAAkB,OAElBC,GAAkB,OAClBC,GAAqB,UACrBzlB,GAAc,CAClBkc,UAAW,UACXwJ,SAAU,UACVrJ,MAAO,UAEHtc,GAAU,CACdmc,WAAW,EACXwJ,UAAU,EACVrJ,MAAO,KAMT,MAAMsJ,WAAc3kB,GAClBR,YAAY1kB,EAASqkB,GACnBc,MAAMnlB,EAASqkB,GACfrE,KAAK4gB,SAAW,KAChB5gB,KAAK8pB,sBAAuB,EAC5B9pB,KAAK+pB,yBAA0B,EAE/B/pB,KAAKkhB,eACP,CAGWjd,qBACT,OAAOA,EACT,CAEWC,yBACT,OAAOA,EACT,CAEWzH,kBACT,MAlDS,OAmDX,CAGAoT,OACoBtP,GAAakB,QAAQzB,KAAKoF,SAAUmkB,IAExC1nB,mBAId7B,KAAKgqB,gBAEDhqB,KAAKqF,QAAQ+a,WACfpgB,KAAKoF,SAAS5J,UAAUtE,IArDN,QAgEpB8I,KAAKoF,SAAS5J,UAAUuH,OAAO0mB,IAG/B1tB,GAAOiE,KAAKoF,UAEZpF,KAAKoF,SAAS5J,UAAUtE,IAAIwyB,GAAiBC,IAE7C3pB,KAAK2F,gBAfY,KACf3F,KAAKoF,SAAS5J,UAAUuH,OAAO4mB,IAE/BppB,GAAakB,QAAQzB,KAAKoF,SAAUokB,IAEpCxpB,KAAKiqB,oBAAoB,GAUGjqB,KAAKoF,SAAUpF,KAAKqF,QAAQ+a,WAC5D,CAEAxQ,OACO5P,KAAKkqB,YAIQ3pB,GAAakB,QAAQzB,KAAKoF,SAAUikB,IAExCxnB,mBAad7B,KAAKoF,SAAS5J,UAAUtE,IAAIyyB,IAE5B3pB,KAAK2F,gBAXY,KACf3F,KAAKoF,SAAS5J,UAAUtE,IAAIuyB,IAG5BzpB,KAAKoF,SAAS5J,UAAUuH,OAAO4mB,GAAoBD,IAEnDnpB,GAAakB,QAAQzB,KAAKoF,SAAUkkB,GAAa,GAKrBtpB,KAAKoF,SAAUpF,KAAKqF,QAAQ+a,YAC5D,CAEA7a,UACEvF,KAAKgqB,gBAEDhqB,KAAKkqB,WACPlqB,KAAKoF,SAAS5J,UAAUuH,OAAO2mB,IAGjCvkB,MAAMI,SACR,CAEA2kB,UACE,OAAOlqB,KAAKoF,SAAS5J,UAAUvW,SAASykC,GAC1C,CAGAO,qBACOjqB,KAAKqF,QAAQukB,WAId5pB,KAAK8pB,sBAAwB9pB,KAAK+pB,0BAItC/pB,KAAK4gB,SAAW/iB,YAAW,KACzBmC,KAAK4P,MAAM,GACV5P,KAAKqF,QAAQkb,QAClB,CAEA4J,eAAe/qB,EAAOgrB,GACpB,OAAQhrB,EAAMqB,MACZ,IAAK,YACL,IAAK,WAEDT,KAAK8pB,qBAAuBM,EAC5B,MAGJ,IAAK,UACL,IAAK,WAEDpqB,KAAK+pB,wBAA0BK,EAKrC,GAAIA,EAGF,YAFApqB,KAAKgqB,gBAKP,MAAMxc,EAAcpO,EAAMU,cAEtBE,KAAKoF,WAAaoI,GAAexN,KAAKoF,SAASngB,SAASuoB,IAI5DxN,KAAKiqB,oBACP,CAEA/I,gBACE3gB,GAAaY,GAAGnB,KAAKoF,SAAU6jB,IAAiB7pB,GAASY,KAAKmqB,eAAe/qB,GAAO,KACpFmB,GAAaY,GAAGnB,KAAKoF,SAAU8jB,IAAgB9pB,GAASY,KAAKmqB,eAAe/qB,GAAO,KACnFmB,GAAaY,GAAGnB,KAAKoF,SAAU+jB,IAAe/pB,GAASY,KAAKmqB,eAAe/qB,GAAO,KAClFmB,GAAaY,GAAGnB,KAAKoF,SAAUgkB,IAAgBhqB,GAASY,KAAKmqB,eAAe/qB,GAAO,IACrF,CAEA4qB,gBACE/c,aAAajN,KAAK4gB,UAClB5gB,KAAK4gB,SAAW,IAClB,CAGA/a,uBAAuBxB,GACrB,OAAOrE,KAAK4G,MAAK,WACf,MAAM9b,EAAO++B,GAAMxjB,oBAAoBrG,KAAMqE,GAE7C,GAAsB,iBAAXA,EAAqB,CAC9B,QAA4B,IAAjBvZ,EAAKuZ,GACd,MAAM,IAAIW,UAAU,oBAAoBX,MAG1CvZ,EAAKuZ,GAAQrE,KACf,CACF,GACF,ECxjKK,IAAuBzD,GDgkK9ByJ,GAAqB6jB,IAKrBxtB,GAAmBwtB,ICrkKWttB,GCK9B,WAC2B,GAAG1J,MAAM5U,KAChC6H,SAASsa,iBAAiB,+BAET7c,KAAI,SAAU8mC,GAC/B,OAAO,IAAI3J,GAAQ2J,EAAkB,CAAE9J,MAAO,CAAE1Q,KAAM,IAAKD,KAAM,MACnE,GACF,EDX6B,WAAvB9pB,SAASgX,WAAyBP,KACjCzW,SAASyF,iBAAiB,mBAAoBgR","sources":["webpack://pydata_sphinx_theme/webpack/bootstrap","webpack://pydata_sphinx_theme/webpack/runtime/define property getters","webpack://pydata_sphinx_theme/webpack/runtime/hasOwnProperty shorthand","webpack://pydata_sphinx_theme/webpack/runtime/make namespace object","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/enums.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getNodeName.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getWindow.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/instanceOf.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/applyStyles.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getBasePlacement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/math.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/userAgent.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/isLayoutViewport.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getBoundingClientRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getLayoutRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/contains.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getComputedStyle.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/isTableElement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getDocumentElement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getParentNode.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getOffsetParent.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getMainAxisFromPlacement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/within.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/mergePaddingObject.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getFreshSideObject.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/expandToHashMap.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/arrow.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getVariation.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/computeStyles.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/eventListeners.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getOppositePlacement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getOppositeVariationPlacement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getWindowScroll.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getWindowScrollBarX.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/isScrollParent.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getScrollParent.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/listScrollParents.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/rectToClientRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getClippingRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getViewportRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getDocumentRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/computeOffsets.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/detectOverflow.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/flip.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/computeAutoPlacement.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/hide.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/offset.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/popperOffsets.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/modifiers/preventOverflow.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/getAltAxis.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getCompositeRect.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getNodeScroll.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/dom-utils/getHTMLElementScroll.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/orderModifiers.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/createPopper.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/debounce.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/utils/mergeByName.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/popper.js","webpack://pydata_sphinx_theme/./node_modules/@popperjs/core/lib/popper-lite.js","webpack://pydata_sphinx_theme/./node_modules/bootstrap/dist/js/bootstrap.esm.js","webpack://pydata_sphinx_theme/./src/pydata_sphinx_theme/assets/scripts/mixin.js","webpack://pydata_sphinx_theme/./src/pydata_sphinx_theme/assets/scripts/bootstrap.js"],"sourcesContent":["// The require scope\nvar __webpack_require__ = {};\n\n","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","// define __esModule on exports\n__webpack_require__.r = (exports) => {\n\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n\t}\n\tObject.defineProperty(exports, '__esModule', { value: true });\n};","export var top = 'top';\nexport var bottom = 'bottom';\nexport var right = 'right';\nexport var left = 'left';\nexport var auto = 'auto';\nexport var basePlacements = [top, bottom, right, left];\nexport var start = 'start';\nexport var end = 'end';\nexport var clippingParents = 'clippingParents';\nexport var viewport = 'viewport';\nexport var popper = 'popper';\nexport var reference = 'reference';\nexport var variationPlacements = /*#__PURE__*/basePlacements.reduce(function (acc, placement) {\n return acc.concat([placement + \"-\" + start, placement + \"-\" + end]);\n}, []);\nexport var placements = /*#__PURE__*/[].concat(basePlacements, [auto]).reduce(function (acc, placement) {\n return acc.concat([placement, placement + \"-\" + start, placement + \"-\" + end]);\n}, []); // modifiers that need to read the DOM\n\nexport var beforeRead = 'beforeRead';\nexport var read = 'read';\nexport var afterRead = 'afterRead'; // pure-logic modifiers\n\nexport var beforeMain = 'beforeMain';\nexport var main = 'main';\nexport var afterMain = 'afterMain'; // modifier with the purpose to write to the DOM (or write into a framework state)\n\nexport var beforeWrite = 'beforeWrite';\nexport var write = 'write';\nexport var afterWrite = 'afterWrite';\nexport var modifierPhases = [beforeRead, read, afterRead, beforeMain, main, afterMain, beforeWrite, write, afterWrite];","export default function getNodeName(element) {\n return element ? (element.nodeName || '').toLowerCase() : null;\n}","export default function getWindow(node) {\n if (node == null) {\n return window;\n }\n\n if (node.toString() !== '[object Window]') {\n var ownerDocument = node.ownerDocument;\n return ownerDocument ? ownerDocument.defaultView || window : window;\n }\n\n return node;\n}","import getWindow from \"./getWindow.js\";\n\nfunction isElement(node) {\n var OwnElement = getWindow(node).Element;\n return node instanceof OwnElement || node instanceof Element;\n}\n\nfunction isHTMLElement(node) {\n var OwnElement = getWindow(node).HTMLElement;\n return node instanceof OwnElement || node instanceof HTMLElement;\n}\n\nfunction isShadowRoot(node) {\n // IE 11 has no ShadowRoot\n if (typeof ShadowRoot === 'undefined') {\n return false;\n }\n\n var OwnElement = getWindow(node).ShadowRoot;\n return node instanceof OwnElement || node instanceof ShadowRoot;\n}\n\nexport { isElement, isHTMLElement, isShadowRoot };","import getNodeName from \"../dom-utils/getNodeName.js\";\nimport { isHTMLElement } from \"../dom-utils/instanceOf.js\"; // This modifier takes the styles prepared by the `computeStyles` modifier\n// and applies them to the HTMLElements such as popper and arrow\n\nfunction applyStyles(_ref) {\n var state = _ref.state;\n Object.keys(state.elements).forEach(function (name) {\n var style = state.styles[name] || {};\n var attributes = state.attributes[name] || {};\n var element = state.elements[name]; // arrow is optional + virtual elements\n\n if (!isHTMLElement(element) || !getNodeName(element)) {\n return;\n } // Flow doesn't support to extend this property, but it's the most\n // effective way to apply styles to an HTMLElement\n // $FlowFixMe[cannot-write]\n\n\n Object.assign(element.style, style);\n Object.keys(attributes).forEach(function (name) {\n var value = attributes[name];\n\n if (value === false) {\n element.removeAttribute(name);\n } else {\n element.setAttribute(name, value === true ? '' : value);\n }\n });\n });\n}\n\nfunction effect(_ref2) {\n var state = _ref2.state;\n var initialStyles = {\n popper: {\n position: state.options.strategy,\n left: '0',\n top: '0',\n margin: '0'\n },\n arrow: {\n position: 'absolute'\n },\n reference: {}\n };\n Object.assign(state.elements.popper.style, initialStyles.popper);\n state.styles = initialStyles;\n\n if (state.elements.arrow) {\n Object.assign(state.elements.arrow.style, initialStyles.arrow);\n }\n\n return function () {\n Object.keys(state.elements).forEach(function (name) {\n var element = state.elements[name];\n var attributes = state.attributes[name] || {};\n var styleProperties = Object.keys(state.styles.hasOwnProperty(name) ? state.styles[name] : initialStyles[name]); // Set all values to an empty string to unset them\n\n var style = styleProperties.reduce(function (style, property) {\n style[property] = '';\n return style;\n }, {}); // arrow is optional + virtual elements\n\n if (!isHTMLElement(element) || !getNodeName(element)) {\n return;\n }\n\n Object.assign(element.style, style);\n Object.keys(attributes).forEach(function (attribute) {\n element.removeAttribute(attribute);\n });\n });\n };\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'applyStyles',\n enabled: true,\n phase: 'write',\n fn: applyStyles,\n effect: effect,\n requires: ['computeStyles']\n};","import { auto } from \"../enums.js\";\nexport default function getBasePlacement(placement) {\n return placement.split('-')[0];\n}","export var max = Math.max;\nexport var min = Math.min;\nexport var round = Math.round;","export default function getUAString() {\n var uaData = navigator.userAgentData;\n\n if (uaData != null && uaData.brands && Array.isArray(uaData.brands)) {\n return uaData.brands.map(function (item) {\n return item.brand + \"/\" + item.version;\n }).join(' ');\n }\n\n return navigator.userAgent;\n}","import getUAString from \"../utils/userAgent.js\";\nexport default function isLayoutViewport() {\n return !/^((?!chrome|android).)*safari/i.test(getUAString());\n}","import { isElement, isHTMLElement } from \"./instanceOf.js\";\nimport { round } from \"../utils/math.js\";\nimport getWindow from \"./getWindow.js\";\nimport isLayoutViewport from \"./isLayoutViewport.js\";\nexport default function getBoundingClientRect(element, includeScale, isFixedStrategy) {\n if (includeScale === void 0) {\n includeScale = false;\n }\n\n if (isFixedStrategy === void 0) {\n isFixedStrategy = false;\n }\n\n var clientRect = element.getBoundingClientRect();\n var scaleX = 1;\n var scaleY = 1;\n\n if (includeScale && isHTMLElement(element)) {\n scaleX = element.offsetWidth > 0 ? round(clientRect.width) / element.offsetWidth || 1 : 1;\n scaleY = element.offsetHeight > 0 ? round(clientRect.height) / element.offsetHeight || 1 : 1;\n }\n\n var _ref = isElement(element) ? getWindow(element) : window,\n visualViewport = _ref.visualViewport;\n\n var addVisualOffsets = !isLayoutViewport() && isFixedStrategy;\n var x = (clientRect.left + (addVisualOffsets && visualViewport ? visualViewport.offsetLeft : 0)) / scaleX;\n var y = (clientRect.top + (addVisualOffsets && visualViewport ? visualViewport.offsetTop : 0)) / scaleY;\n var width = clientRect.width / scaleX;\n var height = clientRect.height / scaleY;\n return {\n width: width,\n height: height,\n top: y,\n right: x + width,\n bottom: y + height,\n left: x,\n x: x,\n y: y\n };\n}","import getBoundingClientRect from \"./getBoundingClientRect.js\"; // Returns the layout rect of an element relative to its offsetParent. Layout\n// means it doesn't take into account transforms.\n\nexport default function getLayoutRect(element) {\n var clientRect = getBoundingClientRect(element); // Use the clientRect sizes if it's not been transformed.\n // Fixes https://github.com/popperjs/popper-core/issues/1223\n\n var width = element.offsetWidth;\n var height = element.offsetHeight;\n\n if (Math.abs(clientRect.width - width) <= 1) {\n width = clientRect.width;\n }\n\n if (Math.abs(clientRect.height - height) <= 1) {\n height = clientRect.height;\n }\n\n return {\n x: element.offsetLeft,\n y: element.offsetTop,\n width: width,\n height: height\n };\n}","import { isShadowRoot } from \"./instanceOf.js\";\nexport default function contains(parent, child) {\n var rootNode = child.getRootNode && child.getRootNode(); // First, attempt with faster native method\n\n if (parent.contains(child)) {\n return true;\n } // then fallback to custom implementation with Shadow DOM support\n else if (rootNode && isShadowRoot(rootNode)) {\n var next = child;\n\n do {\n if (next && parent.isSameNode(next)) {\n return true;\n } // $FlowFixMe[prop-missing]: need a better way to handle this...\n\n\n next = next.parentNode || next.host;\n } while (next);\n } // Give up, the result is false\n\n\n return false;\n}","import getWindow from \"./getWindow.js\";\nexport default function getComputedStyle(element) {\n return getWindow(element).getComputedStyle(element);\n}","import getNodeName from \"./getNodeName.js\";\nexport default function isTableElement(element) {\n return ['table', 'td', 'th'].indexOf(getNodeName(element)) >= 0;\n}","import { isElement } from \"./instanceOf.js\";\nexport default function getDocumentElement(element) {\n // $FlowFixMe[incompatible-return]: assume body is always available\n return ((isElement(element) ? element.ownerDocument : // $FlowFixMe[prop-missing]\n element.document) || window.document).documentElement;\n}","import getNodeName from \"./getNodeName.js\";\nimport getDocumentElement from \"./getDocumentElement.js\";\nimport { isShadowRoot } from \"./instanceOf.js\";\nexport default function getParentNode(element) {\n if (getNodeName(element) === 'html') {\n return element;\n }\n\n return (// this is a quicker (but less type safe) way to save quite some bytes from the bundle\n // $FlowFixMe[incompatible-return]\n // $FlowFixMe[prop-missing]\n element.assignedSlot || // step into the shadow DOM of the parent of a slotted node\n element.parentNode || ( // DOM Element detected\n isShadowRoot(element) ? element.host : null) || // ShadowRoot detected\n // $FlowFixMe[incompatible-call]: HTMLElement is a Node\n getDocumentElement(element) // fallback\n\n );\n}","import getWindow from \"./getWindow.js\";\nimport getNodeName from \"./getNodeName.js\";\nimport getComputedStyle from \"./getComputedStyle.js\";\nimport { isHTMLElement, isShadowRoot } from \"./instanceOf.js\";\nimport isTableElement from \"./isTableElement.js\";\nimport getParentNode from \"./getParentNode.js\";\nimport getUAString from \"../utils/userAgent.js\";\n\nfunction getTrueOffsetParent(element) {\n if (!isHTMLElement(element) || // https://github.com/popperjs/popper-core/issues/837\n getComputedStyle(element).position === 'fixed') {\n return null;\n }\n\n return element.offsetParent;\n} // `.offsetParent` reports `null` for fixed elements, while absolute elements\n// return the containing block\n\n\nfunction getContainingBlock(element) {\n var isFirefox = /firefox/i.test(getUAString());\n var isIE = /Trident/i.test(getUAString());\n\n if (isIE && isHTMLElement(element)) {\n // In IE 9, 10 and 11 fixed elements containing block is always established by the viewport\n var elementCss = getComputedStyle(element);\n\n if (elementCss.position === 'fixed') {\n return null;\n }\n }\n\n var currentNode = getParentNode(element);\n\n if (isShadowRoot(currentNode)) {\n currentNode = currentNode.host;\n }\n\n while (isHTMLElement(currentNode) && ['html', 'body'].indexOf(getNodeName(currentNode)) < 0) {\n var css = getComputedStyle(currentNode); // This is non-exhaustive but covers the most common CSS properties that\n // create a containing block.\n // https://developer.mozilla.org/en-US/docs/Web/CSS/Containing_block#identifying_the_containing_block\n\n if (css.transform !== 'none' || css.perspective !== 'none' || css.contain === 'paint' || ['transform', 'perspective'].indexOf(css.willChange) !== -1 || isFirefox && css.willChange === 'filter' || isFirefox && css.filter && css.filter !== 'none') {\n return currentNode;\n } else {\n currentNode = currentNode.parentNode;\n }\n }\n\n return null;\n} // Gets the closest ancestor positioned element. Handles some edge cases,\n// such as table ancestors and cross browser bugs.\n\n\nexport default function getOffsetParent(element) {\n var window = getWindow(element);\n var offsetParent = getTrueOffsetParent(element);\n\n while (offsetParent && isTableElement(offsetParent) && getComputedStyle(offsetParent).position === 'static') {\n offsetParent = getTrueOffsetParent(offsetParent);\n }\n\n if (offsetParent && (getNodeName(offsetParent) === 'html' || getNodeName(offsetParent) === 'body' && getComputedStyle(offsetParent).position === 'static')) {\n return window;\n }\n\n return offsetParent || getContainingBlock(element) || window;\n}","export default function getMainAxisFromPlacement(placement) {\n return ['top', 'bottom'].indexOf(placement) >= 0 ? 'x' : 'y';\n}","import { max as mathMax, min as mathMin } from \"./math.js\";\nexport function within(min, value, max) {\n return mathMax(min, mathMin(value, max));\n}\nexport function withinMaxClamp(min, value, max) {\n var v = within(min, value, max);\n return v > max ? max : v;\n}","import getFreshSideObject from \"./getFreshSideObject.js\";\nexport default function mergePaddingObject(paddingObject) {\n return Object.assign({}, getFreshSideObject(), paddingObject);\n}","export default function getFreshSideObject() {\n return {\n top: 0,\n right: 0,\n bottom: 0,\n left: 0\n };\n}","export default function expandToHashMap(value, keys) {\n return keys.reduce(function (hashMap, key) {\n hashMap[key] = value;\n return hashMap;\n }, {});\n}","import getBasePlacement from \"../utils/getBasePlacement.js\";\nimport getLayoutRect from \"../dom-utils/getLayoutRect.js\";\nimport contains from \"../dom-utils/contains.js\";\nimport getOffsetParent from \"../dom-utils/getOffsetParent.js\";\nimport getMainAxisFromPlacement from \"../utils/getMainAxisFromPlacement.js\";\nimport { within } from \"../utils/within.js\";\nimport mergePaddingObject from \"../utils/mergePaddingObject.js\";\nimport expandToHashMap from \"../utils/expandToHashMap.js\";\nimport { left, right, basePlacements, top, bottom } from \"../enums.js\";\nimport { isHTMLElement } from \"../dom-utils/instanceOf.js\"; // eslint-disable-next-line import/no-unused-modules\n\nvar toPaddingObject = function toPaddingObject(padding, state) {\n padding = typeof padding === 'function' ? padding(Object.assign({}, state.rects, {\n placement: state.placement\n })) : padding;\n return mergePaddingObject(typeof padding !== 'number' ? padding : expandToHashMap(padding, basePlacements));\n};\n\nfunction arrow(_ref) {\n var _state$modifiersData$;\n\n var state = _ref.state,\n name = _ref.name,\n options = _ref.options;\n var arrowElement = state.elements.arrow;\n var popperOffsets = state.modifiersData.popperOffsets;\n var basePlacement = getBasePlacement(state.placement);\n var axis = getMainAxisFromPlacement(basePlacement);\n var isVertical = [left, right].indexOf(basePlacement) >= 0;\n var len = isVertical ? 'height' : 'width';\n\n if (!arrowElement || !popperOffsets) {\n return;\n }\n\n var paddingObject = toPaddingObject(options.padding, state);\n var arrowRect = getLayoutRect(arrowElement);\n var minProp = axis === 'y' ? top : left;\n var maxProp = axis === 'y' ? bottom : right;\n var endDiff = state.rects.reference[len] + state.rects.reference[axis] - popperOffsets[axis] - state.rects.popper[len];\n var startDiff = popperOffsets[axis] - state.rects.reference[axis];\n var arrowOffsetParent = getOffsetParent(arrowElement);\n var clientSize = arrowOffsetParent ? axis === 'y' ? arrowOffsetParent.clientHeight || 0 : arrowOffsetParent.clientWidth || 0 : 0;\n var centerToReference = endDiff / 2 - startDiff / 2; // Make sure the arrow doesn't overflow the popper if the center point is\n // outside of the popper bounds\n\n var min = paddingObject[minProp];\n var max = clientSize - arrowRect[len] - paddingObject[maxProp];\n var center = clientSize / 2 - arrowRect[len] / 2 + centerToReference;\n var offset = within(min, center, max); // Prevents breaking syntax highlighting...\n\n var axisProp = axis;\n state.modifiersData[name] = (_state$modifiersData$ = {}, _state$modifiersData$[axisProp] = offset, _state$modifiersData$.centerOffset = offset - center, _state$modifiersData$);\n}\n\nfunction effect(_ref2) {\n var state = _ref2.state,\n options = _ref2.options;\n var _options$element = options.element,\n arrowElement = _options$element === void 0 ? '[data-popper-arrow]' : _options$element;\n\n if (arrowElement == null) {\n return;\n } // CSS selector\n\n\n if (typeof arrowElement === 'string') {\n arrowElement = state.elements.popper.querySelector(arrowElement);\n\n if (!arrowElement) {\n return;\n }\n }\n\n if (process.env.NODE_ENV !== \"production\") {\n if (!isHTMLElement(arrowElement)) {\n console.error(['Popper: \"arrow\" element must be an HTMLElement (not an SVGElement).', 'To use an SVG arrow, wrap it in an HTMLElement that will be used as', 'the arrow.'].join(' '));\n }\n }\n\n if (!contains(state.elements.popper, arrowElement)) {\n if (process.env.NODE_ENV !== \"production\") {\n console.error(['Popper: \"arrow\" modifier\\'s `element` must be a child of the popper', 'element.'].join(' '));\n }\n\n return;\n }\n\n state.elements.arrow = arrowElement;\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'arrow',\n enabled: true,\n phase: 'main',\n fn: arrow,\n effect: effect,\n requires: ['popperOffsets'],\n requiresIfExists: ['preventOverflow']\n};","export default function getVariation(placement) {\n return placement.split('-')[1];\n}","import { top, left, right, bottom, end } from \"../enums.js\";\nimport getOffsetParent from \"../dom-utils/getOffsetParent.js\";\nimport getWindow from \"../dom-utils/getWindow.js\";\nimport getDocumentElement from \"../dom-utils/getDocumentElement.js\";\nimport getComputedStyle from \"../dom-utils/getComputedStyle.js\";\nimport getBasePlacement from \"../utils/getBasePlacement.js\";\nimport getVariation from \"../utils/getVariation.js\";\nimport { round } from \"../utils/math.js\"; // eslint-disable-next-line import/no-unused-modules\n\nvar unsetSides = {\n top: 'auto',\n right: 'auto',\n bottom: 'auto',\n left: 'auto'\n}; // Round the offsets to the nearest suitable subpixel based on the DPR.\n// Zooming can change the DPR, but it seems to report a value that will\n// cleanly divide the values into the appropriate subpixels.\n\nfunction roundOffsetsByDPR(_ref, win) {\n var x = _ref.x,\n y = _ref.y;\n var dpr = win.devicePixelRatio || 1;\n return {\n x: round(x * dpr) / dpr || 0,\n y: round(y * dpr) / dpr || 0\n };\n}\n\nexport function mapToStyles(_ref2) {\n var _Object$assign2;\n\n var popper = _ref2.popper,\n popperRect = _ref2.popperRect,\n placement = _ref2.placement,\n variation = _ref2.variation,\n offsets = _ref2.offsets,\n position = _ref2.position,\n gpuAcceleration = _ref2.gpuAcceleration,\n adaptive = _ref2.adaptive,\n roundOffsets = _ref2.roundOffsets,\n isFixed = _ref2.isFixed;\n var _offsets$x = offsets.x,\n x = _offsets$x === void 0 ? 0 : _offsets$x,\n _offsets$y = offsets.y,\n y = _offsets$y === void 0 ? 0 : _offsets$y;\n\n var _ref3 = typeof roundOffsets === 'function' ? roundOffsets({\n x: x,\n y: y\n }) : {\n x: x,\n y: y\n };\n\n x = _ref3.x;\n y = _ref3.y;\n var hasX = offsets.hasOwnProperty('x');\n var hasY = offsets.hasOwnProperty('y');\n var sideX = left;\n var sideY = top;\n var win = window;\n\n if (adaptive) {\n var offsetParent = getOffsetParent(popper);\n var heightProp = 'clientHeight';\n var widthProp = 'clientWidth';\n\n if (offsetParent === getWindow(popper)) {\n offsetParent = getDocumentElement(popper);\n\n if (getComputedStyle(offsetParent).position !== 'static' && position === 'absolute') {\n heightProp = 'scrollHeight';\n widthProp = 'scrollWidth';\n }\n } // $FlowFixMe[incompatible-cast]: force type refinement, we compare offsetParent with window above, but Flow doesn't detect it\n\n\n offsetParent = offsetParent;\n\n if (placement === top || (placement === left || placement === right) && variation === end) {\n sideY = bottom;\n var offsetY = isFixed && offsetParent === win && win.visualViewport ? win.visualViewport.height : // $FlowFixMe[prop-missing]\n offsetParent[heightProp];\n y -= offsetY - popperRect.height;\n y *= gpuAcceleration ? 1 : -1;\n }\n\n if (placement === left || (placement === top || placement === bottom) && variation === end) {\n sideX = right;\n var offsetX = isFixed && offsetParent === win && win.visualViewport ? win.visualViewport.width : // $FlowFixMe[prop-missing]\n offsetParent[widthProp];\n x -= offsetX - popperRect.width;\n x *= gpuAcceleration ? 1 : -1;\n }\n }\n\n var commonStyles = Object.assign({\n position: position\n }, adaptive && unsetSides);\n\n var _ref4 = roundOffsets === true ? roundOffsetsByDPR({\n x: x,\n y: y\n }, getWindow(popper)) : {\n x: x,\n y: y\n };\n\n x = _ref4.x;\n y = _ref4.y;\n\n if (gpuAcceleration) {\n var _Object$assign;\n\n return Object.assign({}, commonStyles, (_Object$assign = {}, _Object$assign[sideY] = hasY ? '0' : '', _Object$assign[sideX] = hasX ? '0' : '', _Object$assign.transform = (win.devicePixelRatio || 1) <= 1 ? \"translate(\" + x + \"px, \" + y + \"px)\" : \"translate3d(\" + x + \"px, \" + y + \"px, 0)\", _Object$assign));\n }\n\n return Object.assign({}, commonStyles, (_Object$assign2 = {}, _Object$assign2[sideY] = hasY ? y + \"px\" : '', _Object$assign2[sideX] = hasX ? x + \"px\" : '', _Object$assign2.transform = '', _Object$assign2));\n}\n\nfunction computeStyles(_ref5) {\n var state = _ref5.state,\n options = _ref5.options;\n var _options$gpuAccelerat = options.gpuAcceleration,\n gpuAcceleration = _options$gpuAccelerat === void 0 ? true : _options$gpuAccelerat,\n _options$adaptive = options.adaptive,\n adaptive = _options$adaptive === void 0 ? true : _options$adaptive,\n _options$roundOffsets = options.roundOffsets,\n roundOffsets = _options$roundOffsets === void 0 ? true : _options$roundOffsets;\n\n if (process.env.NODE_ENV !== \"production\") {\n var transitionProperty = getComputedStyle(state.elements.popper).transitionProperty || '';\n\n if (adaptive && ['transform', 'top', 'right', 'bottom', 'left'].some(function (property) {\n return transitionProperty.indexOf(property) >= 0;\n })) {\n console.warn(['Popper: Detected CSS transitions on at least one of the following', 'CSS properties: \"transform\", \"top\", \"right\", \"bottom\", \"left\".', '\\n\\n', 'Disable the \"computeStyles\" modifier\\'s `adaptive` option to allow', 'for smooth transitions, or remove these properties from the CSS', 'transition declaration on the popper element if only transitioning', 'opacity or background-color for example.', '\\n\\n', 'We recommend using the popper element as a wrapper around an inner', 'element that can have any CSS property transitioned for animations.'].join(' '));\n }\n }\n\n var commonStyles = {\n placement: getBasePlacement(state.placement),\n variation: getVariation(state.placement),\n popper: state.elements.popper,\n popperRect: state.rects.popper,\n gpuAcceleration: gpuAcceleration,\n isFixed: state.options.strategy === 'fixed'\n };\n\n if (state.modifiersData.popperOffsets != null) {\n state.styles.popper = Object.assign({}, state.styles.popper, mapToStyles(Object.assign({}, commonStyles, {\n offsets: state.modifiersData.popperOffsets,\n position: state.options.strategy,\n adaptive: adaptive,\n roundOffsets: roundOffsets\n })));\n }\n\n if (state.modifiersData.arrow != null) {\n state.styles.arrow = Object.assign({}, state.styles.arrow, mapToStyles(Object.assign({}, commonStyles, {\n offsets: state.modifiersData.arrow,\n position: 'absolute',\n adaptive: false,\n roundOffsets: roundOffsets\n })));\n }\n\n state.attributes.popper = Object.assign({}, state.attributes.popper, {\n 'data-popper-placement': state.placement\n });\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'computeStyles',\n enabled: true,\n phase: 'beforeWrite',\n fn: computeStyles,\n data: {}\n};","import getWindow from \"../dom-utils/getWindow.js\"; // eslint-disable-next-line import/no-unused-modules\n\nvar passive = {\n passive: true\n};\n\nfunction effect(_ref) {\n var state = _ref.state,\n instance = _ref.instance,\n options = _ref.options;\n var _options$scroll = options.scroll,\n scroll = _options$scroll === void 0 ? true : _options$scroll,\n _options$resize = options.resize,\n resize = _options$resize === void 0 ? true : _options$resize;\n var window = getWindow(state.elements.popper);\n var scrollParents = [].concat(state.scrollParents.reference, state.scrollParents.popper);\n\n if (scroll) {\n scrollParents.forEach(function (scrollParent) {\n scrollParent.addEventListener('scroll', instance.update, passive);\n });\n }\n\n if (resize) {\n window.addEventListener('resize', instance.update, passive);\n }\n\n return function () {\n if (scroll) {\n scrollParents.forEach(function (scrollParent) {\n scrollParent.removeEventListener('scroll', instance.update, passive);\n });\n }\n\n if (resize) {\n window.removeEventListener('resize', instance.update, passive);\n }\n };\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'eventListeners',\n enabled: true,\n phase: 'write',\n fn: function fn() {},\n effect: effect,\n data: {}\n};","var hash = {\n left: 'right',\n right: 'left',\n bottom: 'top',\n top: 'bottom'\n};\nexport default function getOppositePlacement(placement) {\n return placement.replace(/left|right|bottom|top/g, function (matched) {\n return hash[matched];\n });\n}","var hash = {\n start: 'end',\n end: 'start'\n};\nexport default function getOppositeVariationPlacement(placement) {\n return placement.replace(/start|end/g, function (matched) {\n return hash[matched];\n });\n}","import getWindow from \"./getWindow.js\";\nexport default function getWindowScroll(node) {\n var win = getWindow(node);\n var scrollLeft = win.pageXOffset;\n var scrollTop = win.pageYOffset;\n return {\n scrollLeft: scrollLeft,\n scrollTop: scrollTop\n };\n}","import getBoundingClientRect from \"./getBoundingClientRect.js\";\nimport getDocumentElement from \"./getDocumentElement.js\";\nimport getWindowScroll from \"./getWindowScroll.js\";\nexport default function getWindowScrollBarX(element) {\n // If has a CSS width greater than the viewport, then this will be\n // incorrect for RTL.\n // Popper 1 is broken in this case and never had a bug report so let's assume\n // it's not an issue. I don't think anyone ever specifies width on \n // anyway.\n // Browsers where the left scrollbar doesn't cause an issue report `0` for\n // this (e.g. Edge 2019, IE11, Safari)\n return getBoundingClientRect(getDocumentElement(element)).left + getWindowScroll(element).scrollLeft;\n}","import getComputedStyle from \"./getComputedStyle.js\";\nexport default function isScrollParent(element) {\n // Firefox wants us to check `-x` and `-y` variations as well\n var _getComputedStyle = getComputedStyle(element),\n overflow = _getComputedStyle.overflow,\n overflowX = _getComputedStyle.overflowX,\n overflowY = _getComputedStyle.overflowY;\n\n return /auto|scroll|overlay|hidden/.test(overflow + overflowY + overflowX);\n}","import getParentNode from \"./getParentNode.js\";\nimport isScrollParent from \"./isScrollParent.js\";\nimport getNodeName from \"./getNodeName.js\";\nimport { isHTMLElement } from \"./instanceOf.js\";\nexport default function getScrollParent(node) {\n if (['html', 'body', '#document'].indexOf(getNodeName(node)) >= 0) {\n // $FlowFixMe[incompatible-return]: assume body is always available\n return node.ownerDocument.body;\n }\n\n if (isHTMLElement(node) && isScrollParent(node)) {\n return node;\n }\n\n return getScrollParent(getParentNode(node));\n}","import getScrollParent from \"./getScrollParent.js\";\nimport getParentNode from \"./getParentNode.js\";\nimport getWindow from \"./getWindow.js\";\nimport isScrollParent from \"./isScrollParent.js\";\n/*\ngiven a DOM element, return the list of all scroll parents, up the list of ancesors\nuntil we get to the top window object. This list is what we attach scroll listeners\nto, because if any of these parent elements scroll, we'll need to re-calculate the\nreference element's position.\n*/\n\nexport default function listScrollParents(element, list) {\n var _element$ownerDocumen;\n\n if (list === void 0) {\n list = [];\n }\n\n var scrollParent = getScrollParent(element);\n var isBody = scrollParent === ((_element$ownerDocumen = element.ownerDocument) == null ? void 0 : _element$ownerDocumen.body);\n var win = getWindow(scrollParent);\n var target = isBody ? [win].concat(win.visualViewport || [], isScrollParent(scrollParent) ? scrollParent : []) : scrollParent;\n var updatedList = list.concat(target);\n return isBody ? updatedList : // $FlowFixMe[incompatible-call]: isBody tells us target will be an HTMLElement here\n updatedList.concat(listScrollParents(getParentNode(target)));\n}","export default function rectToClientRect(rect) {\n return Object.assign({}, rect, {\n left: rect.x,\n top: rect.y,\n right: rect.x + rect.width,\n bottom: rect.y + rect.height\n });\n}","import { viewport } from \"../enums.js\";\nimport getViewportRect from \"./getViewportRect.js\";\nimport getDocumentRect from \"./getDocumentRect.js\";\nimport listScrollParents from \"./listScrollParents.js\";\nimport getOffsetParent from \"./getOffsetParent.js\";\nimport getDocumentElement from \"./getDocumentElement.js\";\nimport getComputedStyle from \"./getComputedStyle.js\";\nimport { isElement, isHTMLElement } from \"./instanceOf.js\";\nimport getBoundingClientRect from \"./getBoundingClientRect.js\";\nimport getParentNode from \"./getParentNode.js\";\nimport contains from \"./contains.js\";\nimport getNodeName from \"./getNodeName.js\";\nimport rectToClientRect from \"../utils/rectToClientRect.js\";\nimport { max, min } from \"../utils/math.js\";\n\nfunction getInnerBoundingClientRect(element, strategy) {\n var rect = getBoundingClientRect(element, false, strategy === 'fixed');\n rect.top = rect.top + element.clientTop;\n rect.left = rect.left + element.clientLeft;\n rect.bottom = rect.top + element.clientHeight;\n rect.right = rect.left + element.clientWidth;\n rect.width = element.clientWidth;\n rect.height = element.clientHeight;\n rect.x = rect.left;\n rect.y = rect.top;\n return rect;\n}\n\nfunction getClientRectFromMixedType(element, clippingParent, strategy) {\n return clippingParent === viewport ? rectToClientRect(getViewportRect(element, strategy)) : isElement(clippingParent) ? getInnerBoundingClientRect(clippingParent, strategy) : rectToClientRect(getDocumentRect(getDocumentElement(element)));\n} // A \"clipping parent\" is an overflowable container with the characteristic of\n// clipping (or hiding) overflowing elements with a position different from\n// `initial`\n\n\nfunction getClippingParents(element) {\n var clippingParents = listScrollParents(getParentNode(element));\n var canEscapeClipping = ['absolute', 'fixed'].indexOf(getComputedStyle(element).position) >= 0;\n var clipperElement = canEscapeClipping && isHTMLElement(element) ? getOffsetParent(element) : element;\n\n if (!isElement(clipperElement)) {\n return [];\n } // $FlowFixMe[incompatible-return]: https://github.com/facebook/flow/issues/1414\n\n\n return clippingParents.filter(function (clippingParent) {\n return isElement(clippingParent) && contains(clippingParent, clipperElement) && getNodeName(clippingParent) !== 'body';\n });\n} // Gets the maximum area that the element is visible in due to any number of\n// clipping parents\n\n\nexport default function getClippingRect(element, boundary, rootBoundary, strategy) {\n var mainClippingParents = boundary === 'clippingParents' ? getClippingParents(element) : [].concat(boundary);\n var clippingParents = [].concat(mainClippingParents, [rootBoundary]);\n var firstClippingParent = clippingParents[0];\n var clippingRect = clippingParents.reduce(function (accRect, clippingParent) {\n var rect = getClientRectFromMixedType(element, clippingParent, strategy);\n accRect.top = max(rect.top, accRect.top);\n accRect.right = min(rect.right, accRect.right);\n accRect.bottom = min(rect.bottom, accRect.bottom);\n accRect.left = max(rect.left, accRect.left);\n return accRect;\n }, getClientRectFromMixedType(element, firstClippingParent, strategy));\n clippingRect.width = clippingRect.right - clippingRect.left;\n clippingRect.height = clippingRect.bottom - clippingRect.top;\n clippingRect.x = clippingRect.left;\n clippingRect.y = clippingRect.top;\n return clippingRect;\n}","import getWindow from \"./getWindow.js\";\nimport getDocumentElement from \"./getDocumentElement.js\";\nimport getWindowScrollBarX from \"./getWindowScrollBarX.js\";\nimport isLayoutViewport from \"./isLayoutViewport.js\";\nexport default function getViewportRect(element, strategy) {\n var win = getWindow(element);\n var html = getDocumentElement(element);\n var visualViewport = win.visualViewport;\n var width = html.clientWidth;\n var height = html.clientHeight;\n var x = 0;\n var y = 0;\n\n if (visualViewport) {\n width = visualViewport.width;\n height = visualViewport.height;\n var layoutViewport = isLayoutViewport();\n\n if (layoutViewport || !layoutViewport && strategy === 'fixed') {\n x = visualViewport.offsetLeft;\n y = visualViewport.offsetTop;\n }\n }\n\n return {\n width: width,\n height: height,\n x: x + getWindowScrollBarX(element),\n y: y\n };\n}","import getDocumentElement from \"./getDocumentElement.js\";\nimport getComputedStyle from \"./getComputedStyle.js\";\nimport getWindowScrollBarX from \"./getWindowScrollBarX.js\";\nimport getWindowScroll from \"./getWindowScroll.js\";\nimport { max } from \"../utils/math.js\"; // Gets the entire size of the scrollable document area, even extending outside\n// of the `` and `` rect bounds if horizontally scrollable\n\nexport default function getDocumentRect(element) {\n var _element$ownerDocumen;\n\n var html = getDocumentElement(element);\n var winScroll = getWindowScroll(element);\n var body = (_element$ownerDocumen = element.ownerDocument) == null ? void 0 : _element$ownerDocumen.body;\n var width = max(html.scrollWidth, html.clientWidth, body ? body.scrollWidth : 0, body ? body.clientWidth : 0);\n var height = max(html.scrollHeight, html.clientHeight, body ? body.scrollHeight : 0, body ? body.clientHeight : 0);\n var x = -winScroll.scrollLeft + getWindowScrollBarX(element);\n var y = -winScroll.scrollTop;\n\n if (getComputedStyle(body || html).direction === 'rtl') {\n x += max(html.clientWidth, body ? body.clientWidth : 0) - width;\n }\n\n return {\n width: width,\n height: height,\n x: x,\n y: y\n };\n}","import getBasePlacement from \"./getBasePlacement.js\";\nimport getVariation from \"./getVariation.js\";\nimport getMainAxisFromPlacement from \"./getMainAxisFromPlacement.js\";\nimport { top, right, bottom, left, start, end } from \"../enums.js\";\nexport default function computeOffsets(_ref) {\n var reference = _ref.reference,\n element = _ref.element,\n placement = _ref.placement;\n var basePlacement = placement ? getBasePlacement(placement) : null;\n var variation = placement ? getVariation(placement) : null;\n var commonX = reference.x + reference.width / 2 - element.width / 2;\n var commonY = reference.y + reference.height / 2 - element.height / 2;\n var offsets;\n\n switch (basePlacement) {\n case top:\n offsets = {\n x: commonX,\n y: reference.y - element.height\n };\n break;\n\n case bottom:\n offsets = {\n x: commonX,\n y: reference.y + reference.height\n };\n break;\n\n case right:\n offsets = {\n x: reference.x + reference.width,\n y: commonY\n };\n break;\n\n case left:\n offsets = {\n x: reference.x - element.width,\n y: commonY\n };\n break;\n\n default:\n offsets = {\n x: reference.x,\n y: reference.y\n };\n }\n\n var mainAxis = basePlacement ? getMainAxisFromPlacement(basePlacement) : null;\n\n if (mainAxis != null) {\n var len = mainAxis === 'y' ? 'height' : 'width';\n\n switch (variation) {\n case start:\n offsets[mainAxis] = offsets[mainAxis] - (reference[len] / 2 - element[len] / 2);\n break;\n\n case end:\n offsets[mainAxis] = offsets[mainAxis] + (reference[len] / 2 - element[len] / 2);\n break;\n\n default:\n }\n }\n\n return offsets;\n}","import getClippingRect from \"../dom-utils/getClippingRect.js\";\nimport getDocumentElement from \"../dom-utils/getDocumentElement.js\";\nimport getBoundingClientRect from \"../dom-utils/getBoundingClientRect.js\";\nimport computeOffsets from \"./computeOffsets.js\";\nimport rectToClientRect from \"./rectToClientRect.js\";\nimport { clippingParents, reference, popper, bottom, top, right, basePlacements, viewport } from \"../enums.js\";\nimport { isElement } from \"../dom-utils/instanceOf.js\";\nimport mergePaddingObject from \"./mergePaddingObject.js\";\nimport expandToHashMap from \"./expandToHashMap.js\"; // eslint-disable-next-line import/no-unused-modules\n\nexport default function detectOverflow(state, options) {\n if (options === void 0) {\n options = {};\n }\n\n var _options = options,\n _options$placement = _options.placement,\n placement = _options$placement === void 0 ? state.placement : _options$placement,\n _options$strategy = _options.strategy,\n strategy = _options$strategy === void 0 ? state.strategy : _options$strategy,\n _options$boundary = _options.boundary,\n boundary = _options$boundary === void 0 ? clippingParents : _options$boundary,\n _options$rootBoundary = _options.rootBoundary,\n rootBoundary = _options$rootBoundary === void 0 ? viewport : _options$rootBoundary,\n _options$elementConte = _options.elementContext,\n elementContext = _options$elementConte === void 0 ? popper : _options$elementConte,\n _options$altBoundary = _options.altBoundary,\n altBoundary = _options$altBoundary === void 0 ? false : _options$altBoundary,\n _options$padding = _options.padding,\n padding = _options$padding === void 0 ? 0 : _options$padding;\n var paddingObject = mergePaddingObject(typeof padding !== 'number' ? padding : expandToHashMap(padding, basePlacements));\n var altContext = elementContext === popper ? reference : popper;\n var popperRect = state.rects.popper;\n var element = state.elements[altBoundary ? altContext : elementContext];\n var clippingClientRect = getClippingRect(isElement(element) ? element : element.contextElement || getDocumentElement(state.elements.popper), boundary, rootBoundary, strategy);\n var referenceClientRect = getBoundingClientRect(state.elements.reference);\n var popperOffsets = computeOffsets({\n reference: referenceClientRect,\n element: popperRect,\n strategy: 'absolute',\n placement: placement\n });\n var popperClientRect = rectToClientRect(Object.assign({}, popperRect, popperOffsets));\n var elementClientRect = elementContext === popper ? popperClientRect : referenceClientRect; // positive = overflowing the clipping rect\n // 0 or negative = within the clipping rect\n\n var overflowOffsets = {\n top: clippingClientRect.top - elementClientRect.top + paddingObject.top,\n bottom: elementClientRect.bottom - clippingClientRect.bottom + paddingObject.bottom,\n left: clippingClientRect.left - elementClientRect.left + paddingObject.left,\n right: elementClientRect.right - clippingClientRect.right + paddingObject.right\n };\n var offsetData = state.modifiersData.offset; // Offsets can be applied only to the popper element\n\n if (elementContext === popper && offsetData) {\n var offset = offsetData[placement];\n Object.keys(overflowOffsets).forEach(function (key) {\n var multiply = [right, bottom].indexOf(key) >= 0 ? 1 : -1;\n var axis = [top, bottom].indexOf(key) >= 0 ? 'y' : 'x';\n overflowOffsets[key] += offset[axis] * multiply;\n });\n }\n\n return overflowOffsets;\n}","import getOppositePlacement from \"../utils/getOppositePlacement.js\";\nimport getBasePlacement from \"../utils/getBasePlacement.js\";\nimport getOppositeVariationPlacement from \"../utils/getOppositeVariationPlacement.js\";\nimport detectOverflow from \"../utils/detectOverflow.js\";\nimport computeAutoPlacement from \"../utils/computeAutoPlacement.js\";\nimport { bottom, top, start, right, left, auto } from \"../enums.js\";\nimport getVariation from \"../utils/getVariation.js\"; // eslint-disable-next-line import/no-unused-modules\n\nfunction getExpandedFallbackPlacements(placement) {\n if (getBasePlacement(placement) === auto) {\n return [];\n }\n\n var oppositePlacement = getOppositePlacement(placement);\n return [getOppositeVariationPlacement(placement), oppositePlacement, getOppositeVariationPlacement(oppositePlacement)];\n}\n\nfunction flip(_ref) {\n var state = _ref.state,\n options = _ref.options,\n name = _ref.name;\n\n if (state.modifiersData[name]._skip) {\n return;\n }\n\n var _options$mainAxis = options.mainAxis,\n checkMainAxis = _options$mainAxis === void 0 ? true : _options$mainAxis,\n _options$altAxis = options.altAxis,\n checkAltAxis = _options$altAxis === void 0 ? true : _options$altAxis,\n specifiedFallbackPlacements = options.fallbackPlacements,\n padding = options.padding,\n boundary = options.boundary,\n rootBoundary = options.rootBoundary,\n altBoundary = options.altBoundary,\n _options$flipVariatio = options.flipVariations,\n flipVariations = _options$flipVariatio === void 0 ? true : _options$flipVariatio,\n allowedAutoPlacements = options.allowedAutoPlacements;\n var preferredPlacement = state.options.placement;\n var basePlacement = getBasePlacement(preferredPlacement);\n var isBasePlacement = basePlacement === preferredPlacement;\n var fallbackPlacements = specifiedFallbackPlacements || (isBasePlacement || !flipVariations ? [getOppositePlacement(preferredPlacement)] : getExpandedFallbackPlacements(preferredPlacement));\n var placements = [preferredPlacement].concat(fallbackPlacements).reduce(function (acc, placement) {\n return acc.concat(getBasePlacement(placement) === auto ? computeAutoPlacement(state, {\n placement: placement,\n boundary: boundary,\n rootBoundary: rootBoundary,\n padding: padding,\n flipVariations: flipVariations,\n allowedAutoPlacements: allowedAutoPlacements\n }) : placement);\n }, []);\n var referenceRect = state.rects.reference;\n var popperRect = state.rects.popper;\n var checksMap = new Map();\n var makeFallbackChecks = true;\n var firstFittingPlacement = placements[0];\n\n for (var i = 0; i < placements.length; i++) {\n var placement = placements[i];\n\n var _basePlacement = getBasePlacement(placement);\n\n var isStartVariation = getVariation(placement) === start;\n var isVertical = [top, bottom].indexOf(_basePlacement) >= 0;\n var len = isVertical ? 'width' : 'height';\n var overflow = detectOverflow(state, {\n placement: placement,\n boundary: boundary,\n rootBoundary: rootBoundary,\n altBoundary: altBoundary,\n padding: padding\n });\n var mainVariationSide = isVertical ? isStartVariation ? right : left : isStartVariation ? bottom : top;\n\n if (referenceRect[len] > popperRect[len]) {\n mainVariationSide = getOppositePlacement(mainVariationSide);\n }\n\n var altVariationSide = getOppositePlacement(mainVariationSide);\n var checks = [];\n\n if (checkMainAxis) {\n checks.push(overflow[_basePlacement] <= 0);\n }\n\n if (checkAltAxis) {\n checks.push(overflow[mainVariationSide] <= 0, overflow[altVariationSide] <= 0);\n }\n\n if (checks.every(function (check) {\n return check;\n })) {\n firstFittingPlacement = placement;\n makeFallbackChecks = false;\n break;\n }\n\n checksMap.set(placement, checks);\n }\n\n if (makeFallbackChecks) {\n // `2` may be desired in some cases – research later\n var numberOfChecks = flipVariations ? 3 : 1;\n\n var _loop = function _loop(_i) {\n var fittingPlacement = placements.find(function (placement) {\n var checks = checksMap.get(placement);\n\n if (checks) {\n return checks.slice(0, _i).every(function (check) {\n return check;\n });\n }\n });\n\n if (fittingPlacement) {\n firstFittingPlacement = fittingPlacement;\n return \"break\";\n }\n };\n\n for (var _i = numberOfChecks; _i > 0; _i--) {\n var _ret = _loop(_i);\n\n if (_ret === \"break\") break;\n }\n }\n\n if (state.placement !== firstFittingPlacement) {\n state.modifiersData[name]._skip = true;\n state.placement = firstFittingPlacement;\n state.reset = true;\n }\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'flip',\n enabled: true,\n phase: 'main',\n fn: flip,\n requiresIfExists: ['offset'],\n data: {\n _skip: false\n }\n};","import getVariation from \"./getVariation.js\";\nimport { variationPlacements, basePlacements, placements as allPlacements } from \"../enums.js\";\nimport detectOverflow from \"./detectOverflow.js\";\nimport getBasePlacement from \"./getBasePlacement.js\";\nexport default function computeAutoPlacement(state, options) {\n if (options === void 0) {\n options = {};\n }\n\n var _options = options,\n placement = _options.placement,\n boundary = _options.boundary,\n rootBoundary = _options.rootBoundary,\n padding = _options.padding,\n flipVariations = _options.flipVariations,\n _options$allowedAutoP = _options.allowedAutoPlacements,\n allowedAutoPlacements = _options$allowedAutoP === void 0 ? allPlacements : _options$allowedAutoP;\n var variation = getVariation(placement);\n var placements = variation ? flipVariations ? variationPlacements : variationPlacements.filter(function (placement) {\n return getVariation(placement) === variation;\n }) : basePlacements;\n var allowedPlacements = placements.filter(function (placement) {\n return allowedAutoPlacements.indexOf(placement) >= 0;\n });\n\n if (allowedPlacements.length === 0) {\n allowedPlacements = placements;\n\n if (process.env.NODE_ENV !== \"production\") {\n console.error(['Popper: The `allowedAutoPlacements` option did not allow any', 'placements. Ensure the `placement` option matches the variation', 'of the allowed placements.', 'For example, \"auto\" cannot be used to allow \"bottom-start\".', 'Use \"auto-start\" instead.'].join(' '));\n }\n } // $FlowFixMe[incompatible-type]: Flow seems to have problems with two array unions...\n\n\n var overflows = allowedPlacements.reduce(function (acc, placement) {\n acc[placement] = detectOverflow(state, {\n placement: placement,\n boundary: boundary,\n rootBoundary: rootBoundary,\n padding: padding\n })[getBasePlacement(placement)];\n return acc;\n }, {});\n return Object.keys(overflows).sort(function (a, b) {\n return overflows[a] - overflows[b];\n });\n}","import { top, bottom, left, right } from \"../enums.js\";\nimport detectOverflow from \"../utils/detectOverflow.js\";\n\nfunction getSideOffsets(overflow, rect, preventedOffsets) {\n if (preventedOffsets === void 0) {\n preventedOffsets = {\n x: 0,\n y: 0\n };\n }\n\n return {\n top: overflow.top - rect.height - preventedOffsets.y,\n right: overflow.right - rect.width + preventedOffsets.x,\n bottom: overflow.bottom - rect.height + preventedOffsets.y,\n left: overflow.left - rect.width - preventedOffsets.x\n };\n}\n\nfunction isAnySideFullyClipped(overflow) {\n return [top, right, bottom, left].some(function (side) {\n return overflow[side] >= 0;\n });\n}\n\nfunction hide(_ref) {\n var state = _ref.state,\n name = _ref.name;\n var referenceRect = state.rects.reference;\n var popperRect = state.rects.popper;\n var preventedOffsets = state.modifiersData.preventOverflow;\n var referenceOverflow = detectOverflow(state, {\n elementContext: 'reference'\n });\n var popperAltOverflow = detectOverflow(state, {\n altBoundary: true\n });\n var referenceClippingOffsets = getSideOffsets(referenceOverflow, referenceRect);\n var popperEscapeOffsets = getSideOffsets(popperAltOverflow, popperRect, preventedOffsets);\n var isReferenceHidden = isAnySideFullyClipped(referenceClippingOffsets);\n var hasPopperEscaped = isAnySideFullyClipped(popperEscapeOffsets);\n state.modifiersData[name] = {\n referenceClippingOffsets: referenceClippingOffsets,\n popperEscapeOffsets: popperEscapeOffsets,\n isReferenceHidden: isReferenceHidden,\n hasPopperEscaped: hasPopperEscaped\n };\n state.attributes.popper = Object.assign({}, state.attributes.popper, {\n 'data-popper-reference-hidden': isReferenceHidden,\n 'data-popper-escaped': hasPopperEscaped\n });\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'hide',\n enabled: true,\n phase: 'main',\n requiresIfExists: ['preventOverflow'],\n fn: hide\n};","import getBasePlacement from \"../utils/getBasePlacement.js\";\nimport { top, left, right, placements } from \"../enums.js\"; // eslint-disable-next-line import/no-unused-modules\n\nexport function distanceAndSkiddingToXY(placement, rects, offset) {\n var basePlacement = getBasePlacement(placement);\n var invertDistance = [left, top].indexOf(basePlacement) >= 0 ? -1 : 1;\n\n var _ref = typeof offset === 'function' ? offset(Object.assign({}, rects, {\n placement: placement\n })) : offset,\n skidding = _ref[0],\n distance = _ref[1];\n\n skidding = skidding || 0;\n distance = (distance || 0) * invertDistance;\n return [left, right].indexOf(basePlacement) >= 0 ? {\n x: distance,\n y: skidding\n } : {\n x: skidding,\n y: distance\n };\n}\n\nfunction offset(_ref2) {\n var state = _ref2.state,\n options = _ref2.options,\n name = _ref2.name;\n var _options$offset = options.offset,\n offset = _options$offset === void 0 ? [0, 0] : _options$offset;\n var data = placements.reduce(function (acc, placement) {\n acc[placement] = distanceAndSkiddingToXY(placement, state.rects, offset);\n return acc;\n }, {});\n var _data$state$placement = data[state.placement],\n x = _data$state$placement.x,\n y = _data$state$placement.y;\n\n if (state.modifiersData.popperOffsets != null) {\n state.modifiersData.popperOffsets.x += x;\n state.modifiersData.popperOffsets.y += y;\n }\n\n state.modifiersData[name] = data;\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'offset',\n enabled: true,\n phase: 'main',\n requires: ['popperOffsets'],\n fn: offset\n};","import computeOffsets from \"../utils/computeOffsets.js\";\n\nfunction popperOffsets(_ref) {\n var state = _ref.state,\n name = _ref.name;\n // Offsets are the actual position the popper needs to have to be\n // properly positioned near its reference element\n // This is the most basic placement, and will be adjusted by\n // the modifiers in the next step\n state.modifiersData[name] = computeOffsets({\n reference: state.rects.reference,\n element: state.rects.popper,\n strategy: 'absolute',\n placement: state.placement\n });\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'popperOffsets',\n enabled: true,\n phase: 'read',\n fn: popperOffsets,\n data: {}\n};","import { top, left, right, bottom, start } from \"../enums.js\";\nimport getBasePlacement from \"../utils/getBasePlacement.js\";\nimport getMainAxisFromPlacement from \"../utils/getMainAxisFromPlacement.js\";\nimport getAltAxis from \"../utils/getAltAxis.js\";\nimport { within, withinMaxClamp } from \"../utils/within.js\";\nimport getLayoutRect from \"../dom-utils/getLayoutRect.js\";\nimport getOffsetParent from \"../dom-utils/getOffsetParent.js\";\nimport detectOverflow from \"../utils/detectOverflow.js\";\nimport getVariation from \"../utils/getVariation.js\";\nimport getFreshSideObject from \"../utils/getFreshSideObject.js\";\nimport { min as mathMin, max as mathMax } from \"../utils/math.js\";\n\nfunction preventOverflow(_ref) {\n var state = _ref.state,\n options = _ref.options,\n name = _ref.name;\n var _options$mainAxis = options.mainAxis,\n checkMainAxis = _options$mainAxis === void 0 ? true : _options$mainAxis,\n _options$altAxis = options.altAxis,\n checkAltAxis = _options$altAxis === void 0 ? false : _options$altAxis,\n boundary = options.boundary,\n rootBoundary = options.rootBoundary,\n altBoundary = options.altBoundary,\n padding = options.padding,\n _options$tether = options.tether,\n tether = _options$tether === void 0 ? true : _options$tether,\n _options$tetherOffset = options.tetherOffset,\n tetherOffset = _options$tetherOffset === void 0 ? 0 : _options$tetherOffset;\n var overflow = detectOverflow(state, {\n boundary: boundary,\n rootBoundary: rootBoundary,\n padding: padding,\n altBoundary: altBoundary\n });\n var basePlacement = getBasePlacement(state.placement);\n var variation = getVariation(state.placement);\n var isBasePlacement = !variation;\n var mainAxis = getMainAxisFromPlacement(basePlacement);\n var altAxis = getAltAxis(mainAxis);\n var popperOffsets = state.modifiersData.popperOffsets;\n var referenceRect = state.rects.reference;\n var popperRect = state.rects.popper;\n var tetherOffsetValue = typeof tetherOffset === 'function' ? tetherOffset(Object.assign({}, state.rects, {\n placement: state.placement\n })) : tetherOffset;\n var normalizedTetherOffsetValue = typeof tetherOffsetValue === 'number' ? {\n mainAxis: tetherOffsetValue,\n altAxis: tetherOffsetValue\n } : Object.assign({\n mainAxis: 0,\n altAxis: 0\n }, tetherOffsetValue);\n var offsetModifierState = state.modifiersData.offset ? state.modifiersData.offset[state.placement] : null;\n var data = {\n x: 0,\n y: 0\n };\n\n if (!popperOffsets) {\n return;\n }\n\n if (checkMainAxis) {\n var _offsetModifierState$;\n\n var mainSide = mainAxis === 'y' ? top : left;\n var altSide = mainAxis === 'y' ? bottom : right;\n var len = mainAxis === 'y' ? 'height' : 'width';\n var offset = popperOffsets[mainAxis];\n var min = offset + overflow[mainSide];\n var max = offset - overflow[altSide];\n var additive = tether ? -popperRect[len] / 2 : 0;\n var minLen = variation === start ? referenceRect[len] : popperRect[len];\n var maxLen = variation === start ? -popperRect[len] : -referenceRect[len]; // We need to include the arrow in the calculation so the arrow doesn't go\n // outside the reference bounds\n\n var arrowElement = state.elements.arrow;\n var arrowRect = tether && arrowElement ? getLayoutRect(arrowElement) : {\n width: 0,\n height: 0\n };\n var arrowPaddingObject = state.modifiersData['arrow#persistent'] ? state.modifiersData['arrow#persistent'].padding : getFreshSideObject();\n var arrowPaddingMin = arrowPaddingObject[mainSide];\n var arrowPaddingMax = arrowPaddingObject[altSide]; // If the reference length is smaller than the arrow length, we don't want\n // to include its full size in the calculation. If the reference is small\n // and near the edge of a boundary, the popper can overflow even if the\n // reference is not overflowing as well (e.g. virtual elements with no\n // width or height)\n\n var arrowLen = within(0, referenceRect[len], arrowRect[len]);\n var minOffset = isBasePlacement ? referenceRect[len] / 2 - additive - arrowLen - arrowPaddingMin - normalizedTetherOffsetValue.mainAxis : minLen - arrowLen - arrowPaddingMin - normalizedTetherOffsetValue.mainAxis;\n var maxOffset = isBasePlacement ? -referenceRect[len] / 2 + additive + arrowLen + arrowPaddingMax + normalizedTetherOffsetValue.mainAxis : maxLen + arrowLen + arrowPaddingMax + normalizedTetherOffsetValue.mainAxis;\n var arrowOffsetParent = state.elements.arrow && getOffsetParent(state.elements.arrow);\n var clientOffset = arrowOffsetParent ? mainAxis === 'y' ? arrowOffsetParent.clientTop || 0 : arrowOffsetParent.clientLeft || 0 : 0;\n var offsetModifierValue = (_offsetModifierState$ = offsetModifierState == null ? void 0 : offsetModifierState[mainAxis]) != null ? _offsetModifierState$ : 0;\n var tetherMin = offset + minOffset - offsetModifierValue - clientOffset;\n var tetherMax = offset + maxOffset - offsetModifierValue;\n var preventedOffset = within(tether ? mathMin(min, tetherMin) : min, offset, tether ? mathMax(max, tetherMax) : max);\n popperOffsets[mainAxis] = preventedOffset;\n data[mainAxis] = preventedOffset - offset;\n }\n\n if (checkAltAxis) {\n var _offsetModifierState$2;\n\n var _mainSide = mainAxis === 'x' ? top : left;\n\n var _altSide = mainAxis === 'x' ? bottom : right;\n\n var _offset = popperOffsets[altAxis];\n\n var _len = altAxis === 'y' ? 'height' : 'width';\n\n var _min = _offset + overflow[_mainSide];\n\n var _max = _offset - overflow[_altSide];\n\n var isOriginSide = [top, left].indexOf(basePlacement) !== -1;\n\n var _offsetModifierValue = (_offsetModifierState$2 = offsetModifierState == null ? void 0 : offsetModifierState[altAxis]) != null ? _offsetModifierState$2 : 0;\n\n var _tetherMin = isOriginSide ? _min : _offset - referenceRect[_len] - popperRect[_len] - _offsetModifierValue + normalizedTetherOffsetValue.altAxis;\n\n var _tetherMax = isOriginSide ? _offset + referenceRect[_len] + popperRect[_len] - _offsetModifierValue - normalizedTetherOffsetValue.altAxis : _max;\n\n var _preventedOffset = tether && isOriginSide ? withinMaxClamp(_tetherMin, _offset, _tetherMax) : within(tether ? _tetherMin : _min, _offset, tether ? _tetherMax : _max);\n\n popperOffsets[altAxis] = _preventedOffset;\n data[altAxis] = _preventedOffset - _offset;\n }\n\n state.modifiersData[name] = data;\n} // eslint-disable-next-line import/no-unused-modules\n\n\nexport default {\n name: 'preventOverflow',\n enabled: true,\n phase: 'main',\n fn: preventOverflow,\n requiresIfExists: ['offset']\n};","export default function getAltAxis(axis) {\n return axis === 'x' ? 'y' : 'x';\n}","import getBoundingClientRect from \"./getBoundingClientRect.js\";\nimport getNodeScroll from \"./getNodeScroll.js\";\nimport getNodeName from \"./getNodeName.js\";\nimport { isHTMLElement } from \"./instanceOf.js\";\nimport getWindowScrollBarX from \"./getWindowScrollBarX.js\";\nimport getDocumentElement from \"./getDocumentElement.js\";\nimport isScrollParent from \"./isScrollParent.js\";\nimport { round } from \"../utils/math.js\";\n\nfunction isElementScaled(element) {\n var rect = element.getBoundingClientRect();\n var scaleX = round(rect.width) / element.offsetWidth || 1;\n var scaleY = round(rect.height) / element.offsetHeight || 1;\n return scaleX !== 1 || scaleY !== 1;\n} // Returns the composite rect of an element relative to its offsetParent.\n// Composite means it takes into account transforms as well as layout.\n\n\nexport default function getCompositeRect(elementOrVirtualElement, offsetParent, isFixed) {\n if (isFixed === void 0) {\n isFixed = false;\n }\n\n var isOffsetParentAnElement = isHTMLElement(offsetParent);\n var offsetParentIsScaled = isHTMLElement(offsetParent) && isElementScaled(offsetParent);\n var documentElement = getDocumentElement(offsetParent);\n var rect = getBoundingClientRect(elementOrVirtualElement, offsetParentIsScaled, isFixed);\n var scroll = {\n scrollLeft: 0,\n scrollTop: 0\n };\n var offsets = {\n x: 0,\n y: 0\n };\n\n if (isOffsetParentAnElement || !isOffsetParentAnElement && !isFixed) {\n if (getNodeName(offsetParent) !== 'body' || // https://github.com/popperjs/popper-core/issues/1078\n isScrollParent(documentElement)) {\n scroll = getNodeScroll(offsetParent);\n }\n\n if (isHTMLElement(offsetParent)) {\n offsets = getBoundingClientRect(offsetParent, true);\n offsets.x += offsetParent.clientLeft;\n offsets.y += offsetParent.clientTop;\n } else if (documentElement) {\n offsets.x = getWindowScrollBarX(documentElement);\n }\n }\n\n return {\n x: rect.left + scroll.scrollLeft - offsets.x,\n y: rect.top + scroll.scrollTop - offsets.y,\n width: rect.width,\n height: rect.height\n };\n}","import getWindowScroll from \"./getWindowScroll.js\";\nimport getWindow from \"./getWindow.js\";\nimport { isHTMLElement } from \"./instanceOf.js\";\nimport getHTMLElementScroll from \"./getHTMLElementScroll.js\";\nexport default function getNodeScroll(node) {\n if (node === getWindow(node) || !isHTMLElement(node)) {\n return getWindowScroll(node);\n } else {\n return getHTMLElementScroll(node);\n }\n}","export default function getHTMLElementScroll(element) {\n return {\n scrollLeft: element.scrollLeft,\n scrollTop: element.scrollTop\n };\n}","import { modifierPhases } from \"../enums.js\"; // source: https://stackoverflow.com/questions/49875255\n\nfunction order(modifiers) {\n var map = new Map();\n var visited = new Set();\n var result = [];\n modifiers.forEach(function (modifier) {\n map.set(modifier.name, modifier);\n }); // On visiting object, check for its dependencies and visit them recursively\n\n function sort(modifier) {\n visited.add(modifier.name);\n var requires = [].concat(modifier.requires || [], modifier.requiresIfExists || []);\n requires.forEach(function (dep) {\n if (!visited.has(dep)) {\n var depModifier = map.get(dep);\n\n if (depModifier) {\n sort(depModifier);\n }\n }\n });\n result.push(modifier);\n }\n\n modifiers.forEach(function (modifier) {\n if (!visited.has(modifier.name)) {\n // check for visited object\n sort(modifier);\n }\n });\n return result;\n}\n\nexport default function orderModifiers(modifiers) {\n // order based on dependencies\n var orderedModifiers = order(modifiers); // order based on phase\n\n return modifierPhases.reduce(function (acc, phase) {\n return acc.concat(orderedModifiers.filter(function (modifier) {\n return modifier.phase === phase;\n }));\n }, []);\n}","import getCompositeRect from \"./dom-utils/getCompositeRect.js\";\nimport getLayoutRect from \"./dom-utils/getLayoutRect.js\";\nimport listScrollParents from \"./dom-utils/listScrollParents.js\";\nimport getOffsetParent from \"./dom-utils/getOffsetParent.js\";\nimport getComputedStyle from \"./dom-utils/getComputedStyle.js\";\nimport orderModifiers from \"./utils/orderModifiers.js\";\nimport debounce from \"./utils/debounce.js\";\nimport validateModifiers from \"./utils/validateModifiers.js\";\nimport uniqueBy from \"./utils/uniqueBy.js\";\nimport getBasePlacement from \"./utils/getBasePlacement.js\";\nimport mergeByName from \"./utils/mergeByName.js\";\nimport detectOverflow from \"./utils/detectOverflow.js\";\nimport { isElement } from \"./dom-utils/instanceOf.js\";\nimport { auto } from \"./enums.js\";\nvar INVALID_ELEMENT_ERROR = 'Popper: Invalid reference or popper argument provided. They must be either a DOM element or virtual element.';\nvar INFINITE_LOOP_ERROR = 'Popper: An infinite loop in the modifiers cycle has been detected! The cycle has been interrupted to prevent a browser crash.';\nvar DEFAULT_OPTIONS = {\n placement: 'bottom',\n modifiers: [],\n strategy: 'absolute'\n};\n\nfunction areValidElements() {\n for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {\n args[_key] = arguments[_key];\n }\n\n return !args.some(function (element) {\n return !(element && typeof element.getBoundingClientRect === 'function');\n });\n}\n\nexport function popperGenerator(generatorOptions) {\n if (generatorOptions === void 0) {\n generatorOptions = {};\n }\n\n var _generatorOptions = generatorOptions,\n _generatorOptions$def = _generatorOptions.defaultModifiers,\n defaultModifiers = _generatorOptions$def === void 0 ? [] : _generatorOptions$def,\n _generatorOptions$def2 = _generatorOptions.defaultOptions,\n defaultOptions = _generatorOptions$def2 === void 0 ? DEFAULT_OPTIONS : _generatorOptions$def2;\n return function createPopper(reference, popper, options) {\n if (options === void 0) {\n options = defaultOptions;\n }\n\n var state = {\n placement: 'bottom',\n orderedModifiers: [],\n options: Object.assign({}, DEFAULT_OPTIONS, defaultOptions),\n modifiersData: {},\n elements: {\n reference: reference,\n popper: popper\n },\n attributes: {},\n styles: {}\n };\n var effectCleanupFns = [];\n var isDestroyed = false;\n var instance = {\n state: state,\n setOptions: function setOptions(setOptionsAction) {\n var options = typeof setOptionsAction === 'function' ? setOptionsAction(state.options) : setOptionsAction;\n cleanupModifierEffects();\n state.options = Object.assign({}, defaultOptions, state.options, options);\n state.scrollParents = {\n reference: isElement(reference) ? listScrollParents(reference) : reference.contextElement ? listScrollParents(reference.contextElement) : [],\n popper: listScrollParents(popper)\n }; // Orders the modifiers based on their dependencies and `phase`\n // properties\n\n var orderedModifiers = orderModifiers(mergeByName([].concat(defaultModifiers, state.options.modifiers))); // Strip out disabled modifiers\n\n state.orderedModifiers = orderedModifiers.filter(function (m) {\n return m.enabled;\n }); // Validate the provided modifiers so that the consumer will get warned\n // if one of the modifiers is invalid for any reason\n\n if (process.env.NODE_ENV !== \"production\") {\n var modifiers = uniqueBy([].concat(orderedModifiers, state.options.modifiers), function (_ref) {\n var name = _ref.name;\n return name;\n });\n validateModifiers(modifiers);\n\n if (getBasePlacement(state.options.placement) === auto) {\n var flipModifier = state.orderedModifiers.find(function (_ref2) {\n var name = _ref2.name;\n return name === 'flip';\n });\n\n if (!flipModifier) {\n console.error(['Popper: \"auto\" placements require the \"flip\" modifier be', 'present and enabled to work.'].join(' '));\n }\n }\n\n var _getComputedStyle = getComputedStyle(popper),\n marginTop = _getComputedStyle.marginTop,\n marginRight = _getComputedStyle.marginRight,\n marginBottom = _getComputedStyle.marginBottom,\n marginLeft = _getComputedStyle.marginLeft; // We no longer take into account `margins` on the popper, and it can\n // cause bugs with positioning, so we'll warn the consumer\n\n\n if ([marginTop, marginRight, marginBottom, marginLeft].some(function (margin) {\n return parseFloat(margin);\n })) {\n console.warn(['Popper: CSS \"margin\" styles cannot be used to apply padding', 'between the popper and its reference element or boundary.', 'To replicate margin, use the `offset` modifier, as well as', 'the `padding` option in the `preventOverflow` and `flip`', 'modifiers.'].join(' '));\n }\n }\n\n runModifierEffects();\n return instance.update();\n },\n // Sync update – it will always be executed, even if not necessary. This\n // is useful for low frequency updates where sync behavior simplifies the\n // logic.\n // For high frequency updates (e.g. `resize` and `scroll` events), always\n // prefer the async Popper#update method\n forceUpdate: function forceUpdate() {\n if (isDestroyed) {\n return;\n }\n\n var _state$elements = state.elements,\n reference = _state$elements.reference,\n popper = _state$elements.popper; // Don't proceed if `reference` or `popper` are not valid elements\n // anymore\n\n if (!areValidElements(reference, popper)) {\n if (process.env.NODE_ENV !== \"production\") {\n console.error(INVALID_ELEMENT_ERROR);\n }\n\n return;\n } // Store the reference and popper rects to be read by modifiers\n\n\n state.rects = {\n reference: getCompositeRect(reference, getOffsetParent(popper), state.options.strategy === 'fixed'),\n popper: getLayoutRect(popper)\n }; // Modifiers have the ability to reset the current update cycle. The\n // most common use case for this is the `flip` modifier changing the\n // placement, which then needs to re-run all the modifiers, because the\n // logic was previously ran for the previous placement and is therefore\n // stale/incorrect\n\n state.reset = false;\n state.placement = state.options.placement; // On each update cycle, the `modifiersData` property for each modifier\n // is filled with the initial data specified by the modifier. This means\n // it doesn't persist and is fresh on each update.\n // To ensure persistent data, use `${name}#persistent`\n\n state.orderedModifiers.forEach(function (modifier) {\n return state.modifiersData[modifier.name] = Object.assign({}, modifier.data);\n });\n var __debug_loops__ = 0;\n\n for (var index = 0; index < state.orderedModifiers.length; index++) {\n if (process.env.NODE_ENV !== \"production\") {\n __debug_loops__ += 1;\n\n if (__debug_loops__ > 100) {\n console.error(INFINITE_LOOP_ERROR);\n break;\n }\n }\n\n if (state.reset === true) {\n state.reset = false;\n index = -1;\n continue;\n }\n\n var _state$orderedModifie = state.orderedModifiers[index],\n fn = _state$orderedModifie.fn,\n _state$orderedModifie2 = _state$orderedModifie.options,\n _options = _state$orderedModifie2 === void 0 ? {} : _state$orderedModifie2,\n name = _state$orderedModifie.name;\n\n if (typeof fn === 'function') {\n state = fn({\n state: state,\n options: _options,\n name: name,\n instance: instance\n }) || state;\n }\n }\n },\n // Async and optimistically optimized update – it will not be executed if\n // not necessary (debounced to run at most once-per-tick)\n update: debounce(function () {\n return new Promise(function (resolve) {\n instance.forceUpdate();\n resolve(state);\n });\n }),\n destroy: function destroy() {\n cleanupModifierEffects();\n isDestroyed = true;\n }\n };\n\n if (!areValidElements(reference, popper)) {\n if (process.env.NODE_ENV !== \"production\") {\n console.error(INVALID_ELEMENT_ERROR);\n }\n\n return instance;\n }\n\n instance.setOptions(options).then(function (state) {\n if (!isDestroyed && options.onFirstUpdate) {\n options.onFirstUpdate(state);\n }\n }); // Modifiers have the ability to execute arbitrary code before the first\n // update cycle runs. They will be executed in the same order as the update\n // cycle. This is useful when a modifier adds some persistent data that\n // other modifiers need to use, but the modifier is run after the dependent\n // one.\n\n function runModifierEffects() {\n state.orderedModifiers.forEach(function (_ref3) {\n var name = _ref3.name,\n _ref3$options = _ref3.options,\n options = _ref3$options === void 0 ? {} : _ref3$options,\n effect = _ref3.effect;\n\n if (typeof effect === 'function') {\n var cleanupFn = effect({\n state: state,\n name: name,\n instance: instance,\n options: options\n });\n\n var noopFn = function noopFn() {};\n\n effectCleanupFns.push(cleanupFn || noopFn);\n }\n });\n }\n\n function cleanupModifierEffects() {\n effectCleanupFns.forEach(function (fn) {\n return fn();\n });\n effectCleanupFns = [];\n }\n\n return instance;\n };\n}\nexport var createPopper = /*#__PURE__*/popperGenerator(); // eslint-disable-next-line import/no-unused-modules\n\nexport { detectOverflow };","export default function debounce(fn) {\n var pending;\n return function () {\n if (!pending) {\n pending = new Promise(function (resolve) {\n Promise.resolve().then(function () {\n pending = undefined;\n resolve(fn());\n });\n });\n }\n\n return pending;\n };\n}","export default function mergeByName(modifiers) {\n var merged = modifiers.reduce(function (merged, current) {\n var existing = merged[current.name];\n merged[current.name] = existing ? Object.assign({}, existing, current, {\n options: Object.assign({}, existing.options, current.options),\n data: Object.assign({}, existing.data, current.data)\n }) : current;\n return merged;\n }, {}); // IE11 does not support Object.values\n\n return Object.keys(merged).map(function (key) {\n return merged[key];\n });\n}","import { popperGenerator, detectOverflow } from \"./createPopper.js\";\nimport eventListeners from \"./modifiers/eventListeners.js\";\nimport popperOffsets from \"./modifiers/popperOffsets.js\";\nimport computeStyles from \"./modifiers/computeStyles.js\";\nimport applyStyles from \"./modifiers/applyStyles.js\";\nimport offset from \"./modifiers/offset.js\";\nimport flip from \"./modifiers/flip.js\";\nimport preventOverflow from \"./modifiers/preventOverflow.js\";\nimport arrow from \"./modifiers/arrow.js\";\nimport hide from \"./modifiers/hide.js\";\nvar defaultModifiers = [eventListeners, popperOffsets, computeStyles, applyStyles, offset, flip, preventOverflow, arrow, hide];\nvar createPopper = /*#__PURE__*/popperGenerator({\n defaultModifiers: defaultModifiers\n}); // eslint-disable-next-line import/no-unused-modules\n\nexport { createPopper, popperGenerator, defaultModifiers, detectOverflow }; // eslint-disable-next-line import/no-unused-modules\n\nexport { createPopper as createPopperLite } from \"./popper-lite.js\"; // eslint-disable-next-line import/no-unused-modules\n\nexport * from \"./modifiers/index.js\";","import { popperGenerator, detectOverflow } from \"./createPopper.js\";\nimport eventListeners from \"./modifiers/eventListeners.js\";\nimport popperOffsets from \"./modifiers/popperOffsets.js\";\nimport computeStyles from \"./modifiers/computeStyles.js\";\nimport applyStyles from \"./modifiers/applyStyles.js\";\nvar defaultModifiers = [eventListeners, popperOffsets, computeStyles, applyStyles];\nvar createPopper = /*#__PURE__*/popperGenerator({\n defaultModifiers: defaultModifiers\n}); // eslint-disable-next-line import/no-unused-modules\n\nexport { createPopper, popperGenerator, defaultModifiers, detectOverflow };","/*!\n * Bootstrap v5.2.3 (https://getbootstrap.com/)\n * Copyright 2011-2022 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors)\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n */\nimport * as Popper from '@popperjs/core';\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/index.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\nconst MAX_UID = 1000000;\nconst MILLISECONDS_MULTIPLIER = 1000;\nconst TRANSITION_END = 'transitionend'; // Shout-out Angus Croll (https://goo.gl/pxwQGp)\n\nconst toType = object => {\n if (object === null || object === undefined) {\n return `${object}`;\n }\n\n return Object.prototype.toString.call(object).match(/\\s([a-z]+)/i)[1].toLowerCase();\n};\n/**\n * Public Util API\n */\n\n\nconst getUID = prefix => {\n do {\n prefix += Math.floor(Math.random() * MAX_UID);\n } while (document.getElementById(prefix));\n\n return prefix;\n};\n\nconst getSelector = element => {\n let selector = element.getAttribute('data-bs-target');\n\n if (!selector || selector === '#') {\n let hrefAttribute = element.getAttribute('href'); // The only valid content that could double as a selector are IDs or classes,\n // so everything starting with `#` or `.`. If a \"real\" URL is used as the selector,\n // `document.querySelector` will rightfully complain it is invalid.\n // See https://github.com/twbs/bootstrap/issues/32273\n\n if (!hrefAttribute || !hrefAttribute.includes('#') && !hrefAttribute.startsWith('.')) {\n return null;\n } // Just in case some CMS puts out a full URL with the anchor appended\n\n\n if (hrefAttribute.includes('#') && !hrefAttribute.startsWith('#')) {\n hrefAttribute = `#${hrefAttribute.split('#')[1]}`;\n }\n\n selector = hrefAttribute && hrefAttribute !== '#' ? hrefAttribute.trim() : null;\n }\n\n return selector;\n};\n\nconst getSelectorFromElement = element => {\n const selector = getSelector(element);\n\n if (selector) {\n return document.querySelector(selector) ? selector : null;\n }\n\n return null;\n};\n\nconst getElementFromSelector = element => {\n const selector = getSelector(element);\n return selector ? document.querySelector(selector) : null;\n};\n\nconst getTransitionDurationFromElement = element => {\n if (!element) {\n return 0;\n } // Get transition-duration of the element\n\n\n let {\n transitionDuration,\n transitionDelay\n } = window.getComputedStyle(element);\n const floatTransitionDuration = Number.parseFloat(transitionDuration);\n const floatTransitionDelay = Number.parseFloat(transitionDelay); // Return 0 if element or transition duration is not found\n\n if (!floatTransitionDuration && !floatTransitionDelay) {\n return 0;\n } // If multiple durations are defined, take the first\n\n\n transitionDuration = transitionDuration.split(',')[0];\n transitionDelay = transitionDelay.split(',')[0];\n return (Number.parseFloat(transitionDuration) + Number.parseFloat(transitionDelay)) * MILLISECONDS_MULTIPLIER;\n};\n\nconst triggerTransitionEnd = element => {\n element.dispatchEvent(new Event(TRANSITION_END));\n};\n\nconst isElement = object => {\n if (!object || typeof object !== 'object') {\n return false;\n }\n\n if (typeof object.jquery !== 'undefined') {\n object = object[0];\n }\n\n return typeof object.nodeType !== 'undefined';\n};\n\nconst getElement = object => {\n // it's a jQuery object or a node element\n if (isElement(object)) {\n return object.jquery ? object[0] : object;\n }\n\n if (typeof object === 'string' && object.length > 0) {\n return document.querySelector(object);\n }\n\n return null;\n};\n\nconst isVisible = element => {\n if (!isElement(element) || element.getClientRects().length === 0) {\n return false;\n }\n\n const elementIsVisible = getComputedStyle(element).getPropertyValue('visibility') === 'visible'; // Handle `details` element as its content may falsie appear visible when it is closed\n\n const closedDetails = element.closest('details:not([open])');\n\n if (!closedDetails) {\n return elementIsVisible;\n }\n\n if (closedDetails !== element) {\n const summary = element.closest('summary');\n\n if (summary && summary.parentNode !== closedDetails) {\n return false;\n }\n\n if (summary === null) {\n return false;\n }\n }\n\n return elementIsVisible;\n};\n\nconst isDisabled = element => {\n if (!element || element.nodeType !== Node.ELEMENT_NODE) {\n return true;\n }\n\n if (element.classList.contains('disabled')) {\n return true;\n }\n\n if (typeof element.disabled !== 'undefined') {\n return element.disabled;\n }\n\n return element.hasAttribute('disabled') && element.getAttribute('disabled') !== 'false';\n};\n\nconst findShadowRoot = element => {\n if (!document.documentElement.attachShadow) {\n return null;\n } // Can find the shadow root otherwise it'll return the document\n\n\n if (typeof element.getRootNode === 'function') {\n const root = element.getRootNode();\n return root instanceof ShadowRoot ? root : null;\n }\n\n if (element instanceof ShadowRoot) {\n return element;\n } // when we don't find a shadow root\n\n\n if (!element.parentNode) {\n return null;\n }\n\n return findShadowRoot(element.parentNode);\n};\n\nconst noop = () => {};\n/**\n * Trick to restart an element's animation\n *\n * @param {HTMLElement} element\n * @return void\n *\n * @see https://www.charistheo.io/blog/2021/02/restart-a-css-animation-with-javascript/#restarting-a-css-animation\n */\n\n\nconst reflow = element => {\n element.offsetHeight; // eslint-disable-line no-unused-expressions\n};\n\nconst getjQuery = () => {\n if (window.jQuery && !document.body.hasAttribute('data-bs-no-jquery')) {\n return window.jQuery;\n }\n\n return null;\n};\n\nconst DOMContentLoadedCallbacks = [];\n\nconst onDOMContentLoaded = callback => {\n if (document.readyState === 'loading') {\n // add listener on the first call when the document is in loading state\n if (!DOMContentLoadedCallbacks.length) {\n document.addEventListener('DOMContentLoaded', () => {\n for (const callback of DOMContentLoadedCallbacks) {\n callback();\n }\n });\n }\n\n DOMContentLoadedCallbacks.push(callback);\n } else {\n callback();\n }\n};\n\nconst isRTL = () => document.documentElement.dir === 'rtl';\n\nconst defineJQueryPlugin = plugin => {\n onDOMContentLoaded(() => {\n const $ = getjQuery();\n /* istanbul ignore if */\n\n if ($) {\n const name = plugin.NAME;\n const JQUERY_NO_CONFLICT = $.fn[name];\n $.fn[name] = plugin.jQueryInterface;\n $.fn[name].Constructor = plugin;\n\n $.fn[name].noConflict = () => {\n $.fn[name] = JQUERY_NO_CONFLICT;\n return plugin.jQueryInterface;\n };\n }\n });\n};\n\nconst execute = callback => {\n if (typeof callback === 'function') {\n callback();\n }\n};\n\nconst executeAfterTransition = (callback, transitionElement, waitForTransition = true) => {\n if (!waitForTransition) {\n execute(callback);\n return;\n }\n\n const durationPadding = 5;\n const emulatedDuration = getTransitionDurationFromElement(transitionElement) + durationPadding;\n let called = false;\n\n const handler = ({\n target\n }) => {\n if (target !== transitionElement) {\n return;\n }\n\n called = true;\n transitionElement.removeEventListener(TRANSITION_END, handler);\n execute(callback);\n };\n\n transitionElement.addEventListener(TRANSITION_END, handler);\n setTimeout(() => {\n if (!called) {\n triggerTransitionEnd(transitionElement);\n }\n }, emulatedDuration);\n};\n/**\n * Return the previous/next element of a list.\n *\n * @param {array} list The list of elements\n * @param activeElement The active element\n * @param shouldGetNext Choose to get next or previous element\n * @param isCycleAllowed\n * @return {Element|elem} The proper element\n */\n\n\nconst getNextActiveElement = (list, activeElement, shouldGetNext, isCycleAllowed) => {\n const listLength = list.length;\n let index = list.indexOf(activeElement); // if the element does not exist in the list return an element\n // depending on the direction and if cycle is allowed\n\n if (index === -1) {\n return !shouldGetNext && isCycleAllowed ? list[listLength - 1] : list[0];\n }\n\n index += shouldGetNext ? 1 : -1;\n\n if (isCycleAllowed) {\n index = (index + listLength) % listLength;\n }\n\n return list[Math.max(0, Math.min(index, listLength - 1))];\n};\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): dom/event-handler.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst namespaceRegex = /[^.]*(?=\\..*)\\.|.*/;\nconst stripNameRegex = /\\..*/;\nconst stripUidRegex = /::\\d+$/;\nconst eventRegistry = {}; // Events storage\n\nlet uidEvent = 1;\nconst customEvents = {\n mouseenter: 'mouseover',\n mouseleave: 'mouseout'\n};\nconst nativeEvents = new Set(['click', 'dblclick', 'mouseup', 'mousedown', 'contextmenu', 'mousewheel', 'DOMMouseScroll', 'mouseover', 'mouseout', 'mousemove', 'selectstart', 'selectend', 'keydown', 'keypress', 'keyup', 'orientationchange', 'touchstart', 'touchmove', 'touchend', 'touchcancel', 'pointerdown', 'pointermove', 'pointerup', 'pointerleave', 'pointercancel', 'gesturestart', 'gesturechange', 'gestureend', 'focus', 'blur', 'change', 'reset', 'select', 'submit', 'focusin', 'focusout', 'load', 'unload', 'beforeunload', 'resize', 'move', 'DOMContentLoaded', 'readystatechange', 'error', 'abort', 'scroll']);\n/**\n * Private methods\n */\n\nfunction makeEventUid(element, uid) {\n return uid && `${uid}::${uidEvent++}` || element.uidEvent || uidEvent++;\n}\n\nfunction getElementEvents(element) {\n const uid = makeEventUid(element);\n element.uidEvent = uid;\n eventRegistry[uid] = eventRegistry[uid] || {};\n return eventRegistry[uid];\n}\n\nfunction bootstrapHandler(element, fn) {\n return function handler(event) {\n hydrateObj(event, {\n delegateTarget: element\n });\n\n if (handler.oneOff) {\n EventHandler.off(element, event.type, fn);\n }\n\n return fn.apply(element, [event]);\n };\n}\n\nfunction bootstrapDelegationHandler(element, selector, fn) {\n return function handler(event) {\n const domElements = element.querySelectorAll(selector);\n\n for (let {\n target\n } = event; target && target !== this; target = target.parentNode) {\n for (const domElement of domElements) {\n if (domElement !== target) {\n continue;\n }\n\n hydrateObj(event, {\n delegateTarget: target\n });\n\n if (handler.oneOff) {\n EventHandler.off(element, event.type, selector, fn);\n }\n\n return fn.apply(target, [event]);\n }\n }\n };\n}\n\nfunction findHandler(events, callable, delegationSelector = null) {\n return Object.values(events).find(event => event.callable === callable && event.delegationSelector === delegationSelector);\n}\n\nfunction normalizeParameters(originalTypeEvent, handler, delegationFunction) {\n const isDelegated = typeof handler === 'string'; // todo: tooltip passes `false` instead of selector, so we need to check\n\n const callable = isDelegated ? delegationFunction : handler || delegationFunction;\n let typeEvent = getTypeEvent(originalTypeEvent);\n\n if (!nativeEvents.has(typeEvent)) {\n typeEvent = originalTypeEvent;\n }\n\n return [isDelegated, callable, typeEvent];\n}\n\nfunction addHandler(element, originalTypeEvent, handler, delegationFunction, oneOff) {\n if (typeof originalTypeEvent !== 'string' || !element) {\n return;\n }\n\n let [isDelegated, callable, typeEvent] = normalizeParameters(originalTypeEvent, handler, delegationFunction); // in case of mouseenter or mouseleave wrap the handler within a function that checks for its DOM position\n // this prevents the handler from being dispatched the same way as mouseover or mouseout does\n\n if (originalTypeEvent in customEvents) {\n const wrapFunction = fn => {\n return function (event) {\n if (!event.relatedTarget || event.relatedTarget !== event.delegateTarget && !event.delegateTarget.contains(event.relatedTarget)) {\n return fn.call(this, event);\n }\n };\n };\n\n callable = wrapFunction(callable);\n }\n\n const events = getElementEvents(element);\n const handlers = events[typeEvent] || (events[typeEvent] = {});\n const previousFunction = findHandler(handlers, callable, isDelegated ? handler : null);\n\n if (previousFunction) {\n previousFunction.oneOff = previousFunction.oneOff && oneOff;\n return;\n }\n\n const uid = makeEventUid(callable, originalTypeEvent.replace(namespaceRegex, ''));\n const fn = isDelegated ? bootstrapDelegationHandler(element, handler, callable) : bootstrapHandler(element, callable);\n fn.delegationSelector = isDelegated ? handler : null;\n fn.callable = callable;\n fn.oneOff = oneOff;\n fn.uidEvent = uid;\n handlers[uid] = fn;\n element.addEventListener(typeEvent, fn, isDelegated);\n}\n\nfunction removeHandler(element, events, typeEvent, handler, delegationSelector) {\n const fn = findHandler(events[typeEvent], handler, delegationSelector);\n\n if (!fn) {\n return;\n }\n\n element.removeEventListener(typeEvent, fn, Boolean(delegationSelector));\n delete events[typeEvent][fn.uidEvent];\n}\n\nfunction removeNamespacedHandlers(element, events, typeEvent, namespace) {\n const storeElementEvent = events[typeEvent] || {};\n\n for (const handlerKey of Object.keys(storeElementEvent)) {\n if (handlerKey.includes(namespace)) {\n const event = storeElementEvent[handlerKey];\n removeHandler(element, events, typeEvent, event.callable, event.delegationSelector);\n }\n }\n}\n\nfunction getTypeEvent(event) {\n // allow to get the native events from namespaced events ('click.bs.button' --> 'click')\n event = event.replace(stripNameRegex, '');\n return customEvents[event] || event;\n}\n\nconst EventHandler = {\n on(element, event, handler, delegationFunction) {\n addHandler(element, event, handler, delegationFunction, false);\n },\n\n one(element, event, handler, delegationFunction) {\n addHandler(element, event, handler, delegationFunction, true);\n },\n\n off(element, originalTypeEvent, handler, delegationFunction) {\n if (typeof originalTypeEvent !== 'string' || !element) {\n return;\n }\n\n const [isDelegated, callable, typeEvent] = normalizeParameters(originalTypeEvent, handler, delegationFunction);\n const inNamespace = typeEvent !== originalTypeEvent;\n const events = getElementEvents(element);\n const storeElementEvent = events[typeEvent] || {};\n const isNamespace = originalTypeEvent.startsWith('.');\n\n if (typeof callable !== 'undefined') {\n // Simplest case: handler is passed, remove that listener ONLY.\n if (!Object.keys(storeElementEvent).length) {\n return;\n }\n\n removeHandler(element, events, typeEvent, callable, isDelegated ? handler : null);\n return;\n }\n\n if (isNamespace) {\n for (const elementEvent of Object.keys(events)) {\n removeNamespacedHandlers(element, events, elementEvent, originalTypeEvent.slice(1));\n }\n }\n\n for (const keyHandlers of Object.keys(storeElementEvent)) {\n const handlerKey = keyHandlers.replace(stripUidRegex, '');\n\n if (!inNamespace || originalTypeEvent.includes(handlerKey)) {\n const event = storeElementEvent[keyHandlers];\n removeHandler(element, events, typeEvent, event.callable, event.delegationSelector);\n }\n }\n },\n\n trigger(element, event, args) {\n if (typeof event !== 'string' || !element) {\n return null;\n }\n\n const $ = getjQuery();\n const typeEvent = getTypeEvent(event);\n const inNamespace = event !== typeEvent;\n let jQueryEvent = null;\n let bubbles = true;\n let nativeDispatch = true;\n let defaultPrevented = false;\n\n if (inNamespace && $) {\n jQueryEvent = $.Event(event, args);\n $(element).trigger(jQueryEvent);\n bubbles = !jQueryEvent.isPropagationStopped();\n nativeDispatch = !jQueryEvent.isImmediatePropagationStopped();\n defaultPrevented = jQueryEvent.isDefaultPrevented();\n }\n\n let evt = new Event(event, {\n bubbles,\n cancelable: true\n });\n evt = hydrateObj(evt, args);\n\n if (defaultPrevented) {\n evt.preventDefault();\n }\n\n if (nativeDispatch) {\n element.dispatchEvent(evt);\n }\n\n if (evt.defaultPrevented && jQueryEvent) {\n jQueryEvent.preventDefault();\n }\n\n return evt;\n }\n\n};\n\nfunction hydrateObj(obj, meta) {\n for (const [key, value] of Object.entries(meta || {})) {\n try {\n obj[key] = value;\n } catch (_unused) {\n Object.defineProperty(obj, key, {\n configurable: true,\n\n get() {\n return value;\n }\n\n });\n }\n }\n\n return obj;\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): dom/data.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n\n/**\n * Constants\n */\nconst elementMap = new Map();\nconst Data = {\n set(element, key, instance) {\n if (!elementMap.has(element)) {\n elementMap.set(element, new Map());\n }\n\n const instanceMap = elementMap.get(element); // make it clear we only want one instance per element\n // can be removed later when multiple key/instances are fine to be used\n\n if (!instanceMap.has(key) && instanceMap.size !== 0) {\n // eslint-disable-next-line no-console\n console.error(`Bootstrap doesn't allow more than one instance per element. Bound instance: ${Array.from(instanceMap.keys())[0]}.`);\n return;\n }\n\n instanceMap.set(key, instance);\n },\n\n get(element, key) {\n if (elementMap.has(element)) {\n return elementMap.get(element).get(key) || null;\n }\n\n return null;\n },\n\n remove(element, key) {\n if (!elementMap.has(element)) {\n return;\n }\n\n const instanceMap = elementMap.get(element);\n instanceMap.delete(key); // free up element references if there are no instances left for an element\n\n if (instanceMap.size === 0) {\n elementMap.delete(element);\n }\n }\n\n};\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): dom/manipulator.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\nfunction normalizeData(value) {\n if (value === 'true') {\n return true;\n }\n\n if (value === 'false') {\n return false;\n }\n\n if (value === Number(value).toString()) {\n return Number(value);\n }\n\n if (value === '' || value === 'null') {\n return null;\n }\n\n if (typeof value !== 'string') {\n return value;\n }\n\n try {\n return JSON.parse(decodeURIComponent(value));\n } catch (_unused) {\n return value;\n }\n}\n\nfunction normalizeDataKey(key) {\n return key.replace(/[A-Z]/g, chr => `-${chr.toLowerCase()}`);\n}\n\nconst Manipulator = {\n setDataAttribute(element, key, value) {\n element.setAttribute(`data-bs-${normalizeDataKey(key)}`, value);\n },\n\n removeDataAttribute(element, key) {\n element.removeAttribute(`data-bs-${normalizeDataKey(key)}`);\n },\n\n getDataAttributes(element) {\n if (!element) {\n return {};\n }\n\n const attributes = {};\n const bsKeys = Object.keys(element.dataset).filter(key => key.startsWith('bs') && !key.startsWith('bsConfig'));\n\n for (const key of bsKeys) {\n let pureKey = key.replace(/^bs/, '');\n pureKey = pureKey.charAt(0).toLowerCase() + pureKey.slice(1, pureKey.length);\n attributes[pureKey] = normalizeData(element.dataset[key]);\n }\n\n return attributes;\n },\n\n getDataAttribute(element, key) {\n return normalizeData(element.getAttribute(`data-bs-${normalizeDataKey(key)}`));\n }\n\n};\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/config.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Class definition\n */\n\nclass Config {\n // Getters\n static get Default() {\n return {};\n }\n\n static get DefaultType() {\n return {};\n }\n\n static get NAME() {\n throw new Error('You have to implement the static method \"NAME\", for each component!');\n }\n\n _getConfig(config) {\n config = this._mergeConfigObj(config);\n config = this._configAfterMerge(config);\n\n this._typeCheckConfig(config);\n\n return config;\n }\n\n _configAfterMerge(config) {\n return config;\n }\n\n _mergeConfigObj(config, element) {\n const jsonConfig = isElement(element) ? Manipulator.getDataAttribute(element, 'config') : {}; // try to parse\n\n return { ...this.constructor.Default,\n ...(typeof jsonConfig === 'object' ? jsonConfig : {}),\n ...(isElement(element) ? Manipulator.getDataAttributes(element) : {}),\n ...(typeof config === 'object' ? config : {})\n };\n }\n\n _typeCheckConfig(config, configTypes = this.constructor.DefaultType) {\n for (const property of Object.keys(configTypes)) {\n const expectedTypes = configTypes[property];\n const value = config[property];\n const valueType = isElement(value) ? 'element' : toType(value);\n\n if (!new RegExp(expectedTypes).test(valueType)) {\n throw new TypeError(`${this.constructor.NAME.toUpperCase()}: Option \"${property}\" provided type \"${valueType}\" but expected type \"${expectedTypes}\".`);\n }\n }\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): base-component.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst VERSION = '5.2.3';\n/**\n * Class definition\n */\n\nclass BaseComponent extends Config {\n constructor(element, config) {\n super();\n element = getElement(element);\n\n if (!element) {\n return;\n }\n\n this._element = element;\n this._config = this._getConfig(config);\n Data.set(this._element, this.constructor.DATA_KEY, this);\n } // Public\n\n\n dispose() {\n Data.remove(this._element, this.constructor.DATA_KEY);\n EventHandler.off(this._element, this.constructor.EVENT_KEY);\n\n for (const propertyName of Object.getOwnPropertyNames(this)) {\n this[propertyName] = null;\n }\n }\n\n _queueCallback(callback, element, isAnimated = true) {\n executeAfterTransition(callback, element, isAnimated);\n }\n\n _getConfig(config) {\n config = this._mergeConfigObj(config, this._element);\n config = this._configAfterMerge(config);\n\n this._typeCheckConfig(config);\n\n return config;\n } // Static\n\n\n static getInstance(element) {\n return Data.get(getElement(element), this.DATA_KEY);\n }\n\n static getOrCreateInstance(element, config = {}) {\n return this.getInstance(element) || new this(element, typeof config === 'object' ? config : null);\n }\n\n static get VERSION() {\n return VERSION;\n }\n\n static get DATA_KEY() {\n return `bs.${this.NAME}`;\n }\n\n static get EVENT_KEY() {\n return `.${this.DATA_KEY}`;\n }\n\n static eventName(name) {\n return `${name}${this.EVENT_KEY}`;\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/component-functions.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n\nconst enableDismissTrigger = (component, method = 'hide') => {\n const clickEvent = `click.dismiss${component.EVENT_KEY}`;\n const name = component.NAME;\n EventHandler.on(document, clickEvent, `[data-bs-dismiss=\"${name}\"]`, function (event) {\n if (['A', 'AREA'].includes(this.tagName)) {\n event.preventDefault();\n }\n\n if (isDisabled(this)) {\n return;\n }\n\n const target = getElementFromSelector(this) || this.closest(`.${name}`);\n const instance = component.getOrCreateInstance(target); // Method argument is left, for Alert and only, as it doesn't implement the 'hide' method\n\n instance[method]();\n });\n};\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): alert.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$f = 'alert';\nconst DATA_KEY$a = 'bs.alert';\nconst EVENT_KEY$b = `.${DATA_KEY$a}`;\nconst EVENT_CLOSE = `close${EVENT_KEY$b}`;\nconst EVENT_CLOSED = `closed${EVENT_KEY$b}`;\nconst CLASS_NAME_FADE$5 = 'fade';\nconst CLASS_NAME_SHOW$8 = 'show';\n/**\n * Class definition\n */\n\nclass Alert extends BaseComponent {\n // Getters\n static get NAME() {\n return NAME$f;\n } // Public\n\n\n close() {\n const closeEvent = EventHandler.trigger(this._element, EVENT_CLOSE);\n\n if (closeEvent.defaultPrevented) {\n return;\n }\n\n this._element.classList.remove(CLASS_NAME_SHOW$8);\n\n const isAnimated = this._element.classList.contains(CLASS_NAME_FADE$5);\n\n this._queueCallback(() => this._destroyElement(), this._element, isAnimated);\n } // Private\n\n\n _destroyElement() {\n this._element.remove();\n\n EventHandler.trigger(this._element, EVENT_CLOSED);\n this.dispose();\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Alert.getOrCreateInstance(this);\n\n if (typeof config !== 'string') {\n return;\n }\n\n if (data[config] === undefined || config.startsWith('_') || config === 'constructor') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config](this);\n });\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nenableDismissTrigger(Alert, 'close');\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Alert);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): button.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$e = 'button';\nconst DATA_KEY$9 = 'bs.button';\nconst EVENT_KEY$a = `.${DATA_KEY$9}`;\nconst DATA_API_KEY$6 = '.data-api';\nconst CLASS_NAME_ACTIVE$3 = 'active';\nconst SELECTOR_DATA_TOGGLE$5 = '[data-bs-toggle=\"button\"]';\nconst EVENT_CLICK_DATA_API$6 = `click${EVENT_KEY$a}${DATA_API_KEY$6}`;\n/**\n * Class definition\n */\n\nclass Button extends BaseComponent {\n // Getters\n static get NAME() {\n return NAME$e;\n } // Public\n\n\n toggle() {\n // Toggle class and sync the `aria-pressed` attribute with the return value of the `.toggle()` method\n this._element.setAttribute('aria-pressed', this._element.classList.toggle(CLASS_NAME_ACTIVE$3));\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Button.getOrCreateInstance(this);\n\n if (config === 'toggle') {\n data[config]();\n }\n });\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nEventHandler.on(document, EVENT_CLICK_DATA_API$6, SELECTOR_DATA_TOGGLE$5, event => {\n event.preventDefault();\n const button = event.target.closest(SELECTOR_DATA_TOGGLE$5);\n const data = Button.getOrCreateInstance(button);\n data.toggle();\n});\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Button);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): dom/selector-engine.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst SelectorEngine = {\n find(selector, element = document.documentElement) {\n return [].concat(...Element.prototype.querySelectorAll.call(element, selector));\n },\n\n findOne(selector, element = document.documentElement) {\n return Element.prototype.querySelector.call(element, selector);\n },\n\n children(element, selector) {\n return [].concat(...element.children).filter(child => child.matches(selector));\n },\n\n parents(element, selector) {\n const parents = [];\n let ancestor = element.parentNode.closest(selector);\n\n while (ancestor) {\n parents.push(ancestor);\n ancestor = ancestor.parentNode.closest(selector);\n }\n\n return parents;\n },\n\n prev(element, selector) {\n let previous = element.previousElementSibling;\n\n while (previous) {\n if (previous.matches(selector)) {\n return [previous];\n }\n\n previous = previous.previousElementSibling;\n }\n\n return [];\n },\n\n // TODO: this is now unused; remove later along with prev()\n next(element, selector) {\n let next = element.nextElementSibling;\n\n while (next) {\n if (next.matches(selector)) {\n return [next];\n }\n\n next = next.nextElementSibling;\n }\n\n return [];\n },\n\n focusableChildren(element) {\n const focusables = ['a', 'button', 'input', 'textarea', 'select', 'details', '[tabindex]', '[contenteditable=\"true\"]'].map(selector => `${selector}:not([tabindex^=\"-\"])`).join(',');\n return this.find(focusables, element).filter(el => !isDisabled(el) && isVisible(el));\n }\n\n};\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/swipe.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$d = 'swipe';\nconst EVENT_KEY$9 = '.bs.swipe';\nconst EVENT_TOUCHSTART = `touchstart${EVENT_KEY$9}`;\nconst EVENT_TOUCHMOVE = `touchmove${EVENT_KEY$9}`;\nconst EVENT_TOUCHEND = `touchend${EVENT_KEY$9}`;\nconst EVENT_POINTERDOWN = `pointerdown${EVENT_KEY$9}`;\nconst EVENT_POINTERUP = `pointerup${EVENT_KEY$9}`;\nconst POINTER_TYPE_TOUCH = 'touch';\nconst POINTER_TYPE_PEN = 'pen';\nconst CLASS_NAME_POINTER_EVENT = 'pointer-event';\nconst SWIPE_THRESHOLD = 40;\nconst Default$c = {\n endCallback: null,\n leftCallback: null,\n rightCallback: null\n};\nconst DefaultType$c = {\n endCallback: '(function|null)',\n leftCallback: '(function|null)',\n rightCallback: '(function|null)'\n};\n/**\n * Class definition\n */\n\nclass Swipe extends Config {\n constructor(element, config) {\n super();\n this._element = element;\n\n if (!element || !Swipe.isSupported()) {\n return;\n }\n\n this._config = this._getConfig(config);\n this._deltaX = 0;\n this._supportPointerEvents = Boolean(window.PointerEvent);\n\n this._initEvents();\n } // Getters\n\n\n static get Default() {\n return Default$c;\n }\n\n static get DefaultType() {\n return DefaultType$c;\n }\n\n static get NAME() {\n return NAME$d;\n } // Public\n\n\n dispose() {\n EventHandler.off(this._element, EVENT_KEY$9);\n } // Private\n\n\n _start(event) {\n if (!this._supportPointerEvents) {\n this._deltaX = event.touches[0].clientX;\n return;\n }\n\n if (this._eventIsPointerPenTouch(event)) {\n this._deltaX = event.clientX;\n }\n }\n\n _end(event) {\n if (this._eventIsPointerPenTouch(event)) {\n this._deltaX = event.clientX - this._deltaX;\n }\n\n this._handleSwipe();\n\n execute(this._config.endCallback);\n }\n\n _move(event) {\n this._deltaX = event.touches && event.touches.length > 1 ? 0 : event.touches[0].clientX - this._deltaX;\n }\n\n _handleSwipe() {\n const absDeltaX = Math.abs(this._deltaX);\n\n if (absDeltaX <= SWIPE_THRESHOLD) {\n return;\n }\n\n const direction = absDeltaX / this._deltaX;\n this._deltaX = 0;\n\n if (!direction) {\n return;\n }\n\n execute(direction > 0 ? this._config.rightCallback : this._config.leftCallback);\n }\n\n _initEvents() {\n if (this._supportPointerEvents) {\n EventHandler.on(this._element, EVENT_POINTERDOWN, event => this._start(event));\n EventHandler.on(this._element, EVENT_POINTERUP, event => this._end(event));\n\n this._element.classList.add(CLASS_NAME_POINTER_EVENT);\n } else {\n EventHandler.on(this._element, EVENT_TOUCHSTART, event => this._start(event));\n EventHandler.on(this._element, EVENT_TOUCHMOVE, event => this._move(event));\n EventHandler.on(this._element, EVENT_TOUCHEND, event => this._end(event));\n }\n }\n\n _eventIsPointerPenTouch(event) {\n return this._supportPointerEvents && (event.pointerType === POINTER_TYPE_PEN || event.pointerType === POINTER_TYPE_TOUCH);\n } // Static\n\n\n static isSupported() {\n return 'ontouchstart' in document.documentElement || navigator.maxTouchPoints > 0;\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): carousel.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$c = 'carousel';\nconst DATA_KEY$8 = 'bs.carousel';\nconst EVENT_KEY$8 = `.${DATA_KEY$8}`;\nconst DATA_API_KEY$5 = '.data-api';\nconst ARROW_LEFT_KEY$1 = 'ArrowLeft';\nconst ARROW_RIGHT_KEY$1 = 'ArrowRight';\nconst TOUCHEVENT_COMPAT_WAIT = 500; // Time for mouse compat events to fire after touch\n\nconst ORDER_NEXT = 'next';\nconst ORDER_PREV = 'prev';\nconst DIRECTION_LEFT = 'left';\nconst DIRECTION_RIGHT = 'right';\nconst EVENT_SLIDE = `slide${EVENT_KEY$8}`;\nconst EVENT_SLID = `slid${EVENT_KEY$8}`;\nconst EVENT_KEYDOWN$1 = `keydown${EVENT_KEY$8}`;\nconst EVENT_MOUSEENTER$1 = `mouseenter${EVENT_KEY$8}`;\nconst EVENT_MOUSELEAVE$1 = `mouseleave${EVENT_KEY$8}`;\nconst EVENT_DRAG_START = `dragstart${EVENT_KEY$8}`;\nconst EVENT_LOAD_DATA_API$3 = `load${EVENT_KEY$8}${DATA_API_KEY$5}`;\nconst EVENT_CLICK_DATA_API$5 = `click${EVENT_KEY$8}${DATA_API_KEY$5}`;\nconst CLASS_NAME_CAROUSEL = 'carousel';\nconst CLASS_NAME_ACTIVE$2 = 'active';\nconst CLASS_NAME_SLIDE = 'slide';\nconst CLASS_NAME_END = 'carousel-item-end';\nconst CLASS_NAME_START = 'carousel-item-start';\nconst CLASS_NAME_NEXT = 'carousel-item-next';\nconst CLASS_NAME_PREV = 'carousel-item-prev';\nconst SELECTOR_ACTIVE = '.active';\nconst SELECTOR_ITEM = '.carousel-item';\nconst SELECTOR_ACTIVE_ITEM = SELECTOR_ACTIVE + SELECTOR_ITEM;\nconst SELECTOR_ITEM_IMG = '.carousel-item img';\nconst SELECTOR_INDICATORS = '.carousel-indicators';\nconst SELECTOR_DATA_SLIDE = '[data-bs-slide], [data-bs-slide-to]';\nconst SELECTOR_DATA_RIDE = '[data-bs-ride=\"carousel\"]';\nconst KEY_TO_DIRECTION = {\n [ARROW_LEFT_KEY$1]: DIRECTION_RIGHT,\n [ARROW_RIGHT_KEY$1]: DIRECTION_LEFT\n};\nconst Default$b = {\n interval: 5000,\n keyboard: true,\n pause: 'hover',\n ride: false,\n touch: true,\n wrap: true\n};\nconst DefaultType$b = {\n interval: '(number|boolean)',\n // TODO:v6 remove boolean support\n keyboard: 'boolean',\n pause: '(string|boolean)',\n ride: '(boolean|string)',\n touch: 'boolean',\n wrap: 'boolean'\n};\n/**\n * Class definition\n */\n\nclass Carousel extends BaseComponent {\n constructor(element, config) {\n super(element, config);\n this._interval = null;\n this._activeElement = null;\n this._isSliding = false;\n this.touchTimeout = null;\n this._swipeHelper = null;\n this._indicatorsElement = SelectorEngine.findOne(SELECTOR_INDICATORS, this._element);\n\n this._addEventListeners();\n\n if (this._config.ride === CLASS_NAME_CAROUSEL) {\n this.cycle();\n }\n } // Getters\n\n\n static get Default() {\n return Default$b;\n }\n\n static get DefaultType() {\n return DefaultType$b;\n }\n\n static get NAME() {\n return NAME$c;\n } // Public\n\n\n next() {\n this._slide(ORDER_NEXT);\n }\n\n nextWhenVisible() {\n // FIXME TODO use `document.visibilityState`\n // Don't call next when the page isn't visible\n // or the carousel or its parent isn't visible\n if (!document.hidden && isVisible(this._element)) {\n this.next();\n }\n }\n\n prev() {\n this._slide(ORDER_PREV);\n }\n\n pause() {\n if (this._isSliding) {\n triggerTransitionEnd(this._element);\n }\n\n this._clearInterval();\n }\n\n cycle() {\n this._clearInterval();\n\n this._updateInterval();\n\n this._interval = setInterval(() => this.nextWhenVisible(), this._config.interval);\n }\n\n _maybeEnableCycle() {\n if (!this._config.ride) {\n return;\n }\n\n if (this._isSliding) {\n EventHandler.one(this._element, EVENT_SLID, () => this.cycle());\n return;\n }\n\n this.cycle();\n }\n\n to(index) {\n const items = this._getItems();\n\n if (index > items.length - 1 || index < 0) {\n return;\n }\n\n if (this._isSliding) {\n EventHandler.one(this._element, EVENT_SLID, () => this.to(index));\n return;\n }\n\n const activeIndex = this._getItemIndex(this._getActive());\n\n if (activeIndex === index) {\n return;\n }\n\n const order = index > activeIndex ? ORDER_NEXT : ORDER_PREV;\n\n this._slide(order, items[index]);\n }\n\n dispose() {\n if (this._swipeHelper) {\n this._swipeHelper.dispose();\n }\n\n super.dispose();\n } // Private\n\n\n _configAfterMerge(config) {\n config.defaultInterval = config.interval;\n return config;\n }\n\n _addEventListeners() {\n if (this._config.keyboard) {\n EventHandler.on(this._element, EVENT_KEYDOWN$1, event => this._keydown(event));\n }\n\n if (this._config.pause === 'hover') {\n EventHandler.on(this._element, EVENT_MOUSEENTER$1, () => this.pause());\n EventHandler.on(this._element, EVENT_MOUSELEAVE$1, () => this._maybeEnableCycle());\n }\n\n if (this._config.touch && Swipe.isSupported()) {\n this._addTouchEventListeners();\n }\n }\n\n _addTouchEventListeners() {\n for (const img of SelectorEngine.find(SELECTOR_ITEM_IMG, this._element)) {\n EventHandler.on(img, EVENT_DRAG_START, event => event.preventDefault());\n }\n\n const endCallBack = () => {\n if (this._config.pause !== 'hover') {\n return;\n } // If it's a touch-enabled device, mouseenter/leave are fired as\n // part of the mouse compatibility events on first tap - the carousel\n // would stop cycling until user tapped out of it;\n // here, we listen for touchend, explicitly pause the carousel\n // (as if it's the second time we tap on it, mouseenter compat event\n // is NOT fired) and after a timeout (to allow for mouse compatibility\n // events to fire) we explicitly restart cycling\n\n\n this.pause();\n\n if (this.touchTimeout) {\n clearTimeout(this.touchTimeout);\n }\n\n this.touchTimeout = setTimeout(() => this._maybeEnableCycle(), TOUCHEVENT_COMPAT_WAIT + this._config.interval);\n };\n\n const swipeConfig = {\n leftCallback: () => this._slide(this._directionToOrder(DIRECTION_LEFT)),\n rightCallback: () => this._slide(this._directionToOrder(DIRECTION_RIGHT)),\n endCallback: endCallBack\n };\n this._swipeHelper = new Swipe(this._element, swipeConfig);\n }\n\n _keydown(event) {\n if (/input|textarea/i.test(event.target.tagName)) {\n return;\n }\n\n const direction = KEY_TO_DIRECTION[event.key];\n\n if (direction) {\n event.preventDefault();\n\n this._slide(this._directionToOrder(direction));\n }\n }\n\n _getItemIndex(element) {\n return this._getItems().indexOf(element);\n }\n\n _setActiveIndicatorElement(index) {\n if (!this._indicatorsElement) {\n return;\n }\n\n const activeIndicator = SelectorEngine.findOne(SELECTOR_ACTIVE, this._indicatorsElement);\n activeIndicator.classList.remove(CLASS_NAME_ACTIVE$2);\n activeIndicator.removeAttribute('aria-current');\n const newActiveIndicator = SelectorEngine.findOne(`[data-bs-slide-to=\"${index}\"]`, this._indicatorsElement);\n\n if (newActiveIndicator) {\n newActiveIndicator.classList.add(CLASS_NAME_ACTIVE$2);\n newActiveIndicator.setAttribute('aria-current', 'true');\n }\n }\n\n _updateInterval() {\n const element = this._activeElement || this._getActive();\n\n if (!element) {\n return;\n }\n\n const elementInterval = Number.parseInt(element.getAttribute('data-bs-interval'), 10);\n this._config.interval = elementInterval || this._config.defaultInterval;\n }\n\n _slide(order, element = null) {\n if (this._isSliding) {\n return;\n }\n\n const activeElement = this._getActive();\n\n const isNext = order === ORDER_NEXT;\n const nextElement = element || getNextActiveElement(this._getItems(), activeElement, isNext, this._config.wrap);\n\n if (nextElement === activeElement) {\n return;\n }\n\n const nextElementIndex = this._getItemIndex(nextElement);\n\n const triggerEvent = eventName => {\n return EventHandler.trigger(this._element, eventName, {\n relatedTarget: nextElement,\n direction: this._orderToDirection(order),\n from: this._getItemIndex(activeElement),\n to: nextElementIndex\n });\n };\n\n const slideEvent = triggerEvent(EVENT_SLIDE);\n\n if (slideEvent.defaultPrevented) {\n return;\n }\n\n if (!activeElement || !nextElement) {\n // Some weirdness is happening, so we bail\n // todo: change tests that use empty divs to avoid this check\n return;\n }\n\n const isCycling = Boolean(this._interval);\n this.pause();\n this._isSliding = true;\n\n this._setActiveIndicatorElement(nextElementIndex);\n\n this._activeElement = nextElement;\n const directionalClassName = isNext ? CLASS_NAME_START : CLASS_NAME_END;\n const orderClassName = isNext ? CLASS_NAME_NEXT : CLASS_NAME_PREV;\n nextElement.classList.add(orderClassName);\n reflow(nextElement);\n activeElement.classList.add(directionalClassName);\n nextElement.classList.add(directionalClassName);\n\n const completeCallBack = () => {\n nextElement.classList.remove(directionalClassName, orderClassName);\n nextElement.classList.add(CLASS_NAME_ACTIVE$2);\n activeElement.classList.remove(CLASS_NAME_ACTIVE$2, orderClassName, directionalClassName);\n this._isSliding = false;\n triggerEvent(EVENT_SLID);\n };\n\n this._queueCallback(completeCallBack, activeElement, this._isAnimated());\n\n if (isCycling) {\n this.cycle();\n }\n }\n\n _isAnimated() {\n return this._element.classList.contains(CLASS_NAME_SLIDE);\n }\n\n _getActive() {\n return SelectorEngine.findOne(SELECTOR_ACTIVE_ITEM, this._element);\n }\n\n _getItems() {\n return SelectorEngine.find(SELECTOR_ITEM, this._element);\n }\n\n _clearInterval() {\n if (this._interval) {\n clearInterval(this._interval);\n this._interval = null;\n }\n }\n\n _directionToOrder(direction) {\n if (isRTL()) {\n return direction === DIRECTION_LEFT ? ORDER_PREV : ORDER_NEXT;\n }\n\n return direction === DIRECTION_LEFT ? ORDER_NEXT : ORDER_PREV;\n }\n\n _orderToDirection(order) {\n if (isRTL()) {\n return order === ORDER_PREV ? DIRECTION_LEFT : DIRECTION_RIGHT;\n }\n\n return order === ORDER_PREV ? DIRECTION_RIGHT : DIRECTION_LEFT;\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Carousel.getOrCreateInstance(this, config);\n\n if (typeof config === 'number') {\n data.to(config);\n return;\n }\n\n if (typeof config === 'string') {\n if (data[config] === undefined || config.startsWith('_') || config === 'constructor') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config]();\n }\n });\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nEventHandler.on(document, EVENT_CLICK_DATA_API$5, SELECTOR_DATA_SLIDE, function (event) {\n const target = getElementFromSelector(this);\n\n if (!target || !target.classList.contains(CLASS_NAME_CAROUSEL)) {\n return;\n }\n\n event.preventDefault();\n const carousel = Carousel.getOrCreateInstance(target);\n const slideIndex = this.getAttribute('data-bs-slide-to');\n\n if (slideIndex) {\n carousel.to(slideIndex);\n\n carousel._maybeEnableCycle();\n\n return;\n }\n\n if (Manipulator.getDataAttribute(this, 'slide') === 'next') {\n carousel.next();\n\n carousel._maybeEnableCycle();\n\n return;\n }\n\n carousel.prev();\n\n carousel._maybeEnableCycle();\n});\nEventHandler.on(window, EVENT_LOAD_DATA_API$3, () => {\n const carousels = SelectorEngine.find(SELECTOR_DATA_RIDE);\n\n for (const carousel of carousels) {\n Carousel.getOrCreateInstance(carousel);\n }\n});\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Carousel);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): collapse.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$b = 'collapse';\nconst DATA_KEY$7 = 'bs.collapse';\nconst EVENT_KEY$7 = `.${DATA_KEY$7}`;\nconst DATA_API_KEY$4 = '.data-api';\nconst EVENT_SHOW$6 = `show${EVENT_KEY$7}`;\nconst EVENT_SHOWN$6 = `shown${EVENT_KEY$7}`;\nconst EVENT_HIDE$6 = `hide${EVENT_KEY$7}`;\nconst EVENT_HIDDEN$6 = `hidden${EVENT_KEY$7}`;\nconst EVENT_CLICK_DATA_API$4 = `click${EVENT_KEY$7}${DATA_API_KEY$4}`;\nconst CLASS_NAME_SHOW$7 = 'show';\nconst CLASS_NAME_COLLAPSE = 'collapse';\nconst CLASS_NAME_COLLAPSING = 'collapsing';\nconst CLASS_NAME_COLLAPSED = 'collapsed';\nconst CLASS_NAME_DEEPER_CHILDREN = `:scope .${CLASS_NAME_COLLAPSE} .${CLASS_NAME_COLLAPSE}`;\nconst CLASS_NAME_HORIZONTAL = 'collapse-horizontal';\nconst WIDTH = 'width';\nconst HEIGHT = 'height';\nconst SELECTOR_ACTIVES = '.collapse.show, .collapse.collapsing';\nconst SELECTOR_DATA_TOGGLE$4 = '[data-bs-toggle=\"collapse\"]';\nconst Default$a = {\n parent: null,\n toggle: true\n};\nconst DefaultType$a = {\n parent: '(null|element)',\n toggle: 'boolean'\n};\n/**\n * Class definition\n */\n\nclass Collapse extends BaseComponent {\n constructor(element, config) {\n super(element, config);\n this._isTransitioning = false;\n this._triggerArray = [];\n const toggleList = SelectorEngine.find(SELECTOR_DATA_TOGGLE$4);\n\n for (const elem of toggleList) {\n const selector = getSelectorFromElement(elem);\n const filterElement = SelectorEngine.find(selector).filter(foundElement => foundElement === this._element);\n\n if (selector !== null && filterElement.length) {\n this._triggerArray.push(elem);\n }\n }\n\n this._initializeChildren();\n\n if (!this._config.parent) {\n this._addAriaAndCollapsedClass(this._triggerArray, this._isShown());\n }\n\n if (this._config.toggle) {\n this.toggle();\n }\n } // Getters\n\n\n static get Default() {\n return Default$a;\n }\n\n static get DefaultType() {\n return DefaultType$a;\n }\n\n static get NAME() {\n return NAME$b;\n } // Public\n\n\n toggle() {\n if (this._isShown()) {\n this.hide();\n } else {\n this.show();\n }\n }\n\n show() {\n if (this._isTransitioning || this._isShown()) {\n return;\n }\n\n let activeChildren = []; // find active children\n\n if (this._config.parent) {\n activeChildren = this._getFirstLevelChildren(SELECTOR_ACTIVES).filter(element => element !== this._element).map(element => Collapse.getOrCreateInstance(element, {\n toggle: false\n }));\n }\n\n if (activeChildren.length && activeChildren[0]._isTransitioning) {\n return;\n }\n\n const startEvent = EventHandler.trigger(this._element, EVENT_SHOW$6);\n\n if (startEvent.defaultPrevented) {\n return;\n }\n\n for (const activeInstance of activeChildren) {\n activeInstance.hide();\n }\n\n const dimension = this._getDimension();\n\n this._element.classList.remove(CLASS_NAME_COLLAPSE);\n\n this._element.classList.add(CLASS_NAME_COLLAPSING);\n\n this._element.style[dimension] = 0;\n\n this._addAriaAndCollapsedClass(this._triggerArray, true);\n\n this._isTransitioning = true;\n\n const complete = () => {\n this._isTransitioning = false;\n\n this._element.classList.remove(CLASS_NAME_COLLAPSING);\n\n this._element.classList.add(CLASS_NAME_COLLAPSE, CLASS_NAME_SHOW$7);\n\n this._element.style[dimension] = '';\n EventHandler.trigger(this._element, EVENT_SHOWN$6);\n };\n\n const capitalizedDimension = dimension[0].toUpperCase() + dimension.slice(1);\n const scrollSize = `scroll${capitalizedDimension}`;\n\n this._queueCallback(complete, this._element, true);\n\n this._element.style[dimension] = `${this._element[scrollSize]}px`;\n }\n\n hide() {\n if (this._isTransitioning || !this._isShown()) {\n return;\n }\n\n const startEvent = EventHandler.trigger(this._element, EVENT_HIDE$6);\n\n if (startEvent.defaultPrevented) {\n return;\n }\n\n const dimension = this._getDimension();\n\n this._element.style[dimension] = `${this._element.getBoundingClientRect()[dimension]}px`;\n reflow(this._element);\n\n this._element.classList.add(CLASS_NAME_COLLAPSING);\n\n this._element.classList.remove(CLASS_NAME_COLLAPSE, CLASS_NAME_SHOW$7);\n\n for (const trigger of this._triggerArray) {\n const element = getElementFromSelector(trigger);\n\n if (element && !this._isShown(element)) {\n this._addAriaAndCollapsedClass([trigger], false);\n }\n }\n\n this._isTransitioning = true;\n\n const complete = () => {\n this._isTransitioning = false;\n\n this._element.classList.remove(CLASS_NAME_COLLAPSING);\n\n this._element.classList.add(CLASS_NAME_COLLAPSE);\n\n EventHandler.trigger(this._element, EVENT_HIDDEN$6);\n };\n\n this._element.style[dimension] = '';\n\n this._queueCallback(complete, this._element, true);\n }\n\n _isShown(element = this._element) {\n return element.classList.contains(CLASS_NAME_SHOW$7);\n } // Private\n\n\n _configAfterMerge(config) {\n config.toggle = Boolean(config.toggle); // Coerce string values\n\n config.parent = getElement(config.parent);\n return config;\n }\n\n _getDimension() {\n return this._element.classList.contains(CLASS_NAME_HORIZONTAL) ? WIDTH : HEIGHT;\n }\n\n _initializeChildren() {\n if (!this._config.parent) {\n return;\n }\n\n const children = this._getFirstLevelChildren(SELECTOR_DATA_TOGGLE$4);\n\n for (const element of children) {\n const selected = getElementFromSelector(element);\n\n if (selected) {\n this._addAriaAndCollapsedClass([element], this._isShown(selected));\n }\n }\n }\n\n _getFirstLevelChildren(selector) {\n const children = SelectorEngine.find(CLASS_NAME_DEEPER_CHILDREN, this._config.parent); // remove children if greater depth\n\n return SelectorEngine.find(selector, this._config.parent).filter(element => !children.includes(element));\n }\n\n _addAriaAndCollapsedClass(triggerArray, isOpen) {\n if (!triggerArray.length) {\n return;\n }\n\n for (const element of triggerArray) {\n element.classList.toggle(CLASS_NAME_COLLAPSED, !isOpen);\n element.setAttribute('aria-expanded', isOpen);\n }\n } // Static\n\n\n static jQueryInterface(config) {\n const _config = {};\n\n if (typeof config === 'string' && /show|hide/.test(config)) {\n _config.toggle = false;\n }\n\n return this.each(function () {\n const data = Collapse.getOrCreateInstance(this, _config);\n\n if (typeof config === 'string') {\n if (typeof data[config] === 'undefined') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config]();\n }\n });\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nEventHandler.on(document, EVENT_CLICK_DATA_API$4, SELECTOR_DATA_TOGGLE$4, function (event) {\n // preventDefault only for elements (which change the URL) not inside the collapsible element\n if (event.target.tagName === 'A' || event.delegateTarget && event.delegateTarget.tagName === 'A') {\n event.preventDefault();\n }\n\n const selector = getSelectorFromElement(this);\n const selectorElements = SelectorEngine.find(selector);\n\n for (const element of selectorElements) {\n Collapse.getOrCreateInstance(element, {\n toggle: false\n }).toggle();\n }\n});\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Collapse);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): dropdown.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$a = 'dropdown';\nconst DATA_KEY$6 = 'bs.dropdown';\nconst EVENT_KEY$6 = `.${DATA_KEY$6}`;\nconst DATA_API_KEY$3 = '.data-api';\nconst ESCAPE_KEY$2 = 'Escape';\nconst TAB_KEY$1 = 'Tab';\nconst ARROW_UP_KEY$1 = 'ArrowUp';\nconst ARROW_DOWN_KEY$1 = 'ArrowDown';\nconst RIGHT_MOUSE_BUTTON = 2; // MouseEvent.button value for the secondary button, usually the right button\n\nconst EVENT_HIDE$5 = `hide${EVENT_KEY$6}`;\nconst EVENT_HIDDEN$5 = `hidden${EVENT_KEY$6}`;\nconst EVENT_SHOW$5 = `show${EVENT_KEY$6}`;\nconst EVENT_SHOWN$5 = `shown${EVENT_KEY$6}`;\nconst EVENT_CLICK_DATA_API$3 = `click${EVENT_KEY$6}${DATA_API_KEY$3}`;\nconst EVENT_KEYDOWN_DATA_API = `keydown${EVENT_KEY$6}${DATA_API_KEY$3}`;\nconst EVENT_KEYUP_DATA_API = `keyup${EVENT_KEY$6}${DATA_API_KEY$3}`;\nconst CLASS_NAME_SHOW$6 = 'show';\nconst CLASS_NAME_DROPUP = 'dropup';\nconst CLASS_NAME_DROPEND = 'dropend';\nconst CLASS_NAME_DROPSTART = 'dropstart';\nconst CLASS_NAME_DROPUP_CENTER = 'dropup-center';\nconst CLASS_NAME_DROPDOWN_CENTER = 'dropdown-center';\nconst SELECTOR_DATA_TOGGLE$3 = '[data-bs-toggle=\"dropdown\"]:not(.disabled):not(:disabled)';\nconst SELECTOR_DATA_TOGGLE_SHOWN = `${SELECTOR_DATA_TOGGLE$3}.${CLASS_NAME_SHOW$6}`;\nconst SELECTOR_MENU = '.dropdown-menu';\nconst SELECTOR_NAVBAR = '.navbar';\nconst SELECTOR_NAVBAR_NAV = '.navbar-nav';\nconst SELECTOR_VISIBLE_ITEMS = '.dropdown-menu .dropdown-item:not(.disabled):not(:disabled)';\nconst PLACEMENT_TOP = isRTL() ? 'top-end' : 'top-start';\nconst PLACEMENT_TOPEND = isRTL() ? 'top-start' : 'top-end';\nconst PLACEMENT_BOTTOM = isRTL() ? 'bottom-end' : 'bottom-start';\nconst PLACEMENT_BOTTOMEND = isRTL() ? 'bottom-start' : 'bottom-end';\nconst PLACEMENT_RIGHT = isRTL() ? 'left-start' : 'right-start';\nconst PLACEMENT_LEFT = isRTL() ? 'right-start' : 'left-start';\nconst PLACEMENT_TOPCENTER = 'top';\nconst PLACEMENT_BOTTOMCENTER = 'bottom';\nconst Default$9 = {\n autoClose: true,\n boundary: 'clippingParents',\n display: 'dynamic',\n offset: [0, 2],\n popperConfig: null,\n reference: 'toggle'\n};\nconst DefaultType$9 = {\n autoClose: '(boolean|string)',\n boundary: '(string|element)',\n display: 'string',\n offset: '(array|string|function)',\n popperConfig: '(null|object|function)',\n reference: '(string|element|object)'\n};\n/**\n * Class definition\n */\n\nclass Dropdown extends BaseComponent {\n constructor(element, config) {\n super(element, config);\n this._popper = null;\n this._parent = this._element.parentNode; // dropdown wrapper\n // todo: v6 revert #37011 & change markup https://getbootstrap.com/docs/5.2/forms/input-group/\n\n this._menu = SelectorEngine.next(this._element, SELECTOR_MENU)[0] || SelectorEngine.prev(this._element, SELECTOR_MENU)[0] || SelectorEngine.findOne(SELECTOR_MENU, this._parent);\n this._inNavbar = this._detectNavbar();\n } // Getters\n\n\n static get Default() {\n return Default$9;\n }\n\n static get DefaultType() {\n return DefaultType$9;\n }\n\n static get NAME() {\n return NAME$a;\n } // Public\n\n\n toggle() {\n return this._isShown() ? this.hide() : this.show();\n }\n\n show() {\n if (isDisabled(this._element) || this._isShown()) {\n return;\n }\n\n const relatedTarget = {\n relatedTarget: this._element\n };\n const showEvent = EventHandler.trigger(this._element, EVENT_SHOW$5, relatedTarget);\n\n if (showEvent.defaultPrevented) {\n return;\n }\n\n this._createPopper(); // If this is a touch-enabled device we add extra\n // empty mouseover listeners to the body's immediate children;\n // only needed because of broken event delegation on iOS\n // https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html\n\n\n if ('ontouchstart' in document.documentElement && !this._parent.closest(SELECTOR_NAVBAR_NAV)) {\n for (const element of [].concat(...document.body.children)) {\n EventHandler.on(element, 'mouseover', noop);\n }\n }\n\n this._element.focus();\n\n this._element.setAttribute('aria-expanded', true);\n\n this._menu.classList.add(CLASS_NAME_SHOW$6);\n\n this._element.classList.add(CLASS_NAME_SHOW$6);\n\n EventHandler.trigger(this._element, EVENT_SHOWN$5, relatedTarget);\n }\n\n hide() {\n if (isDisabled(this._element) || !this._isShown()) {\n return;\n }\n\n const relatedTarget = {\n relatedTarget: this._element\n };\n\n this._completeHide(relatedTarget);\n }\n\n dispose() {\n if (this._popper) {\n this._popper.destroy();\n }\n\n super.dispose();\n }\n\n update() {\n this._inNavbar = this._detectNavbar();\n\n if (this._popper) {\n this._popper.update();\n }\n } // Private\n\n\n _completeHide(relatedTarget) {\n const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE$5, relatedTarget);\n\n if (hideEvent.defaultPrevented) {\n return;\n } // If this is a touch-enabled device we remove the extra\n // empty mouseover listeners we added for iOS support\n\n\n if ('ontouchstart' in document.documentElement) {\n for (const element of [].concat(...document.body.children)) {\n EventHandler.off(element, 'mouseover', noop);\n }\n }\n\n if (this._popper) {\n this._popper.destroy();\n }\n\n this._menu.classList.remove(CLASS_NAME_SHOW$6);\n\n this._element.classList.remove(CLASS_NAME_SHOW$6);\n\n this._element.setAttribute('aria-expanded', 'false');\n\n Manipulator.removeDataAttribute(this._menu, 'popper');\n EventHandler.trigger(this._element, EVENT_HIDDEN$5, relatedTarget);\n }\n\n _getConfig(config) {\n config = super._getConfig(config);\n\n if (typeof config.reference === 'object' && !isElement(config.reference) && typeof config.reference.getBoundingClientRect !== 'function') {\n // Popper virtual elements require a getBoundingClientRect method\n throw new TypeError(`${NAME$a.toUpperCase()}: Option \"reference\" provided type \"object\" without a required \"getBoundingClientRect\" method.`);\n }\n\n return config;\n }\n\n _createPopper() {\n if (typeof Popper === 'undefined') {\n throw new TypeError('Bootstrap\\'s dropdowns require Popper (https://popper.js.org)');\n }\n\n let referenceElement = this._element;\n\n if (this._config.reference === 'parent') {\n referenceElement = this._parent;\n } else if (isElement(this._config.reference)) {\n referenceElement = getElement(this._config.reference);\n } else if (typeof this._config.reference === 'object') {\n referenceElement = this._config.reference;\n }\n\n const popperConfig = this._getPopperConfig();\n\n this._popper = Popper.createPopper(referenceElement, this._menu, popperConfig);\n }\n\n _isShown() {\n return this._menu.classList.contains(CLASS_NAME_SHOW$6);\n }\n\n _getPlacement() {\n const parentDropdown = this._parent;\n\n if (parentDropdown.classList.contains(CLASS_NAME_DROPEND)) {\n return PLACEMENT_RIGHT;\n }\n\n if (parentDropdown.classList.contains(CLASS_NAME_DROPSTART)) {\n return PLACEMENT_LEFT;\n }\n\n if (parentDropdown.classList.contains(CLASS_NAME_DROPUP_CENTER)) {\n return PLACEMENT_TOPCENTER;\n }\n\n if (parentDropdown.classList.contains(CLASS_NAME_DROPDOWN_CENTER)) {\n return PLACEMENT_BOTTOMCENTER;\n } // We need to trim the value because custom properties can also include spaces\n\n\n const isEnd = getComputedStyle(this._menu).getPropertyValue('--bs-position').trim() === 'end';\n\n if (parentDropdown.classList.contains(CLASS_NAME_DROPUP)) {\n return isEnd ? PLACEMENT_TOPEND : PLACEMENT_TOP;\n }\n\n return isEnd ? PLACEMENT_BOTTOMEND : PLACEMENT_BOTTOM;\n }\n\n _detectNavbar() {\n return this._element.closest(SELECTOR_NAVBAR) !== null;\n }\n\n _getOffset() {\n const {\n offset\n } = this._config;\n\n if (typeof offset === 'string') {\n return offset.split(',').map(value => Number.parseInt(value, 10));\n }\n\n if (typeof offset === 'function') {\n return popperData => offset(popperData, this._element);\n }\n\n return offset;\n }\n\n _getPopperConfig() {\n const defaultBsPopperConfig = {\n placement: this._getPlacement(),\n modifiers: [{\n name: 'preventOverflow',\n options: {\n boundary: this._config.boundary\n }\n }, {\n name: 'offset',\n options: {\n offset: this._getOffset()\n }\n }]\n }; // Disable Popper if we have a static display or Dropdown is in Navbar\n\n if (this._inNavbar || this._config.display === 'static') {\n Manipulator.setDataAttribute(this._menu, 'popper', 'static'); // todo:v6 remove\n\n defaultBsPopperConfig.modifiers = [{\n name: 'applyStyles',\n enabled: false\n }];\n }\n\n return { ...defaultBsPopperConfig,\n ...(typeof this._config.popperConfig === 'function' ? this._config.popperConfig(defaultBsPopperConfig) : this._config.popperConfig)\n };\n }\n\n _selectMenuItem({\n key,\n target\n }) {\n const items = SelectorEngine.find(SELECTOR_VISIBLE_ITEMS, this._menu).filter(element => isVisible(element));\n\n if (!items.length) {\n return;\n } // if target isn't included in items (e.g. when expanding the dropdown)\n // allow cycling to get the last item in case key equals ARROW_UP_KEY\n\n\n getNextActiveElement(items, target, key === ARROW_DOWN_KEY$1, !items.includes(target)).focus();\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Dropdown.getOrCreateInstance(this, config);\n\n if (typeof config !== 'string') {\n return;\n }\n\n if (typeof data[config] === 'undefined') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config]();\n });\n }\n\n static clearMenus(event) {\n if (event.button === RIGHT_MOUSE_BUTTON || event.type === 'keyup' && event.key !== TAB_KEY$1) {\n return;\n }\n\n const openToggles = SelectorEngine.find(SELECTOR_DATA_TOGGLE_SHOWN);\n\n for (const toggle of openToggles) {\n const context = Dropdown.getInstance(toggle);\n\n if (!context || context._config.autoClose === false) {\n continue;\n }\n\n const composedPath = event.composedPath();\n const isMenuTarget = composedPath.includes(context._menu);\n\n if (composedPath.includes(context._element) || context._config.autoClose === 'inside' && !isMenuTarget || context._config.autoClose === 'outside' && isMenuTarget) {\n continue;\n } // Tab navigation through the dropdown menu or events from contained inputs shouldn't close the menu\n\n\n if (context._menu.contains(event.target) && (event.type === 'keyup' && event.key === TAB_KEY$1 || /input|select|option|textarea|form/i.test(event.target.tagName))) {\n continue;\n }\n\n const relatedTarget = {\n relatedTarget: context._element\n };\n\n if (event.type === 'click') {\n relatedTarget.clickEvent = event;\n }\n\n context._completeHide(relatedTarget);\n }\n }\n\n static dataApiKeydownHandler(event) {\n // If not an UP | DOWN | ESCAPE key => not a dropdown command\n // If input/textarea && if key is other than ESCAPE => not a dropdown command\n const isInput = /input|textarea/i.test(event.target.tagName);\n const isEscapeEvent = event.key === ESCAPE_KEY$2;\n const isUpOrDownEvent = [ARROW_UP_KEY$1, ARROW_DOWN_KEY$1].includes(event.key);\n\n if (!isUpOrDownEvent && !isEscapeEvent) {\n return;\n }\n\n if (isInput && !isEscapeEvent) {\n return;\n }\n\n event.preventDefault(); // todo: v6 revert #37011 & change markup https://getbootstrap.com/docs/5.2/forms/input-group/\n\n const getToggleButton = this.matches(SELECTOR_DATA_TOGGLE$3) ? this : SelectorEngine.prev(this, SELECTOR_DATA_TOGGLE$3)[0] || SelectorEngine.next(this, SELECTOR_DATA_TOGGLE$3)[0] || SelectorEngine.findOne(SELECTOR_DATA_TOGGLE$3, event.delegateTarget.parentNode);\n const instance = Dropdown.getOrCreateInstance(getToggleButton);\n\n if (isUpOrDownEvent) {\n event.stopPropagation();\n instance.show();\n\n instance._selectMenuItem(event);\n\n return;\n }\n\n if (instance._isShown()) {\n // else is escape and we check if it is shown\n event.stopPropagation();\n instance.hide();\n getToggleButton.focus();\n }\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nEventHandler.on(document, EVENT_KEYDOWN_DATA_API, SELECTOR_DATA_TOGGLE$3, Dropdown.dataApiKeydownHandler);\nEventHandler.on(document, EVENT_KEYDOWN_DATA_API, SELECTOR_MENU, Dropdown.dataApiKeydownHandler);\nEventHandler.on(document, EVENT_CLICK_DATA_API$3, Dropdown.clearMenus);\nEventHandler.on(document, EVENT_KEYUP_DATA_API, Dropdown.clearMenus);\nEventHandler.on(document, EVENT_CLICK_DATA_API$3, SELECTOR_DATA_TOGGLE$3, function (event) {\n event.preventDefault();\n Dropdown.getOrCreateInstance(this).toggle();\n});\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Dropdown);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/scrollBar.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst SELECTOR_FIXED_CONTENT = '.fixed-top, .fixed-bottom, .is-fixed, .sticky-top';\nconst SELECTOR_STICKY_CONTENT = '.sticky-top';\nconst PROPERTY_PADDING = 'padding-right';\nconst PROPERTY_MARGIN = 'margin-right';\n/**\n * Class definition\n */\n\nclass ScrollBarHelper {\n constructor() {\n this._element = document.body;\n } // Public\n\n\n getWidth() {\n // https://developer.mozilla.org/en-US/docs/Web/API/Window/innerWidth#usage_notes\n const documentWidth = document.documentElement.clientWidth;\n return Math.abs(window.innerWidth - documentWidth);\n }\n\n hide() {\n const width = this.getWidth();\n\n this._disableOverFlow(); // give padding to element to balance the hidden scrollbar width\n\n\n this._setElementAttributes(this._element, PROPERTY_PADDING, calculatedValue => calculatedValue + width); // trick: We adjust positive paddingRight and negative marginRight to sticky-top elements to keep showing fullwidth\n\n\n this._setElementAttributes(SELECTOR_FIXED_CONTENT, PROPERTY_PADDING, calculatedValue => calculatedValue + width);\n\n this._setElementAttributes(SELECTOR_STICKY_CONTENT, PROPERTY_MARGIN, calculatedValue => calculatedValue - width);\n }\n\n reset() {\n this._resetElementAttributes(this._element, 'overflow');\n\n this._resetElementAttributes(this._element, PROPERTY_PADDING);\n\n this._resetElementAttributes(SELECTOR_FIXED_CONTENT, PROPERTY_PADDING);\n\n this._resetElementAttributes(SELECTOR_STICKY_CONTENT, PROPERTY_MARGIN);\n }\n\n isOverflowing() {\n return this.getWidth() > 0;\n } // Private\n\n\n _disableOverFlow() {\n this._saveInitialAttribute(this._element, 'overflow');\n\n this._element.style.overflow = 'hidden';\n }\n\n _setElementAttributes(selector, styleProperty, callback) {\n const scrollbarWidth = this.getWidth();\n\n const manipulationCallBack = element => {\n if (element !== this._element && window.innerWidth > element.clientWidth + scrollbarWidth) {\n return;\n }\n\n this._saveInitialAttribute(element, styleProperty);\n\n const calculatedValue = window.getComputedStyle(element).getPropertyValue(styleProperty);\n element.style.setProperty(styleProperty, `${callback(Number.parseFloat(calculatedValue))}px`);\n };\n\n this._applyManipulationCallback(selector, manipulationCallBack);\n }\n\n _saveInitialAttribute(element, styleProperty) {\n const actualValue = element.style.getPropertyValue(styleProperty);\n\n if (actualValue) {\n Manipulator.setDataAttribute(element, styleProperty, actualValue);\n }\n }\n\n _resetElementAttributes(selector, styleProperty) {\n const manipulationCallBack = element => {\n const value = Manipulator.getDataAttribute(element, styleProperty); // We only want to remove the property if the value is `null`; the value can also be zero\n\n if (value === null) {\n element.style.removeProperty(styleProperty);\n return;\n }\n\n Manipulator.removeDataAttribute(element, styleProperty);\n element.style.setProperty(styleProperty, value);\n };\n\n this._applyManipulationCallback(selector, manipulationCallBack);\n }\n\n _applyManipulationCallback(selector, callBack) {\n if (isElement(selector)) {\n callBack(selector);\n return;\n }\n\n for (const sel of SelectorEngine.find(selector, this._element)) {\n callBack(sel);\n }\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/backdrop.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$9 = 'backdrop';\nconst CLASS_NAME_FADE$4 = 'fade';\nconst CLASS_NAME_SHOW$5 = 'show';\nconst EVENT_MOUSEDOWN = `mousedown.bs.${NAME$9}`;\nconst Default$8 = {\n className: 'modal-backdrop',\n clickCallback: null,\n isAnimated: false,\n isVisible: true,\n // if false, we use the backdrop helper without adding any element to the dom\n rootElement: 'body' // give the choice to place backdrop under different elements\n\n};\nconst DefaultType$8 = {\n className: 'string',\n clickCallback: '(function|null)',\n isAnimated: 'boolean',\n isVisible: 'boolean',\n rootElement: '(element|string)'\n};\n/**\n * Class definition\n */\n\nclass Backdrop extends Config {\n constructor(config) {\n super();\n this._config = this._getConfig(config);\n this._isAppended = false;\n this._element = null;\n } // Getters\n\n\n static get Default() {\n return Default$8;\n }\n\n static get DefaultType() {\n return DefaultType$8;\n }\n\n static get NAME() {\n return NAME$9;\n } // Public\n\n\n show(callback) {\n if (!this._config.isVisible) {\n execute(callback);\n return;\n }\n\n this._append();\n\n const element = this._getElement();\n\n if (this._config.isAnimated) {\n reflow(element);\n }\n\n element.classList.add(CLASS_NAME_SHOW$5);\n\n this._emulateAnimation(() => {\n execute(callback);\n });\n }\n\n hide(callback) {\n if (!this._config.isVisible) {\n execute(callback);\n return;\n }\n\n this._getElement().classList.remove(CLASS_NAME_SHOW$5);\n\n this._emulateAnimation(() => {\n this.dispose();\n execute(callback);\n });\n }\n\n dispose() {\n if (!this._isAppended) {\n return;\n }\n\n EventHandler.off(this._element, EVENT_MOUSEDOWN);\n\n this._element.remove();\n\n this._isAppended = false;\n } // Private\n\n\n _getElement() {\n if (!this._element) {\n const backdrop = document.createElement('div');\n backdrop.className = this._config.className;\n\n if (this._config.isAnimated) {\n backdrop.classList.add(CLASS_NAME_FADE$4);\n }\n\n this._element = backdrop;\n }\n\n return this._element;\n }\n\n _configAfterMerge(config) {\n // use getElement() with the default \"body\" to get a fresh Element on each instantiation\n config.rootElement = getElement(config.rootElement);\n return config;\n }\n\n _append() {\n if (this._isAppended) {\n return;\n }\n\n const element = this._getElement();\n\n this._config.rootElement.append(element);\n\n EventHandler.on(element, EVENT_MOUSEDOWN, () => {\n execute(this._config.clickCallback);\n });\n this._isAppended = true;\n }\n\n _emulateAnimation(callback) {\n executeAfterTransition(callback, this._getElement(), this._config.isAnimated);\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/focustrap.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$8 = 'focustrap';\nconst DATA_KEY$5 = 'bs.focustrap';\nconst EVENT_KEY$5 = `.${DATA_KEY$5}`;\nconst EVENT_FOCUSIN$2 = `focusin${EVENT_KEY$5}`;\nconst EVENT_KEYDOWN_TAB = `keydown.tab${EVENT_KEY$5}`;\nconst TAB_KEY = 'Tab';\nconst TAB_NAV_FORWARD = 'forward';\nconst TAB_NAV_BACKWARD = 'backward';\nconst Default$7 = {\n autofocus: true,\n trapElement: null // The element to trap focus inside of\n\n};\nconst DefaultType$7 = {\n autofocus: 'boolean',\n trapElement: 'element'\n};\n/**\n * Class definition\n */\n\nclass FocusTrap extends Config {\n constructor(config) {\n super();\n this._config = this._getConfig(config);\n this._isActive = false;\n this._lastTabNavDirection = null;\n } // Getters\n\n\n static get Default() {\n return Default$7;\n }\n\n static get DefaultType() {\n return DefaultType$7;\n }\n\n static get NAME() {\n return NAME$8;\n } // Public\n\n\n activate() {\n if (this._isActive) {\n return;\n }\n\n if (this._config.autofocus) {\n this._config.trapElement.focus();\n }\n\n EventHandler.off(document, EVENT_KEY$5); // guard against infinite focus loop\n\n EventHandler.on(document, EVENT_FOCUSIN$2, event => this._handleFocusin(event));\n EventHandler.on(document, EVENT_KEYDOWN_TAB, event => this._handleKeydown(event));\n this._isActive = true;\n }\n\n deactivate() {\n if (!this._isActive) {\n return;\n }\n\n this._isActive = false;\n EventHandler.off(document, EVENT_KEY$5);\n } // Private\n\n\n _handleFocusin(event) {\n const {\n trapElement\n } = this._config;\n\n if (event.target === document || event.target === trapElement || trapElement.contains(event.target)) {\n return;\n }\n\n const elements = SelectorEngine.focusableChildren(trapElement);\n\n if (elements.length === 0) {\n trapElement.focus();\n } else if (this._lastTabNavDirection === TAB_NAV_BACKWARD) {\n elements[elements.length - 1].focus();\n } else {\n elements[0].focus();\n }\n }\n\n _handleKeydown(event) {\n if (event.key !== TAB_KEY) {\n return;\n }\n\n this._lastTabNavDirection = event.shiftKey ? TAB_NAV_BACKWARD : TAB_NAV_FORWARD;\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): modal.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$7 = 'modal';\nconst DATA_KEY$4 = 'bs.modal';\nconst EVENT_KEY$4 = `.${DATA_KEY$4}`;\nconst DATA_API_KEY$2 = '.data-api';\nconst ESCAPE_KEY$1 = 'Escape';\nconst EVENT_HIDE$4 = `hide${EVENT_KEY$4}`;\nconst EVENT_HIDE_PREVENTED$1 = `hidePrevented${EVENT_KEY$4}`;\nconst EVENT_HIDDEN$4 = `hidden${EVENT_KEY$4}`;\nconst EVENT_SHOW$4 = `show${EVENT_KEY$4}`;\nconst EVENT_SHOWN$4 = `shown${EVENT_KEY$4}`;\nconst EVENT_RESIZE$1 = `resize${EVENT_KEY$4}`;\nconst EVENT_CLICK_DISMISS = `click.dismiss${EVENT_KEY$4}`;\nconst EVENT_MOUSEDOWN_DISMISS = `mousedown.dismiss${EVENT_KEY$4}`;\nconst EVENT_KEYDOWN_DISMISS$1 = `keydown.dismiss${EVENT_KEY$4}`;\nconst EVENT_CLICK_DATA_API$2 = `click${EVENT_KEY$4}${DATA_API_KEY$2}`;\nconst CLASS_NAME_OPEN = 'modal-open';\nconst CLASS_NAME_FADE$3 = 'fade';\nconst CLASS_NAME_SHOW$4 = 'show';\nconst CLASS_NAME_STATIC = 'modal-static';\nconst OPEN_SELECTOR$1 = '.modal.show';\nconst SELECTOR_DIALOG = '.modal-dialog';\nconst SELECTOR_MODAL_BODY = '.modal-body';\nconst SELECTOR_DATA_TOGGLE$2 = '[data-bs-toggle=\"modal\"]';\nconst Default$6 = {\n backdrop: true,\n focus: true,\n keyboard: true\n};\nconst DefaultType$6 = {\n backdrop: '(boolean|string)',\n focus: 'boolean',\n keyboard: 'boolean'\n};\n/**\n * Class definition\n */\n\nclass Modal extends BaseComponent {\n constructor(element, config) {\n super(element, config);\n this._dialog = SelectorEngine.findOne(SELECTOR_DIALOG, this._element);\n this._backdrop = this._initializeBackDrop();\n this._focustrap = this._initializeFocusTrap();\n this._isShown = false;\n this._isTransitioning = false;\n this._scrollBar = new ScrollBarHelper();\n\n this._addEventListeners();\n } // Getters\n\n\n static get Default() {\n return Default$6;\n }\n\n static get DefaultType() {\n return DefaultType$6;\n }\n\n static get NAME() {\n return NAME$7;\n } // Public\n\n\n toggle(relatedTarget) {\n return this._isShown ? this.hide() : this.show(relatedTarget);\n }\n\n show(relatedTarget) {\n if (this._isShown || this._isTransitioning) {\n return;\n }\n\n const showEvent = EventHandler.trigger(this._element, EVENT_SHOW$4, {\n relatedTarget\n });\n\n if (showEvent.defaultPrevented) {\n return;\n }\n\n this._isShown = true;\n this._isTransitioning = true;\n\n this._scrollBar.hide();\n\n document.body.classList.add(CLASS_NAME_OPEN);\n\n this._adjustDialog();\n\n this._backdrop.show(() => this._showElement(relatedTarget));\n }\n\n hide() {\n if (!this._isShown || this._isTransitioning) {\n return;\n }\n\n const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE$4);\n\n if (hideEvent.defaultPrevented) {\n return;\n }\n\n this._isShown = false;\n this._isTransitioning = true;\n\n this._focustrap.deactivate();\n\n this._element.classList.remove(CLASS_NAME_SHOW$4);\n\n this._queueCallback(() => this._hideModal(), this._element, this._isAnimated());\n }\n\n dispose() {\n for (const htmlElement of [window, this._dialog]) {\n EventHandler.off(htmlElement, EVENT_KEY$4);\n }\n\n this._backdrop.dispose();\n\n this._focustrap.deactivate();\n\n super.dispose();\n }\n\n handleUpdate() {\n this._adjustDialog();\n } // Private\n\n\n _initializeBackDrop() {\n return new Backdrop({\n isVisible: Boolean(this._config.backdrop),\n // 'static' option will be translated to true, and booleans will keep their value,\n isAnimated: this._isAnimated()\n });\n }\n\n _initializeFocusTrap() {\n return new FocusTrap({\n trapElement: this._element\n });\n }\n\n _showElement(relatedTarget) {\n // try to append dynamic modal\n if (!document.body.contains(this._element)) {\n document.body.append(this._element);\n }\n\n this._element.style.display = 'block';\n\n this._element.removeAttribute('aria-hidden');\n\n this._element.setAttribute('aria-modal', true);\n\n this._element.setAttribute('role', 'dialog');\n\n this._element.scrollTop = 0;\n const modalBody = SelectorEngine.findOne(SELECTOR_MODAL_BODY, this._dialog);\n\n if (modalBody) {\n modalBody.scrollTop = 0;\n }\n\n reflow(this._element);\n\n this._element.classList.add(CLASS_NAME_SHOW$4);\n\n const transitionComplete = () => {\n if (this._config.focus) {\n this._focustrap.activate();\n }\n\n this._isTransitioning = false;\n EventHandler.trigger(this._element, EVENT_SHOWN$4, {\n relatedTarget\n });\n };\n\n this._queueCallback(transitionComplete, this._dialog, this._isAnimated());\n }\n\n _addEventListeners() {\n EventHandler.on(this._element, EVENT_KEYDOWN_DISMISS$1, event => {\n if (event.key !== ESCAPE_KEY$1) {\n return;\n }\n\n if (this._config.keyboard) {\n event.preventDefault();\n this.hide();\n return;\n }\n\n this._triggerBackdropTransition();\n });\n EventHandler.on(window, EVENT_RESIZE$1, () => {\n if (this._isShown && !this._isTransitioning) {\n this._adjustDialog();\n }\n });\n EventHandler.on(this._element, EVENT_MOUSEDOWN_DISMISS, event => {\n // a bad trick to segregate clicks that may start inside dialog but end outside, and avoid listen to scrollbar clicks\n EventHandler.one(this._element, EVENT_CLICK_DISMISS, event2 => {\n if (this._element !== event.target || this._element !== event2.target) {\n return;\n }\n\n if (this._config.backdrop === 'static') {\n this._triggerBackdropTransition();\n\n return;\n }\n\n if (this._config.backdrop) {\n this.hide();\n }\n });\n });\n }\n\n _hideModal() {\n this._element.style.display = 'none';\n\n this._element.setAttribute('aria-hidden', true);\n\n this._element.removeAttribute('aria-modal');\n\n this._element.removeAttribute('role');\n\n this._isTransitioning = false;\n\n this._backdrop.hide(() => {\n document.body.classList.remove(CLASS_NAME_OPEN);\n\n this._resetAdjustments();\n\n this._scrollBar.reset();\n\n EventHandler.trigger(this._element, EVENT_HIDDEN$4);\n });\n }\n\n _isAnimated() {\n return this._element.classList.contains(CLASS_NAME_FADE$3);\n }\n\n _triggerBackdropTransition() {\n const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE_PREVENTED$1);\n\n if (hideEvent.defaultPrevented) {\n return;\n }\n\n const isModalOverflowing = this._element.scrollHeight > document.documentElement.clientHeight;\n const initialOverflowY = this._element.style.overflowY; // return if the following background transition hasn't yet completed\n\n if (initialOverflowY === 'hidden' || this._element.classList.contains(CLASS_NAME_STATIC)) {\n return;\n }\n\n if (!isModalOverflowing) {\n this._element.style.overflowY = 'hidden';\n }\n\n this._element.classList.add(CLASS_NAME_STATIC);\n\n this._queueCallback(() => {\n this._element.classList.remove(CLASS_NAME_STATIC);\n\n this._queueCallback(() => {\n this._element.style.overflowY = initialOverflowY;\n }, this._dialog);\n }, this._dialog);\n\n this._element.focus();\n }\n /**\n * The following methods are used to handle overflowing modals\n */\n\n\n _adjustDialog() {\n const isModalOverflowing = this._element.scrollHeight > document.documentElement.clientHeight;\n\n const scrollbarWidth = this._scrollBar.getWidth();\n\n const isBodyOverflowing = scrollbarWidth > 0;\n\n if (isBodyOverflowing && !isModalOverflowing) {\n const property = isRTL() ? 'paddingLeft' : 'paddingRight';\n this._element.style[property] = `${scrollbarWidth}px`;\n }\n\n if (!isBodyOverflowing && isModalOverflowing) {\n const property = isRTL() ? 'paddingRight' : 'paddingLeft';\n this._element.style[property] = `${scrollbarWidth}px`;\n }\n }\n\n _resetAdjustments() {\n this._element.style.paddingLeft = '';\n this._element.style.paddingRight = '';\n } // Static\n\n\n static jQueryInterface(config, relatedTarget) {\n return this.each(function () {\n const data = Modal.getOrCreateInstance(this, config);\n\n if (typeof config !== 'string') {\n return;\n }\n\n if (typeof data[config] === 'undefined') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config](relatedTarget);\n });\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nEventHandler.on(document, EVENT_CLICK_DATA_API$2, SELECTOR_DATA_TOGGLE$2, function (event) {\n const target = getElementFromSelector(this);\n\n if (['A', 'AREA'].includes(this.tagName)) {\n event.preventDefault();\n }\n\n EventHandler.one(target, EVENT_SHOW$4, showEvent => {\n if (showEvent.defaultPrevented) {\n // only register focus restorer if modal will actually get shown\n return;\n }\n\n EventHandler.one(target, EVENT_HIDDEN$4, () => {\n if (isVisible(this)) {\n this.focus();\n }\n });\n }); // avoid conflict when clicking modal toggler while another one is open\n\n const alreadyOpen = SelectorEngine.findOne(OPEN_SELECTOR$1);\n\n if (alreadyOpen) {\n Modal.getInstance(alreadyOpen).hide();\n }\n\n const data = Modal.getOrCreateInstance(target);\n data.toggle(this);\n});\nenableDismissTrigger(Modal);\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Modal);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): offcanvas.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$6 = 'offcanvas';\nconst DATA_KEY$3 = 'bs.offcanvas';\nconst EVENT_KEY$3 = `.${DATA_KEY$3}`;\nconst DATA_API_KEY$1 = '.data-api';\nconst EVENT_LOAD_DATA_API$2 = `load${EVENT_KEY$3}${DATA_API_KEY$1}`;\nconst ESCAPE_KEY = 'Escape';\nconst CLASS_NAME_SHOW$3 = 'show';\nconst CLASS_NAME_SHOWING$1 = 'showing';\nconst CLASS_NAME_HIDING = 'hiding';\nconst CLASS_NAME_BACKDROP = 'offcanvas-backdrop';\nconst OPEN_SELECTOR = '.offcanvas.show';\nconst EVENT_SHOW$3 = `show${EVENT_KEY$3}`;\nconst EVENT_SHOWN$3 = `shown${EVENT_KEY$3}`;\nconst EVENT_HIDE$3 = `hide${EVENT_KEY$3}`;\nconst EVENT_HIDE_PREVENTED = `hidePrevented${EVENT_KEY$3}`;\nconst EVENT_HIDDEN$3 = `hidden${EVENT_KEY$3}`;\nconst EVENT_RESIZE = `resize${EVENT_KEY$3}`;\nconst EVENT_CLICK_DATA_API$1 = `click${EVENT_KEY$3}${DATA_API_KEY$1}`;\nconst EVENT_KEYDOWN_DISMISS = `keydown.dismiss${EVENT_KEY$3}`;\nconst SELECTOR_DATA_TOGGLE$1 = '[data-bs-toggle=\"offcanvas\"]';\nconst Default$5 = {\n backdrop: true,\n keyboard: true,\n scroll: false\n};\nconst DefaultType$5 = {\n backdrop: '(boolean|string)',\n keyboard: 'boolean',\n scroll: 'boolean'\n};\n/**\n * Class definition\n */\n\nclass Offcanvas extends BaseComponent {\n constructor(element, config) {\n super(element, config);\n this._isShown = false;\n this._backdrop = this._initializeBackDrop();\n this._focustrap = this._initializeFocusTrap();\n\n this._addEventListeners();\n } // Getters\n\n\n static get Default() {\n return Default$5;\n }\n\n static get DefaultType() {\n return DefaultType$5;\n }\n\n static get NAME() {\n return NAME$6;\n } // Public\n\n\n toggle(relatedTarget) {\n return this._isShown ? this.hide() : this.show(relatedTarget);\n }\n\n show(relatedTarget) {\n if (this._isShown) {\n return;\n }\n\n const showEvent = EventHandler.trigger(this._element, EVENT_SHOW$3, {\n relatedTarget\n });\n\n if (showEvent.defaultPrevented) {\n return;\n }\n\n this._isShown = true;\n\n this._backdrop.show();\n\n if (!this._config.scroll) {\n new ScrollBarHelper().hide();\n }\n\n this._element.setAttribute('aria-modal', true);\n\n this._element.setAttribute('role', 'dialog');\n\n this._element.classList.add(CLASS_NAME_SHOWING$1);\n\n const completeCallBack = () => {\n if (!this._config.scroll || this._config.backdrop) {\n this._focustrap.activate();\n }\n\n this._element.classList.add(CLASS_NAME_SHOW$3);\n\n this._element.classList.remove(CLASS_NAME_SHOWING$1);\n\n EventHandler.trigger(this._element, EVENT_SHOWN$3, {\n relatedTarget\n });\n };\n\n this._queueCallback(completeCallBack, this._element, true);\n }\n\n hide() {\n if (!this._isShown) {\n return;\n }\n\n const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE$3);\n\n if (hideEvent.defaultPrevented) {\n return;\n }\n\n this._focustrap.deactivate();\n\n this._element.blur();\n\n this._isShown = false;\n\n this._element.classList.add(CLASS_NAME_HIDING);\n\n this._backdrop.hide();\n\n const completeCallback = () => {\n this._element.classList.remove(CLASS_NAME_SHOW$3, CLASS_NAME_HIDING);\n\n this._element.removeAttribute('aria-modal');\n\n this._element.removeAttribute('role');\n\n if (!this._config.scroll) {\n new ScrollBarHelper().reset();\n }\n\n EventHandler.trigger(this._element, EVENT_HIDDEN$3);\n };\n\n this._queueCallback(completeCallback, this._element, true);\n }\n\n dispose() {\n this._backdrop.dispose();\n\n this._focustrap.deactivate();\n\n super.dispose();\n } // Private\n\n\n _initializeBackDrop() {\n const clickCallback = () => {\n if (this._config.backdrop === 'static') {\n EventHandler.trigger(this._element, EVENT_HIDE_PREVENTED);\n return;\n }\n\n this.hide();\n }; // 'static' option will be translated to true, and booleans will keep their value\n\n\n const isVisible = Boolean(this._config.backdrop);\n return new Backdrop({\n className: CLASS_NAME_BACKDROP,\n isVisible,\n isAnimated: true,\n rootElement: this._element.parentNode,\n clickCallback: isVisible ? clickCallback : null\n });\n }\n\n _initializeFocusTrap() {\n return new FocusTrap({\n trapElement: this._element\n });\n }\n\n _addEventListeners() {\n EventHandler.on(this._element, EVENT_KEYDOWN_DISMISS, event => {\n if (event.key !== ESCAPE_KEY) {\n return;\n }\n\n if (!this._config.keyboard) {\n EventHandler.trigger(this._element, EVENT_HIDE_PREVENTED);\n return;\n }\n\n this.hide();\n });\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Offcanvas.getOrCreateInstance(this, config);\n\n if (typeof config !== 'string') {\n return;\n }\n\n if (data[config] === undefined || config.startsWith('_') || config === 'constructor') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config](this);\n });\n }\n\n}\n/**\n * Data API implementation\n */\n\n\nEventHandler.on(document, EVENT_CLICK_DATA_API$1, SELECTOR_DATA_TOGGLE$1, function (event) {\n const target = getElementFromSelector(this);\n\n if (['A', 'AREA'].includes(this.tagName)) {\n event.preventDefault();\n }\n\n if (isDisabled(this)) {\n return;\n }\n\n EventHandler.one(target, EVENT_HIDDEN$3, () => {\n // focus on trigger when it is closed\n if (isVisible(this)) {\n this.focus();\n }\n }); // avoid conflict when clicking a toggler of an offcanvas, while another is open\n\n const alreadyOpen = SelectorEngine.findOne(OPEN_SELECTOR);\n\n if (alreadyOpen && alreadyOpen !== target) {\n Offcanvas.getInstance(alreadyOpen).hide();\n }\n\n const data = Offcanvas.getOrCreateInstance(target);\n data.toggle(this);\n});\nEventHandler.on(window, EVENT_LOAD_DATA_API$2, () => {\n for (const selector of SelectorEngine.find(OPEN_SELECTOR)) {\n Offcanvas.getOrCreateInstance(selector).show();\n }\n});\nEventHandler.on(window, EVENT_RESIZE, () => {\n for (const element of SelectorEngine.find('[aria-modal][class*=show][class*=offcanvas-]')) {\n if (getComputedStyle(element).position !== 'fixed') {\n Offcanvas.getOrCreateInstance(element).hide();\n }\n }\n});\nenableDismissTrigger(Offcanvas);\n/**\n * jQuery\n */\n\ndefineJQueryPlugin(Offcanvas);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/sanitizer.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\nconst uriAttributes = new Set(['background', 'cite', 'href', 'itemtype', 'longdesc', 'poster', 'src', 'xlink:href']);\nconst ARIA_ATTRIBUTE_PATTERN = /^aria-[\\w-]*$/i;\n/**\n * A pattern that recognizes a commonly useful subset of URLs that are safe.\n *\n * Shout-out to Angular https://github.com/angular/angular/blob/12.2.x/packages/core/src/sanitization/url_sanitizer.ts\n */\n\nconst SAFE_URL_PATTERN = /^(?:(?:https?|mailto|ftp|tel|file|sms):|[^#&/:?]*(?:[#/?]|$))/i;\n/**\n * A pattern that matches safe data URLs. Only matches image, video and audio types.\n *\n * Shout-out to Angular https://github.com/angular/angular/blob/12.2.x/packages/core/src/sanitization/url_sanitizer.ts\n */\n\nconst DATA_URL_PATTERN = /^data:(?:image\\/(?:bmp|gif|jpeg|jpg|png|tiff|webp)|video\\/(?:mpeg|mp4|ogg|webm)|audio\\/(?:mp3|oga|ogg|opus));base64,[\\d+/a-z]+=*$/i;\n\nconst allowedAttribute = (attribute, allowedAttributeList) => {\n const attributeName = attribute.nodeName.toLowerCase();\n\n if (allowedAttributeList.includes(attributeName)) {\n if (uriAttributes.has(attributeName)) {\n return Boolean(SAFE_URL_PATTERN.test(attribute.nodeValue) || DATA_URL_PATTERN.test(attribute.nodeValue));\n }\n\n return true;\n } // Check if a regular expression validates the attribute.\n\n\n return allowedAttributeList.filter(attributeRegex => attributeRegex instanceof RegExp).some(regex => regex.test(attributeName));\n};\n\nconst DefaultAllowlist = {\n // Global attributes allowed on any supplied element below.\n '*': ['class', 'dir', 'id', 'lang', 'role', ARIA_ATTRIBUTE_PATTERN],\n a: ['target', 'href', 'title', 'rel'],\n area: [],\n b: [],\n br: [],\n col: [],\n code: [],\n div: [],\n em: [],\n hr: [],\n h1: [],\n h2: [],\n h3: [],\n h4: [],\n h5: [],\n h6: [],\n i: [],\n img: ['src', 'srcset', 'alt', 'title', 'width', 'height'],\n li: [],\n ol: [],\n p: [],\n pre: [],\n s: [],\n small: [],\n span: [],\n sub: [],\n sup: [],\n strong: [],\n u: [],\n ul: []\n};\nfunction sanitizeHtml(unsafeHtml, allowList, sanitizeFunction) {\n if (!unsafeHtml.length) {\n return unsafeHtml;\n }\n\n if (sanitizeFunction && typeof sanitizeFunction === 'function') {\n return sanitizeFunction(unsafeHtml);\n }\n\n const domParser = new window.DOMParser();\n const createdDocument = domParser.parseFromString(unsafeHtml, 'text/html');\n const elements = [].concat(...createdDocument.body.querySelectorAll('*'));\n\n for (const element of elements) {\n const elementName = element.nodeName.toLowerCase();\n\n if (!Object.keys(allowList).includes(elementName)) {\n element.remove();\n continue;\n }\n\n const attributeList = [].concat(...element.attributes);\n const allowedAttributes = [].concat(allowList['*'] || [], allowList[elementName] || []);\n\n for (const attribute of attributeList) {\n if (!allowedAttribute(attribute, allowedAttributes)) {\n element.removeAttribute(attribute.nodeName);\n }\n }\n }\n\n return createdDocument.body.innerHTML;\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): util/template-factory.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$5 = 'TemplateFactory';\nconst Default$4 = {\n allowList: DefaultAllowlist,\n content: {},\n // { selector : text , selector2 : text2 , }\n extraClass: '',\n html: false,\n sanitize: true,\n sanitizeFn: null,\n template: '
    '\n};\nconst DefaultType$4 = {\n allowList: 'object',\n content: 'object',\n extraClass: '(string|function)',\n html: 'boolean',\n sanitize: 'boolean',\n sanitizeFn: '(null|function)',\n template: 'string'\n};\nconst DefaultContentType = {\n entry: '(string|element|function|null)',\n selector: '(string|element)'\n};\n/**\n * Class definition\n */\n\nclass TemplateFactory extends Config {\n constructor(config) {\n super();\n this._config = this._getConfig(config);\n } // Getters\n\n\n static get Default() {\n return Default$4;\n }\n\n static get DefaultType() {\n return DefaultType$4;\n }\n\n static get NAME() {\n return NAME$5;\n } // Public\n\n\n getContent() {\n return Object.values(this._config.content).map(config => this._resolvePossibleFunction(config)).filter(Boolean);\n }\n\n hasContent() {\n return this.getContent().length > 0;\n }\n\n changeContent(content) {\n this._checkContent(content);\n\n this._config.content = { ...this._config.content,\n ...content\n };\n return this;\n }\n\n toHtml() {\n const templateWrapper = document.createElement('div');\n templateWrapper.innerHTML = this._maybeSanitize(this._config.template);\n\n for (const [selector, text] of Object.entries(this._config.content)) {\n this._setContent(templateWrapper, text, selector);\n }\n\n const template = templateWrapper.children[0];\n\n const extraClass = this._resolvePossibleFunction(this._config.extraClass);\n\n if (extraClass) {\n template.classList.add(...extraClass.split(' '));\n }\n\n return template;\n } // Private\n\n\n _typeCheckConfig(config) {\n super._typeCheckConfig(config);\n\n this._checkContent(config.content);\n }\n\n _checkContent(arg) {\n for (const [selector, content] of Object.entries(arg)) {\n super._typeCheckConfig({\n selector,\n entry: content\n }, DefaultContentType);\n }\n }\n\n _setContent(template, content, selector) {\n const templateElement = SelectorEngine.findOne(selector, template);\n\n if (!templateElement) {\n return;\n }\n\n content = this._resolvePossibleFunction(content);\n\n if (!content) {\n templateElement.remove();\n return;\n }\n\n if (isElement(content)) {\n this._putElementInTemplate(getElement(content), templateElement);\n\n return;\n }\n\n if (this._config.html) {\n templateElement.innerHTML = this._maybeSanitize(content);\n return;\n }\n\n templateElement.textContent = content;\n }\n\n _maybeSanitize(arg) {\n return this._config.sanitize ? sanitizeHtml(arg, this._config.allowList, this._config.sanitizeFn) : arg;\n }\n\n _resolvePossibleFunction(arg) {\n return typeof arg === 'function' ? arg(this) : arg;\n }\n\n _putElementInTemplate(element, templateElement) {\n if (this._config.html) {\n templateElement.innerHTML = '';\n templateElement.append(element);\n return;\n }\n\n templateElement.textContent = element.textContent;\n }\n\n}\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): tooltip.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$4 = 'tooltip';\nconst DISALLOWED_ATTRIBUTES = new Set(['sanitize', 'allowList', 'sanitizeFn']);\nconst CLASS_NAME_FADE$2 = 'fade';\nconst CLASS_NAME_MODAL = 'modal';\nconst CLASS_NAME_SHOW$2 = 'show';\nconst SELECTOR_TOOLTIP_INNER = '.tooltip-inner';\nconst SELECTOR_MODAL = `.${CLASS_NAME_MODAL}`;\nconst EVENT_MODAL_HIDE = 'hide.bs.modal';\nconst TRIGGER_HOVER = 'hover';\nconst TRIGGER_FOCUS = 'focus';\nconst TRIGGER_CLICK = 'click';\nconst TRIGGER_MANUAL = 'manual';\nconst EVENT_HIDE$2 = 'hide';\nconst EVENT_HIDDEN$2 = 'hidden';\nconst EVENT_SHOW$2 = 'show';\nconst EVENT_SHOWN$2 = 'shown';\nconst EVENT_INSERTED = 'inserted';\nconst EVENT_CLICK$1 = 'click';\nconst EVENT_FOCUSIN$1 = 'focusin';\nconst EVENT_FOCUSOUT$1 = 'focusout';\nconst EVENT_MOUSEENTER = 'mouseenter';\nconst EVENT_MOUSELEAVE = 'mouseleave';\nconst AttachmentMap = {\n AUTO: 'auto',\n TOP: 'top',\n RIGHT: isRTL() ? 'left' : 'right',\n BOTTOM: 'bottom',\n LEFT: isRTL() ? 'right' : 'left'\n};\nconst Default$3 = {\n allowList: DefaultAllowlist,\n animation: true,\n boundary: 'clippingParents',\n container: false,\n customClass: '',\n delay: 0,\n fallbackPlacements: ['top', 'right', 'bottom', 'left'],\n html: false,\n offset: [0, 0],\n placement: 'top',\n popperConfig: null,\n sanitize: true,\n sanitizeFn: null,\n selector: false,\n template: '
    ' + '
    ' + '
    ' + '
    ',\n title: '',\n trigger: 'hover focus'\n};\nconst DefaultType$3 = {\n allowList: 'object',\n animation: 'boolean',\n boundary: '(string|element)',\n container: '(string|element|boolean)',\n customClass: '(string|function)',\n delay: '(number|object)',\n fallbackPlacements: 'array',\n html: 'boolean',\n offset: '(array|string|function)',\n placement: '(string|function)',\n popperConfig: '(null|object|function)',\n sanitize: 'boolean',\n sanitizeFn: '(null|function)',\n selector: '(string|boolean)',\n template: 'string',\n title: '(string|element|function)',\n trigger: 'string'\n};\n/**\n * Class definition\n */\n\nclass Tooltip extends BaseComponent {\n constructor(element, config) {\n if (typeof Popper === 'undefined') {\n throw new TypeError('Bootstrap\\'s tooltips require Popper (https://popper.js.org)');\n }\n\n super(element, config); // Private\n\n this._isEnabled = true;\n this._timeout = 0;\n this._isHovered = null;\n this._activeTrigger = {};\n this._popper = null;\n this._templateFactory = null;\n this._newContent = null; // Protected\n\n this.tip = null;\n\n this._setListeners();\n\n if (!this._config.selector) {\n this._fixTitle();\n }\n } // Getters\n\n\n static get Default() {\n return Default$3;\n }\n\n static get DefaultType() {\n return DefaultType$3;\n }\n\n static get NAME() {\n return NAME$4;\n } // Public\n\n\n enable() {\n this._isEnabled = true;\n }\n\n disable() {\n this._isEnabled = false;\n }\n\n toggleEnabled() {\n this._isEnabled = !this._isEnabled;\n }\n\n toggle() {\n if (!this._isEnabled) {\n return;\n }\n\n this._activeTrigger.click = !this._activeTrigger.click;\n\n if (this._isShown()) {\n this._leave();\n\n return;\n }\n\n this._enter();\n }\n\n dispose() {\n clearTimeout(this._timeout);\n EventHandler.off(this._element.closest(SELECTOR_MODAL), EVENT_MODAL_HIDE, this._hideModalHandler);\n\n if (this._element.getAttribute('data-bs-original-title')) {\n this._element.setAttribute('title', this._element.getAttribute('data-bs-original-title'));\n }\n\n this._disposePopper();\n\n super.dispose();\n }\n\n show() {\n if (this._element.style.display === 'none') {\n throw new Error('Please use show on visible elements');\n }\n\n if (!(this._isWithContent() && this._isEnabled)) {\n return;\n }\n\n const showEvent = EventHandler.trigger(this._element, this.constructor.eventName(EVENT_SHOW$2));\n const shadowRoot = findShadowRoot(this._element);\n\n const isInTheDom = (shadowRoot || this._element.ownerDocument.documentElement).contains(this._element);\n\n if (showEvent.defaultPrevented || !isInTheDom) {\n return;\n } // todo v6 remove this OR make it optional\n\n\n this._disposePopper();\n\n const tip = this._getTipElement();\n\n this._element.setAttribute('aria-describedby', tip.getAttribute('id'));\n\n const {\n container\n } = this._config;\n\n if (!this._element.ownerDocument.documentElement.contains(this.tip)) {\n container.append(tip);\n EventHandler.trigger(this._element, this.constructor.eventName(EVENT_INSERTED));\n }\n\n this._popper = this._createPopper(tip);\n tip.classList.add(CLASS_NAME_SHOW$2); // If this is a touch-enabled device we add extra\n // empty mouseover listeners to the body's immediate children;\n // only needed because of broken event delegation on iOS\n // https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html\n\n if ('ontouchstart' in document.documentElement) {\n for (const element of [].concat(...document.body.children)) {\n EventHandler.on(element, 'mouseover', noop);\n }\n }\n\n const complete = () => {\n EventHandler.trigger(this._element, this.constructor.eventName(EVENT_SHOWN$2));\n\n if (this._isHovered === false) {\n this._leave();\n }\n\n this._isHovered = false;\n };\n\n this._queueCallback(complete, this.tip, this._isAnimated());\n }\n\n hide() {\n if (!this._isShown()) {\n return;\n }\n\n const hideEvent = EventHandler.trigger(this._element, this.constructor.eventName(EVENT_HIDE$2));\n\n if (hideEvent.defaultPrevented) {\n return;\n }\n\n const tip = this._getTipElement();\n\n tip.classList.remove(CLASS_NAME_SHOW$2); // If this is a touch-enabled device we remove the extra\n // empty mouseover listeners we added for iOS support\n\n if ('ontouchstart' in document.documentElement) {\n for (const element of [].concat(...document.body.children)) {\n EventHandler.off(element, 'mouseover', noop);\n }\n }\n\n this._activeTrigger[TRIGGER_CLICK] = false;\n this._activeTrigger[TRIGGER_FOCUS] = false;\n this._activeTrigger[TRIGGER_HOVER] = false;\n this._isHovered = null; // it is a trick to support manual triggering\n\n const complete = () => {\n if (this._isWithActiveTrigger()) {\n return;\n }\n\n if (!this._isHovered) {\n this._disposePopper();\n }\n\n this._element.removeAttribute('aria-describedby');\n\n EventHandler.trigger(this._element, this.constructor.eventName(EVENT_HIDDEN$2));\n };\n\n this._queueCallback(complete, this.tip, this._isAnimated());\n }\n\n update() {\n if (this._popper) {\n this._popper.update();\n }\n } // Protected\n\n\n _isWithContent() {\n return Boolean(this._getTitle());\n }\n\n _getTipElement() {\n if (!this.tip) {\n this.tip = this._createTipElement(this._newContent || this._getContentForTemplate());\n }\n\n return this.tip;\n }\n\n _createTipElement(content) {\n const tip = this._getTemplateFactory(content).toHtml(); // todo: remove this check on v6\n\n\n if (!tip) {\n return null;\n }\n\n tip.classList.remove(CLASS_NAME_FADE$2, CLASS_NAME_SHOW$2); // todo: on v6 the following can be achieved with CSS only\n\n tip.classList.add(`bs-${this.constructor.NAME}-auto`);\n const tipId = getUID(this.constructor.NAME).toString();\n tip.setAttribute('id', tipId);\n\n if (this._isAnimated()) {\n tip.classList.add(CLASS_NAME_FADE$2);\n }\n\n return tip;\n }\n\n setContent(content) {\n this._newContent = content;\n\n if (this._isShown()) {\n this._disposePopper();\n\n this.show();\n }\n }\n\n _getTemplateFactory(content) {\n if (this._templateFactory) {\n this._templateFactory.changeContent(content);\n } else {\n this._templateFactory = new TemplateFactory({ ...this._config,\n // the `content` var has to be after `this._config`\n // to override config.content in case of popover\n content,\n extraClass: this._resolvePossibleFunction(this._config.customClass)\n });\n }\n\n return this._templateFactory;\n }\n\n _getContentForTemplate() {\n return {\n [SELECTOR_TOOLTIP_INNER]: this._getTitle()\n };\n }\n\n _getTitle() {\n return this._resolvePossibleFunction(this._config.title) || this._element.getAttribute('data-bs-original-title');\n } // Private\n\n\n _initializeOnDelegatedTarget(event) {\n return this.constructor.getOrCreateInstance(event.delegateTarget, this._getDelegateConfig());\n }\n\n _isAnimated() {\n return this._config.animation || this.tip && this.tip.classList.contains(CLASS_NAME_FADE$2);\n }\n\n _isShown() {\n return this.tip && this.tip.classList.contains(CLASS_NAME_SHOW$2);\n }\n\n _createPopper(tip) {\n const placement = typeof this._config.placement === 'function' ? this._config.placement.call(this, tip, this._element) : this._config.placement;\n const attachment = AttachmentMap[placement.toUpperCase()];\n return Popper.createPopper(this._element, tip, this._getPopperConfig(attachment));\n }\n\n _getOffset() {\n const {\n offset\n } = this._config;\n\n if (typeof offset === 'string') {\n return offset.split(',').map(value => Number.parseInt(value, 10));\n }\n\n if (typeof offset === 'function') {\n return popperData => offset(popperData, this._element);\n }\n\n return offset;\n }\n\n _resolvePossibleFunction(arg) {\n return typeof arg === 'function' ? arg.call(this._element) : arg;\n }\n\n _getPopperConfig(attachment) {\n const defaultBsPopperConfig = {\n placement: attachment,\n modifiers: [{\n name: 'flip',\n options: {\n fallbackPlacements: this._config.fallbackPlacements\n }\n }, {\n name: 'offset',\n options: {\n offset: this._getOffset()\n }\n }, {\n name: 'preventOverflow',\n options: {\n boundary: this._config.boundary\n }\n }, {\n name: 'arrow',\n options: {\n element: `.${this.constructor.NAME}-arrow`\n }\n }, {\n name: 'preSetPlacement',\n enabled: true,\n phase: 'beforeMain',\n fn: data => {\n // Pre-set Popper's placement attribute in order to read the arrow sizes properly.\n // Otherwise, Popper mixes up the width and height dimensions since the initial arrow style is for top placement\n this._getTipElement().setAttribute('data-popper-placement', data.state.placement);\n }\n }]\n };\n return { ...defaultBsPopperConfig,\n ...(typeof this._config.popperConfig === 'function' ? this._config.popperConfig(defaultBsPopperConfig) : this._config.popperConfig)\n };\n }\n\n _setListeners() {\n const triggers = this._config.trigger.split(' ');\n\n for (const trigger of triggers) {\n if (trigger === 'click') {\n EventHandler.on(this._element, this.constructor.eventName(EVENT_CLICK$1), this._config.selector, event => {\n const context = this._initializeOnDelegatedTarget(event);\n\n context.toggle();\n });\n } else if (trigger !== TRIGGER_MANUAL) {\n const eventIn = trigger === TRIGGER_HOVER ? this.constructor.eventName(EVENT_MOUSEENTER) : this.constructor.eventName(EVENT_FOCUSIN$1);\n const eventOut = trigger === TRIGGER_HOVER ? this.constructor.eventName(EVENT_MOUSELEAVE) : this.constructor.eventName(EVENT_FOCUSOUT$1);\n EventHandler.on(this._element, eventIn, this._config.selector, event => {\n const context = this._initializeOnDelegatedTarget(event);\n\n context._activeTrigger[event.type === 'focusin' ? TRIGGER_FOCUS : TRIGGER_HOVER] = true;\n\n context._enter();\n });\n EventHandler.on(this._element, eventOut, this._config.selector, event => {\n const context = this._initializeOnDelegatedTarget(event);\n\n context._activeTrigger[event.type === 'focusout' ? TRIGGER_FOCUS : TRIGGER_HOVER] = context._element.contains(event.relatedTarget);\n\n context._leave();\n });\n }\n }\n\n this._hideModalHandler = () => {\n if (this._element) {\n this.hide();\n }\n };\n\n EventHandler.on(this._element.closest(SELECTOR_MODAL), EVENT_MODAL_HIDE, this._hideModalHandler);\n }\n\n _fixTitle() {\n const title = this._element.getAttribute('title');\n\n if (!title) {\n return;\n }\n\n if (!this._element.getAttribute('aria-label') && !this._element.textContent.trim()) {\n this._element.setAttribute('aria-label', title);\n }\n\n this._element.setAttribute('data-bs-original-title', title); // DO NOT USE IT. Is only for backwards compatibility\n\n\n this._element.removeAttribute('title');\n }\n\n _enter() {\n if (this._isShown() || this._isHovered) {\n this._isHovered = true;\n return;\n }\n\n this._isHovered = true;\n\n this._setTimeout(() => {\n if (this._isHovered) {\n this.show();\n }\n }, this._config.delay.show);\n }\n\n _leave() {\n if (this._isWithActiveTrigger()) {\n return;\n }\n\n this._isHovered = false;\n\n this._setTimeout(() => {\n if (!this._isHovered) {\n this.hide();\n }\n }, this._config.delay.hide);\n }\n\n _setTimeout(handler, timeout) {\n clearTimeout(this._timeout);\n this._timeout = setTimeout(handler, timeout);\n }\n\n _isWithActiveTrigger() {\n return Object.values(this._activeTrigger).includes(true);\n }\n\n _getConfig(config) {\n const dataAttributes = Manipulator.getDataAttributes(this._element);\n\n for (const dataAttribute of Object.keys(dataAttributes)) {\n if (DISALLOWED_ATTRIBUTES.has(dataAttribute)) {\n delete dataAttributes[dataAttribute];\n }\n }\n\n config = { ...dataAttributes,\n ...(typeof config === 'object' && config ? config : {})\n };\n config = this._mergeConfigObj(config);\n config = this._configAfterMerge(config);\n\n this._typeCheckConfig(config);\n\n return config;\n }\n\n _configAfterMerge(config) {\n config.container = config.container === false ? document.body : getElement(config.container);\n\n if (typeof config.delay === 'number') {\n config.delay = {\n show: config.delay,\n hide: config.delay\n };\n }\n\n if (typeof config.title === 'number') {\n config.title = config.title.toString();\n }\n\n if (typeof config.content === 'number') {\n config.content = config.content.toString();\n }\n\n return config;\n }\n\n _getDelegateConfig() {\n const config = {};\n\n for (const key in this._config) {\n if (this.constructor.Default[key] !== this._config[key]) {\n config[key] = this._config[key];\n }\n }\n\n config.selector = false;\n config.trigger = 'manual'; // In the future can be replaced with:\n // const keysWithDifferentValues = Object.entries(this._config).filter(entry => this.constructor.Default[entry[0]] !== this._config[entry[0]])\n // `Object.fromEntries(keysWithDifferentValues)`\n\n return config;\n }\n\n _disposePopper() {\n if (this._popper) {\n this._popper.destroy();\n\n this._popper = null;\n }\n\n if (this.tip) {\n this.tip.remove();\n this.tip = null;\n }\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Tooltip.getOrCreateInstance(this, config);\n\n if (typeof config !== 'string') {\n return;\n }\n\n if (typeof data[config] === 'undefined') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config]();\n });\n }\n\n}\n/**\n * jQuery\n */\n\n\ndefineJQueryPlugin(Tooltip);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): popover.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$3 = 'popover';\nconst SELECTOR_TITLE = '.popover-header';\nconst SELECTOR_CONTENT = '.popover-body';\nconst Default$2 = { ...Tooltip.Default,\n content: '',\n offset: [0, 8],\n placement: 'right',\n template: '
    ' + '
    ' + '

    ' + '
    ' + '
    ',\n trigger: 'click'\n};\nconst DefaultType$2 = { ...Tooltip.DefaultType,\n content: '(null|string|element|function)'\n};\n/**\n * Class definition\n */\n\nclass Popover extends Tooltip {\n // Getters\n static get Default() {\n return Default$2;\n }\n\n static get DefaultType() {\n return DefaultType$2;\n }\n\n static get NAME() {\n return NAME$3;\n } // Overrides\n\n\n _isWithContent() {\n return this._getTitle() || this._getContent();\n } // Private\n\n\n _getContentForTemplate() {\n return {\n [SELECTOR_TITLE]: this._getTitle(),\n [SELECTOR_CONTENT]: this._getContent()\n };\n }\n\n _getContent() {\n return this._resolvePossibleFunction(this._config.content);\n } // Static\n\n\n static jQueryInterface(config) {\n return this.each(function () {\n const data = Popover.getOrCreateInstance(this, config);\n\n if (typeof config !== 'string') {\n return;\n }\n\n if (typeof data[config] === 'undefined') {\n throw new TypeError(`No method named \"${config}\"`);\n }\n\n data[config]();\n });\n }\n\n}\n/**\n * jQuery\n */\n\n\ndefineJQueryPlugin(Popover);\n\n/**\n * --------------------------------------------------------------------------\n * Bootstrap (v5.2.3): scrollspy.js\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * --------------------------------------------------------------------------\n */\n/**\n * Constants\n */\n\nconst NAME$2 = 'scrollspy';\nconst DATA_KEY$2 = 'bs.scrollspy';\nconst EVENT_KEY$2 = `.${DATA_KEY$2}`;\nconst DATA_API_KEY = '.data-api';\nconst EVENT_ACTIVATE = `activate${EVENT_KEY$2}`;\nconst EVENT_CLICK = `click${EVENT_KEY$2}`;\nconst EVENT_LOAD_DATA_API$1 = `load${EVENT_KEY$2}${DATA_API_KEY}`;\nconst CLASS_NAME_DROPDOWN_ITEM = 'dropdown-item';\nconst CLASS_NAME_ACTIVE$1 = 'active';\nconst SELECTOR_DATA_SPY = '[data-bs-spy=\"scroll\"]';\nconst SELECTOR_TARGET_LINKS = '[href]';\nconst SELECTOR_NAV_LIST_GROUP = '.nav, .list-group';\nconst SELECTOR_NAV_LINKS = '.nav-link';\nconst SELECTOR_NAV_ITEMS = '.nav-item';\nconst SELECTOR_LIST_ITEMS = '.list-group-item';\nconst SELECTOR_LINK_ITEMS = `${SELECTOR_NAV_LINKS}, ${SELECTOR_NAV_ITEMS} > ${SELECTOR_NAV_LINKS}, ${SELECTOR_LIST_ITEMS}`;\nconst SELECTOR_DROPDOWN = '.dropdown';\nconst SELECTOR_DROPDOWN_TOGGLE$1 = '.dropdown-toggle';\nconst Default$1 = {\n offset: null,\n // TODO: v6 @deprecated, keep it for backwards compatibility reasons\n rootMargin: '0px 0px -25%',\n smoothScroll: false,\n target: null,\n threshold: [0.1, 0.5, 1]\n};\nconst DefaultType$1 = {\n offset: '(number|null)',\n // TODO v6 @deprecated, keep it for backwards compatibility reasons\n rootMargin: 'string',\n smoothScroll: 'boolean',\n target: 'element',\n threshold: 'array'\n};\n/**\n * Class definition\n */\n\nclass ScrollSpy extends BaseComponent {\n constructor(element, config) {\n super(element, config); // this._element is the observablesContainer and config.target the menu links wrapper\n\n this._targetLinks = new Map();\n this._observableSections = new Map();\n this._rootElement = getComputedStyle(this._element).overflowY === 'visible' ? null : this._element;\n this._activeTarget = null;\n this._observer = null;\n this._previousScrollData = {\n visibleEntryTop: 0,\n parentScrollTop: 0\n };\n this.refresh(); // initialize\n } // Getters\n\n\n static get Default() {\n return Default$1;\n }\n\n static get DefaultType() {\n return DefaultType$1;\n }\n\n static get NAME() {\n return NAME$2;\n } // Public\n\n\n refresh() {\n this._initializeTargetsAndObservables();\n\n this._maybeEnableSmoothScroll();\n\n if (this._observer) {\n this._observer.disconnect();\n } else {\n this._observer = this._getNewObserver();\n }\n\n for (const section of this._observableSections.values()) {\n this._observer.observe(section);\n }\n }\n\n dispose() {\n this._observer.disconnect();\n\n super.dispose();\n } // Private\n\n\n _configAfterMerge(config) {\n // TODO: on v6 target should be given explicitly & remove the {target: 'ss-target'} case\n config.target = getElement(config.target) || document.body; // TODO: v6 Only for backwards compatibility reasons. Use rootMargin only\n\n config.rootMargin = config.offset ? `${config.offset}px 0px -30%` : config.rootMargin;\n\n if (typeof config.threshold === 'string') {\n config.threshold = config.threshold.split(',').map(value => Number.parseFloat(value));\n }\n\n return config;\n }\n\n _maybeEnableSmoothScroll() {\n if (!this._config.smoothScroll) {\n return;\n } // unregister any previous listeners\n\n\n EventHandler.off(this._config.target, EVENT_CLICK);\n EventHandler.on(this._config.target, EVENT_CLICK, SELECTOR_TARGET_LINKS, event => {\n const observableSection = this._observableSections.get(event.target.hash);\n\n if (observableSection) {\n event.preventDefault();\n const root = this._rootElement || window;\n const height = observableSection.offsetTop - this._element.offsetTop;\n\n if (root.scrollTo) {\n root.scrollTo({\n top: height,\n behavior: 'smooth'\n });\n return;\n } // Chrome 60 doesn't support `scrollTo`\n\n\n root.scrollTop = height;\n }\n });\n }\n\n _getNewObserver() {\n const options = {\n root: this._rootElement,\n threshold: this._config.threshold,\n rootMargin: this._config.rootMargin\n };\n return new IntersectionObserver(entries => this._observerCallback(entries), options);\n } // The logic of selection\n\n\n _observerCallback(entries) {\n const targetElement = entry => this._targetLinks.get(`#${entry.target.id}`);\n\n const activate = entry => {\n this._previousScrollData.visibleEntryTop = entry.target.offsetTop;\n\n this._process(targetElement(entry));\n };\n\n const parentScrollTop = (this._rootElement || document.documentElement).scrollTop;\n const userScrollsDown = parentScrollTop >= this._previousScrollData.parentScrollTop;\n this._previousScrollData.parentScrollTop = parentScrollTop;\n\n for (const entry of entries) {\n if (!entry.isIntersecting) {\n this._activeTarget = null;\n\n this._clearActiveClass(targetElement(entry));\n\n continue;\n }\n\n const entryIsLowerThanPrevious = entry.target.offsetTop >= this._previousScrollData.visibleEntryTop; // if we are scrolling down, pick the bigger offsetTop\n\n if (userScrollsDown && entryIsLowerThanPrevious) {\n activate(entry); // if parent isn't scrolled, let's keep the first visible item, breaking the iteration\n\n if (!parentScrollTop) {\n return;\n }\n\n continue;\n } // if we are scrolling up, pick the smallest offsetTop\n\n\n if (!userScrollsDown && !entryIsLowerThanPrevious) {\n activate(entry);\n }\n }\n }\n\n _initializeTargetsAndObservables() {\n this._targetLinks = new Map();\n this._observableSections = new Map();\n const targetLinks = SelectorEngine.find(SELECTOR_TARGET_LINKS, this._config.target);\n\n for (const anchor of targetLinks) {\n // ensure that the anchor has an id and is not disabled\n if (!anchor.hash || isDisabled(anchor)) {\n continue;\n }\n\n const observableSection = SelectorEngine.findOne(anchor.hash, this._element); // ensure that the observableSection exists & is visible\n\n if (isVisible(observableSection)) {\n this._targetLinks.set(anchor.hash, anchor);\n\n this._observableSections.set(anchor.hash, observableSection);\n }\n }\n }\n\n _process(target) {\n if (this._activeTarget === target) {\n return;\n }\n\n this._clearActiveClass(this._config.target);\n\n this._activeTarget = target;\n target.classList.add(CLASS_NAME_ACTIVE$1);\n\n this._activateParents(target);\n\n EventHandler.trigger(this._element, EVENT_ACTIVATE, {\n relatedTarget: target\n });\n }\n\n _activateParents(target) {\n // Activate dropdown parents\n if (target.classList.contains(CLASS_NAME_DROPDOWN_ITEM)) {\n SelectorEngine.findOne(SELECTOR_DROPDOWN_TOGGLE$1, target.closest(SELECTOR_DROPDOWN)).classList.add(CLASS_NAME_ACTIVE$1);\n return;\n }\n\n for (const listGroup of SelectorEngine.parents(target, SELECTOR_NAV_LIST_GROUP)) {\n // Set triggered links parents as active\n // With both
      and