Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@angusdunnett
angusdunnett committed Jan 11, 2021
1 parent 2e00cb1 commit 186d064
Show file tree
Hide file tree
Showing 10 changed files with 97 additions and 32 deletions.
4 changes: 4 additions & 0 deletions docs/build/assets/documenter.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 8 additions & 4 deletions docs/build/assets/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions docs/build/assets/themes/documenter-dark.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7277,6 +7277,8 @@ html.theme--documenter-dark {
opacity: 0.2; }
html.theme--documenter-dark .docstring > section:hover a.docs-sourcelink {
opacity: 1; }
html.theme--documenter-dark .documenter-example-output {
background-color: #1f2424; }
html.theme--documenter-dark .content pre {
border: 1px solid #5e6d6f; }
html.theme--documenter-dark .content code {
Expand All @@ -7303,11 +7305,15 @@ html.theme--documenter-dark {
html.theme--documenter-dark .katex .katex-mathml {
top: 0;
right: 0; }
html.theme--documenter-dark .katex-display, html.theme--documenter-dark mjx-container, html.theme--documenter-dark .MathJax_Display {
margin: 0.5em 0 !important; }
html.theme--documenter-dark html {
-moz-osx-font-smoothing: auto;
-webkit-font-smoothing: auto; }
html.theme--documenter-dark #documenter .docs-main > article {
overflow-wrap: break-word; }
html.theme--documenter-dark #documenter .docs-main > article .math-container {
overflow-x: auto; }
@media screen and (min-width: 1056px) {
html.theme--documenter-dark #documenter .docs-main {
max-width: 52rem;
Expand Down Expand Up @@ -7379,6 +7385,7 @@ html.theme--documenter-dark {
margin-bottom: 0.4em; }
html.theme--documenter-dark #documenter .docs-main .docs-footer {
display: flex;
flex-wrap: wrap;
margin-left: 0;
margin-right: 0;
border-top: 1px solid #5e6d6f;
Expand All @@ -7392,6 +7399,13 @@ html.theme--documenter-dark {
flex-grow: 1; }
html.theme--documenter-dark #documenter .docs-main .docs-footer .docs-footer-nextpage {
text-align: right; }
html.theme--documenter-dark #documenter .docs-main .docs-footer .flexbox-break {
flex-basis: 100%;
height: 0; }
html.theme--documenter-dark #documenter .docs-main .docs-footer .footer-message {
font-size: 0.8em;
margin: 0.5em auto 0 auto;
text-align: center; }
html.theme--documenter-dark #documenter .docs-sidebar {
display: flex;
flex-direction: column;
Expand Down
16 changes: 16 additions & 0 deletions docs/build/assets/themes/documenter-light.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7239,6 +7239,9 @@ h1:hover .docs-heading-anchor-permalink, h2:hover .docs-heading-anchor-permalink
.docstring > section:hover a.docs-sourcelink {
opacity: 1; }

.documenter-example-output {
background-color: white; }

.content pre {
border: 1px solid #dbdbdb; }

Expand Down Expand Up @@ -7274,6 +7277,9 @@ h1:hover .docs-heading-anchor-permalink, h2:hover .docs-heading-anchor-permalink
top: 0;
right: 0; }

.katex-display, mjx-container, .MathJax_Display {
margin: 0.5em 0 !important; }

html {
-moz-osx-font-smoothing: auto;
-webkit-font-smoothing: auto; }
Expand All @@ -7284,6 +7290,8 @@ html {
*/
#documenter .docs-main > article {
overflow-wrap: break-word; }
#documenter .docs-main > article .math-container {
overflow-x: auto; }

