From 4797fe2021dc0f05cc0da266e802c513ac543927 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 1 Mar 2018 11:44:10 +0100 Subject: Update static docs using current pkdown --- ChangeLog | 32 +++++++++- DESCRIPTION | 4 +- docs/authors.html | 20 ++++-- docs/index.html | 24 ++++--- docs/pkgdown.css | 129 +++++++++++++++++++++++++++++++------- docs/pkgdown.js | 88 +++++++++++++++++++++++++- docs/reference/index.html | 56 ++++++++++++----- docs/reference/install_PELMO.html | 38 ++++++++--- 8 files changed, 329 insertions(+), 62 deletions(-) diff --git a/ChangeLog b/ChangeLog index bd68b6b..2a47aba 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,4 +1,34 @@ -commit 147cba00160380874987a00b417eac5bea562010 +commit 5a60a334a61dde923a131d8798d6fa03f38525b2 +Author: Johannes Ranke +Date: 2017-03-15 09:50:29 +0100 + + Rebuild pkgdown + +commit 991c0078dc3e6e082d32e8657698af1c2ffaceba +Author: Johannes Ranke +Date: 2017-03-15 09:47:43 +0100 + + Change doc location to pkgdown.jrwb.de + +commit d4dce210ca772fba8cab7dcbef74b242c98da050 +Author: Johannes Ranke +Date: 2017-03-06 17:49:25 +0100 + + Move static docs to pkgdown.jrwb.de + +commit 2454dd9077f1d499549791a774687f12c87aeb8e +Author: Johannes Ranke +Date: 2017-01-31 07:42:39 +0100 + + Document all arguments of install_PELMO + +commit 5cf14fe9a9fe15e866529ebde14492b56645f6b7 +Author: Johannes Ranke +Date: 2017-01-31 07:40:09 +0100 + + Remove winbuilder target, documentation fix. + +commit 4f4cd07a9ef72c53bbfa53eda835f19dc9f9ad72 Author: Johannes Ranke Date: 2017-01-25 18:39:48 +0100 diff --git a/DESCRIPTION b/DESCRIPTION index 1089b66..9d5be2a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: PELMO.installeR Type: Package Title: Install FOCUS PELMO into an R library location Version: 0.1-1 -Date: 2017-01-25 +Date: 2018-03-01 Authors@R: person("Johannes Ranke", email = "jranke@uni-bremen.de", role = c("aut", "cre", "cph")) Description: The only function in this package downloads 'FOCUS PELMO' from the @@ -13,4 +13,4 @@ Imports: clipr License: GPL LazyLoad: yes LazyData: yes -RoxygenNote: 5.0.1.9000 +RoxygenNote: 6.0.1 diff --git a/docs/authors.html b/docs/authors.html index e8abd36..46a2aa2 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -18,19 +18,25 @@ + + - + + + - + + + @@ -49,6 +55,12 @@
-

Site built with pkgdown.

+

Site built with pkgdown.

diff --git a/docs/index.html b/docs/index.html index 878949a..9d7b5cd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,8 +8,12 @@ Install FOCUS PELMO into an R library location • PELMO.installeR - - + + + + @@ -28,6 +32,12 @@ @@ -76,7 +86,7 @@
-

Site built with pkgdown.

+

Site built with pkgdown.

diff --git a/docs/pkgdown.css b/docs/pkgdown.css index fd7b0ba..181fe63 100644 --- a/docs/pkgdown.css +++ b/docs/pkgdown.css @@ -34,13 +34,14 @@ img.icon { float: right; } -/* Section anchors ---------------------------------*/ - -.hasAnchor { - margin-left: -30px; +img { + max-width: 100%; } +/* Section anchors ---------------------------------*/ + a.anchor { + margin-left: -30px; display:inline-block; width: 30px; height: 30px; @@ -56,6 +57,13 @@ a.anchor { visibility: visible; } +@media (max-width: 767px) { + .hasAnchor:hover a.anchor { + visibility: hidden; + } +} + + /* Fixes for fixed navbar --------------------------*/ .contents h1, .contents h2, .contents h3, .contents h4 { @@ -63,6 +71,17 @@ a.anchor { margin-top: -60px; } +/* Static header placement on mobile devices */ +@media (max-width: 767px) { + .navbar-fixed-top { + position: absolute; + } + .navbar { + padding: 0; + } +} + + /* Sidebar --------------------------*/ #sidebar { @@ -81,33 +100,95 @@ a.anchor { margin-bottom: 0.5em; } +.orcid { + height: 16px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} +.ref-index h2 {font-size: 20px;} + +.ref-index td {vertical-align: top;} +.ref-index .alias {width: 40%;} +.ref-index .title {width: 60%;} + +.ref-index .alias {width: 40%;} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top;} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + /* Syntax highlighting ---------------------------------------------------- */ -code { - background-color: #f7f7f7; - color: #333; +pre { + word-wrap: normal; + word-break: normal; + border: 1px solid #eee; } -code a { - color: #375f84; + +pre, code { + background-color: #f8f8f8; + color: #333; } -.warning { color: red; } -.message { font-weight: bolder; } -.error { color: red; font-weight: bolder; } +pre code { + overflow: auto; + word-wrap: normal; + white-space: pre; +} -.fl,.number {color:rgb(21,20,181);} -.fu,.functioncall {color:#264D66 ;} -.ch,.st,.string {color:#375D81 ;} -.kw,.keyword {color:black;} -.argument {color:#264D66 ;} -.co,.comment {color: #777;} -.formalargs {color: #264D66;} -.eqformalargs {color:#264D66;} -.slot {font-style:italic;} -.symbol {color:black ;} -.prompt {color:black ;} +pre .img { + margin: 5px 0; +} -pre img { +pre .img img { background-color: #fff; display: block; + height: auto; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.message { color: black; font-weight: bolder;} +.error { color: orange; font-weight: bolder;} +.warning { color: #6A0366; font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; } diff --git a/docs/pkgdown.js b/docs/pkgdown.js index c8b38c4..64b20df 100644 --- a/docs/pkgdown.js +++ b/docs/pkgdown.js @@ -1,8 +1,94 @@ $(function() { - $("#sidebar").stick_in_parent({offset_top: 40}); + + $("#sidebar") + .stick_in_parent({offset_top: 40}) + .on('sticky_kit:bottom', function(e) { + $(this).parent().css('position', 'static'); + }) + .on('sticky_kit:unbottom', function(e) { + $(this).parent().css('position', 'relative'); + }); + $('body').scrollspy({ target: '#sidebar', offset: 60 }); + var cur_path = paths(location.pathname); + $("#navbar ul li a").each(function(index, value) { + if (value.text == "Home") + return; + if (value.getAttribute("href") === "#") + return; + + var path = paths(value.pathname); + if (is_prefix(cur_path, path)) { + // Add class to parent
  • , and enclosing
  • if in dropdown + var menu_anchor = $(value); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); }); + +function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); +} + +function is_prefix(needle, haystack) { + if (needle.length > haystack.lengh) + return(false); + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(false); + } + + return(true); +} + +/* Clipboard --------------------------*/ + +function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); +} + +if(Clipboard.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $(".examples").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new Clipboard('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent; + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); +} + diff --git a/docs/reference/index.html b/docs/reference/index.html index 6410de9..98764f7 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -18,19 +18,25 @@ + + - + + + - + + + @@ -49,6 +55,12 @@
    -

    Site built with pkgdown.

    +

    Site built with pkgdown.

    -- cgit v1.2.1