Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bccheung committed Dec 7, 2021
1 parent 481d3c3 commit d522fba
Show file tree
Hide file tree
Showing 25 changed files with 606 additions and 410 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: 8cf27416c23eae43f030a875c467ff9c
config: f41f7cd1583d36c635ca5b824a9466ee
tags: 645f666f9bcd5a90fca523b33c5a78b7
88 changes: 66 additions & 22 deletions docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ ul.search li a {
font-weight: bold;
}

ul.search li div.context {
ul.search li p.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
Expand Down Expand Up @@ -508,6 +508,63 @@ 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 ----------------------------------------------------- */

Expand Down Expand Up @@ -634,14 +691,6 @@ dl.glossary dt {
font-size: 1.1em;
}

.optional {
font-size: 1.3em;
}

.sig-paren {
font-size: larger;
}

.versionmodified {
font-style: italic;
}
Expand Down Expand Up @@ -682,8 +731,9 @@ dl.glossary dt {

.classifier:before {
font-style: normal;
margin: 0.5em;
margin: 0 0.5em;
content: ":";
display: inline-block;
}

abbr, acronym {
Expand Down Expand Up @@ -770,8 +820,12 @@ div.code-block-caption code {

table.highlighttable td.linenos,
span.linenos,
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
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 {
Expand All @@ -786,16 +840,6 @@ div.literal-block-wrapper {
margin: 1em 0;
}

code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}

code.descclassname {
background-color: transparent;
}

code.xref, a code {
background-color: transparent;
font-weight: bold;
Expand Down
2 changes: 2 additions & 0 deletions docs/_static/css/blank.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/* This file is intentionally left blank to override the stylesheet of the
parent theme via theme.conf. The parent style we import directly in theme.css */

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/_static/css/theme.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
/* Provided by the Sphinx base theme template at build time */
@import "../basic.css";

:root {
/*****************************************************************************
* Theme config
Expand Down
2 changes: 2 additions & 0 deletions docs/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -301,12 +301,14 @@ var Documentation = {
window.location.href = prevHref;
return false;
}
break;
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
}
}
});
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.2.1',
VERSION: '1.2.2',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
15 changes: 11 additions & 4 deletions docs/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,10 @@ var Search = {
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
var summary = Search.makeSearchSummary(data, searchterms, hlterms);
if (summary) {
listItem.append(summary);
}
}
Search.output.append(listItem);
setTimeout(function() {
Expand Down Expand Up @@ -325,7 +328,9 @@ var Search = {
var results = [];

for (var prefix in objects) {
for (var name in objects[prefix]) {
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) {
Expand All @@ -339,7 +344,6 @@ var Search = {
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
Expand Down Expand Up @@ -498,6 +502,9 @@ var Search = {
*/
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
if (text == "") {
return null;
}
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
Expand All @@ -509,7 +516,7 @@ var Search = {
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
var rv = $('<p class="context"></p>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
Expand Down
Loading

0 comments on commit d522fba

Please sign in to comment.