@media screen and (min-width: 1056px) {
#documenter .docs-main {
Expand Down Expand Up @@ -7360,6 +7368,7 @@ html {

#documenter .docs-main .docs-footer {
display: flex;
flex-wrap: wrap;
margin-left: 0;
margin-right: 0;
border-top: 1px solid #dbdbdb;
Expand All @@ -7373,6 +7382,13 @@ html {
flex-grow: 1; }
#documenter .docs-main .docs-footer .docs-footer-nextpage {
text-align: right; }
#documenter .docs-main .docs-footer .flexbox-break {
flex-basis: 100%;
height: 0; }
#documenter .docs-main .docs-footer .footer-message {
font-size: 0.8em;
margin: 0.5em auto 0 auto;
text-align: center; }

#documenter .docs-sidebar {
display: flex;
Expand Down
38 changes: 31 additions & 7 deletions docs/build/assets/themeswap.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
// Small function to quickly swap out themes. Gets put into the <head> tag..
function set_theme_from_local_storage() {
// Browser does not support Web Storage, bail early.
if(typeof(window.localStorage) === "undefined") return;
// Get the user-picked theme from localStorage. May be `null`, which means the default
// theme.
var theme = window.localStorage.getItem("documenter-theme");
// Intialize the theme to null, which means default
var theme = null;
// If the browser supports the localstorage and is not disabled then try to get the
// documenter theme
if(window.localStorage != null) {
// Get the user-picked theme from localStorage. May be `null`, which means the default
// theme.
theme = window.localStorage.getItem("documenter-theme");
}
// Check if the browser supports user color preference
var darkPreference = false;
// Check if the users preference is for dark color scheme
if(window.matchMedia('(prefers-color-scheme: dark)').matches === true) {
darkPreference = true;
}
// Initialize a few variables for the loop:
//
// - active: will contain the index of the theme that should be active. Note that there
Expand All @@ -14,7 +24,7 @@ function set_theme_from_local_storage() {
//
// - disabled: style sheets that should be disabled (i.e. all the theme style sheets
// that are not the currently active theme)
var active = null; var disabled = [];
var active = null; var disabled = []; var darkTheme = null;
for (var i = 0; i < document.styleSheets.length; i++) {
var ss = document.styleSheets[i];
// The <link> tag of each style sheet is expected to have a data-theme-name attribute
Expand All @@ -25,8 +35,12 @@ function set_theme_from_local_storage() {
// To distinguish the default (primary) theme, it needs to have the data-theme-primary
// attribute set.
var isprimary = (ss.ownerNode.getAttribute("data-theme-primary") !== null);
// Check if the theme is primary dark theme
var isDarkTheme = (ss.ownerNode.getAttribute("data-theme-primary-dark") !== null);
// If ss is for dark theme then set the value of darkTheme to the name of the theme
if(isDarkTheme) darkTheme = themename;
// If we find a matching theme (and it's not the default), we'll set active to non-null
if(!isprimary && themename === theme) active = i;
if(themename === theme) active = i;
// Store the style sheets of inactive themes so that we could disable them
if(themename !== theme) disabled.push(ss);
}
Expand All @@ -38,5 +52,15 @@ function set_theme_from_local_storage() {
ss.disabled = true;
});
}
else if(darkTheme !== null && darkPreference === true) {
// If we did find an active theme, we'll (1) add the theme--$(theme) class to <html>
document.getElementsByTagName('html')[0].className = "theme--" + darkTheme;
// and (2) disable all the other theme stylesheets
disabled.forEach(function(ss){
if (ss.ownerNode.getAttribute("data-theme-name") !== darkTheme) {
ss.disabled = true;
}
});
}
}
set_theme_from_local_storage();
4 changes: 2 additions & 2 deletions docs/build/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/build/search/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · MPS Docs</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">MPS Docs</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">-</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Monday 22 June 2020 12:12">Monday 22 June 2020</span>. Using Julia version 1.0.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · MPSDynamics Documentation</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">MPSDynamics Documentation</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">MPSDynamics Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Monday 11 January 2021 16:58">Monday 11 January 2021</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
Loading

0 comments on commit 186d064

Please sign in to comment.