Skip to content

Commit

Permalink
Add rendered JSON Schema docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@AlexAxthelm
AlexAxthelm committed Aug 21, 2024
1 parent db25147 commit 43b524e
Show file tree
Hide file tree
Showing 14 changed files with 361 additions and 0 deletions.
7 changes: 7 additions & 0 deletions inst/extdata/schema/css/bootstrap-4.3.1.min.css
View file

Large diffs are not rendered by default.

160 changes: 160 additions & 0 deletions inst/extdata/schema/css/overpass300,400,600,800.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
/* cyrillic-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 300;
src: url(../font/qFdH35WCmI96Ajtm81GoU9vyww.woff2) format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
}
/* cyrillic */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 300;
src: url(../font/qFdH35WCmI96Ajtm81GhU9vyww.woff2) format('woff2');
unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}
/* vietnamese */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 300;
src: url(../font/qFdH35WCmI96Ajtm81GqU9vyww.woff2) format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 300;
src: url(../font/qFdH35WCmI96Ajtm81GrU9vyww.woff2) format('woff2');
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 300;
src: url(../font/qFdH35WCmI96Ajtm81GlU9s.woff2) format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
/* cyrillic-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 400;
src: url(../font/qFdH35WCmI96Ajtm81GoU9vyww.woff2) format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
}
/* cyrillic */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 400;
src: url(../font/qFdH35WCmI96Ajtm81GhU9vyww.woff2) format('woff2');
unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}
/* vietnamese */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 400;
src: url(../font/qFdH35WCmI96Ajtm81GqU9vyww.woff2) format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 400;
src: url(../font/qFdH35WCmI96Ajtm81GrU9vyww.woff2) format('woff2');
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 400;
src: url(../font/qFdH35WCmI96Ajtm81GlU9s.woff2) format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
/* cyrillic-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 600;
src: url(../font/qFdH35WCmI96Ajtm81GoU9vyww.woff2) format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
}
/* cyrillic */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 600;
src: url(../font/qFdH35WCmI96Ajtm81GhU9vyww.woff2) format('woff2');
unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}
/* vietnamese */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 600;
src: url(../font/qFdH35WCmI96Ajtm81GqU9vyww.woff2) format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 600;
src: url(../font/qFdH35WCmI96Ajtm81GrU9vyww.woff2) format('woff2');
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 600;
src: url(../font/qFdH35WCmI96Ajtm81GlU9s.woff2) format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
/* cyrillic-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 800;
src: url(../font/qFdH35WCmI96Ajtm81GoU9vyww.woff2) format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
}
/* cyrillic */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 800;
src: url(../font/qFdH35WCmI96Ajtm81GhU9vyww.woff2) format('woff2');
unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}
/* vietnamese */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 800;
src: url(../font/qFdH35WCmI96Ajtm81GqU9vyww.woff2) format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 800;
src: url(../font/qFdH35WCmI96Ajtm81GrU9vyww.woff2) format('woff2');
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Overpass';
font-style: normal;
font-weight: 800;
src: url(../font/qFdH35WCmI96Ajtm81GlU9s.woff2) format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
181 changes: 181 additions & 0 deletions inst/extdata/schema/css/schema_doc.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
body {
font: 16px/1.5em "Overpass", "Open Sans", Helvetica, sans-serif;
color: #333;
font-weight: 300;
padding: 40px;
}

.btn.btn-link {
font-size: 18px;
user-select: text;
}

.jsfh-animated-property {
animation: eclair;
animation-iteration-count: 1;
animation-fill-mode: forwards;
animation-duration: .75s;

}

@keyframes eclair {
0%,100% {
transform: scale(1);
}
50% {
transform: scale(1.03);
}
}

.btn.btn-primary {
margin: 10px;
}

.btn.example-show.collapsed:before {
content: "show"
}

.btn.example-show:before {
content: "hide"
}

.description.collapse:not(.show) {
max-height: 100px !important;
overflow: hidden;

display: -webkit-box;
-webkit-line-clamp: 2;
-webkit-box-orient: vertical;
}

.description.collapsing {
min-height: 100px !important;
}

.collapse-description-link.collapsed:after {
content: '+ Read More';
}

.collapse-description-link:not(.collapsed):after {
content: '- Read Less';
}

.badge {
font-size: 100%;
margin-bottom: 0.5rem;
margin-top: 0.5rem;
}

.badge.value-type {
font-size: 120%;
margin-right: 5px;
margin-bottom: 10px;
}


.badge.default-value {
font-size: 120%;
margin-left: 5px;
margin-bottom: 10px;
}

.badge.restriction {
display: inline-block;
}

.badge.required-property,.badge.deprecated-property,.badge.pattern-property,.badge.no-additional {
font-size: 100%;
margin-left: 10px;
}

.accordion div.card:only-child {
border-bottom: 1px solid rgba(0, 0, 0, 0.125);
}

.examples {
padding: 1rem !important;
}

.examples pre {
margin-bottom: 0;
}

.highlight.jumbotron {
padding: 1rem !important;
}

.generated-by-footer {
margin-top: 1em;
text-align: right;
}

