Skip to content

Commit

Permalink
Update docs with PR 17
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrwm
chrwm committed Dec 12, 2023
1 parent 0ea028d commit d8b6da8
Show file tree
Hide file tree
Showing 29 changed files with 1,727 additions and 528 deletions.
6 changes: 6 additions & 0 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@
<li class="navitem">
<a href="/how_to_contribute_data/" class="nav-link">How to contribute data?</a>
</li>
<li class="navitem">
<a href="/data_preface/" class="nav-link">Data preface</a>
</li>
<li class="navitem">
<a href="/faq/" class="nav-link">FAQ</a>
</li>
<li class="navitem">
<a href="/glossary/" class="nav-link">Glossary</a>
</li>
Expand Down
28 changes: 16 additions & 12 deletions css/base.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,43 +209,47 @@ footer {
padding-left: .5em;
}

h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink{
h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink {
display:inline-block;
}



.admonition {
.admonition, details {
padding: 15px;
margin-bottom: 20px;
border: 1px solid transparent;
border-radius: 4px;
text-align: left;
}

.admonition.note { /* csslint allow: adjoining-classes */
color: #3a87ad;
background-color: #d9edf7;
.admonition.note, details.note { /* csslint allow: adjoining-classes */
color: #2e6b89;
background-color: #e2f0f7;
border-color: #bce8f1;
}

.admonition.warning { /* csslint allow: adjoining-classes */
color: #c09853;
background-color: #fcf8e3;
.admonition.warning, details.warning { /* csslint allow: adjoining-classes */
color: #7a6032;
background-color: #fffae5;
border-color: #fbeed5;
}

.admonition.danger { /* csslint allow: adjoining-classes */
color: #b94a48;
background-color: #f2dede;
.admonition.danger, details.danger { /* csslint allow: adjoining-classes */
color: #7f3130;
background-color: #fde3e3;
border-color: #eed3d7;
}

.admonition-title {
.admonition-title, summary {
font-weight: bold;
text-align: left;
}

.admonition>p:last-child, details>p:last-child {
margin-bottom: 0;
}

@media (max-width: 991.98px) {
.navbar-collapse.show { /* csslint allow: adjoining-classes */
overflow-y: auto;
Expand Down
229 changes: 229 additions & 0 deletions data_preface/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">



<link rel="shortcut icon" href="../img/favicon.ico">
<title>Data preface - SEDOS Project</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css">

<script src="../js/jquery-1.10.2.min.js" defer></script>
<script src="../js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>

<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="..">SEDOS Project</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
<span class="navbar-toggler-icon"></span>
</button>

<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Data requirements <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../data_requirements/overview/" class="dropdown-item">Overview</a>
</li>

<li>
<a href="../data_requirements/input_data/" class="dropdown-item">Data</a>
</li>

<li>
<a href="../data_requirements/nomenclature/" class="dropdown-item">Nomenclature</a>
</li>

<li>
<a href="../data_requirements/metadata/" class="dropdown-item">Metadata</a>
</li>

<li>
<a href="../data_requirements/ontology/" class="dropdown-item">Ontology</a>
</li>

<li>
<a href="../data_requirements/licensing/" class="dropdown-item">Licensing</a>
</li>
</ul>
</li>
<li class="navitem">
<a href="../how_to_contribute_data/" class="nav-link">How to contribute data?</a>
</li>
<li class="navitem active">
<a href="./" class="nav-link">Data preface</a>
</li>
<li class="navitem">
<a href="../faq/" class="nav-link">FAQ</a>
</li>
<li class="navitem">
<a href="../glossary/" class="nav-link">Glossary</a>
</li>
</ul>

<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../how_to_contribute_data/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../faq/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>

<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>


<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">

<li class="nav-item" data-level="1"><a href="#data#preface" class="nav-link">Data preface</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#units" class="nav-link">Units</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">

<h1 id="data#preface">Data preface<a class="headerlink" href="#data#preface" title="Permanent link">&para;</a></h1>
<p>The SEDOS Reference Dataset (SRD) entails technology data across five sectors (power, heat, PtX, industry, mobility)
and various aggregation levels.</p>
<p>This <em>data preface</em> provides additional information about the syntax of parameters and units in SRD.</p>
<details class="note">
<summary>Monetary value</summary>
<p>If not further specified the base year for the monatary value is 2021.</p>
</details>
<h2 id="units">Units<a class="headerlink" href="#units" title="Permanent link">&para;</a></h2>
<table>
<thead>
<tr>
<th>Symbol</th>
<th>Name</th>
<th>Range</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>%</code></td>
<td><code>Percent</code></td>
<td>[0,100]</td>
<td>A number or ratio expressed as a fraction of 100.</td>
</tr>
</tbody>
</table></div>
</div>
</div>

<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js" defer></script>
<script src="../search/main.js" defer></script>

<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>

</body>
</html>
Loading

0 comments on commit d8b6da8

Please sign in to comment.