/* From https://github.com/richleland/pygments-css/blob/master/friendly.css, see https://github.com/trentm/python-markdown2/wiki/fenced-code-blocks */
.highlight { background: #e9ecef; } /* Changed from #f0f0f0 in the original style to be the same as bootstrap's jumbotron */
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #60a0b0; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #c65d09; 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: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #40a070 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #40a070 } /* Literal.Number.Bin */
.highlight .mf { color: #40a070 } /* Literal.Number.Float */
.highlight .mh { color: #40a070 } /* Literal.Number.Hex */
.highlight .mi { color: #40a070 } /* Literal.Number.Integer */
.highlight .mo { color: #40a070 } /* Literal.Number.Oct */
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #06287e } /* Name.Function.Magic */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */
Binary file added inst/extdata/schema/font/qFdH35WCmI96Ajtm81GhU9vyww.woff2
View file
Binary file not shown.
Binary file added inst/extdata/schema/font/qFdH35WCmI96Ajtm81GlU9s.woff2
View file
Binary file not shown.
Binary file added inst/extdata/schema/font/qFdH35WCmI96Ajtm81GoU9vyww.woff2
View file
Binary file not shown.
Binary file added inst/extdata/schema/font/qFdH35WCmI96Ajtm81GqU9vyww.woff2
View file
Binary file not shown.
Binary file added inst/extdata/schema/font/qFdH35WCmI96Ajtm81GrU9vyww.woff2
View file
Binary file not shown.
7 changes: 7 additions & 0 deletions inst/extdata/schema/js/bootstrap-4.3.1.min.js
View file

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions inst/extdata/schema/js/jquery-3.4.1.min.js
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions inst/extdata/schema/js/schema_doc.min.js
View file

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

1 change: 1 addition & 0 deletions inst/extdata/schema/portfolio.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html><html lang=en> <head><link rel=stylesheet type=text/css href=css/overpass300,400,600,800.css><script src=js/jquery-3.4.1.min.js></script><link href=css/bootstrap-4.3.1.min.css rel=stylesheet><script src=js/bootstrap-4.3.1.min.js></script><link rel=stylesheet type=text/css href=css/schema_doc.css><!-- <script src="js/facf9fa52c.js"></script> --><script src=js/schema_doc.min.js></script><meta charset=utf-8><title>portfolio</title></head> <body onload=anchorOnLoad(); id=root><div class=text-right> <button class="btn btn-primary" type=button data-toggle=collapse data-target=.collapse:not(.show) aria-expanded=false>Expand all</button> <button class="btn btn-primary" type=button data-toggle=collapse data-target=.collapse.show aria-expanded=false>Collapse all</button> </div> <div class=breadcrumbs></div> <h1>portfolio</h1><span class="badge badge-dark value-type">Type: object</span><br> <span class=description><p>Definition for PACTA portfolio object</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class=accordion id=accordionfiles> <div class=card> <div class=card-header id=headingfiles> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#files aria-expanded aria-controls=files onclick="setAnchor('#files')"><span class=property-name>files</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=files class="collapse property-definition-div" aria-labelledby=headingfiles data-parent=#accordionfiles> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#files onclick="anchorLink('files')">files</a></div><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>List of portfolio files to be analyzed.</p> </span> </div> </div> </div> </div> <div class=accordion id=accordionholdingsDate> <div class=card> <div class=card-header id=headingholdingsDate> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#holdingsDate aria-expanded aria-controls=holdingsDate onclick="setAnchor('#holdingsDate')"><span class=property-name>holdingsDate</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=holdingsDate class="collapse property-definition-div" aria-labelledby=headingholdingsDate data-parent=#accordionholdingsDate> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#holdingsDate onclick="anchorLink('holdingsDate')">holdingsDate</a></div><span class="badge badge-dark value-type">Type: enum (of string)</span><span class="badge badge-info value-type">Format: date</span><br> <span class=description><p>Date of the holdings data.</p> </span><div class=enum-value id=holdingsDate_enum> <h4>Must be one of:</h4> <ul class=list-group><li class="list-group-item enum-item">"2022-12-31"</li><li class="list-group-item enum-item">"2023-12-31"</li></ul> </div> </div> </div> </div> </div> <div class=accordion id=accordionname> <div class=card> <div class=card-header id=headingname> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#name aria-expanded aria-controls=name onclick="setAnchor('#name')"><span class=property-name>name</span></button> </h2> </div> <div id=name class="collapse property-definition-div" aria-labelledby=headingname data-parent=#accordionname> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#name onclick="anchorLink('name')">name</a></div><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>Name of the portfolio.</p> </span> </div> </div> </div> </div> <footer> <p class=generated-by-footer>Generated using <a href=https://github.com/coveooss/json-schema-for-humans>json-schema-for-humans</a> on 2024-08-21 at 09:35:19 +0000</p> </footer></body> </html>
1 change: 1 addition & 0 deletions inst/extdata/schema/portfolioParameters.html
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions inst/extdata/schema/rawParameters.html
View file

Large diffs are not rendered by default.

0 comments on commit 43b524e

Please sign in to comment.