mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-06-21 18:53:55 +02:00
deploy: c2952ce52edd40580d7e7f3eadd53392e3140498
This commit is contained in:
philipp-horstenkamp
BIN
doctrees/Pflichtenheft.doctree
Normal file
BIN
doctrees/Pflichtenheft.doctree
Normal file
Binary file not shown.
BIN
doctrees/aki_prj23_transparenzregister.black_test.doctree
Normal file
BIN
doctrees/aki_prj23_transparenzregister.black_test.doctree
Normal file
Binary file not shown.
BIN
doctrees/aki_prj23_transparenzregister.doctree
Normal file
BIN
doctrees/aki_prj23_transparenzregister.doctree
Normal file
Binary file not shown.
BIN
doctrees/aki_prj23_transparenzregister.flake8_test.doctree
Normal file
BIN
doctrees/aki_prj23_transparenzregister.flake8_test.doctree
Normal file
Binary file not shown.
BIN
doctrees/environment.pickle
Normal file
BIN
doctrees/environment.pickle
Normal file
Binary file not shown.
BIN
doctrees/index.doctree
Normal file
BIN
doctrees/index.doctree
Normal file
Binary file not shown.
BIN
doctrees/meeting-notes/Meeting_2023-03-30.doctree
Normal file
BIN
doctrees/meeting-notes/Meeting_2023-03-30.doctree
Normal file
Binary file not shown.
BIN
doctrees/meeting-notes/Meeting_2023-04-13.doctree
Normal file
BIN
doctrees/meeting-notes/Meeting_2023-04-13.doctree
Normal file
Binary file not shown.
BIN
doctrees/meeting-notes/Meeting_2023-05-04.doctree
Normal file
BIN
doctrees/meeting-notes/Meeting_2023-05-04.doctree
Normal file
Binary file not shown.
BIN
doctrees/meeting-notes/Meeting_2023-05-11.doctree
Normal file
BIN
doctrees/meeting-notes/Meeting_2023-05-11.doctree
Normal file
Binary file not shown.
BIN
doctrees/meeting-notes/Meeting_2023_05-25.doctree
Normal file
BIN
doctrees/meeting-notes/Meeting_2023_05-25.doctree
Normal file
Binary file not shown.
BIN
doctrees/modules.doctree
Normal file
BIN
doctrees/modules.doctree
Normal file
Binary file not shown.
BIN
doctrees/research/RE_Vom-Problem-zur-Loesung.doctree
Normal file
BIN
doctrees/research/RE_Vom-Problem-zur-Loesung.doctree
Normal file
Binary file not shown.
BIN
doctrees/research/Timeseries/Overview.doctree
Normal file
BIN
doctrees/research/Timeseries/Overview.doctree
Normal file
Binary file not shown.
BIN
doctrees/research/data_and_metrics.doctree
Normal file
BIN
doctrees/research/data_and_metrics.doctree
Normal file
Binary file not shown.
BIN
doctrees/research/news_apis.doctree
Normal file
BIN
doctrees/research/news_apis.doctree
Normal file
Binary file not shown.
BIN
doctrees/research/resarch-central.doctree
Normal file
BIN
doctrees/research/resarch-central.doctree
Normal file
Binary file not shown.
BIN
doctrees/seminararbeiten/3_Datenspeicherung.doctree
Normal file
BIN
doctrees/seminararbeiten/3_Datenspeicherung.doctree
Normal file
Binary file not shown.
Binary file not shown.
BIN
doctrees/seminararbeiten/Abstract_Data_Extraction.doctree
Normal file
BIN
doctrees/seminararbeiten/Abstract_Data_Extraction.doctree
Normal file
Binary file not shown.
BIN
doctrees/seminararbeiten/Abstract_Datenvisualisierung.doctree
Normal file
BIN
doctrees/seminararbeiten/Abstract_Datenvisualisierung.doctree
Normal file
Binary file not shown.
BIN
doctrees/seminararbeiten/Datenvisualisierung/Übersicht.doctree
Normal file
BIN
doctrees/seminararbeiten/Datenvisualisierung/Übersicht.doctree
Normal file
Binary file not shown.
Binary file not shown.
BIN
doctrees/seminararbeiten/verflechtungsanalyse.doctree
Normal file
BIN
doctrees/seminararbeiten/verflechtungsanalyse.doctree
Normal file
Binary file not shown.
BIN
doctrees/templates/meeting_notes_template.doctree
Normal file
BIN
doctrees/templates/meeting_notes_template.doctree
Normal file
Binary file not shown.
BIN
doctrees/timeline.doctree
Normal file
BIN
doctrees/timeline.doctree
Normal file
Binary file not shown.
4
html/.buildinfo
Normal file
4
html/.buildinfo
Normal file
@ -0,0 +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: ec21fcfe6fbedb4bdf44a3664b1f7df5
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
418
html/Pflichtenheft.html
Normal file
418
html/Pflichtenheft.html
Normal file
@ -0,0 +1,418 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Pflichtenheft: Kapitalgesellschaften referenzregister — transparenzregister 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/clipboard.min.js"></script>
|
||||
<script src="_static/copybutton.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Timeline" href="timeline.html" />
|
||||
<link rel="prev" title="Transparenzregister Documentation" href="index.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
transparenzregister
|
||||
</a>
|
||||
<div class="version">
|
||||
0.1.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Pflichtenheft: Kapitalgesellschaften referenzregister</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#historie-der-dokumentenversion">Historie der Dokumentenversion <a name="historie"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#inhaltsverzeichnis">Inhaltsverzeichnis <a name="inhaltsverzeichnis"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#einleitung">Einleitung <a name="einleitung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#allgemeines">Allgemeines <a name="allgemeines"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ziel-und-zweck-des-dokuments">Ziel und Zweck des Dokuments <a name="ziel/zweck"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ausgangssituation">Ausgangssituation <a name="ausgangssituation"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#projektbezug">Projektbezug <a name="projektbezug"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#abkurzungen">Abkürzungen <a name="abkürzungen"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#schnittstellen-bezug-zu-anderen-dokumenten">Schnittstellen/ Bezug zu anderen Dokumenten <a name="schnittstellen"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#konzept-und-rahmenbedingungen">Konzept und Rahmenbedingungen <a name="konzept_und_rahmenbedingung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ziele-des-anbieters">Ziele des Anbieters <a name="ziele_anbieter"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ziele-und-nutzen-des-anwenders">Ziele und Nutzen des Anwenders <a name="ziele_anwender"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#benutzer-zielgruppen">Benutzer / Zielgruppen <a name="benutzer/zielgruppen"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#systemvoraussetzungen-optional">Systemvoraussetzungen (Optional) <a name="systemvoraussetzungen"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ressourcen-optional">Ressourcen (Optional) <a name="ressourcen"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#funktionale-anforderungen">Funktionale Anforderungen <a name="f_anforderung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#muss-ziele"><strong>Muss Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#f100">F100 <a name="f100"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#f110">F110 <a name="f110"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#f120">F120 <a name="f120"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#soll-ziele"><strong>Soll Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#f200">F200 <a name="f200"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#f210">F210 <a name="f210"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#f220">F220 <a name="f220"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#nicht-funktionale-anforderungen">Nicht-Funktionale Anforderungen <a name="nf_anforderung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id1"><strong>Muss Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#n100">N100 <a name="n100"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2"><strong>Soll Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#n200">N200 <a name="n200"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#n210">N210 <a name="n210"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#kann-ziele"><strong>Kann Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#n300">N300 <a name="n300"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#n310">N310 <a name="n310"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#anforderungsverfolgung-zu-den-spezifikationen">Anforderungsverfolgung zu den Spezifikationen <a name="verfolgung_spezifikation"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#abnahmekriterien-und-vorgehen-zur-ausgangsprufung">Abnahmekriterien und Vorgehen zur Ausgangsprüfung <a name="abnahmekriterien"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#lieferumfang">Lieferumfang <a name="lieferumfang"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#anhang-ressourcen">Anhang / Ressourcen <a name="anhang/ressourcen"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">transparenzregister</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Pflichtenheft: Kapitalgesellschaften referenzregister</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/Pflichtenheft.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="pflichtenheft-kapitalgesellschaften-referenzregister">
|
||||
<h1>Pflichtenheft: Kapitalgesellschaften referenzregister<a class="headerlink" href="#pflichtenheft-kapitalgesellschaften-referenzregister" title="Permalink to this heading"></a></h1>
|
||||
<p>Version 0.1 Erstellt am 07.04.2023</p>
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Autoren</p></th>
|
||||
<th class="head"><p>Matrikelnummer</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>Kim Mesewinkel</p></td>
|
||||
<td><p>000</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Tristan Nolde</p></td>
|
||||
<td><p>000</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Sebastian Zelenie</p></td>
|
||||
<td><p>000</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Philip Horstenkamp</p></td>
|
||||
<td><p>000</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Sascha Zhu</p></td>
|
||||
<td><p>000</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>Tim Ronneburg</p></td>
|
||||
<td><p>000</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="historie-der-dokumentenversion">
|
||||
<h2>Historie der Dokumentenversion <a name="historie"></a><a class="headerlink" href="#historie-der-dokumentenversion" title="Permalink to this heading"></a></h2>
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Version</p></th>
|
||||
<th class="head"><p>Datum</p></th>
|
||||
<th class="head"><p>Autor</p></th>
|
||||
<th class="head"><p>Änderungsgrund / Bemerkung</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>0.1</p></td>
|
||||
<td><p>07.04.2023</p></td>
|
||||
<td><p>Tim Ronneburg</p></td>
|
||||
<td><p>Initiales aufsetzen des Pflichtenhefts</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>0.2</p></td>
|
||||
<td><p>000</p></td>
|
||||
<td><p></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>…</p></td>
|
||||
<td><p>000</p></td>
|
||||
<td><p></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>1.0</p></td>
|
||||
<td><p>000</p></td>
|
||||
<td><p></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="inhaltsverzeichnis">
|
||||
<h2>Inhaltsverzeichnis <a name="inhaltsverzeichnis"></a><a class="headerlink" href="#inhaltsverzeichnis" title="Permalink to this heading"></a></h2>
|
||||
<p><a class="reference internal" href="#historie"><span class="xref myst">Historie der Dokumentenversion</span></a>
|
||||
<a class="reference internal" href="#inhaltsverzeichnis"><span class="xref myst">Inhaltsverzeichnis</span></a></p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><a class="reference internal" href="#einleitung"><span class="xref myst">Einleitung</span></a></p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><a class="reference internal" href="#allgemeines"><span class="xref myst">allgemeines</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#ziel/zweck"><span class="xref myst">Ziel und Zweck des Dokuments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#ausgangssituation"><span class="xref myst">Ausgangssituation</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#projektbezug"><span class="xref myst">Projektbezug</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#abk%C3%BCrzungen"><span class="xref myst">Abkürzungen</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#schnittstellen"><span class="xref myst">Schnittstellen/ Bezug zu anderen Dokumenten</span></a></p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#konzept_und_rahmenbedingung"><span class="xref myst">Konzept und Rahmenbedingungen</span></a></p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><a class="reference internal" href="#ziele_anbieter"><span class="xref myst">Ziele des Anbieters</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#ziele_anwender"><span class="xref myst">Ziele und Nutzen des Anwenders</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#benutzer/zielgruppen"><span class="xref myst">Benutzer / Zielgruppen</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#systemvoraussetzungen"><span class="xref myst">Systemvoraussetzungen (Optional)</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#ressourcen"><span class="xref myst">Ressourcen (Optional)</span></a></p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#f_anforderung"><span class="xref myst">Funktionale Anforderungen</span></a></p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><a class="reference internal" href="#f100"><span class="xref myst">F100</span></a></p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#nf_anforderung"><span class="xref myst">Nicht-Funktionale Anforderungen</span></a></p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><a class="reference internal" href="#n100"><span class="xref myst">N100</span></a></p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#verfolgung_spezifikation"><span class="xref myst">Anforderungsverfolgung zu den Spezifikationen</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#abnahmekriterien"><span class="xref myst">Abnahmekriterien und Vorgehen zur Ausgangsprüfung</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#lieferumfang"><span class="xref myst">Lieferumfang</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#anhang/ressourcen"><span class="xref myst">Anhang / Ressourcen</span></a></p></li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="einleitung">
|
||||
<h2>Einleitung <a name="einleitung"></a><a class="headerlink" href="#einleitung" title="Permalink to this heading"></a></h2>
|
||||
<section id="allgemeines">
|
||||
<h3>Allgemeines <a name="allgemeines"></a><a class="headerlink" href="#allgemeines" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="ziel-und-zweck-des-dokuments">
|
||||
<h3>Ziel und Zweck des Dokuments <a name="ziel/zweck"></a><a class="headerlink" href="#ziel-und-zweck-des-dokuments" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="ausgangssituation">
|
||||
<h3>Ausgangssituation <a name="ausgangssituation"></a><a class="headerlink" href="#ausgangssituation" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="projektbezug">
|
||||
<h3>Projektbezug <a name="projektbezug"></a><a class="headerlink" href="#projektbezug" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="abkurzungen">
|
||||
<h3>Abkürzungen <a name="abkürzungen"></a><a class="headerlink" href="#abkurzungen" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="schnittstellen-bezug-zu-anderen-dokumenten">
|
||||
<h3>Schnittstellen/ Bezug zu anderen Dokumenten <a name="schnittstellen"></a><a class="headerlink" href="#schnittstellen-bezug-zu-anderen-dokumenten" title="Permalink to this heading"></a></h3>
|
||||
<p>Test</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="konzept-und-rahmenbedingungen">
|
||||
<h2>Konzept und Rahmenbedingungen <a name="konzept_und_rahmenbedingung"></a><a class="headerlink" href="#konzept-und-rahmenbedingungen" title="Permalink to this heading"></a></h2>
|
||||
<section id="ziele-des-anbieters">
|
||||
<h3>Ziele des Anbieters <a name="ziele_anbieter"></a><a class="headerlink" href="#ziele-des-anbieters" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="ziele-und-nutzen-des-anwenders">
|
||||
<h3>Ziele und Nutzen des Anwenders <a name="ziele_anwender"></a><a class="headerlink" href="#ziele-und-nutzen-des-anwenders" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="benutzer-zielgruppen">
|
||||
<h3>Benutzer / Zielgruppen <a name="benutzer/zielgruppen"></a><a class="headerlink" href="#benutzer-zielgruppen" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="systemvoraussetzungen-optional">
|
||||
<h3>Systemvoraussetzungen (Optional) <a name="systemvoraussetzungen"></a><a class="headerlink" href="#systemvoraussetzungen-optional" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="ressourcen-optional">
|
||||
<h3>Ressourcen (Optional) <a name="ressourcen"></a><a class="headerlink" href="#ressourcen-optional" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
</section>
|
||||
<section id="funktionale-anforderungen">
|
||||
<h2>Funktionale Anforderungen <a name="f_anforderung"></a><a class="headerlink" href="#funktionale-anforderungen" title="Permalink to this heading"></a></h2>
|
||||
<section id="muss-ziele">
|
||||
<h3><strong>Muss Ziele</strong><a class="headerlink" href="#muss-ziele" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="f100">
|
||||
<h3>F100 <a name="f100"></a><a class="headerlink" href="#f100" title="Permalink to this heading"></a></h3>
|
||||
<p>Die Software berechnet und veranschaulicht folgende Unternehmenskennzahlen:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Umsatz</p></li>
|
||||
<li><p>Gewinn</p></li>
|
||||
<li><p>Bilanzsumme</p></li>
|
||||
<li><p>Eigenkapital (Eigenkapitalquote)</p></li>
|
||||
<li><p>Vorstand / Geschäftsführung</p></li>
|
||||
<li><p>Aufsichtsrat / Beirat</p></li>
|
||||
<li><p>Wirtschaftsprüfer</p></li>
|
||||
<li><p>Besitzverhältnisse</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="f110">
|
||||
<h3>F110 <a name="f110"></a><a class="headerlink" href="#f110" title="Permalink to this heading"></a></h3>
|
||||
<p>Das System muss, neben den Kennzahlen von F100, die Metriken aus dem Anhang “data_and_metrics.md” je nach Datenlage für die Unternehmen berechnen und anzeigen.</p>
|
||||
</section>
|
||||
<section id="f120">
|
||||
<h3>F120 <a name="f120"></a><a class="headerlink" href="#f120" title="Permalink to this heading"></a></h3>
|
||||
<p>Die Software muss eine Suche nach Unternehmen und Personen anbieten die zu einer Detailansicht führt mit den in F100 genannten Kennzahlen.</p>
|
||||
</section>
|
||||
<section id="soll-ziele">
|
||||
<h3><strong>Soll Ziele</strong><a class="headerlink" href="#soll-ziele" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="f200">
|
||||
<h3>F200 <a name="f200"></a><a class="headerlink" href="#f200" title="Permalink to this heading"></a></h3>
|
||||
<p>Die Software veranschaulicht die Konzernstruktur (Mutterkonzern <-> Tochterfirmen). Diese sollen durch ein Netz transparent dargestellt werden.</p>
|
||||
</section>
|
||||
<section id="f210">
|
||||
<h3>F210 <a name="f210"></a><a class="headerlink" href="#f210" title="Permalink to this heading"></a></h3>
|
||||
<p>Die Software zeigt die Beziehungen von Unternehmen untereinander und mit den Wirtschaftsprüfern auf. Diese sollen durch ein Netz transparent dargestellt werden.</p>
|
||||
</section>
|
||||
<section id="f220">
|
||||
<h3>F220 <a name="f220"></a><a class="headerlink" href="#f220" title="Permalink to this heading"></a></h3>
|
||||
<p>Die Software soll bewerten ob die Berichtserstattung der letzten 7 Tage eher Positiv oder Negativ zu dem Unternehmen war. Dabei sind häufige Vorstandswechsel negativ und Zielerreichungen positiv.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="nicht-funktionale-anforderungen">
|
||||
<h2>Nicht-Funktionale Anforderungen <a name="nf_anforderung"></a><a class="headerlink" href="#nicht-funktionale-anforderungen" title="Permalink to this heading"></a></h2>
|
||||
<section id="id1">
|
||||
<h3><strong>Muss Ziele</strong><a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="n100">
|
||||
<h3>N100 <a name="n100"></a><a class="headerlink" href="#n100" title="Permalink to this heading"></a></h3>
|
||||
<p>Das System muss die 1000 größten deutschen und europäischen Unternehmen beinhalten. Diese werden anhand der Kennzahlen</p>
|
||||
<ul class="simple">
|
||||
<li><p>Umsatz</p></li>
|
||||
<li></li>
|
||||
<li></li>
|
||||
</ul>
|
||||
<p>bewertet und bemessen.</p>
|
||||
</section>
|
||||
<section id="id2">
|
||||
<h3><strong>Soll Ziele</strong><a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="n200">
|
||||
<h3>N200 <a name="n200"></a><a class="headerlink" href="#n200" title="Permalink to this heading"></a></h3>
|
||||
<p>Das System ist 24/7 über das Internet für jede Person mit Internetzugang erreichbar.</p>
|
||||
</section>
|
||||
<section id="n210">
|
||||
<h3>N210 <a name="n210"></a><a class="headerlink" href="#n210" title="Permalink to this heading"></a></h3>
|
||||
<p>Das System soll eine Verfügbarkeit von 99 % erreichen, mit maximal 10 Ausfällen pro Jahr.</p>
|
||||
</section>
|
||||
<section id="kann-ziele">
|
||||
<h3><strong>Kann Ziele</strong><a class="headerlink" href="#kann-ziele" title="Permalink to this heading"></a></h3>
|
||||
</section>
|
||||
<section id="n300">
|
||||
<h3>N300 <a name="n300"></a><a class="headerlink" href="#n300" title="Permalink to this heading"></a></h3>
|
||||
<p>Das System kann möglichst über einen Disaster Recovery Schutz verfügen und in einem zweiten, 250 KM vom Hauptrechenzentrum entfernten Rechenzentrum die Systeme und Daten spiegeln.</p>
|
||||
</section>
|
||||
<section id="n310">
|
||||
<h3>N310 <a name="n310"></a><a class="headerlink" href="#n310" title="Permalink to this heading"></a></h3>
|
||||
<p>Das System kann möglichst skalierbar sein, sodass auch eine Nutzerzahl von 1000 Benutzern die Software nutzen können.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="anforderungsverfolgung-zu-den-spezifikationen">
|
||||
<h2>Anforderungsverfolgung zu den Spezifikationen <a name="verfolgung_spezifikation"></a><a class="headerlink" href="#anforderungsverfolgung-zu-den-spezifikationen" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="abnahmekriterien-und-vorgehen-zur-ausgangsprufung">
|
||||
<h2>Abnahmekriterien und Vorgehen zur Ausgangsprüfung <a name="abnahmekriterien"></a><a class="headerlink" href="#abnahmekriterien-und-vorgehen-zur-ausgangsprufung" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="lieferumfang">
|
||||
<h2>Lieferumfang <a name="lieferumfang"></a><a class="headerlink" href="#lieferumfang" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="anhang-ressourcen">
|
||||
<h2>Anhang / Ressourcen <a name="anhang/ressourcen"></a><a class="headerlink" href="#anhang-ressourcen" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="index.html" class="btn btn-neutral float-left" title="Transparenzregister Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="timeline.html" class="btn btn-neutral float-right" title="Timeline" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, AKI PRJ23.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
147
html/_sources/Pflichtenheft.md.txt
Normal file
147
html/_sources/Pflichtenheft.md.txt
Normal file
@ -0,0 +1,147 @@
|
||||
# Pflichtenheft: Kapitalgesellschaften referenzregister
|
||||
|
||||
Version 0.1 Erstellt am 07.04.2023
|
||||
|
||||
| Autoren | Matrikelnummer |
|
||||
|--------------------|----------------|
|
||||
| Kim Mesewinkel | 000 |
|
||||
| Tristan Nolde | 000 |
|
||||
| Sebastian Zelenie | 000 |
|
||||
| Philip Horstenkamp | 000 |
|
||||
| Sascha Zhu | 000 |
|
||||
| Tim Ronneburg | 000 |
|
||||
|
||||
|
||||
|
||||
|
||||
## Historie der Dokumentenversion <a name="historie"></a>
|
||||
|
||||
| Version | Datum | Autor | Änderungsgrund / Bemerkung |
|
||||
|-----------|------------|---------------|----------------------------------------|
|
||||
| 0.1 | 07.04.2023 | Tim Ronneburg | Initiales aufsetzen des Pflichtenhefts |
|
||||
| 0.2 | 000 | | |
|
||||
| ... | 000 | | |
|
||||
| 1.0 | 000 | | |
|
||||
|
||||
## Inhaltsverzeichnis <a name="inhaltsverzeichnis"></a>
|
||||
[Historie der Dokumentenversion](#historie)
|
||||
[Inhaltsverzeichnis](#inhaltsverzeichnis)
|
||||
1. [Einleitung](#einleitung)
|
||||
1. [allgemeines](#allgemeines)
|
||||
1. [Ziel und Zweck des Dokuments](#ziel/zweck)
|
||||
1. [Ausgangssituation](#ausgangssituation)
|
||||
1. [Projektbezug](#projektbezug)
|
||||
1. [Abkürzungen](#abkürzungen)
|
||||
1. [Schnittstellen/ Bezug zu anderen Dokumenten](#schnittstellen)
|
||||
1. [Konzept und Rahmenbedingungen](#konzept_und_rahmenbedingung)
|
||||
1. [Ziele des Anbieters](#ziele_anbieter)
|
||||
1. [Ziele und Nutzen des Anwenders](#ziele_anwender)
|
||||
1. [Benutzer / Zielgruppen](#benutzer/zielgruppen)
|
||||
1. [Systemvoraussetzungen (Optional)](#systemvoraussetzungen)
|
||||
1. [Ressourcen (Optional)](#ressourcen)
|
||||
1. [Funktionale Anforderungen](#f_anforderung)
|
||||
1. [F100](#f100)
|
||||
1. [Nicht-Funktionale Anforderungen](#nf_anforderung)
|
||||
1. [N100](#n100)
|
||||
1. [Anforderungsverfolgung zu den Spezifikationen](#verfolgung_spezifikation)
|
||||
1. [Abnahmekriterien und Vorgehen zur Ausgangsprüfung](#abnahmekriterien)
|
||||
1. [Lieferumfang](#lieferumfang)
|
||||
1. [Anhang / Ressourcen](#anhang/ressourcen)
|
||||
|
||||
|
||||
## Einleitung <a name="einleitung"></a>
|
||||
|
||||
### Allgemeines <a name="allgemeines"></a>
|
||||
|
||||
### Ziel und Zweck des Dokuments <a name="ziel/zweck"></a>
|
||||
|
||||
### Ausgangssituation <a name="ausgangssituation"></a>
|
||||
|
||||
### Projektbezug <a name="projektbezug"></a>
|
||||
|
||||
### Abkürzungen <a name="abkürzungen"></a>
|
||||
|
||||
### Schnittstellen/ Bezug zu anderen Dokumenten <a name="schnittstellen"></a>
|
||||
Test
|
||||
|
||||
## Konzept und Rahmenbedingungen <a name="konzept_und_rahmenbedingung"></a>
|
||||
|
||||
### Ziele des Anbieters <a name="ziele_anbieter"></a>
|
||||
|
||||
### Ziele und Nutzen des Anwenders <a name="ziele_anwender"></a>
|
||||
|
||||
### Benutzer / Zielgruppen <a name="benutzer/zielgruppen"></a>
|
||||
|
||||
### Systemvoraussetzungen (Optional) <a name="systemvoraussetzungen"></a>
|
||||
|
||||
### Ressourcen (Optional) <a name="ressourcen"></a>
|
||||
|
||||
|
||||
|
||||
## Funktionale Anforderungen <a name="f_anforderung"></a>
|
||||
|
||||
### **Muss Ziele**
|
||||
|
||||
### F100 <a name="f100"></a>
|
||||
Die Software berechnet und veranschaulicht folgende Unternehmenskennzahlen:
|
||||
- Umsatz
|
||||
- Gewinn
|
||||
- Bilanzsumme
|
||||
- Eigenkapital (Eigenkapitalquote)
|
||||
- Vorstand / Geschäftsführung
|
||||
- Aufsichtsrat / Beirat
|
||||
- Wirtschaftsprüfer
|
||||
- Besitzverhältnisse
|
||||
|
||||
### F110 <a name="f110"></a>
|
||||
Das System muss, neben den Kennzahlen von F100, die Metriken aus dem Anhang "data_and_metrics.md" je nach Datenlage für die Unternehmen berechnen und anzeigen.
|
||||
|
||||
### F120 <a name="f120"></a>
|
||||
Die Software muss eine Suche nach Unternehmen und Personen anbieten die zu einer Detailansicht führt mit den in F100 genannten Kennzahlen.
|
||||
|
||||
### **Soll Ziele**
|
||||
|
||||
### F200 <a name="f200"></a>
|
||||
Die Software veranschaulicht die Konzernstruktur (Mutterkonzern <-> Tochterfirmen). Diese sollen durch ein Netz transparent dargestellt werden.
|
||||
|
||||
### F210 <a name="f210"></a>
|
||||
Die Software zeigt die Beziehungen von Unternehmen untereinander und mit den Wirtschaftsprüfern auf. Diese sollen durch ein Netz transparent dargestellt werden.
|
||||
|
||||
### F220 <a name="f220"></a>
|
||||
Die Software soll bewerten ob die Berichtserstattung der letzten 7 Tage eher Positiv oder Negativ zu dem Unternehmen war. Dabei sind häufige Vorstandswechsel negativ und Zielerreichungen positiv.
|
||||
|
||||
## Nicht-Funktionale Anforderungen <a name="nf_anforderung"></a>
|
||||
|
||||
### **Muss Ziele**
|
||||
|
||||
### N100 <a name="n100"></a>
|
||||
Das System muss die 1000 größten deutschen und europäischen Unternehmen beinhalten. Diese werden anhand der Kennzahlen
|
||||
- Umsatz
|
||||
-
|
||||
-
|
||||
bewertet und bemessen.
|
||||
|
||||
### **Soll Ziele**
|
||||
|
||||
### N200 <a name="n200"></a>
|
||||
Das System ist 24/7 über das Internet für jede Person mit Internetzugang erreichbar.
|
||||
|
||||
### N210 <a name="n210"></a>
|
||||
Das System soll eine Verfügbarkeit von 99 % erreichen, mit maximal 10 Ausfällen pro Jahr.
|
||||
|
||||
### **Kann Ziele**
|
||||
|
||||
### N300 <a name="n300"></a>
|
||||
Das System kann möglichst über einen Disaster Recovery Schutz verfügen und in einem zweiten, 250 KM vom Hauptrechenzentrum entfernten Rechenzentrum die Systeme und Daten spiegeln.
|
||||
|
||||
### N310 <a name="n310"></a>
|
||||
Das System kann möglichst skalierbar sein, sodass auch eine Nutzerzahl von 1000 Benutzern die Software nutzen können.
|
||||
|
||||
|
||||
## Anforderungsverfolgung zu den Spezifikationen <a name="verfolgung_spezifikation"></a>
|
||||
|
||||
## Abnahmekriterien und Vorgehen zur Ausgangsprüfung <a name="abnahmekriterien"></a>
|
||||
|
||||
## Lieferumfang <a name="lieferumfang"></a>
|
||||
|
||||
## Anhang / Ressourcen <a name="anhang/ressourcen"></a>
|
||||
@ -0,0 +1,8 @@
|
||||
aki\_prj23\_transparenzregister.black\_test module
|
||||
==================================================
|
||||
|
||||
.. automodule:: aki_prj23_transparenzregister.black_test
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
@ -0,0 +1,8 @@
|
||||
aki\_prj23\_transparenzregister.flake8\_test module
|
||||
===================================================
|
||||
|
||||
.. automodule:: aki_prj23_transparenzregister.flake8_test
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
20
html/_sources/aki_prj23_transparenzregister.rst.txt
Normal file
20
html/_sources/aki_prj23_transparenzregister.rst.txt
Normal file
@ -0,0 +1,20 @@
|
||||
aki\_prj23\_transparenzregister package
|
||||
=======================================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
aki_prj23_transparenzregister.black_test
|
||||
aki_prj23_transparenzregister.flake8_test
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: aki_prj23_transparenzregister
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:private-members:
|
||||
46
html/_sources/index.rst.txt
Normal file
46
html/_sources/index.rst.txt
Normal file
@ -0,0 +1,46 @@
|
||||
.. Your Package Name documentation master file, created by Sphinx
|
||||
|
||||
Transparenzregister Documentation
|
||||
=================================
|
||||
This is the documentation for the AKI project group on the german transparenzregister and an Analysis there of.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Project planing
|
||||
|
||||
Pflichtenheft
|
||||
timeline.md
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
:caption: Meeting Notes:
|
||||
|
||||
meeting-notes/*
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 3
|
||||
:caption: Research
|
||||
|
||||
research/*
|
||||
research/*.ipynb
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 0
|
||||
:caption: Modules
|
||||
|
||||
modules
|
||||
|
||||
.. automodule:: aki_prj23_transparenzregister
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:inherited-members:
|
||||
:autodoc_member_order:
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
62
html/_sources/meeting-notes/Meeting_2023-03-30.md.txt
Normal file
62
html/_sources/meeting-notes/Meeting_2023-03-30.md.txt
Normal file
@ -0,0 +1,62 @@
|
||||
# Weekly *1*: 30.03.2023
|
||||
|
||||
## Teilnehmer
|
||||
- Prof. Arinir
|
||||
- Tristan Nolde
|
||||
- Tim Ronneburg
|
||||
- Philipp Horstenkamp
|
||||
- Kim Mesewinkel-Risse
|
||||
- Sascha Zhu
|
||||
- Sebastian Zeleny (Protokollant)
|
||||
|
||||
## Themen
|
||||
- **Inhalt des Project Proposals:**
|
||||
- Mit welchen Metriken können Unternehmen bewertet werden?
|
||||
- Was sind Kennzahlen von Kapitalgesellschaften?
|
||||
- Welche Daten werden benötigt?
|
||||
- Woher erhält man benötigte Daten? (Amtsgerichte --> Insolvenzen, Börsenkurse, Aktienkurse, RSS-Feeds von/zu Unternehmen)
|
||||
- Wie werden die Daten verarbeitet?
|
||||
- Wie können die Daten bzw. Ergebnisse präsentiert werden?
|
||||
- Verflechtungen zwischen Unternehmen: Geschäftsführer, Wirtschaftsprüfer
|
||||
|
||||
- **Anforderungen an Projektdurchführung:**
|
||||
- Backlog für Ideen und Aufgaben
|
||||
- Meeting-Notes mit besprochenen Themen, Entscheidungen, Terminen und Action-List (Wer arbeitet an welcher Aufgabe?)
|
||||
- Projektdurchführung so formal wie möglich, d.h.
|
||||
- Beschreibung des Systemkontexts: Interaktion mit der Umgebung
|
||||
- Datenmodell: schematische Darstellung der Datenflüsse
|
||||
- Lasten- / Pflichtenheft mit Kategorisierung
|
||||
- Vorschlag Frontend von Prof. Arinir: D3.js
|
||||
|
||||
- **Bewertung des Projekts:**
|
||||
- Es muss erkennbar sein, wer welche Aufgabe bearbeitet hat
|
||||
- Jeder Teilnehmer soll die Aufgaben der anderen Teilnehmer kennen und ein Verständnis für diese haben (kein tiefes Domänenwissen!)
|
||||
- Gesamtplanung und Dokumentation sind Teil das Ergebnis, nicht nur die technische Umsetzung
|
||||
- Bewertungsschlüssel:
|
||||
|
||||
| Gewichtung | Aufgabe |
|
||||
|--------------|---------------------------------------------|
|
||||
| 20% | Vortrag Seminararbeit |
|
||||
| 20% | Präsentation |
|
||||
| 30% | Implementierung |
|
||||
| 20% | Finaler Bericht (~15 Seiten pro Teilnehmer) |
|
||||
| 10% | Abschlusspräsentation |
|
||||
|
||||
- **Organisatorisches:**
|
||||
- Regeltermin alle 14 Tage mit allen Projektteilnehmern, beginnend am 30.03.2023: Dieser Termin soll für Sprint Planning und Review mit Prof. Arinir genutzt werden.
|
||||
- Was ist die Erwartungshaltung des Product Owners?
|
||||
- Welche Themen/Aufgaben werden bearbeitet?
|
||||
- Was ist das Ziel für das nächste Review?
|
||||
- Projektbearbeitung/Dokumentation mit Github
|
||||
- Bereitstellung des Github-Repos über FH
|
||||
|
||||
## Abgeleitete Action Items
|
||||
|
||||
| Action Item | Verantwortlicher | Deadline |
|
||||
|-----------------------------------------------------------------------------------------|--------------------|----------------------------------|
|
||||
| Welche Anforderungen / Erwartungen stellen wir inhaltlich und technisch an das Projekt? | alle | nächstes Weekly/work in progress |
|
||||
| Erarbeiten von Arbeitspaketen/Aufgaben aus Anforderungen | alle | nächstes Weekly/work in progress |
|
||||
| Welche Metriken sind notwendig? | alle | nächstes Weekly/work in progress |
|
||||
| Recherche zu Datenquellen | alle | nächstes Weekly/work in progress |
|
||||
| Definition von Meilensteinen | alle | nächstes Weekly |
|
||||
| Erstellung eines (groben) Zeitplans | alle | nächstes Weekly |
|
||||
57
html/_sources/meeting-notes/Meeting_2023-04-13.md.txt
Normal file
57
html/_sources/meeting-notes/Meeting_2023-04-13.md.txt
Normal file
@ -0,0 +1,57 @@
|
||||
# Weekly *2*: 13.04.2023
|
||||
|
||||
## Teilnehmer
|
||||
- Prof. Arinir
|
||||
- Tristan Nolde
|
||||
- Tim Ronneburg (Protokollant)
|
||||
- Philipp Horstenkamp
|
||||
- Kim Mesewinkel-Risse
|
||||
- Sascha Zhu
|
||||
- Sebastian Zeleny
|
||||
|
||||
## Themen
|
||||
|
||||
- **Seminarthemen:**
|
||||
- Themen die im Zuge der Implementierung erarbeitet werden
|
||||
- Themen:
|
||||
- Textmining (Ontologien)
|
||||
- Semantische Suche
|
||||
- Anmeldungsformular:
|
||||
- Jeder sendet das Formular selbst an Herrn Arinir
|
||||
- Projektauftakt: 30.03.2023
|
||||
- Enddatum: 15.02.2024
|
||||
- Titel: Transparanzregister Kapitalgeselschaften
|
||||
- **Vorstellung der Ergebnisse des letzten Sprints:**
|
||||
- Erstellung des GitHubs Projekts
|
||||
- Anlegen eines Protokolltemplates
|
||||
- Interne Meetings jeden Donnerstag
|
||||
- Timeline erstellt mit Mermaid.js in Markdown (Sebastian)
|
||||
- Recherche zum Datenschutz / Urheberrecht: Welche Daten aus den Datenbanken dürfen offline oder online benutzt werden. (Sascha)
|
||||
- Für die eigene Forschung: 75 % der Daten dürfen genutzt werden
|
||||
- 15 % Wenn es an Dritte weitergeleitet werden
|
||||
- Wenn wir die Ergebnisse veröffentlichen müssen die Vorgaben der Datenbanken beachten
|
||||
- Hinweis von Herrn Arinir: Das ist als Vorschungsprojekt zu sehen
|
||||
- Die Ergebnisse werden nicht veröffentlicht
|
||||
- nur die Vorgehensweise wird als Paper veröffentlicht
|
||||
- Recherche zu Unternehmenskennzahlen (Kim)
|
||||
- Hinweis: Für Tendenzanalysen sollen zeitliche Veränderungen erfasst werden (Timescale Datenbank)
|
||||
- Vierteljährliche Daten reichen aus
|
||||
- Recherche zu den verfügbaren Datengrundlagen (Phillip und Tristan)
|
||||
- Anlegen eines Pflichtenhefts mit den Anforderungen an das Projekt (Tim)
|
||||
- **Organisatorisches:**
|
||||
- Es muss noch ein Projekt angelegt werden für das GitHub Repository mit einem Board zur Projektorganisation
|
||||
- Im Meeting erledigt
|
||||
- **Recherche:**
|
||||
- Nicht nur auf Kennzahlen eingehen, sondern auch auf die Berichterstattung eingehen
|
||||
- Dazu sollen die Technologieauswahl recherchiert werden (Trendanalyse von Nachrichten, Finanztreff, Twitter etc.)
|
||||
|
||||
## Abgeleitete Action Items
|
||||
|
||||
| Action Item | Verantwortlicher | Deadline |
|
||||
|-------------|------------------|-----------------|
|
||||
| Rechechieren welche Nachrichtenquellen (Aktuelle und "Alte" Nachrichten) genutzt werden können | Sascha und Tim | 27.04.2023 |
|
||||
| Recherchieren welche Technologien zur Auswertung der Nachrichtenqullen genutzt werden können (z.b. Sentiment Analyse) | Philipp und Kim | 27.04.2023 |
|
||||
| Beschäftigen mit Historien (Timescale Datenbank) | Tristan und Sebastian | 27.04.2023 |
|
||||
| Festlegen von Kriterien wann ein Artikel positiv oder negativ zu bewerten ist | Sascha | Ende offen |
|
||||
| Abgabe des Anmeldeformulars zum Projekt | alle | 20.04.2023 |
|
||||
| Liste mit geeignetetn Metriken | Herr Arinir | 27.04.2023 |
|
||||
54
html/_sources/meeting-notes/Meeting_2023-05-04.md.txt
Normal file
54
html/_sources/meeting-notes/Meeting_2023-05-04.md.txt
Normal file
@ -0,0 +1,54 @@
|
||||
# Weekly *3*: 04.05.2023
|
||||
|
||||
## Teilnehmer
|
||||
- Prof. Arinir
|
||||
- Tristan Nolde
|
||||
- Tim Ronneburg
|
||||
- Phillip Horstenkamp
|
||||
- Kim Mesewinkel-Risse
|
||||
- Sascha Zhu
|
||||
- Sebastian Zeleny
|
||||
|
||||
## Themen
|
||||
|
||||
### Organisatorische Absprachen:
|
||||
|
||||
Gelten die Seminarthemen als Zwischenprüfung? In welcher Form?
|
||||
- Herr Giefers hat Seminarthemen im Vorfeld definiert, in unserer Gruppe gab es eine offene Einarbeitung in die Forschungs- und Entwicklungsarbeit
|
||||
- Geplanter Umfang: Seminararbeit 15-20 Seiten (Rücksprache mit Herrn Giefers und Herrn Gawron durch Herrn Arinir, Feedback beim nächsten Termin) und Vortrag mit Folien oder anderen Quellen (z.B. Quellcode) ca. 15-20 Minuten im Rahmen eines JF Termins (keine Vorstellung im Plenum)
|
||||
- Die Seminararbeiten werden benotet (20% der Endnote), die Ausarbeitung und der Vortrag zählen dabei zu jeweils 50%
|
||||
|
||||
|
||||
Wie lautet der zeitliche Rahmen?
|
||||
- Keine feste Deadline vorgegeben, Absprache innerhalb der Projektgruppe ausreichend
|
||||
- Vortrag: Einigung auf zwei Termine Ende Juni/Anfang Juli -> Thema 1-3 am 22.06.2023 und Thema 4-6 am 06.07.2023
|
||||
- Seminararbeit: Abgabe voraussichtlich Ende des Sommersemesters, potentiell auch zu einem späteren Zeitpunkt möglich
|
||||
|
||||
|
||||
Welche Themenbereiche sollen behandelt werden?
|
||||
- Die erste kurze Beschreibung der 6 Themenbereiche/Domänen wurde durch Herrn Arinir als positiv befunden
|
||||
- Zur Eingrenzung der Themen und für ein konkreteres Feedback soll für jeden Themenbereich beim nächsten JF am 11.05.2023 ein Abstract vorgestellt werden
|
||||
- Grundsätzlich sollen die Themen nicht zu oberflächlich behandelt werden, sondern explizit auf Techniken zur Umsetzung eingegangen werden
|
||||
|
||||
|
||||
Einigung auf Änderungen im Bereich Projektorganisation:
|
||||
- Aufnahme des zeitlichen Ablaufs der Tickets in die Meeting Notes -> Screenshot des Projects in Protokoll mit aufnehmen
|
||||
- Start-, Enddaten und Labels der Tickets besser pflegen
|
||||
|
||||
|
||||
Sonstiges:
|
||||
- Urlaubszeiten Herr Prof. Arinir: 17.07.-01.08.2023
|
||||
|
||||
|
||||
|
||||
## Abgeleitete Action Items
|
||||
|
||||
| Action Item | Verantwortlicher | Deadline |
|
||||
|-------------|------------------|-----------------|
|
||||
| Abstract pro Thema | Alle | nächstes Weekly |
|
||||
| Folienvorlage für den Seminarvortrag | Alle | nächstes Weekly |
|
||||
| Rückmeldung zum Umfang der Seminararbeit | Prof. Arinir | nächstes Weekly |
|
||||
|
||||
|
||||
## Aktueller Projektstand
|
||||
|
||||
117
html/_sources/meeting-notes/Meeting_2023-05-11.md.txt
Normal file
117
html/_sources/meeting-notes/Meeting_2023-05-11.md.txt
Normal file
@ -0,0 +1,117 @@
|
||||
# Weekly *4*: 11.05.2023
|
||||
|
||||
## Teilnehmer
|
||||
- Prof. Arinir
|
||||
- Tristan Nolde
|
||||
- Tim Ronneburg
|
||||
- Phillip Horstenkamp
|
||||
- Kim Mesewinkel-Risse
|
||||
- Sascha Zhu
|
||||
- Sebastian Zeleny
|
||||
|
||||
## Themen
|
||||
|
||||
### Organisatorische Absprachen zum Umfang und Inhalt der Seminararbeit:
|
||||
|
||||
- Herr Arinir wird sich nochmal wegen des Umfangs der Seminararbeit bei unserer Gruppe melden
|
||||
- In der Seminarbeit sollen Anforderungen und Lösungsskizzen für das Projekt "Transparenzregister" dargestellt werden.
|
||||
- Die Seminarabeit soll aus einem theoretischen Teil und einem praktischen Teil, in dem der praktische Nutzen für das Projekt "Transparenzregister" erörtert wird, bestehen; ob das Verhältnis zwischen dem theoretischen und praktischen Teil bei 50:50 oder 40:60 liegt, darüber können die Verfaser der Seminararbeit selbst entscheiden
|
||||
- Der Fokus der Seminarbeit soll stets danach ausgerichtet werden, wie die entsprechenden Aspekte bzw. die entsprechenden Technologien für das Projekt "Transparenzregister" genutzt werden können.
|
||||
|
||||
|
||||
|
||||
### Vorstellung des Abstracts der Seminararbeit zu "Dev Ops" (Philipp Horstenkamp):
|
||||
|
||||
Abstract siehe Datei in github.
|
||||
|
||||
Folgende Punkte wurden bei bzw. nach der Vorstellung des Abstracts diskutiert:
|
||||
|
||||
- Eine sehr straffe Pipeline, die für Seriensoftware in Ordnung wäre, könnte uns für unser Projekt zu sehr „fesseln“ bzw. einschränken.
|
||||
- Es wäre zu überlegen, ob die Software-Entwicklung, wie diese früher ablief, mit der Software-Entwicklung von heute (u.a. mit den Automatisierungsmöglichkeiten von heute) gegenübergestellt werden soll, um daraus zunächst eine Strategie für unser Projekt zu entwickeln, bevor man sich vertieft mit DevOps beschäftigt
|
||||
- Die Verwendung von CI/CD (Continuous Integration/Continuous Delivery)-Pipelines für KI-Projekte wäre ein interessantes Thema.
|
||||
|
||||
|
||||
|
||||
### Vorstellung des Abstracts der Seminararbeit zu "Automatisierte Datenextraktion aus Internetquellen als Grundlage für die Analyse von Kapitalgesellschaften" (Tristan Nolde):
|
||||
|
||||
Abstract siehe Datei in github.
|
||||
|
||||
Folgende Punkte wurden bei bzw. nach der Vorstellung des Abstracts diskutiert:
|
||||
|
||||
- Pros und Cons von WebScraping gegenüber RSS-Feeds und gegenüber der API-Lösung sollen dargestellt werden
|
||||
- Die Quelle E-Mail-Newsletter (z.B. vom Handelsblatt) könnte ebenfalls interessant sein, jedoch muss hierfür möglicherweise ein separater E-Mail-Account erstellt werden, was eher aufwändig ist
|
||||
- Es wäre eventuell zu prüfen, ob auch Daten aus LinkedIn API, XING oder Facebook extrahiert werden könnten.
|
||||
|
||||
|
||||
|
||||
### Vorstellung des Abstracts der Seminararbeit zu "Datenspeicherung" (Sebastian Zeleny):
|
||||
|
||||
Abstract siehe Datei in github.
|
||||
|
||||
Folgende Punkte wurden bei bzw. nach der Vorstellung des Abstracts diskutiert:
|
||||
|
||||
- Bei der Wahl der Datenbank müssen verschiedene Anforderungen berücksichtigt werden, mit hohem Abstimmungsbedarf zwischen den Topics "Datenextraktion" und "Datenvisualisierung"
|
||||
|
||||
- Herr Prof. Arinir fragte noch, ob wir das Thema "relationale Datenbanken" als Modul behandelt haben. Dies wurde bejaht, insbesondere SQL Datenbanken und SQL queries waren Gegenstand des Moduls "Datenbankprogrammierung"
|
||||
|
||||
|
||||
|
||||
### Vorstellung des Abstracts der Seminararbeit zu "Verpflechtungsanalyse" (Tim Ronneburg):
|
||||
|
||||
Abstract siehe Datei in github.
|
||||
|
||||
Folgende Punkte wurden bei bzw. nach der Vorstellung des Abstracts diskutiert:
|
||||
|
||||
- Beim Social Graph wäre zu überlegen, nicht nur Beziehungen zwischen Unternehmen via Personen (z.B. Wirtschaftsprüfer), sondern auch Beziehungen zwischen Unternehmen via Kooperationspartner (Stiftungen, Unis, Forschungsinstitute) bzw. Eigentums-, Kunden- und Lieferbeziehungen darzustellen
|
||||
|
||||
- Beim Social Graph wäre zu überlegen, ob man nach Art der Beziehung filtern könnte
|
||||
|
||||
|
||||
|
||||
### Vorstellung des Abstracts der Seminararbeit zu "Text Mining" (Sascha Zhu):
|
||||
|
||||
Abstract siehe Datei in github.
|
||||
|
||||
Folgende Punkte wurden bei bzw. nach der Vorstellung des Abstracts diskutiert:
|
||||
|
||||
- Bei den Sentiment-Analyse-Tools wie FinBERT oder VADER wäre stets eine maschinelle Übersetzung der deutschen Nachrichtentexte ins Englische erforderlich, da FinBERT oder VADER keine deutschen Texte erkennen können
|
||||
- Die Generierung von Ontologien ist zu komplex und soll nicht Gegenstand der Projektarbeit sein
|
||||
- Bei der semantischen Textanalyse wäre empfehlenswert, dass dies über "Einzel-Personen" ausgeführt wird (das wäre dann ein Punkt im Graphen)
|
||||
- Das Thema "Named Entity Recognition" wird für die Projektarbeit eine hohe Bedeutung haben
|
||||
|
||||
|
||||
|
||||
### Vorstellung des Abstracts der Seminararbeit zu "Datenvisualisierung" (Kim Mesewinkel-Risse):
|
||||
|
||||
Abstract siehe Datei in github.
|
||||
|
||||
Folgende Punkte wurden bei bzw. nach der Vorstellung des Abstracts diskutiert:
|
||||
|
||||
- Bei der Datenvisualisierung wäre zu überlegen, dass man sich nur auf Python-Bibliotheken beschränkt
|
||||
- Die Datenabfrage könnte über SQL oder Spark laufen, eine Schnittstelle zwischen dem Speicher und dem Front-End wird benötigt
|
||||
- Zwischen Daten und der Datenvisualisierung werden eventuell Zwischen-Caches benötigt
|
||||
- Bezüglich der Frage nach der „Middleware“: Wenn Plotly oder Plotly Dash verwendet wird, wird keine Middleware benötigt, da dies schon eingebaut ist.
|
||||
|
||||
|
||||
|
||||
### Feedback von Herrn Prof. Arinir:
|
||||
|
||||
- Es scheint noch kein Gesamtkonzept für das Gewerk vorzuliegen.
|
||||
- Wir sollten uns die Frage stellen: Was soll am Ende für "ein brauchbares Stück Software" herauskommen, damit der Anwender mit der Vielzahl von Informationen und Funktionen zurechtkommt.
|
||||
- Eine Lösungsskizze muss definiert werden, wobei ein Pflichtenheft jetzt noch nicht erforderlich ist
|
||||
- Es sollen zunächst einige GUI-Designs (mit einem Muster-Datensatz) entwickelt werden.
|
||||
- Pros und Cons zwischen einem Wasserfallmodell (Pflichtenheft mit bis zu 1000 Seiten) und der agilen Modellierung sollen berücksichtigt werden.
|
||||
- Wie sollen die Verflechtungen eingebaut werden?
|
||||
- Wie sollen die Daten persistiert werden?
|
||||
- Es wäre empfehlenswert, mit irgendetwas (d.h. einer kleinen Lösung) anzufangen, dann das Ergebnis anzuschauen, und diese kontinuierlich zu verbessern.
|
||||
|
||||
|
||||
|
||||
## Abgeleitete Action Items
|
||||
|
||||
| Action Item | Verantwortlicher | Deadline |
|
||||
|--------------------------------------------|------------------|-------------------|
|
||||
| GUI Designs | Alle | nächstes Weekly |
|
||||
| Rückmeldung zum Umfang der Seminararbeit | Prof. Arinir | nächstes Weekly |
|
||||
|
||||
## Aktueller Projektstand
|
||||
33
html/_sources/meeting-notes/Meeting_2023_05-25.md.txt
Normal file
33
html/_sources/meeting-notes/Meeting_2023_05-25.md.txt
Normal file
@ -0,0 +1,33 @@
|
||||
# Weekly *5*: 25.05.2023
|
||||
|
||||
## Teilnehmer
|
||||
- Prof. Arinir
|
||||
- Tristan Nolde
|
||||
- Tim Ronneburg
|
||||
- Philipp Horstenkamp
|
||||
- Kim Mesewinkel-Risse
|
||||
- Sascha Zhu
|
||||
- Sebastian Zeleny
|
||||
|
||||
## Themen
|
||||
|
||||
- Nächster Termin am 08.06.2023 ist Fronleichnam => Verschoben auf 09.06.2023 09:00
|
||||
- Sebastian präsentiert das Miro Bord mit den Wireframediagrammen. [Siehe Anlage]()
|
||||
- Philipp präsentiert den Sozial graph
|
||||
- Sebastian präsentiert die Unternehmensdetails in sicht auf die Kennzahlen
|
||||
- Sebastian dankt Kim für das Überarbeiten der Graphen im Farbschema
|
||||
- Sebastian zeigt die anderen Übersichten
|
||||
- Sascha weist darauf hin das zusätzlich noch das Quellmaterial für die Stimmungen mit angezeigt werden sollen.
|
||||
- Die Form ist bisher noch unklar.
|
||||
|
||||
- Arinir: Auch indirekte verpflächtungen für N sprünge sollen bei den Details angezeigt werden und einen wert für den Einfluss von personen und Firmen sein.
|
||||
- Zähle die Personenverbindungen juristisch/Natürlich getrennt nach den schichten der Indirektion. Interessant wäre eine auftrennung der natürlichen und Jiristischen personen in der Zählung
|
||||
- Ranking der Personen nach Anzahl der Verbindungen
|
||||
|
||||
- Die Frage wie wir zeitliche veränderungen im sozial graph bewerten sollen kam auf. Wurde aber noch nicht abschließend beantwortet.
|
||||
|
||||
## Abgeleitete Action Items
|
||||
|
||||
| Action Item | Verantwortlicher | Deadline |
|
||||
|------------------------------------------|------------------|-----------------|
|
||||
| Erster entwurf der Seminarpräsentationen | Alle | nächstes Weekly |
|
||||
7
html/_sources/modules.rst.txt
Normal file
7
html/_sources/modules.rst.txt
Normal file
@ -0,0 +1,7 @@
|
||||
aki_prj23_transparenzregister
|
||||
=============================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
aki_prj23_transparenzregister
|
||||
40
html/_sources/research/RE_Vom-Problem-zur-Loesung.md.txt
Normal file
40
html/_sources/research/RE_Vom-Problem-zur-Loesung.md.txt
Normal file
@ -0,0 +1,40 @@
|
||||
# Von der Problemstellung zum Lösungskonzept
|
||||
Um ein Softwaresystem für das Transparenzregister implementieren zu können, ist es notwendig Anforderungen zu formulieren. Diese legen die Eigenschaften der Software fest und werden benötigt, um die fachliche und technische Lösung zu modellieren / entwerfen und ein Produkt zu implementieren.
|
||||
|
||||
Zu Beginn sind die Anforderungen wenig eingeschränkt ("Benötigt wird eine Möglichkeit Daten zu speichern."), im Verlauf der Modellierung wird der Lösungsraum eingeschränkt ("Es bietet sich eine Datenbanklösung oder Dateiablage an.") und abschließend auf eine zu implementierende Lösung festgelegt ("Die Software verwendet ein relationales Modell unter Verwendung einer SQLite Datenbank.").
|
||||
|
||||
## Requirements Engineering Transparenzregister
|
||||
Unser Weg zum Pflichtenheft und zur Spezifikation der Systemanforderungen ist folgend dargestellt.
|
||||
Von unspezifizierten Anforderungen werden wir immer konkreter und beantworten iterativ die Fragen *Was ist das Problem/Anforderung?* und *Wie lösen wir das Problem/Anforderung?*.
|
||||
|
||||
### 1. Anforderungen aus Projektvorstellung
|
||||
|
||||
- Entwicklung einer Software zur Darstellung von Unternehmenskennzahlen und Verbindungen.
|
||||
- Ermittlung der 100 größten deutschen und europäischen Unternehmen
|
||||
- Auswahl geeigneter Metriken
|
||||
- Auswahl geeigneter Quellen
|
||||
- Die erhobenen Daten müssen visualisiert werden (evtl. durch ein Netz, wenn es Verbindungen sind)
|
||||
- Die erhobenen Daten müssen nach Unternehmen und Personen durchsuchbar sein.
|
||||
|
||||
### 2. Identifikation von Anforderungen innerhalb der Gruppe
|
||||
|
||||
- Es werden Datenquellen benötigt, um Unternehmenskennzahlen ermitteln zu können.
|
||||
- Es werden Datenquellen benötigt, um über die öffentliche Darstellung der Unternehmen zu erfahren.
|
||||
- Es werden Werkzeuge benötigt, um Sentimentanalyse über Unternehmen durchzuführen.
|
||||
- Die rechtmäßige Verwendung der Daten muss geklärt werden.
|
||||
- Die ermittelten Daten müssen gespeichert werden.
|
||||
- Es werden Werkzeuge benötigt, um Text Mining zu betreiben.
|
||||
|
||||
### 3. Identifikation von Domänen zur Lösungsfindung
|
||||
Aus den Anforderungen der Projektvorstellung und der Projektgruppe wurden sechs Domänen identifiziert, welche benötigt werden, um ein Softwaresystem für Transparenzregister zu erarbeiten.
|
||||
Um das benötigte Domänenwissen zu vertiefen, bearbeitet jedes Mitglied ein Cluster.
|
||||
|
||||
### 4. technische/fachliche Lösungen
|
||||
Mit dem Domänenwissen können technische und fachliche Lösungen definiert werden ("Zur Datenspeicherung von Unternehmenskennzahlen ist *xy* notwendig, weil *abc*.") und erste Modelle (z.B. GUI-Modell) erstellt werden.
|
||||
|
||||
### 5. Priorisierung von Anforderungen
|
||||
Die Gruppe diskutiert die Anforderungen und legt eine Priorisierung fest.
|
||||
|
||||
### 6. Pflichtenheft
|
||||
Das Team legt sich mit dem Pflichtenheft auf einen definierten Umfang und konkrete Inhalte der Lösung fest. Es wird in *Muss-* und *Kann-*Anforderungen unterschieden.
|
||||
Das Pflichtenheft ist das **Project Proposal**.
|
||||
62
html/_sources/research/Timeseries/Overview.md.txt
Normal file
62
html/_sources/research/Timeseries/Overview.md.txt
Normal file
@ -0,0 +1,62 @@
|
||||
# Timeseries (deutsch: Zeitreihen) im Kontext des Transparenzregisters Kapitalgesellschaften
|
||||
|
||||
## Leitfragen
|
||||
1. Was zeichnet Timeseries Daten aus?
|
||||
2. Wie werden Timeseries effizient gespeichert?
|
||||
3. Welche Daten sind für den vorstehenden Use Case relevant und wie werden diese möglichts optimal (gemäß Software Qualitätskriterien wie Skalierbarkeit u.ä.) modelliert?
|
||||
4. Passt die Struktur und Handhabung von Timeseries Daten auf den Use Case?
|
||||
5. Wo können die benötigten Daten abgerufen werden?
|
||||
6. Wie könnte ein beispielhafter Datensatz (ggf. in Form eines Pandas DataFrames) aussehen?
|
||||
|
||||
## Timeseries
|
||||
Hinter Timeseries (oder Zeitreihen) verbergen sich Datenpunkte meistens numerischer Natur aber auch andere Datentypen sind möglich, die Werte einer Kennzahl oder Entität entlang der Zeit-Achse darstellen. Nennenswerte Beispiele sind die Herzfrequenz eines Menschen sowie Aktienkurse börsennotierter Unternehmen. Es wird generell zwischen `Metriken` (engl.: Metrics; bei regelmäßigem Intervall) und `Ereignissen` (engl.: Events; bei unregelmäßigen Intervallen) unterschieden.
|
||||
|
||||
--<cite>vgl. [influxdata - What is time series data?](https://www.influxdata.com/what-is-time-series-data/)
|
||||
|
||||
Einige zentrale Eigenschaften von Daten, die als Zeitreihen modelliert werden, sind:
|
||||
1. `Unveränderbarkeit` (engl.: Immutability):
|
||||
Da Zeitreihen in der Regel in zeitlicher Reihenfolge aufgenommen werden, werden sie normalerweise lediglich an die bestehende Reihe angehangen und nachträglich nicht mehr angepasst. Der entscheidende Identifikator des Datensatzes besteht dabei aus dem Zeitstempel (engl.: Timestamp) sowie der zugeordneten Entität (z.B. einem Sensor). Andere Features, die als Primärschlüssel fungieren können, sind nicht vorgesehen.
|
||||
2. `Lebensdauer` (engl.: Retention policy):
|
||||
Da Zeitreihen in hoher Frequenz geschrieben aber mit höherem Alter seltener gelesen werden, ist es üblich alte Daten zu löschen bzw. aggregiert zu speichern, um langfristig Speicher zu sparen.
|
||||
3. `Aggregation` (engl.: Aggregation):
|
||||
In den meisten Use Cases werden nicht alle Daten gleichzeitig oder nur einzelne Datensätze sondern Werte eines definierten Zeitraumes abgefragt und häufig aggregiert (z.B. als Summe oder Durchschnitt) zurückgegeben.
|
||||
4. `Hohes Schreib- zu Lese-Verhältnis` (engl.: High write/read ratio):
|
||||
Timeseries Daten werden in der Regel in hoher Frequenz (kurzen Intervallen) geschrieben jedoch nur gelegentlich bzw. wie in Punkt 3 angemerkt aggregiert abgerufen, so dass schreibende Zugriffe zur Datenbank die lesenden an Volumen übertreffen.
|
||||
|
||||
<cite>-- vgl. [TDengine - Characteristics of Time-Series Data](https://tdengine.com/tsdb/characteristics-of-time-series-data/)
|
||||
|
||||
## Modellierung relevanter Kennzahlen
|
||||
|
||||
### Ist die Timeseries Modellierung für den Use Case geeignet?
|
||||
Die im Rahmen der vorher durchgeführten Analyse von für den Use Case [relevanten Unternehmenskennzahlen](../data_and_metrics.md) zeichnen sich durch ein Merkmal aus: sie basieren auf einer jährlich bis maximal jedes Quartal aufgestellten Kennzahl wie den Gewinn oder Umsatz des Unternehmens. Daraus resultiert eine für Zeitreihen geringe Datenfrequenz - üblich sind hier minütlich bis unter sekündlich geschriebene Daten.
|
||||
|
||||
Des Weiteren ist jeder Datensatz nicht nur an die Zeit-Achse sondern eine weitere Entität wie einen Quartals oder Jahresabschluss gebunden. Dies spiegelt nicht nur in der Berechnung der Kennzahl für ein einzelnes Unternehmen sondern auch den Vergleich zwischen Mehreren wieder: Hier ist es möglich, dass Unternehmen ihre Ergebnisse zu unterschiedlichen Zeiten aber den selben Ereignissen veröffentlichen. Immerhin ist es realistisch, dass ein Unternehmen seinen Jahresabschluss deutlich früher als ein anderes der Öffentlichkeit zur Verfügung stellt. So eine Abfrage ließe sich zwar durchaus über die Einführung einer zeitlichen Einschränkung filtern, jedoch ist auch hier die Verknüpfung zu einem Jahres- oder Quartalsabschluss von höherem Interesse.
|
||||
|
||||
In Folge dessen eignet sich eine Zeitreihen basierte Modellierung nicht für die zentralen Unternehmenskennzahlen.
|
||||
|
||||
Für die Speicherung und Verwaltung von Aktienkursen börsennotierter Unternehmen - folglich nicht aller Kapitalgesellschaften, die im Use Case behandelt werden - bietet sich der Einsatz einer Timeseries Datenbank jedoch durchaus an, da Daten hier nicht nur in sehr hoher Frequenz geschrieben sondern auch im bekannten Muster abgefragt werden. Demzufolge mag sich eine Modellierung auf Basis der `Polyglot persistence` (Verwendung verschiedener Datenspeicherungs Technologien) auf Gesamtsicht eignen, so dass Kennzahlen sowie Stammdaten von Unternehmen in einer relationalen DB gespeichert und abhängig ihrer Unternehmensform mit Aktiekursen aus einer Timeseries DB angereichert werden.
|
||||
|
||||
Dieser Ansatz wäre nicht nur für diese Anforderung lohnenswert, sondern kann auch die effiziente Speicherung der Unternehmensverflechtungen vereinfachen, da für diesen Anwendungszweck eine Graphen-Datenbank ins Spiel gebracht werden könnte, die die Relationen zwischen Unternehmen und Unternehmen leicht traversierbar speichert. Es ist daher auch abzuwägen, ob diese nicht auch die Aufgaben des relationalen Modells übernehmen könnte, um die Fülle anforderungsspezifischen DB Technologien zu reduzieren, um auch so die Komplexität des Gesamtsystem gering zu halten.
|
||||
|
||||
Um einen geeigneten Zugang zu den Daten von extern (z.B. der Datenvisualisierungs-Schicht in Form einer Web App) zu ermöglichen, ist der Einsatz von `GraphQL` sinnvoll. Dies ermöglicht dem Client die gesamte Datenbasis zu durchforsten und den benötigten Datenbestand abzufragen. Der ``GraphQL`` Server kann dabei durch seine `Resolver` Struktur problemlos mehrere Datenquellen (siehe oben angesprochene `Polyglot Persistence`) kombinieren.
|
||||
|
||||
### Überblick über Datenrelationen
|
||||
|
||||
```mermaid
|
||||
|
||||
erDiagram
|
||||
Kapitalgesellschaft ||--o{ Jahresabschluss : veroeffentlicht
|
||||
Wirtschaftspruefer ||--o{ Jahresabschluss : prueft
|
||||
Jahresabschluss ||--o{ Metriken : beinhaltet
|
||||
Kapitalgesellschaft ||--o{ Branche : operiert_in
|
||||
Person ||--o{ Vorstand : agiert_als
|
||||
Person ||--o{ Wirtschaftspruefer : agiert_als
|
||||
Vorstand ||--o{ Kapitalgesellschaft: leitet
|
||||
|
||||
Kapitalgesellschaft {
|
||||
}
|
||||
Branche {
|
||||
}
|
||||
Jahresabschluss {
|
||||
}
|
||||
```
|
||||
190
html/_sources/research/data_and_metrics.md.txt
Normal file
190
html/_sources/research/data_and_metrics.md.txt
Normal file
@ -0,0 +1,190 @@
|
||||
# Daten und Kennzahlen von Unternehmen
|
||||
|
||||
|
||||
## Basisdaten der Firma
|
||||
* Name
|
||||
* Sitz
|
||||
* Rechtsform bzw. Art der Kapitalgesellschaft (AG, KGaA, GmbH, UG)
|
||||
* Branche
|
||||
* Gründungsdatum
|
||||
|
||||
|
||||
## Personen
|
||||
* Gesellschafter/innen (Verteilung der Anteile, Höhe der Anteile)
|
||||
* Geschäftsführung bzw. Vorstand (Vorsitzende/r, Stellvertretung, weitere)
|
||||
* Aufsichtsrat (Vorsitzende/r, Stellvertretung, weitere)
|
||||
* Wirtschaftsprüfung (Unternehmen, verantwortliche/r Wirtschaftsprüfer/in)
|
||||
|
||||
Im Fall von realen Personen könnte die eindeutige Identifikation schwierig sein. Hier wären neben dem Nachnamen auch der Vorname wünschenswert.
|
||||
|
||||
|
||||
## Bewertung der Größe der Kapitalgesellschaft
|
||||
*Nach HGB §267: https://www.gesetze-im-internet.de/hgb/__267.html*
|
||||
* Durchschnittliche Mitarbeiterzahl (Anzahl beschäftigte Arbeitnehmer am 31.03., 30.06., 30.09., 31.12.)
|
||||
* Bilanzsumme bzw. Gesamtkapital
|
||||
* Umsatz bzw. Umsatzerlöse
|
||||
|
||||
|
||||
## Kennzahlen bei Aktiengesellschaften
|
||||
*Angelehnt an https://www.tagesschau.de/wirtschaft/boersenkurse/ und https://boerse.de*
|
||||
* ISIN (International Securities Identification Number)
|
||||
* WKN (Wertpapierkennnummer)
|
||||
* Aktienkurs
|
||||
* Währung
|
||||
* Gewinn je Aktie
|
||||
* Dividende
|
||||
* Dividendenrendite
|
||||
* Ausschüttungsquote = Dividende je Aktie / Gewinn je Aktie * 100
|
||||
* Marketkapitalisierung = Anzahl Anteilsscheine * Aktienkurs
|
||||
* Kurs-Gewinn-Verhältnis (KGV) = Aktienkurs / Gewinn pro Aktie
|
||||
* Kurs-Umsatz-Verhältnis (KUV) = Marktkapitalisierung / Umsatz
|
||||
* Kurs-Gewinn-Wachstumsverhältnis (PEG) = KGV / erwarteter Gewinnwachstum im kommenden Geschäftsjahr
|
||||
|
||||
|
||||
## Mögliche Kennzahlen zur Unternehmensbewertung
|
||||
*Handbuch Aktien- und Unternehmensbewertung - Peter Seppelfricke*
|
||||
|
||||
### Erfolgskennzahlen
|
||||
* Umsatz
|
||||
* Gewinn bzw. Jahresüberschuss
|
||||
* Gewinn vor Steuern (EBT)
|
||||
* Gewinn vor Steuern und Zinsen (EBIT/Betriebsergebnis): Bei Gesamtkostenverfahren Summe 1-8, bei Umsatzkostenverfahren Summe 1-7
|
||||
|
||||
### Finanzkennzahlen
|
||||
* Eigenkapitalquote = Eigenkapital / Gesamtkapital * 100
|
||||
* Fremdkapitalquote = Fremdkapital / Gesamtkapital * 100
|
||||
* Verschuldungsgrad = Fremdkapital / Eigenkapital * 100
|
||||
|
||||
### Rentabilitätskennzahlen
|
||||
* Eigenkapitalrentabilität = Jahresüberschuss / Eigenkapital * 100
|
||||
* Return on Investment (ROI) = Gewinn / Gesamtkapital
|
||||
* Umsatzrentabilität = Gewinn / Umsatz * 100
|
||||
|
||||
### _Nichtfinanzielle Kennzahlen_
|
||||
* _CO<sub>2</sub>-Emissionen_
|
||||
* _Unfallrate_
|
||||
|
||||
|
||||
## Gewünschte Kennzahlen
|
||||
*E-Mail vom 13.04.2023*
|
||||
* Umsatz
|
||||
* EBIT
|
||||
* EBIT Marge
|
||||
* Bilanzsumme
|
||||
* Eigenkapitalanteil (Eigenkapital / Bilanzsumme)
|
||||
* Fremdkapitalanteil (Fremdkapital / Bilanzsumme)
|
||||
* Verschuldungsgrad (Fremdkapital / Eigenkapital)
|
||||
* Eigenkapitalrentabilität (EBIT/Eigenkapital)
|
||||
* Umschlaghäufigkeit des Gesamtkapitals (Umsatz / Bilanzsumme)
|
||||
|
||||
## Kurzdefinitionen
|
||||
### Umsatz (Erlös)
|
||||
*https://www.lexoffice.de/lexikon/umsatz/*
|
||||
* Wert aller Produkte und Dienstleistungen, die in einem bestimmten Zeitraum abgesetzt wurden
|
||||
* Muss in der GuV ausgewiesen werden
|
||||
* Berechnung: Bruttoumsatz = Verkaufspreis (pro Stück) x abgesetzte Menge, Nettoumsatz = Bruttoumsatz - Erlösschmälerungen (z.B. Rabatte, Boni, Skonti) - Umsatzsteuer
|
||||
|
||||
### EBIT (Earnings Before Interest and Taxes/Gewinn vor Zinsen und Steuern/Betriebsergebnis/Operativer Gewinn)
|
||||
*https://www.bwl-lexikon.de/wiki/ebit/*
|
||||
* Kennzahl, die den Unternehmensgewinn angibt, der aus der gewöhnlichen Geschäftstätigkeit entsteht
|
||||
* Stellt das operative Ergebnis eines Unternehmens dar
|
||||
* Gibt Auskunft über die Effizienz und die Ertragskraft eines Unternehmens
|
||||
* Berechnung: Jahresüberschuss/-fehlbetrag + Steueraufwand - Steuerertrag + außerordentlicher Aufwand - außerordentlicher Ertrag + Finanzaufwand - Finanzertrag = EBIT
|
||||
|
||||
### EBIT-Marge
|
||||
*https://www.bwl-lexikon.de/wiki/ebit-marge/*
|
||||
* Eignet sich zum Vergleich von verschiedenen Unternehmen, zur Messung der operativen Veränderung und gibt Rückschlüsse auf die zukünftige Rentabilität
|
||||
* Verhältnis von EBIT und Umsatz
|
||||
* Eine EBIT-Marge in Höhe von 10% und mehr ist als positiv zu bewerten
|
||||
* Berechnung: EBIT-Marge = EBIT / Umsatz
|
||||
|
||||
### Bilanzsumme (Gesamtvermögen/Gesamtkapital)
|
||||
*https://www.bwl-lexikon.de/wiki/bilanzsumme/*
|
||||
* Summe des Vermögens bzw. der Aktiva und des Kapitals bzw. der Passiva eines Unternehmens
|
||||
* Kriterium für die Größe von Kapitalgesellschaften
|
||||
* Aktiva = Anlagevermögen + Umlaufvermögen
|
||||
* Passiva = Eigenkapital + Rückstellungen + Verbindlichkeiten
|
||||
* Liefert Anhaltspunkte dafür, ob und wie schnell ein Unternehmen wächst
|
||||
|
||||
### Eigenkapitalquote
|
||||
*https://www.bwl-lexikon.de/wiki/eigenkapitalquote/*
|
||||
* Informiert über die Kapitalstruktur eines Unternehmens
|
||||
* Geht aus der Bilanz eines Unternehmens vor
|
||||
* Je größer der Abstand zwischen eigenen und fremden Mittel, umso freier kann die Unternehmensleitung agieren
|
||||
* Je höher die Quote, desto unabhängiger ist das Unternehmen von Fremdkapitalgebern
|
||||
* Berechnung: Eigenkapital / Gesamtkapital
|
||||
|
||||
### Fremdkapitalquote
|
||||
*https://www.bwl-lexikon.de/wiki/fremdkapitalquote/*
|
||||
* Anteil des Fremdkapitals am gesamten Kapital
|
||||
* Anzeichen für die Zahlungsfähigkeit eines Unternehmens
|
||||
* Je höher die Quote, desto abhängiger ist das Unternehmen von Fremdkapitalgebern, die Kreditwürdigkeit sinkt
|
||||
* Berechnung: Fremdkapital / Gesamtkapital
|
||||
|
||||
### Verschuldungsgrad
|
||||
*https://www.bwl-lexikon.de/wiki/verschuldungsgrad/*
|
||||
* Informiert über die wirtschaftliche Stabilität eines Unternehmens
|
||||
* Bei einem hohen Verschuldungsgrad wird mehr Fremdkapital in einem Unternehmen eingesetzt, die Gefahr der Insolvenz steigt
|
||||
* Bei einem niedrigen Verschuldungsgrad ist die Eigenkapitalfinanzierung höher
|
||||
* Berechnung: Fremdkapital / Eigenkapital
|
||||
|
||||
### Eigenkapitalrentabilität (Return on Equity ROE)
|
||||
*https://www.bwl-lexikon.de/wiki/eigenkapitalrentabilitaet/*
|
||||
* Informiert über die Wirtschaftlichkeit des Unternehmens und die Sinnhaftigkeit des Kapitaleinsatzes
|
||||
* Misst die Ertragskraft des Unternehmens
|
||||
* Gewünschte Höhe der Eigenkapitalrentabilität differiert je nach Branche
|
||||
* Eine doppelt so hohe Eigenkapitalrendite wie der durchschnittliche Zins gilt als wünschenswert
|
||||
* Ist der Kapitalzins höher, sollten Unternehmen das Kapital aus dem Kapitalmarkt anlegen
|
||||
* Berechnung: Gewinn bzw. Jahresüberschuss / Eigenkapital
|
||||
|
||||
### Gesamtkapitalumschlag (Kapitalumschlag/Umschlagshäufigkeit)
|
||||
*https://www.bwl-lexikon.de/wiki/kapitalumschlag/*
|
||||
* Verhältnis vom Umsatz zum Eigen- oder Gesamtkapital
|
||||
* Legt fest, wie viel Umsatz mit dem vorhandenen Kapital eines Unternehmens erwirtschaftet werden kann
|
||||
* Gibt an, wie oft das eingesetzte Kapital durch die Umsatzerlöse zurück in das Unternehmen gelangt ist (desto häufiger, desto besser)
|
||||
* Berechnung: Umsatz / Bilanzsumme bzw. Gesamtkapital
|
||||
|
||||
### Umsatzrentabilität (Umsatzrendite/Umsatzmarge/Nettomarge)
|
||||
*https://www.bwl-lexikon.de/wiki/umsatzrentabilitaet/*
|
||||
* Verhältnis von Gewinn und Umsatz
|
||||
* Betrag, den ein Unternehme pro Euro Umsatz erwirtschaftet
|
||||
* Eine steigende Umsatzrendite deutet darauf hin, dass die Produktivität des Unternehmens steigt
|
||||
* Bildet die Effiziens eines Unternehmens ab
|
||||
* Eine Umsatzrentabilität in Höhe von 5% und mehr gilt als Richtwert
|
||||
* Berechnung: Gewinn / Umsatz
|
||||
|
||||
### Gesamtkapitalrentabilität (Return on Investment ROI, Kapitalrendite)
|
||||
*https://www.bwl-lexikon.de/wiki/gesamtkapitalrentabilitaet/*
|
||||
* Relation zwischen dem investierten Kapital und dem Gewinn
|
||||
* Beurteilungsmaßstad für die Rentabilität
|
||||
* Positiver ROI ist für ein Unternehmen vorteilhaft
|
||||
* Berechnung: Umsatzrentabilität x Kapitalumschlag
|
||||
|
||||
# Fazit
|
||||
Insgesamt sollen folgende Größen bzw. Kennzahlen betrachtet werden:
|
||||
* Unternehmensgröße
|
||||
* Umsatz
|
||||
* EBIT
|
||||
* EBIT-Marge
|
||||
* Bilanzsumme
|
||||
* Eigenkapitalquote
|
||||
* Fremdkapitalquote
|
||||
* Verschuldungsgrad
|
||||
* Eigenkapitalrentabilität
|
||||
* Umsatzrentabilität
|
||||
* Gesamtkapitalrentabilität
|
||||
* Gesamtkapitalumschlag
|
||||
|
||||
|
||||
Dazu werden folgende Daten benötigt:
|
||||
* Umsatz
|
||||
* Bilanzsumme
|
||||
* EBIT
|
||||
* Eigenkapital
|
||||
* Fremdkapital
|
||||
* Gewinn
|
||||
* Durchschnittliche Mitarbeiterzahl
|
||||
|
||||
Vergleichsmöglichkeiten:
|
||||
* Zeitvergleich: Vergleich der ermittelten Kennzahlen in verschiedenen Perioden, mit Hilfe von Zeitvergleichen über längere Zeiträume lassen sich Trends oder Zyklen erkennen
|
||||
* Betriebsvergleich: Gegenüberstellung der Kennzahlen von Unternehmen der gleichen Branche oder Vergleich der Werte eines Unternehmens mit dem Branchendurchschnitt
|
||||
74
html/_sources/research/news_apis.md.txt
Normal file
74
html/_sources/research/news_apis.md.txt
Normal file
@ -0,0 +1,74 @@
|
||||
# Nachrichtenquellen
|
||||
|
||||
## **Twitter API v2**
|
||||
|
||||
### **Access Levels**
|
||||
**Free:**
|
||||
- 1,500 Tweets per months
|
||||
- 1 AppID
|
||||
- Login with Twitter
|
||||
|
||||
**Basic:**
|
||||
- 100 per month
|
||||
|
||||
**Enterprise:**
|
||||
- Monthly subscribtion tiers
|
||||
|
||||
Postman Besipiele: https://developer.twitter.com/en/docs/tutorials/postman-getting-started
|
||||
|
||||
Getting started: https://github.com/twitterdev
|
||||
|
||||
|
||||
|
||||
## **NewsAPI**
|
||||
- Developer ist kostenlos
|
||||
- 24 Stunden verspätet sind die Artikel erreichabr
|
||||
- Bis zu einem Monat alte Artikel abrufbar
|
||||
- 100 Anfragen pro Tag
|
||||
- CORS geht nur für local host
|
||||
- Hat extra einen Punkt für deutsche Nachrichten: https://newsapi.org/s/germany-news-api
|
||||
|
||||
|
||||
Benötigt einen Account um einen API Key zu generieren.
|
||||
Doku: https://newsapi.org/docs/get-started
|
||||
|
||||
**Hinweis**: *Bietet die Möglichkeit nach Artikel mit einem bestimmten Wort zu suchen*
|
||||
|
||||
## **Bloomberg API**
|
||||
- Link: https://www.bloomberg.com/professional/support/api-library/
|
||||
- generell kostenlos, bei starker Nutzung muss ein Preis angefragt werden
|
||||
- sehr gut für Marktanalysen geeignet
|
||||
|
||||
|
||||
## **New York Times API**
|
||||
- die ersten 1000 Anfragen pro Tag sind kostenlos
|
||||
- 11 verschiedene APIs
|
||||
|
||||
|
||||
## **PressePortal**
|
||||
Bietet eine API zur DPA Gruppe an. Eher schlecht beschrieben und der API-Key muss via Email beantragt werden, bietet aber potentiell Zugriff auf deutsche Nachrichten.
|
||||
|
||||
Demo: https://api.presseportal.de/v2/demo/index.htx?mod=section_all&newsroom=&office=&city=&keyword=&topic=&police_officetype=&police_federalstate=&media=dokument&limit=&language=de&companyinfo=6344
|
||||
|
||||
API-Key Anfragen: https://api.presseportal.de/
|
||||
|
||||
|
||||
## **Tagesschau API 2.0**
|
||||
https://tagesschau.api.bund.dev/
|
||||
|
||||
## **Yahoo finance API**
|
||||
https://financeapi.net/
|
||||
|
||||
## **Google News API**
|
||||
- deprecated
|
||||
- kostenlos
|
||||
- gut dokumentiert
|
||||
|
||||
|
||||
## **Sonstiges**
|
||||
Bing News API, ESPN, Guardian API, BBC News API Yahoo News API und Financial Times fallen raus, da diese immer mit kosten verbunden sind oder sich nur mit Sport oder Kommentare befassen.
|
||||
|
||||
- "Die Zeit" hatte mal eine API die abgeschaltet wurde.
|
||||
|
||||
|
||||
-> RSS Feeds Irgendwie abgreifen
|
||||
12
html/_sources/research/resarch-central.md.txt
Normal file
12
html/_sources/research/resarch-central.md.txt
Normal file
@ -0,0 +1,12 @@
|
||||
# Research Central
|
||||
|
||||
|
||||
## Sentiment Analysis
|
||||
|
||||
### FinBert
|
||||
|
||||
FinBert is a specialised sentiment Analysis for Financial Data.
|
||||
Sadly it isn't a very good model, and it does not work at all for texts in german.
|
||||
|
||||
Experiments can be found here:
|
||||
* [FinBert Jupyter](../../Jupyter/AI-models/"Sentiment Analysis"/FinBert.ipynb)
|
||||
68
html/_sources/seminararbeiten/3_Datenspeicherung.md.txt
Normal file
68
html/_sources/seminararbeiten/3_Datenspeicherung.md.txt
Normal file
@ -0,0 +1,68 @@
|
||||
# Aufgabe: Inhaltliche Skizze für die Seminararbeit zur Thematik Datenspeicherung
|
||||
|
||||
# 1. Allgemeine Anforderungen an Datenbank
|
||||
- **Speicherung** von strukturierten Daten, wie Kennzahlen, Stammdaten
|
||||
- **Skalierbarkeit:** Datenbank sollte skalierbar sein, um zukünftige Daten weiterhin zu speichern und weitere Unternehmen hinzuzufügen
|
||||
- **Sicherheit:** Die Datenbank muss Funktionen unterstützen, um die Datenvor unbefugtem Zugriff zu schützen.
|
||||
- **Datensicherung- und Wiederherstellung: ** Die Datenbank muss Funktionen zur Sicherung und Wiederherstellung unterstützen.
|
||||
- **Leistung:** Die Performance der Datenbank ist eher zweitrangig, da die Abfrage nicht hochdynamisch sein muss. Ausserdem werden nicht viele Anfragen erwartet.
|
||||
- **Integration:** Die Datenbank muss sich in ein Python Framework einbinden lassen und mit dem bevorzugten Frontend Daten austauschen können.
|
||||
|
||||
# 2. Datenarten
|
||||
Welche Daten erwarten wir im Projekt? \
|
||||
Cluster, wie z.B. Stammdaten, Stimmungsdaten, Social Graph, Zeitseriendaten/Historien
|
||||
|
||||
> Abstimmung mit den Bereichen Textmining und Datenbeschaffung über verwendete Daten und Formulierung von Anforderungen an Daten.
|
||||
|
||||
## 2.1 strukturierte Daten
|
||||
Was sind strukturierte Daten?
|
||||
|
||||
## 2.2 unstrukturierte Daten
|
||||
Was sind unstrukturierte Daten?
|
||||
|
||||
> Definiere eine Anforderung an die Struktur der Daten.
|
||||
|
||||
# 3. Arten von Datenbanken
|
||||
## 3.1 Relational
|
||||
Was ist eine reltionale Datenbank?
|
||||
Wie werden Daten gespeichert?
|
||||
Beispiel für relationale Datenbank
|
||||
|
||||
## 3.2 Graph
|
||||
Was ist eine Graph Datenbank?
|
||||
Wie werden Daten gespeichert?
|
||||
Beispiel für Graph Datenbank
|
||||
|
||||
## 3.3 Zeitserien
|
||||
Was ist eine Zeitserien Datenbank?
|
||||
Wie werden Daten gespeichert?
|
||||
Beispiel für Zeitserien Datenbank
|
||||
|
||||
> Kurzvorstellung von Datenbanksystemen
|
||||
|
||||
# 4. DBS Transparenzregister
|
||||
## 4.1 relationales Datenbankmodell
|
||||
|
||||
> Modell zur Abbildung der Relationen im Projekt Transparenzregister
|
||||
|
||||
## 4.2 verteilte Datenbank oder ein System
|
||||
Ein DBS: Wenn nur ein Datenbanksystem verwendet wird, muss nur ein System gepflegt und integriert werden.
|
||||
- Vorteil: einfache Verwaltung und schnelle Abfrage von Datenbeziehungen
|
||||
|
||||
verteiltes System: spezialisierte Datenbank für jeden Datenytp, wie z.B. Zeitseriendaten oder Graph Daten
|
||||
|
||||
> Definiere eine Empfehlung/Anforderung für das Projekt Transparenzregister.
|
||||
|
||||
## 4.3 Analyse zur Auswahl eines Datenbanksystems
|
||||
Was sollte bei der Auswahl eines Datenbanksystems beachtet werden?
|
||||
|
||||
> Empfehlungen für DBS-Auswahl
|
||||
|
||||
## 4.4 Anbindung an Front- und Backend
|
||||
Wie kann das DBS an das Front- und Backend angebunden werden?
|
||||
> Jupyter Notebook mit Beispiel
|
||||
|
||||
## 4.5 Abfragen in der Datenbank
|
||||
Wie können Unternehmensdaten abgefragt werden?
|
||||
Wie können Verflechtungen abgefragt werden?
|
||||
> Jupyter Notebook mit Beispiel
|
||||
@ -0,0 +1,45 @@
|
||||
**Abstract/Planung der Seminararbeit zu "Text Mining"**
|
||||
|
||||
**Sascha Zhu**
|
||||
|
||||
**10.05.2023**
|
||||
|
||||
|
||||
|
||||
Gliederung
|
||||
|
||||
1. Einleitung und Begriffsbestimmung
|
||||
|
||||
2. Text Mining Prozess
|
||||
|
||||
3. Verwendung von NLP-Methoden für das Text Mining
|
||||
|
||||
3.1 Morphologische Textanalyse
|
||||
|
||||
3.2 Syntaktische Textanalyse
|
||||
|
||||
3.3 Semantische Textanalyse
|
||||
|
||||
4. Ontologien und Text Mining
|
||||
|
||||
4.1 Verwendung von Ontologien als Grundlage der Textanalyse
|
||||
|
||||
4.2 Generierung von Ontologien mittels Text Mining ("ontology generation"/"ontology learning" )
|
||||
|
||||
5. Sentiment-Analyse als Teilgebiet des Text Minings
|
||||
|
||||
6. Zusammenfassung und Ausblick
|
||||
|
||||
|
||||
|
||||
Die Seminararbeit zu "Text Mining" soll in die oben genannten sechs Abschnitte gegliedert werden.
|
||||
|
||||
Nach einer Einleitung, in der der Begriff "Text Mining" näher definiert wird und gegenüber "Data Mining" und "Computational Linguistics" abgegrenzt wird, folgt der zweite Abschnitt zum Text Mining Prozess, der nach Hippner u. Rentzmann (2006) in die folgenden sechs Schritte eingeteilt wird: (a) Aufgabendefinition; (b) Dokumentenselektion; (c) Dokumentenaufbereitung; (d) Untersuchung mit Text-Mining-Methoden; (e) Interpretation und Evaluation; (f) Anwendung der Ergebnisse.
|
||||
|
||||
Im darauffolgenden dritten Abschnitt zur Verwendung von NLP-Methoden für das Text Mining werden die drei Phasen des Natural Language Processings (NLP), d.h. die morphologische, syntaktische und semantische Textanalyse, näher dargestellt, wobei der Schwerpunkt auf die semantische Analysetechniken wie z.B. "Word Sense Disambiguation" (WSD) und "Named Entity Recognition" (NED) liegen soll.
|
||||
|
||||
Der vierte Abschnitt soll sich dem Thema "Ontologien und Text Mining" widmen. Einerseits können Ontologien, die domänenspezifisches Wissen abbilden, als Grundlage für NLP-Methoden dienen, um etwa die semantische Textanalyse zu verbessern. Andererseits können mittels Text Mining automatisch bzw. semi-automatisch Ontologien als Repräsentation der Text-Mining-Ergebnisse erstellt werden ("ontology generation"/"ontology learning").
|
||||
|
||||
Im vorletzten, fünften Analyse soll die Sentiment-Analyse als Teilgebiet des Text Mining durchleuchtet werden. Dieser Abschnitt soll den Schwerpunkt der gesamten Seminararbeit darstellen. Die Methodik, Funktionsweise, Varianten und Use Cases der Sentiment Analyse sollen anhand ausgewählter Beispiele erläutert werden. Zudem sollen auch bekannte Sentiment-Analyse-Tools wie z.B. FinBERT, VADER, SentiWS etc. näher beschrieben werden.
|
||||
|
||||
Am Ende der Seminararbeit soll der sechste Abschnitt eine Zusammenfassung liefern und einen Ausblick darüber geben, in welche Richtung die zukünftige Entwicklung auf dem Gebiet des Text Minings gehen wird.
|
||||
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: "Automatisierte Daten Extraktion aus Internetquellen als Grundlage für die Analyse von Kapitalgesellschaften"
|
||||
author: "Nolde, Tristan Norbert"
|
||||
date: "2023-05-06"
|
||||
---
|
||||
|
||||
# Abstract: Automatisierte Daten Extraktion aus Internetquellen als Grundlage für die Analyse von Kapitalgesellschaften
|
||||
|
||||
## Gliederung
|
||||
1. Einleitung (Zielsetzung/Problemstellung, Vorgehen)
|
||||
2. Web Scraping/Crawling
|
||||
1. Definition und Theorie
|
||||
2. Technologien
|
||||
3. Umsetzung
|
||||
3. RSS Feeds
|
||||
1. Definition und Theorie
|
||||
2. Technologien
|
||||
3. Umsetzung
|
||||
4. APIs
|
||||
1. Definition und Theorie
|
||||
2. Technologien
|
||||
3. Umsetzung
|
||||
5. Rechtliche Rahmenbedingungen
|
||||
6. Vergleich der Lösungsansätze
|
||||
7. Zusammenfassung
|
||||
|
||||
## Inhalt
|
||||
|
||||
In Zeiten von Big Data und AI stellen Daten und ihre Verfügbarkeit zunehmend eines der wichtigsten Wirtschaftsgüter dar. Als solches können sie auch eingesetzt werden, um Kapitalgesellschaften (eine Subklasse von Unternehmen) anhand verschiedener Kennzahlen wie der Mitarbeiterzahl oder dem Jahresgewinn zu analysieren. Obwohl solche Daten zu Genüge in Zeitungsartikeln, Newslettern oder dedizierten Aktienanalysen zu finden sind, so gestaltet sich eine automatisierte Extraktion dieser Daten aufgrund verschiedener Formate sowie weiterer Restriktionen schwierig.
|
||||
|
||||
Daher sollen im Rahmen dieser Seminararbeit verschiedene Wege betrachtet werden, die eben diese Daten erheben und zur Verfügung stellen können. Zu den nennenswerten Quellen gehören: Der Bundesanzeiger, RSS Feeds, Nachrichten APIs. Ziel ist es, aus diesen Quellen wertvolle Informationen bezogen auf den wirtschaftlichen Erfolg einer Kapitalgesellschaft sowie aktueller Nachrichten zu extrahieren und in ein einheitliches Format zu überführen.
|
||||
|
||||
Neben des technischen Einsatzes von Web Scraping/Crawling, um Informationen aus Webseiten zu gewinnen, sowie des Abfragens verfügbarer APIs soll auch der rechltiche Aspekt dieser Vorgehens Berücksichtigung finden, um die Rechtmäßigkeit zu bewerten.
|
||||
|
||||
Abschließend wird der Einsatz der verschiedenen Technologien an den Faktoren: Flexibilität, Simplizität, Verfügbarkeit und Rechtmäßigkeit, ein Fazit gezogen sowie ein Ausblick des weiteren Einsatzes gegeben.
|
||||
@ -0,0 +1,47 @@
|
||||
# Seminarthema: Datenvisualisierung
|
||||
|
||||
## Geplanter Inhalt:
|
||||
- Einführung
|
||||
- Best Practice für Datenvisualisierung
|
||||
- Vorstellung verschiedener Diagrammarten
|
||||
- Welche Diagrammarten eignen sich für unsere drei Anwendungsbereiche Time Series Daten, Netzwerke und Stimmungen?
|
||||
- Betrachtung verschiedener Bibliotheken (z.B. D3Blocks, pyvis, plotly)
|
||||
- Zweck der Bibliothek, unterstützte Visualisierungen, Vor- und Nachteile
|
||||
- Minimalbeispiele
|
||||
- Anwendung auf unser Projekt:
|
||||
- Vergleich der Bibliotheken mit Blick auf unsere drei Anwendungsbereiche
|
||||
- Welche Daten werden für die einzelnen Diagramme gebraucht?
|
||||
- Welche Ideen/Anforderungen ergeben sich an die anderen Themenbereiche?
|
||||
- Fazit und Handlungsempfehlung
|
||||
- Welche Diagramme und welche Bibliotheken eignen sich für uns?
|
||||
|
||||
## Abstract:
|
||||
|
||||
In dieser Seminararbeit geht es um die Visualisierung von Daten in Python. Im Fokus steht die Anwendung auf die drei Themenbereiche, die im Projekt "Transparenzregister" behandelt werden: Time Series Daten, Soziale Netzwerke und Stimmungen. Nach einer Einführung in das Thema werden Best Practices für die Datenvisualisierung vorgestellt und verschiedene Diagrammarten präsentiert. Anschließend wird diskutiert, welche Diagramme für die genannten Anwendungsbereiche am besten geeignet sind.
|
||||
|
||||
Im zweiten Abschnitt werden verschiedene Python Bibliotheken vorgestellt und anhand von Minimalbeispielen betrachtet. Dabei wird analysiert, welche Bibliotheken die gewünschten Diagramme für unsere Anwendungsbereiche am besten darstellen und welche Daten für die Erstellung der verschiedenen Diagramme benötigt werden. Es werden zudem Ideen und Anforderungen an die anderen Themenbereiche aufgezeigt.
|
||||
|
||||
Im letzten Abschnitt der Arbeit wird ein Fazit gezogen und eine Handlungsempfehlung gegeben. Insgesamt soll die Arbeit einen Einblick in die Welt der Datenvisualisierung in Python geben und unserem Projekt helfen, die richtigen Entscheidungen bei der Wahl der Diagrammarten und Bibliotheken zu treffen.
|
||||
|
||||
## Erste Sammlung von Referenzen:
|
||||
Bibliotheken/Tools:
|
||||
- D3Blocks: [Documentation](https://d3blocks.github.io/d3blocks/pages/html/index.html), [Medium Blog](https://towardsdatascience.com/d3blocks-the-python-library-to-create-interactive-and-standalone-d3js-charts-3dda98ce97d4)
|
||||
- pyvis: [Documentation](https://pyvis.readthedocs.io/en/latest/tutorial.html)
|
||||
- networkx: [Documentation](https://networkx.org/documentation/stable/auto_examples/index.html), [Example](https://www.kirenz.com/post/2019-08-13-network_analysis/)
|
||||
- plotly: [Documentation](https://plotly.com/python/#animations)
|
||||
|
||||
Netzwerke:
|
||||
- Zentralitätsmaße: [Medium Blog](https://towardsdatascience.com/social-network-analysis-from-theory-to-applications-with-python-d12e9a34c2c7)
|
||||
- Visualisierungsideen: [Medium Blog](https://towardsdatascience.com/visualizing-networks-in-python-d70f4cbeb259)
|
||||
|
||||
Kennzahlen:
|
||||
- Visualisierungsideem: [Towards AI](https://towardsai.net/p/l/time-series-data-visualization-in-python)
|
||||
|
||||
Best Practice:
|
||||
- [Science Direct](https://www.sciencedirect.com/science/article/pii/S2666389920301896)
|
||||
- [Toptal](https://www.toptal.com/designers/data-visualization/data-visualization-best-practices)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,4 @@
|
||||
# Themen in der Seminararbeit zum Thema Datenvisualisierung
|
||||
|
||||
## Python Bibliotheken
|
||||
- networkx und pyvis
|
||||
@ -0,0 +1,21 @@
|
||||
# Dev Ops
|
||||
|
||||
## Roadmap
|
||||
|
||||
My plan for this coursework is to explore the dev ops thema and how it applies to the AI theme and this project in specific.
|
||||
|
||||
There are the following things in the theme of dev ops I want to explore:
|
||||
|
||||
1. Python dependency management via poetry
|
||||
2. Write a documentation around pre-commit hooks and how they can be used for this project with arguments for and against each of the hooks.
|
||||
3. Add a GitHub Runner on my own hardware to the repository and build a pipline with GitHub actions.
|
||||
- Add linter (black, flake8, pylint, mypy, bandit, pip-audit)
|
||||
- Testing setup in the pipline via pytest
|
||||
- Explore the ability of GitHub to summaries the linting and testing results.
|
||||
- Add SonarQube to the project if the test and lint summaries in GitHub does not suffice.
|
||||
- Build the artifacts. Something like python wheels, Docker container and deployment files.
|
||||
- Startup to new build and see if it crashes in the first 60s if a framework is shown.
|
||||
- Build the documentation via sphinx for this project via the pipline.
|
||||
4. How to deploy the collection of Docker containers via docker-compose and/or kubernetes.
|
||||
5. Evaluate the use of dependabot to upgrade the poetry dependency groups.
|
||||
6. Steadily grow the build pipline as the application grows.
|
||||
48
html/_sources/seminararbeiten/verflechtungsanalyse.md.txt
Normal file
48
html/_sources/seminararbeiten/verflechtungsanalyse.md.txt
Normal file
@ -0,0 +1,48 @@
|
||||
# Verflechtungsanalyse
|
||||
|
||||
## Entwurf des Inhaltsverzeichnis + Stichpunkte
|
||||
|
||||
1 Einleitung
|
||||
|
||||
1.1 Problemstellung
|
||||
|
||||
1.2 Zielsetzung und Aufbau der Arbeit
|
||||
|
||||
2 Graphentheorie
|
||||
|
||||
2.1 Begriffliche Definition
|
||||
|
||||
2.2 Sociometry
|
||||
- sociometry: quantitatives Methode um soziale Beziehungen zu messen.
|
||||
|
||||
2.3 Sociogram/ Social Graph
|
||||
- Ist ein graph der ein Soziales netzwerk darstellt
|
||||
- Basiert auf der Graphentheorie
|
||||
- Wurde offiziell Sociogram genannt
|
||||
- von facebook in der F8 2007 vorgestellt
|
||||
|
||||
2.4 Social Network Analysis (SNA)
|
||||
|
||||
- Social Network Analysis (SNA): Untersuchen von Sozialen Strukturen anhand von Netzwerken und Graphtheorie.
|
||||
|
||||
3 Ein Social Graph für das Transparentsregister
|
||||
|
||||
3.5 Handlungsempfehlung
|
||||
|
||||
4 Zusammenfassung
|
||||
|
||||
4.1 Kritische Reflexion
|
||||
|
||||
4.2 Fazit
|
||||
|
||||
4.3 Ausblick
|
||||
|
||||
## Abstract
|
||||
|
||||
In der Seminararbeit zum Thema: "Verpflechtungsanalyse der Unternehmen und Personen im Transparenzregister" soll einerseits die Theorie für die Analyse von Verflechtungen vermittelt sowie anhand des Projektess aufgezeigt werden wie diese angewendet werden kann.
|
||||
|
||||
Als Fundament dient die Graphentheorie, welche Grundlegen für die Analyse von Netzstrukturen ist. Zunächst werden die wichtigsten Begriffe definiert und es wird eine Einführung ins Thema der Graphentheorie mit Beispielen und Erläuterung gegeben. Darauffolgend wird tiefer in das Thema eingetaucht und sich mit dem Bereich Sociogram/ Social Graph auseinandergesetzt. Ein Sociogram ist ein Model eines Netzwerks von sozialen Verbindungen die durch einen Graphen repräsentiert werden. Diese Idee wurde 2007 von Facebook als Social Graph in der F8 vorgestellt. Diese Art von Graph basiert auf der Graphentheorie. Die stärken dieses Graphen liegen in der Veranschaulichung der sozialen Verflechtungen. Daher wird der Social Graph für die Analyse der Verflechtungen innerhalb des Transparenzregisters genutzt.
|
||||
|
||||
Im Hauptteil der Seminararbeit wird aufgezeigt wie der Social Graph auf das Transparenzregister angewendet werden könnte. Es wird gezeigt welche Komponenten gebildet werden müssten und wie die Daten aufbereitet werden um einen Social graph bauen zu können. Des Weiteren wird auf die Formel und Algorithmen eingegangen die zur Erstellung des Graphen nötig sind. Dabei orientiert sich die Arbeit an Beispielen um die Theorie nachvollziebar zu vermitteln. Dieser Abschnitt wird mit einer Handlungsempfehlung für das Projekt abgeschlossen.
|
||||
|
||||
Abgeschlossen wird das Werk mit einer kritischen Reflexion, gefolgt von einem Fazit und einem Ausblick.
|
||||
21
html/_sources/templates/meeting_notes_template.md.txt
Normal file
21
html/_sources/templates/meeting_notes_template.md.txt
Normal file
@ -0,0 +1,21 @@
|
||||
# Weekly *X*: DD.MM.YYYY
|
||||
|
||||
## Teilnehmer
|
||||
- Prof. Arinir
|
||||
- Tristan Nolde
|
||||
- Tim Ronneburg
|
||||
- Phillip Horstenkamp
|
||||
- Kim Mesewinkel-Risse
|
||||
- Sascha Zhu
|
||||
- Sebastian Zeleny
|
||||
|
||||
## Themen
|
||||
|
||||
- ABC:
|
||||
- ...
|
||||
|
||||
## Abgeleitete Action Items
|
||||
|
||||
| Action Item | Verantwortlicher | Deadline |
|
||||
|-------------|------------------|-----------------|
|
||||
| Beispiel | Max Mustermann | nächstes Weekly |
|
||||
71
html/_sources/timeline.md.txt
Normal file
71
html/_sources/timeline.md.txt
Normal file
@ -0,0 +1,71 @@
|
||||
# Timeline
|
||||
```{mermaid}
|
||||
|
||||
gantt
|
||||
|
||||
title Timeline PG Transparenzregister
|
||||
dateFormat YYYY-MM-DD
|
||||
section Organisation
|
||||
Kennenlernen des Projektteams : done, a1, 2023-03-30, 1d
|
||||
Erstellen des Organigramms : done, after a1 , 1d
|
||||
GitHub : done, 2023-04-06, 7d
|
||||
Zeitplanung SoSe : active , 2023-04-06, 7d
|
||||
|
||||
section Dokumentation
|
||||
Meeting Notes: active, 2023-03-30, 10w
|
||||
Seminarthemen: active, 2023-04-13, 8w
|
||||
Lastenheft: active, 2023-04-06, 5w
|
||||
Pflichtenheft: milestone, 2023-05-11
|
||||
Reserve: crit, 2023-06-08, 1w
|
||||
|
||||
|
||||
section Meeting
|
||||
Weekly 1 : done, 2023-03-30, 0.5h
|
||||
Statustermin 1 : done ,2023-03-30 , 1h
|
||||
Weekly 2 : done, 2023-04-06, 2h
|
||||
|
||||
Statustermin 2 : active, 2023-04-13, 1h
|
||||
Weekly 3 : active, 2023-04-13, 0.5h
|
||||
Weekly 4 : active, 2023-04-20, 2h
|
||||
|
||||
Weekly 5 : active, 2023-04-27, 0.5h
|
||||
Statustermin 3 : active, 2023-04-27, 1h
|
||||
|
||||
Weekly 6 : active, 2023-05-04, 2h
|
||||
|
||||
Weekly 7 : active, 2023-05-11, 0.5h
|
||||
Statustermin 4 : active, 2023-05-11, 1h
|
||||
|
||||
Weekly 8 : active, 2023-05-18, 2h
|
||||
Weekly 9 : active, 2023-05-25, 0.9h
|
||||
Statustermin 5 : active, 2023-05-25, 1h
|
||||
|
||||
Weekly 10 : active, 2023-06-01, 2h
|
||||
Weekly 11 : active, 2023-06-01, 0.9h
|
||||
Statustermin 6 : active, 2023-06-08, 1h
|
||||
|
||||
section Recherche
|
||||
Unternehmensformen : active, 2023-04-06, 14d
|
||||
Kennzahlen : active, 2023-04-10, 14d
|
||||
Datenquellen : active, 2023-04-10, 14d
|
||||
rechtliche Verwendbarkeit: active, 2023-04-06, 18d
|
||||
Verwendete Metriken, Datenquellen, Rechtmäßigkeit: milestone, 2023-04-24
|
||||
Reserve: crit, 2023-04-24, 3d
|
||||
|
||||
section Definition
|
||||
fachl. Aufgabe : active, 2023-04-27, 1d
|
||||
techn. Aufgabe : active, 2023-04-27, 1d
|
||||
Funktionelle Anf. : active, 2023-04-27, 7d
|
||||
Qualitative Anf. : active, 2023-04-27, 7d
|
||||
Modell: active, 2023-05-04, 7d
|
||||
Hierarchie: active, 2023-05-04, 7d
|
||||
Definition der Anforderungen : milestone, 2023-05-11
|
||||
Reserve: crit, 2023-05-11, 1w
|
||||
|
||||
section Proof of concept
|
||||
Project Proposal : active, 2023-05-18, 10d
|
||||
Vorstellung Project Proposal: milestone, 2023-05-28
|
||||
Implementierung des Proposals: active, 2023-05-25, 14d
|
||||
Vorstellung Proof of Concept: milestone, 2023-06-08
|
||||
Reserve: crit, 2023-06-08, 1w
|
||||
```
|
||||
123
html/_static/_sphinx_javascript_frameworks_compat.js
Normal file
123
html/_static/_sphinx_javascript_frameworks_compat.js
Normal file
@ -0,0 +1,123 @@
|
||||
/* Compatability shim for jQuery and underscores.js.
|
||||
*
|
||||
* Copyright Sphinx contributors
|
||||
* Released under the two clause BSD licence
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 &&
|
||||
!jQuery(node.parentNode).hasClass(className) &&
|
||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
903
html/_static/basic.css
Normal file
903
html/_static/basic.css
Normal file
@ -0,0 +1,903 @@
|
||||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
div.section::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox form.search {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
float: left;
|
||||
width: 80%;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
float: left;
|
||||
width: 20%;
|
||||
border-left: none;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li p.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
table.indextable > tbody > tr > td > ul {
|
||||
padding-left: 0em;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- domain module index --------------------------------------------------- */
|
||||
|
||||
table.modindextable td {
|
||||
padding: 2px;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body {
|
||||
min-width: 360px;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
clear: right;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
nav.contents,
|
||||
aside.topic,
|
||||
div.admonition, div.topic, blockquote {
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
nav.contents,
|
||||
aside.topic,
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
nav.contents > :last-child,
|
||||
aside.topic > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
nav.contents::after,
|
||||
aside.topic::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > :first-child,
|
||||
td > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > :last-child,
|
||||
td > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure, figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption, figcaption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- hlist styles ---------------------------------------------------------- */
|
||||
|
||||
table.hlist {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
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 ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:first-child > :first-child,
|
||||
:not(li) > ul > li:first-child > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:last-child > :last-child,
|
||||
:not(li) > ul > li:last-child > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
ol.simple ol p,
|
||||
ol.simple ul p,
|
||||
ul.simple ol p,
|
||||
ul.simple ul p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple > li:not(:first-child) > p,
|
||||
ul.simple > li:not(:first-child) > p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple p,
|
||||
ul.simple p {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
aside.footnote > span,
|
||||
div.citation > span {
|
||||
float: left;
|
||||
}
|
||||
aside.footnote > span:last-of-type,
|
||||
div.citation > span:last-of-type {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
aside.footnote > p {
|
||||
margin-left: 2em;
|
||||
}
|
||||
div.citation > p {
|
||||
margin-left: 4em;
|
||||
}
|
||||
aside.footnote > p:last-of-type,
|
||||
div.citation > p:last-of-type {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
aside.footnote > p:last-of-type:after,
|
||||
div.citation > p:last-of-type:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dl > dd:last-child,
|
||||
dl > dd:last-child > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0 0.5em;
|
||||
content: ":";
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
pre, div[class*="highlight-"] {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
div[class*="highlight-"] {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tbody {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tr {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td.code {
|
||||
flex: 1;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.highlight .hll {
|
||||
display: block;
|
||||
}
|
||||
|
||||
div.highlight pre,
|
||||
table.highlighttable pre {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption + div {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
margin-top: 1em;
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
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 {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
div.math:hover a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
4
html/_static/check-solid.svg
Normal file
4
html/_static/check-solid.svg
Normal file
@ -0,0 +1,4 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-check" width="44" height="44" viewBox="0 0 24 24" stroke-width="2" stroke="#22863a" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<path d="M5 12l5 5l10 -10" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 313 B |
7
html/_static/clipboard.min.js
vendored
Normal file
7
html/_static/clipboard.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
5
html/_static/copy-button.svg
Normal file
5
html/_static/copy-button.svg
Normal file
@ -0,0 +1,5 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<rect x="8" y="8" width="12" height="12" rx="2" />
|
||||
<path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 411 B |
94
html/_static/copybutton.css
Normal file
94
html/_static/copybutton.css
Normal file
@ -0,0 +1,94 @@
|
||||
/* Copy buttons */
|
||||
button.copybtn {
|
||||
position: absolute;
|
||||
display: flex;
|
||||
top: .3em;
|
||||
right: .3em;
|
||||
width: 1.7em;
|
||||
height: 1.7em;
|
||||
opacity: 0;
|
||||
transition: opacity 0.3s, border .3s, background-color .3s;
|
||||
user-select: none;
|
||||
padding: 0;
|
||||
border: none;
|
||||
outline: none;
|
||||
border-radius: 0.4em;
|
||||
/* The colors that GitHub uses */
|
||||
border: #1b1f2426 1px solid;
|
||||
background-color: #f6f8fa;
|
||||
color: #57606a;
|
||||
}
|
||||
|
||||
button.copybtn.success {
|
||||
border-color: #22863a;
|
||||
color: #22863a;
|
||||
}
|
||||
|
||||
button.copybtn svg {
|
||||
stroke: currentColor;
|
||||
width: 1.5em;
|
||||
height: 1.5em;
|
||||
padding: 0.1em;
|
||||
}
|
||||
|
||||
div.highlight {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
/* Show the copybutton */
|
||||
.highlight:hover button.copybtn, button.copybtn.success {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
.highlight button.copybtn:hover {
|
||||
background-color: rgb(235, 235, 235);
|
||||
}
|
||||
|
||||
.highlight button.copybtn:active {
|
||||
background-color: rgb(187, 187, 187);
|
||||
}
|
||||
|
||||
/**
|
||||
* A minimal CSS-only tooltip copied from:
|
||||
* https://codepen.io/mildrenben/pen/rVBrpK
|
||||
*
|
||||
* To use, write HTML like the following:
|
||||
*
|
||||
* <p class="o-tooltip--left" data-tooltip="Hey">Short</p>
|
||||
*/
|
||||
.o-tooltip--left {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.o-tooltip--left:after {
|
||||
opacity: 0;
|
||||
visibility: hidden;
|
||||
position: absolute;
|
||||
content: attr(data-tooltip);
|
||||
padding: .2em;
|
||||
font-size: .8em;
|
||||
left: -.2em;
|
||||
background: grey;
|
||||
color: white;
|
||||
white-space: nowrap;
|
||||
z-index: 2;
|
||||
border-radius: 2px;
|
||||
transform: translateX(-102%) translateY(0);
|
||||
transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
|
||||
}
|
||||
|
||||
.o-tooltip--left:hover:after {
|
||||
display: block;
|
||||
opacity: 1;
|
||||
visibility: visible;
|
||||
transform: translateX(-100%) translateY(0);
|
||||
transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
|
||||
transition-delay: .5s;
|
||||
}
|
||||
|
||||
/* By default the copy button shouldn't show up when printing a page */
|
||||
@media print {
|
||||
button.copybtn {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
248
html/_static/copybutton.js
Normal file
248
html/_static/copybutton.js
Normal file
@ -0,0 +1,248 @@
|
||||
// Localization support
|
||||
const messages = {
|
||||
'en': {
|
||||
'copy': 'Copy',
|
||||
'copy_to_clipboard': 'Copy to clipboard',
|
||||
'copy_success': 'Copied!',
|
||||
'copy_failure': 'Failed to copy',
|
||||
},
|
||||
'es' : {
|
||||
'copy': 'Copiar',
|
||||
'copy_to_clipboard': 'Copiar al portapapeles',
|
||||
'copy_success': '¡Copiado!',
|
||||
'copy_failure': 'Error al copiar',
|
||||
},
|
||||
'de' : {
|
||||
'copy': 'Kopieren',
|
||||
'copy_to_clipboard': 'In die Zwischenablage kopieren',
|
||||
'copy_success': 'Kopiert!',
|
||||
'copy_failure': 'Fehler beim Kopieren',
|
||||
},
|
||||
'fr' : {
|
||||
'copy': 'Copier',
|
||||
'copy_to_clipboard': 'Copier dans le presse-papier',
|
||||
'copy_success': 'Copié !',
|
||||
'copy_failure': 'Échec de la copie',
|
||||
},
|
||||
'ru': {
|
||||
'copy': 'Скопировать',
|
||||
'copy_to_clipboard': 'Скопировать в буфер',
|
||||
'copy_success': 'Скопировано!',
|
||||
'copy_failure': 'Не удалось скопировать',
|
||||
},
|
||||
'zh-CN': {
|
||||
'copy': '复制',
|
||||
'copy_to_clipboard': '复制到剪贴板',
|
||||
'copy_success': '复制成功!',
|
||||
'copy_failure': '复制失败',
|
||||
},
|
||||
'it' : {
|
||||
'copy': 'Copiare',
|
||||
'copy_to_clipboard': 'Copiato negli appunti',
|
||||
'copy_success': 'Copiato!',
|
||||
'copy_failure': 'Errore durante la copia',
|
||||
}
|
||||
}
|
||||
|
||||
let locale = 'en'
|
||||
if( document.documentElement.lang !== undefined
|
||||
&& messages[document.documentElement.lang] !== undefined ) {
|
||||
locale = document.documentElement.lang
|
||||
}
|
||||
|
||||
let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT;
|
||||
if (doc_url_root == '#') {
|
||||
doc_url_root = '';
|
||||
}
|
||||
|
||||
/**
|
||||
* SVG files for our copy buttons
|
||||
*/
|
||||
let iconCheck = `<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-check" width="44" height="44" viewBox="0 0 24 24" stroke-width="2" stroke="#22863a" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||||
<title>${messages[locale]['copy_success']}</title>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<path d="M5 12l5 5l10 -10" />
|
||||
</svg>`
|
||||
|
||||
// If the user specified their own SVG use that, otherwise use the default
|
||||
let iconCopy = ``;
|
||||
if (!iconCopy) {
|
||||
iconCopy = `<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||||
<title>${messages[locale]['copy_to_clipboard']}</title>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<rect x="8" y="8" width="12" height="12" rx="2" />
|
||||
<path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2" />
|
||||
</svg>`
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up copy/paste for code blocks
|
||||
*/
|
||||
|
||||
const runWhenDOMLoaded = cb => {
|
||||
if (document.readyState != 'loading') {
|
||||
cb()
|
||||
} else if (document.addEventListener) {
|
||||
document.addEventListener('DOMContentLoaded', cb)
|
||||
} else {
|
||||
document.attachEvent('onreadystatechange', function() {
|
||||
if (document.readyState == 'complete') cb()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const codeCellId = index => `codecell${index}`
|
||||
|
||||
// Clears selected text since ClipboardJS will select the text when copying
|
||||
const clearSelection = () => {
|
||||
if (window.getSelection) {
|
||||
window.getSelection().removeAllRanges()
|
||||
} else if (document.selection) {
|
||||
document.selection.empty()
|
||||
}
|
||||
}
|
||||
|
||||
// Changes tooltip text for a moment, then changes it back
|
||||
// We want the timeout of our `success` class to be a bit shorter than the
|
||||
// tooltip and icon change, so that we can hide the icon before changing back.
|
||||
var timeoutIcon = 2000;
|
||||
var timeoutSuccessClass = 1500;
|
||||
|
||||
const temporarilyChangeTooltip = (el, oldText, newText) => {
|
||||
el.setAttribute('data-tooltip', newText)
|
||||
el.classList.add('success')
|
||||
// Remove success a little bit sooner than we change the tooltip
|
||||
// So that we can use CSS to hide the copybutton first
|
||||
setTimeout(() => el.classList.remove('success'), timeoutSuccessClass)
|
||||
setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon)
|
||||
}
|
||||
|
||||
// Changes the copy button icon for two seconds, then changes it back
|
||||
const temporarilyChangeIcon = (el) => {
|
||||
el.innerHTML = iconCheck;
|
||||
setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon)
|
||||
}
|
||||
|
||||
const addCopyButtonToCodeCells = () => {
|
||||
// If ClipboardJS hasn't loaded, wait a bit and try again. This
|
||||
// happens because we load ClipboardJS asynchronously.
|
||||
if (window.ClipboardJS === undefined) {
|
||||
setTimeout(addCopyButtonToCodeCells, 250)
|
||||
return
|
||||
}
|
||||
|
||||
// Add copybuttons to all of our code cells
|
||||
const COPYBUTTON_SELECTOR = 'div.highlight pre';
|
||||
const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR)
|
||||
codeCells.forEach((codeCell, index) => {
|
||||
const id = codeCellId(index)
|
||||
codeCell.setAttribute('id', id)
|
||||
|
||||
const clipboardButton = id =>
|
||||
`<button class="copybtn o-tooltip--left" data-tooltip="${messages[locale]['copy']}" data-clipboard-target="#${id}">
|
||||
${iconCopy}
|
||||
</button>`
|
||||
codeCell.insertAdjacentHTML('afterend', clipboardButton(id))
|
||||
})
|
||||
|
||||
function escapeRegExp(string) {
|
||||
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes excluded text from a Node.
|
||||
*
|
||||
* @param {Node} target Node to filter.
|
||||
* @param {string} exclude CSS selector of nodes to exclude.
|
||||
* @returns {DOMString} Text from `target` with text removed.
|
||||
*/
|
||||
function filterText(target, exclude) {
|
||||
const clone = target.cloneNode(true); // clone as to not modify the live DOM
|
||||
if (exclude) {
|
||||
// remove excluded nodes
|
||||
clone.querySelectorAll(exclude).forEach(node => node.remove());
|
||||
}
|
||||
return clone.innerText;
|
||||
}
|
||||
|
||||
// Callback when a copy button is clicked. Will be passed the node that was clicked
|
||||
// should then grab the text and replace pieces of text that shouldn't be used in output
|
||||
function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
|
||||
var regexp;
|
||||
var match;
|
||||
|
||||
// Do we check for line continuation characters and "HERE-documents"?
|
||||
var useLineCont = !!lineContinuationChar
|
||||
var useHereDoc = !!hereDocDelim
|
||||
|
||||
// create regexp to capture prompt and remaining line
|
||||
if (isRegexp) {
|
||||
regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
|
||||
} else {
|
||||
regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
|
||||
}
|
||||
|
||||
const outputLines = [];
|
||||
var promptFound = false;
|
||||
var gotLineCont = false;
|
||||
var gotHereDoc = false;
|
||||
const lineGotPrompt = [];
|
||||
for (const line of textContent.split('\n')) {
|
||||
match = line.match(regexp)
|
||||
if (match || gotLineCont || gotHereDoc) {
|
||||
promptFound = regexp.test(line)
|
||||
lineGotPrompt.push(promptFound)
|
||||
if (removePrompts && promptFound) {
|
||||
outputLines.push(match[2])
|
||||
} else {
|
||||
outputLines.push(line)
|
||||
}
|
||||
gotLineCont = line.endsWith(lineContinuationChar) & useLineCont
|
||||
if (line.includes(hereDocDelim) & useHereDoc)
|
||||
gotHereDoc = !gotHereDoc
|
||||
} else if (!onlyCopyPromptLines) {
|
||||
outputLines.push(line)
|
||||
} else if (copyEmptyLines && line.trim() === '') {
|
||||
outputLines.push(line)
|
||||
}
|
||||
}
|
||||
|
||||
// If no lines with the prompt were found then just use original lines
|
||||
if (lineGotPrompt.some(v => v === true)) {
|
||||
textContent = outputLines.join('\n');
|
||||
}
|
||||
|
||||
// Remove a trailing newline to avoid auto-running when pasting
|
||||
if (textContent.endsWith("\n")) {
|
||||
textContent = textContent.slice(0, -1)
|
||||
}
|
||||
return textContent
|
||||
}
|
||||
|
||||
|
||||
var copyTargetText = (trigger) => {
|
||||
var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
|
||||
|
||||
// get filtered text
|
||||
let exclude = '.linenos';
|
||||
|
||||
let text = filterText(target, exclude);
|
||||
return formatCopyText(text, '', false, true, true, true, '', '')
|
||||
}
|
||||
|
||||
// Initialize with a callback so we can modify the text before copy
|
||||
const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText})
|
||||
|
||||
// Update UI with error/success messages
|
||||
clipboard.on('success', event => {
|
||||
clearSelection()
|
||||
temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success'])
|
||||
temporarilyChangeIcon(event.trigger)
|
||||
})
|
||||
|
||||
clipboard.on('error', event => {
|
||||
temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure'])
|
||||
})
|
||||
}
|
||||
|
||||
runWhenDOMLoaded(addCopyButtonToCodeCells)
|
||||
73
html/_static/copybutton_funcs.js
Normal file
73
html/_static/copybutton_funcs.js
Normal file
@ -0,0 +1,73 @@
|
||||
function escapeRegExp(string) {
|
||||
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes excluded text from a Node.
|
||||
*
|
||||
* @param {Node} target Node to filter.
|
||||
* @param {string} exclude CSS selector of nodes to exclude.
|
||||
* @returns {DOMString} Text from `target` with text removed.
|
||||
*/
|
||||
export function filterText(target, exclude) {
|
||||
const clone = target.cloneNode(true); // clone as to not modify the live DOM
|
||||
if (exclude) {
|
||||
// remove excluded nodes
|
||||
clone.querySelectorAll(exclude).forEach(node => node.remove());
|
||||
}
|
||||
return clone.innerText;
|
||||
}
|
||||
|
||||
// Callback when a copy button is clicked. Will be passed the node that was clicked
|
||||
// should then grab the text and replace pieces of text that shouldn't be used in output
|
||||
export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
|
||||
var regexp;
|
||||
var match;
|
||||
|
||||
// Do we check for line continuation characters and "HERE-documents"?
|
||||
var useLineCont = !!lineContinuationChar
|
||||
var useHereDoc = !!hereDocDelim
|
||||
|
||||
// create regexp to capture prompt and remaining line
|
||||
if (isRegexp) {
|
||||
regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
|
||||
} else {
|
||||
regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
|
||||
}
|
||||
|
||||
const outputLines = [];
|
||||
var promptFound = false;
|
||||
var gotLineCont = false;
|
||||
var gotHereDoc = false;
|
||||
const lineGotPrompt = [];
|
||||
for (const line of textContent.split('\n')) {
|
||||
match = line.match(regexp)
|
||||
if (match || gotLineCont || gotHereDoc) {
|
||||
promptFound = regexp.test(line)
|
||||
lineGotPrompt.push(promptFound)
|
||||
if (removePrompts && promptFound) {
|
||||
outputLines.push(match[2])
|
||||
} else {
|
||||
outputLines.push(line)
|
||||
}
|
||||
gotLineCont = line.endsWith(lineContinuationChar) & useLineCont
|
||||
if (line.includes(hereDocDelim) & useHereDoc)
|
||||
gotHereDoc = !gotHereDoc
|
||||
} else if (!onlyCopyPromptLines) {
|
||||
outputLines.push(line)
|
||||
} else if (copyEmptyLines && line.trim() === '') {
|
||||
outputLines.push(line)
|
||||
}
|
||||
}
|
||||
|
||||
// If no lines with the prompt were found then just use original lines
|
||||
if (lineGotPrompt.some(v => v === true)) {
|
||||
textContent = outputLines.join('\n');
|
||||
}
|
||||
|
||||
// Remove a trailing newline to avoid auto-running when pasting
|
||||
if (textContent.endsWith("\n")) {
|
||||
textContent = textContent.slice(0, -1)
|
||||
}
|
||||
return textContent
|
||||
}
|
||||
1
html/_static/css/badge_only.css
Normal file
1
html/_static/css/badge_only.css
Normal file
@ -0,0 +1 @@
|
||||
.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
BIN
html/_static/css/fonts/Roboto-Slab-Bold.woff
Normal file
BIN
html/_static/css/fonts/Roboto-Slab-Bold.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/Roboto-Slab-Bold.woff2
Normal file
BIN
html/_static/css/fonts/Roboto-Slab-Bold.woff2
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/Roboto-Slab-Regular.woff
Normal file
BIN
html/_static/css/fonts/Roboto-Slab-Regular.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/Roboto-Slab-Regular.woff2
Normal file
BIN
html/_static/css/fonts/Roboto-Slab-Regular.woff2
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/fontawesome-webfont.eot
Normal file
BIN
html/_static/css/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
html/_static/css/fonts/fontawesome-webfont.svg
Normal file
2671
html/_static/css/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 434 KiB |
BIN
html/_static/css/fonts/fontawesome-webfont.ttf
Normal file
BIN
html/_static/css/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/fontawesome-webfont.woff
Normal file
BIN
html/_static/css/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/fontawesome-webfont.woff2
Normal file
BIN
html/_static/css/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-bold-italic.woff
Normal file
BIN
html/_static/css/fonts/lato-bold-italic.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-bold-italic.woff2
Normal file
BIN
html/_static/css/fonts/lato-bold-italic.woff2
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-bold.woff
Normal file
BIN
html/_static/css/fonts/lato-bold.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-bold.woff2
Normal file
BIN
html/_static/css/fonts/lato-bold.woff2
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-normal-italic.woff
Normal file
BIN
html/_static/css/fonts/lato-normal-italic.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-normal-italic.woff2
Normal file
BIN
html/_static/css/fonts/lato-normal-italic.woff2
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-normal.woff
Normal file
BIN
html/_static/css/fonts/lato-normal.woff
Normal file
Binary file not shown.
BIN
html/_static/css/fonts/lato-normal.woff2
Normal file
BIN
html/_static/css/fonts/lato-normal.woff2
Normal file
Binary file not shown.
4
html/_static/css/theme.css
Normal file
4
html/_static/css/theme.css
Normal file
File diff suppressed because one or more lines are too long
156
html/_static/doctools.js
Normal file
156
html/_static/doctools.js
Normal file
@ -0,0 +1,156 @@
|
||||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Base JavaScript utilities for all Sphinx HTML documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
|
||||
"TEXTAREA",
|
||||
"INPUT",
|
||||
"SELECT",
|
||||
"BUTTON",
|
||||
]);
|
||||
|
||||
const _ready = (callback) => {
|
||||
if (document.readyState !== "loading") {
|
||||
callback();
|
||||
} else {
|
||||
document.addEventListener("DOMContentLoaded", callback);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
const Documentation = {
|
||||
init: () => {
|
||||
Documentation.initDomainIndexTable();
|
||||
Documentation.initOnKeyListeners();
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS: {},
|
||||
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
|
||||
LOCALE: "unknown",
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext: (string) => {
|
||||
const translated = Documentation.TRANSLATIONS[string];
|
||||
switch (typeof translated) {
|
||||
case "undefined":
|
||||
return string; // no translation
|
||||
case "string":
|
||||
return translated; // translation exists
|
||||
default:
|
||||
return translated[0]; // (singular, plural) translation tuple exists
|
||||
}
|
||||
},
|
||||
|
||||
ngettext: (singular, plural, n) => {
|
||||
const translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated !== "undefined")
|
||||
return translated[Documentation.PLURAL_EXPR(n)];
|
||||
return n === 1 ? singular : plural;
|
||||
},
|
||||
|
||||
addTranslations: (catalog) => {
|
||||
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
|
||||
Documentation.PLURAL_EXPR = new Function(
|
||||
"n",
|
||||
`return (${catalog.plural_expr})`
|
||||
);
|
||||
Documentation.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to focus on search bar
|
||||
*/
|
||||
focusSearchBar: () => {
|
||||
document.querySelectorAll("input[name=q]")[0]?.focus();
|
||||
},
|
||||
|
||||
/**
|
||||
* Initialise the domain index toggle buttons
|
||||
*/
|
||||
initDomainIndexTable: () => {
|
||||
const toggler = (el) => {
|
||||
const idNumber = el.id.substr(7);
|
||||
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
|
||||
if (el.src.substr(-9) === "minus.png") {
|
||||
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
|
||||
toggledRows.forEach((el) => (el.style.display = "none"));
|
||||
} else {
|
||||
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
|
||||
toggledRows.forEach((el) => (el.style.display = ""));
|
||||
}
|
||||
};
|
||||
|
||||
const togglerElements = document.querySelectorAll("img.toggler");
|
||||
togglerElements.forEach((el) =>
|
||||
el.addEventListener("click", (event) => toggler(event.currentTarget))
|
||||
);
|
||||
togglerElements.forEach((el) => (el.style.display = ""));
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
|
||||
},
|
||||
|
||||
initOnKeyListeners: () => {
|
||||
// only install a listener if it is really needed
|
||||
if (
|
||||
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
|
||||
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
||||
)
|
||||
return;
|
||||
|
||||
document.addEventListener("keydown", (event) => {
|
||||
// bail for input elements
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
||||
// bail with special keys
|
||||
if (event.altKey || event.ctrlKey || event.metaKey) return;
|
||||
|
||||
if (!event.shiftKey) {
|
||||
switch (event.key) {
|
||||
case "ArrowLeft":
|
||||
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
||||
|
||||
const prevLink = document.querySelector('link[rel="prev"]');
|
||||
if (prevLink && prevLink.href) {
|
||||
window.location.href = prevLink.href;
|
||||
event.preventDefault();
|
||||
}
|
||||
break;
|
||||
case "ArrowRight":
|
||||
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
||||
|
||||
const nextLink = document.querySelector('link[rel="next"]');
|
||||
if (nextLink && nextLink.href) {
|
||||
window.location.href = nextLink.href;
|
||||
event.preventDefault();
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// some keyboard layouts may need Shift to get /
|
||||
switch (event.key) {
|
||||
case "/":
|
||||
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
||||
Documentation.focusSearchBar();
|
||||
event.preventDefault();
|
||||
}
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
const _ = Documentation.gettext;
|
||||
|
||||
_ready(Documentation.init);
|
||||
14
html/_static/documentation_options.js
Normal file
14
html/_static/documentation_options.js
Normal file
@ -0,0 +1,14 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '0.1.0',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
LINK_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
SHOW_SEARCH_SUMMARY: true,
|
||||
ENABLE_SEARCH_SHORTCUTS: true,
|
||||
};
|
||||
BIN
html/_static/file.png
Normal file
BIN
html/_static/file.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 286 B |
2
html/_static/jquery.js
vendored
Normal file
2
html/_static/jquery.js
vendored
Normal file
File diff suppressed because one or more lines are too long
1
html/_static/js/badge_only.js
Normal file
1
html/_static/js/badge_only.js
Normal file
@ -0,0 +1 @@
|
||||
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
||||
4
html/_static/js/html5shiv-printshiv.min.js
vendored
Normal file
4
html/_static/js/html5shiv-printshiv.min.js
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);
|
||||
4
html/_static/js/html5shiv.min.js
vendored
Normal file
4
html/_static/js/html5shiv.min.js
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
||||
1
html/_static/js/theme.js
Normal file
1
html/_static/js/theme.js
Normal file
File diff suppressed because one or more lines are too long
199
html/_static/language_data.js
Normal file
199
html/_static/language_data.js
Normal file
@ -0,0 +1,199 @@
|
||||
/*
|
||||
* language_data.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
|
||||
|
||||
|
||||
/* Non-minified version is copied as a separate JS file, is available */
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
BIN
html/_static/minus.png
Normal file
BIN
html/_static/minus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
BIN
html/_static/plus.png
Normal file
BIN
html/_static/plus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
74
html/_static/pygments.css
Normal file
74
html/_static/pygments.css
Normal file
@ -0,0 +1,74 @@
|
||||
pre { line-height: 125%; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
|
||||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
|
||||
.highlight .o { color: #666666 } /* Operator */
|
||||
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #9C6500 } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #E40000 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #008400 } /* Generic.Inserted */
|
||||
.highlight .go { color: #717171 } /* Generic.Output */
|
||||
.highlight .gp { color: #000080; 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: #008000; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #B00040 } /* Keyword.Type */
|
||||
.highlight .m { color: #666666 } /* Literal.Number */
|
||||
.highlight .s { color: #BA2121 } /* Literal.String */
|
||||
.highlight .na { color: #687822 } /* Name.Attribute */
|
||||
.highlight .nb { color: #008000 } /* Name.Builtin */
|
||||
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #880000 } /* Name.Constant */
|
||||
.highlight .nd { color: #AA22FF } /* Name.Decorator */
|
||||
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
|
||||
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #0000FF } /* Name.Function */
|
||||
.highlight .nl { color: #767600 } /* Name.Label */
|
||||
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
||||
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #19177C } /* Name.Variable */
|
||||
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #666666 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
|
||||
.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #008000 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #A45A77 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #19177C } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #19177C } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
|
||||
566
html/_static/searchtools.js
Normal file
566
html/_static/searchtools.js
Normal file
@ -0,0 +1,566 @@
|
||||
/*
|
||||
* searchtools.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
* Simple result scoring code.
|
||||
*/
|
||||
if (typeof Scorer === "undefined") {
|
||||
var Scorer = {
|
||||
// Implement the following function to further tweak the score for each result
|
||||
// The function takes a result array [docname, title, anchor, descr, score, filename]
|
||||
// and returns the new score.
|
||||
/*
|
||||
score: result => {
|
||||
const [docname, title, anchor, descr, score, filename] = result
|
||||
return score
|
||||
},
|
||||
*/
|
||||
|
||||
// query matches the full name of an object
|
||||
objNameMatch: 11,
|
||||
// or matches in the last dotted part of the object name
|
||||
objPartialMatch: 6,
|
||||
// Additive scores depending on the priority of the object
|
||||
objPrio: {
|
||||
0: 15, // used to be importantResults
|
||||
1: 5, // used to be objectResults
|
||||
2: -5, // used to be unimportantResults
|
||||
},
|
||||
// Used when the priority is not in the mapping.
|
||||
objPrioDefault: 0,
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5,
|
||||
partialTerm: 2,
|
||||
};
|
||||
}
|
||||
|
||||
const _removeChildren = (element) => {
|
||||
while (element && element.lastChild) element.removeChild(element.lastChild);
|
||||
};
|
||||
|
||||
/**
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
|
||||
*/
|
||||
const _escapeRegExp = (string) =>
|
||||
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
|
||||
|
||||
const _displayItem = (item, searchTerms) => {
|
||||
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
|
||||
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
|
||||
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
|
||||
|
||||
const [docName, title, anchor, descr, score, _filename] = item;
|
||||
|
||||
let listItem = document.createElement("li");
|
||||
let requestUrl;
|
||||
let linkUrl;
|
||||
if (docBuilder === "dirhtml") {
|
||||
// dirhtml builder
|
||||
let dirname = docName + "/";
|
||||
if (dirname.match(/\/index\/$/))
|
||||
dirname = dirname.substring(0, dirname.length - 6);
|
||||
else if (dirname === "index/") dirname = "";
|
||||
requestUrl = docUrlRoot + dirname;
|
||||
linkUrl = requestUrl;
|
||||
} else {
|
||||
// normal html builders
|
||||
requestUrl = docUrlRoot + docName + docFileSuffix;
|
||||
linkUrl = docName + docLinkSuffix;
|
||||
}
|
||||
let linkEl = listItem.appendChild(document.createElement("a"));
|
||||
linkEl.href = linkUrl + anchor;
|
||||
linkEl.dataset.score = score;
|
||||
linkEl.innerHTML = title;
|
||||
if (descr)
|
||||
listItem.appendChild(document.createElement("span")).innerHTML =
|
||||
" (" + descr + ")";
|
||||
else if (showSearchSummary)
|
||||
fetch(requestUrl)
|
||||
.then((responseData) => responseData.text())
|
||||
.then((data) => {
|
||||
if (data)
|
||||
listItem.appendChild(
|
||||
Search.makeSearchSummary(data, searchTerms)
|
||||
);
|
||||
});
|
||||
Search.output.appendChild(listItem);
|
||||
};
|
||||
const _finishSearch = (resultCount) => {
|
||||
Search.stopPulse();
|
||||
Search.title.innerText = _("Search Results");
|
||||
if (!resultCount)
|
||||
Search.status.innerText = Documentation.gettext(
|
||||
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
|
||||
);
|
||||
else
|
||||
Search.status.innerText = _(
|
||||
`Search finished, found ${resultCount} page(s) matching the search query.`
|
||||
);
|
||||
};
|
||||
const _displayNextItem = (
|
||||
results,
|
||||
resultCount,
|
||||
searchTerms
|
||||
) => {
|
||||
// results left, load the summary and display it
|
||||
// this is intended to be dynamic (don't sub resultsCount)
|
||||
if (results.length) {
|
||||
_displayItem(results.pop(), searchTerms);
|
||||
setTimeout(
|
||||
() => _displayNextItem(results, resultCount, searchTerms),
|
||||
5
|
||||
);
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else _finishSearch(resultCount);
|
||||
};
|
||||
|
||||
/**
|
||||
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
|
||||
* custom function per language.
|
||||
*
|
||||
* The regular expression works by splitting the string on consecutive characters
|
||||
* that are not Unicode letters, numbers, underscores, or emoji characters.
|
||||
* This is the same as ``\W+`` in Python, preserving the surrogate pair area.
|
||||
*/
|
||||
if (typeof splitQuery === "undefined") {
|
||||
var splitQuery = (query) => query
|
||||
.split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
|
||||
.filter(term => term) // remove remaining empty strings
|
||||
}
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
const Search = {
|
||||
_index: null,
|
||||
_queued_query: null,
|
||||
_pulse_status: -1,
|
||||
|
||||
htmlToText: (htmlString) => {
|
||||
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
|
||||
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
|
||||
const docContent = htmlElement.querySelector('[role="main"]');
|
||||
if (docContent !== undefined) return docContent.textContent;
|
||||
console.warn(
|
||||
"Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
|
||||
);
|
||||
return "";
|
||||
},
|
||||
|
||||
init: () => {
|
||||
const query = new URLSearchParams(window.location.search).get("q");
|
||||
document
|
||||
.querySelectorAll('input[name="q"]')
|
||||
.forEach((el) => (el.value = query));
|
||||
if (query) Search.performSearch(query);
|
||||
},
|
||||
|
||||
loadIndex: (url) =>
|
||||
(document.body.appendChild(document.createElement("script")).src = url),
|
||||
|
||||
setIndex: (index) => {
|
||||
Search._index = index;
|
||||
if (Search._queued_query !== null) {
|
||||
const query = Search._queued_query;
|
||||
Search._queued_query = null;
|
||||
Search.query(query);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex: () => Search._index !== null,
|
||||
|
||||
deferQuery: (query) => (Search._queued_query = query),
|
||||
|
||||
stopPulse: () => (Search._pulse_status = -1),
|
||||
|
||||
startPulse: () => {
|
||||
if (Search._pulse_status >= 0) return;
|
||||
|
||||
const pulse = () => {
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
Search.dots.innerText = ".".repeat(Search._pulse_status);
|
||||
if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
|
||||
};
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something (or wait until index is loaded)
|
||||
*/
|
||||
performSearch: (query) => {
|
||||
// create the required interface elements
|
||||
const searchText = document.createElement("h2");
|
||||
searchText.textContent = _("Searching");
|
||||
const searchSummary = document.createElement("p");
|
||||
searchSummary.classList.add("search-summary");
|
||||
searchSummary.innerText = "";
|
||||
const searchList = document.createElement("ul");
|
||||
searchList.classList.add("search");
|
||||
|
||||
const out = document.getElementById("search-results");
|
||||
Search.title = out.appendChild(searchText);
|
||||
Search.dots = Search.title.appendChild(document.createElement("span"));
|
||||
Search.status = out.appendChild(searchSummary);
|
||||
Search.output = out.appendChild(searchList);
|
||||
|
||||
const searchProgress = document.getElementById("search-progress");
|
||||
// Some themes don't use the search progress node
|
||||
if (searchProgress) {
|
||||
searchProgress.innerText = _("Preparing search...");
|
||||
}
|
||||
Search.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (Search.hasIndex()) Search.query(query);
|
||||
else Search.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query: (query) => {
|
||||
const filenames = Search._index.filenames;
|
||||
const docNames = Search._index.docnames;
|
||||
const titles = Search._index.titles;
|
||||
const allTitles = Search._index.alltitles;
|
||||
const indexEntries = Search._index.indexentries;
|
||||
|
||||
// stem the search terms and add them to the correct list
|
||||
const stemmer = new Stemmer();
|
||||
const searchTerms = new Set();
|
||||
const excludedTerms = new Set();
|
||||
const highlightTerms = new Set();
|
||||
const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
|
||||
splitQuery(query.trim()).forEach((queryTerm) => {
|
||||
const queryTermLower = queryTerm.toLowerCase();
|
||||
|
||||
// maybe skip this "word"
|
||||
// stopwords array is from language_data.js
|
||||
if (
|
||||
stopwords.indexOf(queryTermLower) !== -1 ||
|
||||
queryTerm.match(/^\d+$/)
|
||||
)
|
||||
return;
|
||||
|
||||
// stem the word
|
||||
let word = stemmer.stemWord(queryTermLower);
|
||||
// select the correct list
|
||||
if (word[0] === "-") excludedTerms.add(word.substr(1));
|
||||
else {
|
||||
searchTerms.add(word);
|
||||
highlightTerms.add(queryTermLower);
|
||||
}
|
||||
});
|
||||
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
|
||||
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
|
||||
}
|
||||
|
||||
// console.debug("SEARCH: searching for:");
|
||||
// console.info("required: ", [...searchTerms]);
|
||||
// console.info("excluded: ", [...excludedTerms]);
|
||||
|
||||
// array of [docname, title, anchor, descr, score, filename]
|
||||
let results = [];
|
||||
_removeChildren(document.getElementById("search-progress"));
|
||||
|
||||
const queryLower = query.toLowerCase();
|
||||
for (const [title, foundTitles] of Object.entries(allTitles)) {
|
||||
if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
|
||||
for (const [file, id] of foundTitles) {
|
||||
let score = Math.round(100 * queryLower.length / title.length)
|
||||
results.push([
|
||||
docNames[file],
|
||||
titles[file] !== title ? `${titles[file]} > ${title}` : title,
|
||||
id !== null ? "#" + id : "",
|
||||
null,
|
||||
score,
|
||||
filenames[file],
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// search for explicit entries in index directives
|
||||
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
|
||||
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
|
||||
for (const [file, id] of foundEntries) {
|
||||
let score = Math.round(100 * queryLower.length / entry.length)
|
||||
results.push([
|
||||
docNames[file],
|
||||
titles[file],
|
||||
id ? "#" + id : "",
|
||||
null,
|
||||
score,
|
||||
filenames[file],
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// lookup as object
|
||||
objectTerms.forEach((term) =>
|
||||
results.push(...Search.performObjectSearch(term, objectTerms))
|
||||
);
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort((a, b) => {
|
||||
const leftScore = a[4];
|
||||
const rightScore = b[4];
|
||||
if (leftScore === rightScore) {
|
||||
// same score: sort alphabetically
|
||||
const leftTitle = a[1].toLowerCase();
|
||||
const rightTitle = b[1].toLowerCase();
|
||||
if (leftTitle === rightTitle) return 0;
|
||||
return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
|
||||
}
|
||||
return leftScore > rightScore ? 1 : -1;
|
||||
});
|
||||
|
||||
// remove duplicate search results
|
||||
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
|
||||
let seen = new Set();
|
||||
results = results.reverse().reduce((acc, result) => {
|
||||
let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
|
||||
if (!seen.has(resultStr)) {
|
||||
acc.push(result);
|
||||
seen.add(resultStr);
|
||||
}
|
||||
return acc;
|
||||
}, []);
|
||||
|
||||
results = results.reverse();
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
// console.info("search results:", Search.lastresults);
|
||||
|
||||
// print the results
|
||||
_displayNextItem(results, results.length, searchTerms);
|
||||
},
|
||||
|
||||
/**
|
||||
* search for object names
|
||||
*/
|
||||
performObjectSearch: (object, objectTerms) => {
|
||||
const filenames = Search._index.filenames;
|
||||
const docNames = Search._index.docnames;
|
||||
const objects = Search._index.objects;
|
||||
const objNames = Search._index.objnames;
|
||||
const titles = Search._index.titles;
|
||||
|
||||
const results = [];
|
||||
|
||||
const objectSearchCallback = (prefix, match) => {
|
||||
const name = match[4]
|
||||
const fullname = (prefix ? prefix + "." : "") + name;
|
||||
const fullnameLower = fullname.toLowerCase();
|
||||
if (fullnameLower.indexOf(object) < 0) return;
|
||||
|
||||
let score = 0;
|
||||
const parts = fullnameLower.split(".");
|
||||
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullnameLower === object || parts.slice(-1)[0] === object)
|
||||
score += Scorer.objNameMatch;
|
||||
else if (parts.slice(-1)[0].indexOf(object) > -1)
|
||||
score += Scorer.objPartialMatch; // matches in last name
|
||||
|
||||
const objName = objNames[match[1]][2];
|
||||
const title = titles[match[0]];
|
||||
|
||||
// If more than one term searched for, we require other words to be
|
||||
// found in the name/title/description
|
||||
const otherTerms = new Set(objectTerms);
|
||||
otherTerms.delete(object);
|
||||
if (otherTerms.size > 0) {
|
||||
const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
|
||||
if (
|
||||
[...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
|
||||
)
|
||||
return;
|
||||
}
|
||||
|
||||
let anchor = match[3];
|
||||
if (anchor === "") anchor = fullname;
|
||||
else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
|
||||
|
||||
const descr = objName + _(", in ") + title;
|
||||
|
||||
// add custom score for some objects according to scorer
|
||||
if (Scorer.objPrio.hasOwnProperty(match[2]))
|
||||
score += Scorer.objPrio[match[2]];
|
||||
else score += Scorer.objPrioDefault;
|
||||
|
||||
results.push([
|
||||
docNames[match[0]],
|
||||
fullname,
|
||||
"#" + anchor,
|
||||
descr,
|
||||
score,
|
||||
filenames[match[0]],
|
||||
]);
|
||||
};
|
||||
Object.keys(objects).forEach((prefix) =>
|
||||
objects[prefix].forEach((array) =>
|
||||
objectSearchCallback(prefix, array)
|
||||
)
|
||||
);
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch: (searchTerms, excludedTerms) => {
|
||||
// prepare search
|
||||
const terms = Search._index.terms;
|
||||
const titleTerms = Search._index.titleterms;
|
||||
const filenames = Search._index.filenames;
|
||||
const docNames = Search._index.docnames;
|
||||
const titles = Search._index.titles;
|
||||
|
||||
const scoreMap = new Map();
|
||||
const fileMap = new Map();
|
||||
|
||||
// perform the search on the required terms
|
||||
searchTerms.forEach((word) => {
|
||||
const files = [];
|
||||
const arr = [
|
||||
{ files: terms[word], score: Scorer.term },
|
||||
{ files: titleTerms[word], score: Scorer.title },
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
const escapedWord = _escapeRegExp(word);
|
||||
Object.keys(terms).forEach((term) => {
|
||||
if (term.match(escapedWord) && !terms[word])
|
||||
arr.push({ files: terms[term], score: Scorer.partialTerm });
|
||||
});
|
||||
Object.keys(titleTerms).forEach((term) => {
|
||||
if (term.match(escapedWord) && !titleTerms[word])
|
||||
arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
|
||||
});
|
||||
}
|
||||
|
||||
// no match but word was a required one
|
||||
if (arr.every((record) => record.files === undefined)) return;
|
||||
|
||||
// found search word in contents
|
||||
arr.forEach((record) => {
|
||||
if (record.files === undefined) return;
|
||||
|
||||
let recordFiles = record.files;
|
||||
if (recordFiles.length === undefined) recordFiles = [recordFiles];
|
||||
files.push(...recordFiles);
|
||||
|
||||
// set score for the word in each file
|
||||
recordFiles.forEach((file) => {
|
||||
if (!scoreMap.has(file)) scoreMap.set(file, {});
|
||||
scoreMap.get(file)[word] = record.score;
|
||||
});
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
files.forEach((file) => {
|
||||
if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
|
||||
fileMap.get(file).push(word);
|
||||
else fileMap.set(file, [word]);
|
||||
});
|
||||
});
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
const results = [];
|
||||
for (const [file, wordList] of fileMap) {
|
||||
// check if all requirements are matched
|
||||
|
||||
// as search terms with length < 3 are discarded
|
||||
const filteredTermCount = [...searchTerms].filter(
|
||||
(term) => term.length > 2
|
||||
).length;
|
||||
if (
|
||||
wordList.length !== searchTerms.size &&
|
||||
wordList.length !== filteredTermCount
|
||||
)
|
||||
continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
if (
|
||||
[...excludedTerms].some(
|
||||
(term) =>
|
||||
terms[term] === file ||
|
||||
titleTerms[term] === file ||
|
||||
(terms[term] || []).includes(file) ||
|
||||
(titleTerms[term] || []).includes(file)
|
||||
)
|
||||
)
|
||||
break;
|
||||
|
||||
// select one (max) score for the file.
|
||||
const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
|
||||
// add result to the result list
|
||||
results.push([
|
||||
docNames[file],
|
||||
titles[file],
|
||||
"",
|
||||
null,
|
||||
score,
|
||||
filenames[file],
|
||||
]);
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words.
|
||||
*/
|
||||
makeSearchSummary: (htmlText, keywords) => {
|
||||
const text = Search.htmlToText(htmlText);
|
||||
if (text === "") return null;
|
||||
|
||||
const textLower = text.toLowerCase();
|
||||
const actualStartPosition = [...keywords]
|
||||
.map((k) => textLower.indexOf(k.toLowerCase()))
|
||||
.filter((i) => i > -1)
|
||||
.slice(-1)[0];
|
||||
const startWithContext = Math.max(actualStartPosition - 120, 0);
|
||||
|
||||
const top = startWithContext === 0 ? "" : "...";
|
||||
const tail = startWithContext + 240 < text.length ? "..." : "";
|
||||
|
||||
let summary = document.createElement("p");
|
||||
summary.classList.add("context");
|
||||
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
|
||||
|
||||
return summary;
|
||||
},
|
||||
};
|
||||
|
||||
_ready(Search.init);
|
||||
144
html/_static/sphinx_highlight.js
Normal file
144
html/_static/sphinx_highlight.js
Normal file
@ -0,0 +1,144 @@
|
||||
/* Highlighting utilities for Sphinx HTML documentation. */
|
||||
"use strict";
|
||||
|
||||
const SPHINX_HIGHLIGHT_ENABLED = true
|
||||
|
||||
/**
|
||||
* highlight a given string on a node by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
const _highlight = (node, addItems, text, className) => {
|
||||
if (node.nodeType === Node.TEXT_NODE) {
|
||||
const val = node.nodeValue;
|
||||
const parent = node.parentNode;
|
||||
const pos = val.toLowerCase().indexOf(text);
|
||||
if (
|
||||
pos >= 0 &&
|
||||
!parent.classList.contains(className) &&
|
||||
!parent.classList.contains("nohighlight")
|
||||
) {
|
||||
let span;
|
||||
|
||||
const closestNode = parent.closest("body, svg, foreignObject");
|
||||
const isInSVG = closestNode && closestNode.matches("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.classList.add(className);
|
||||
}
|
||||
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
parent.insertBefore(
|
||||
span,
|
||||
parent.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling
|
||||
)
|
||||
);
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
|
||||
if (isInSVG) {
|
||||
const rect = document.createElementNS(
|
||||
"http://www.w3.org/2000/svg",
|
||||
"rect"
|
||||
);
|
||||
const bbox = parent.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute("class", className);
|
||||
addItems.push({ parent: parent, target: rect });
|
||||
}
|
||||
}
|
||||
} else if (node.matches && !node.matches("button, select, textarea")) {
|
||||
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
|
||||
}
|
||||
};
|
||||
const _highlightText = (thisNode, text, className) => {
|
||||
let addItems = [];
|
||||
_highlight(thisNode, addItems, text, className);
|
||||
addItems.forEach((obj) =>
|
||||
obj.parent.insertAdjacentElement("beforebegin", obj.target)
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
const SphinxHighlight = {
|
||||
|
||||
/**
|
||||
* highlight the search words provided in localstorage in the text
|
||||
*/
|
||||
highlightSearchWords: () => {
|
||||
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
|
||||
|
||||
// get and clear terms from localstorage
|
||||
const url = new URL(window.location);
|
||||
const highlight =
|
||||
localStorage.getItem("sphinx_highlight_terms")
|
||||
|| url.searchParams.get("highlight")
|
||||
|| "";
|
||||
localStorage.removeItem("sphinx_highlight_terms")
|
||||
url.searchParams.delete("highlight");
|
||||
window.history.replaceState({}, "", url);
|
||||
|
||||
// get individual terms from highlight string
|
||||
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
|
||||
if (terms.length === 0) return; // nothing to do
|
||||
|
||||
// There should never be more than one element matching "div.body"
|
||||
const divBody = document.querySelectorAll("div.body");
|
||||
const body = divBody.length ? divBody[0] : document.querySelector("body");
|
||||
window.setTimeout(() => {
|
||||
terms.forEach((term) => _highlightText(body, term, "highlighted"));
|
||||
}, 10);
|
||||
|
||||
const searchBox = document.getElementById("searchbox");
|
||||
if (searchBox === null) return;
|
||||
searchBox.appendChild(
|
||||
document
|
||||
.createRange()
|
||||
.createContextualFragment(
|
||||
'<p class="highlight-link">' +
|
||||
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
|
||||
_("Hide Search Matches") +
|
||||
"</a></p>"
|
||||
)
|
||||
);
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords: () => {
|
||||
document
|
||||
.querySelectorAll("#searchbox .highlight-link")
|
||||
.forEach((el) => el.remove());
|
||||
document
|
||||
.querySelectorAll("span.highlighted")
|
||||
.forEach((el) => el.classList.remove("highlighted"));
|
||||
localStorage.removeItem("sphinx_highlight_terms")
|
||||
},
|
||||
|
||||
initEscapeListener: () => {
|
||||
// only install a listener if it is really needed
|
||||
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
|
||||
|
||||
document.addEventListener("keydown", (event) => {
|
||||
// bail for input elements
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
||||
// bail with special keys
|
||||
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
|
||||
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
|
||||
SphinxHighlight.hideSearchWords();
|
||||
event.preventDefault();
|
||||
}
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
_ready(SphinxHighlight.highlightSearchWords);
|
||||
_ready(SphinxHighlight.initEscapeListener);
|
||||
149
html/aki_prj23_transparenzregister.black_test.html
Normal file
149
html/aki_prj23_transparenzregister.black_test.html
Normal file
@ -0,0 +1,149 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>aki_prj23_transparenzregister.black_test module — transparenzregister 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/clipboard.min.js"></script>
|
||||
<script src="_static/copybutton.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="aki_prj23_transparenzregister.flake8_test module" href="aki_prj23_transparenzregister.flake8_test.html" />
|
||||
<link rel="prev" title="aki_prj23_transparenzregister package" href="aki_prj23_transparenzregister.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
transparenzregister
|
||||
</a>
|
||||
<div class="version">
|
||||
0.1.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Pflichtenheft.html">Pflichtenheft: Kapitalgesellschaften referenzregister</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="aki_prj23_transparenzregister.html">aki_prj23_transparenzregister package</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="aki_prj23_transparenzregister.html#submodules">Submodules</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">aki_prj23_transparenzregister.black_test module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="aki_prj23_transparenzregister.flake8_test.html">aki_prj23_transparenzregister.flake8_test module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="aki_prj23_transparenzregister.html#module-aki_prj23_transparenzregister">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">transparenzregister</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="modules.html">aki_prj23_transparenzregister</a></li>
|
||||
<li class="breadcrumb-item"><a href="aki_prj23_transparenzregister.html">aki_prj23_transparenzregister package</a></li>
|
||||
<li class="breadcrumb-item active">aki_prj23_transparenzregister.black_test module</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/aki_prj23_transparenzregister.black_test.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="module-aki_prj23_transparenzregister.black_test">
|
||||
<span id="aki-prj23-transparenzregister-black-test-module"></span><h1>aki_prj23_transparenzregister.black_test module<a class="headerlink" href="#module-aki_prj23_transparenzregister.black_test" title="Permalink to this heading"></a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="aki_prj23_transparenzregister.html" class="btn btn-neutral float-left" title="aki_prj23_transparenzregister package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="aki_prj23_transparenzregister.flake8_test.html" class="btn btn-neutral float-right" title="aki_prj23_transparenzregister.flake8_test module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, AKI PRJ23.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
147
html/aki_prj23_transparenzregister.flake8_test.html
Normal file
147
html/aki_prj23_transparenzregister.flake8_test.html
Normal file
@ -0,0 +1,147 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>aki_prj23_transparenzregister.flake8_test module — transparenzregister 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/clipboard.min.js"></script>
|
||||
<script src="_static/copybutton.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="aki_prj23_transparenzregister.black_test module" href="aki_prj23_transparenzregister.black_test.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
transparenzregister
|
||||
</a>
|
||||
<div class="version">
|
||||
0.1.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Pflichtenheft.html">Pflichtenheft: Kapitalgesellschaften referenzregister</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="aki_prj23_transparenzregister.html">aki_prj23_transparenzregister package</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="aki_prj23_transparenzregister.html#submodules">Submodules</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="aki_prj23_transparenzregister.black_test.html">aki_prj23_transparenzregister.black_test module</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">aki_prj23_transparenzregister.flake8_test module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="aki_prj23_transparenzregister.html#module-aki_prj23_transparenzregister">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">transparenzregister</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="modules.html">aki_prj23_transparenzregister</a></li>
|
||||
<li class="breadcrumb-item"><a href="aki_prj23_transparenzregister.html">aki_prj23_transparenzregister package</a></li>
|
||||
<li class="breadcrumb-item active">aki_prj23_transparenzregister.flake8_test module</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/aki_prj23_transparenzregister.flake8_test.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="aki-prj23-transparenzregister-flake8-test-module">
|
||||
<h1>aki_prj23_transparenzregister.flake8_test module<a class="headerlink" href="#aki-prj23-transparenzregister-flake8-test-module" title="Permalink to this heading"></a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="aki_prj23_transparenzregister.black_test.html" class="btn btn-neutral float-left" title="aki_prj23_transparenzregister.black_test module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, AKI PRJ23.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
162
html/aki_prj23_transparenzregister.html
Normal file
162
html/aki_prj23_transparenzregister.html
Normal file
@ -0,0 +1,162 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>aki_prj23_transparenzregister package — transparenzregister 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/clipboard.min.js"></script>
|
||||
<script src="_static/copybutton.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="aki_prj23_transparenzregister.black_test module" href="aki_prj23_transparenzregister.black_test.html" />
|
||||
<link rel="prev" title="aki_prj23_transparenzregister" href="modules.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
transparenzregister
|
||||
</a>
|
||||
<div class="version">
|
||||
0.1.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Pflichtenheft.html">Pflichtenheft: Kapitalgesellschaften referenzregister</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">aki_prj23_transparenzregister package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="aki_prj23_transparenzregister.black_test.html">aki_prj23_transparenzregister.black_test module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="aki_prj23_transparenzregister.flake8_test.html">aki_prj23_transparenzregister.flake8_test module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-aki_prj23_transparenzregister">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">transparenzregister</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="modules.html">aki_prj23_transparenzregister</a></li>
|
||||
<li class="breadcrumb-item active">aki_prj23_transparenzregister package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/aki_prj23_transparenzregister.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="aki-prj23-transparenzregister-package">
|
||||
<h1>aki_prj23_transparenzregister package<a class="headerlink" href="#aki-prj23-transparenzregister-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="aki_prj23_transparenzregister.black_test.html">aki_prj23_transparenzregister.black_test module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="aki_prj23_transparenzregister.flake8_test.html">aki_prj23_transparenzregister.flake8_test module</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="module-aki_prj23_transparenzregister">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-aki_prj23_transparenzregister" title="Permalink to this heading"></a></h2>
|
||||
<p>A project analysing the german transparenzregister and other data sources.</p>
|
||||
<p>to find shared business interests and shared personal and other links for lots of companies</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="modules.html" class="btn btn-neutral float-left" title="aki_prj23_transparenzregister" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="aki_prj23_transparenzregister.black_test.html" class="btn btn-neutral float-right" title="aki_prj23_transparenzregister.black_test module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, AKI PRJ23.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
173
html/genindex.html
Normal file
173
html/genindex.html
Normal file
@ -0,0 +1,173 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — transparenzregister 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/clipboard.min.js"></script>
|
||||
<script src="_static/copybutton.js"></script>
|
||||
<script src="https://unpkg.com/mermaid@10.2.0/dist/mermaid.min.js"></script>
|
||||
<script>mermaid.initialize({startOnLoad:true});</script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
transparenzregister
|
||||
</a>
|
||||
<div class="version">
|
||||
0.1.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Pflichtenheft.html">Pflichtenheft: Kapitalgesellschaften referenzregister</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">transparenzregister</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Index</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#A"><strong>A</strong></a>
|
||||
| <a href="#M"><strong>M</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="A">A</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li>
|
||||
aki_prj23_transparenzregister
|
||||
|
||||
<ul>
|
||||
<li><a href="aki_prj23_transparenzregister.html#module-aki_prj23_transparenzregister">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li>
|
||||
aki_prj23_transparenzregister.black_test
|
||||
|
||||
<ul>
|
||||
<li><a href="aki_prj23_transparenzregister.black_test.html#module-aki_prj23_transparenzregister.black_test">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="M">M</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li>
|
||||
module
|
||||
|
||||
<ul>
|
||||
<li><a href="aki_prj23_transparenzregister.html#module-aki_prj23_transparenzregister">aki_prj23_transparenzregister</a>
|
||||
</li>
|
||||
<li><a href="aki_prj23_transparenzregister.black_test.html#module-aki_prj23_transparenzregister.black_test">aki_prj23_transparenzregister.black_test</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, AKI PRJ23.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
292
html/index.html
Normal file
292
html/index.html
Normal file
@ -0,0 +1,292 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Transparenzregister Documentation — transparenzregister 0.1.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/clipboard.min.js"></script>
|
||||
<script src="_static/copybutton.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Pflichtenheft: Kapitalgesellschaften referenzregister" href="Pflichtenheft.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="#" class="icon icon-home">
|
||||
transparenzregister
|
||||
</a>
|
||||
<div class="version">
|
||||
0.1.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Pflichtenheft.html">Pflichtenheft: Kapitalgesellschaften referenzregister</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="#">transparenzregister</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Transparenzregister Documentation</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="transparenzregister-documentation">
|
||||
<h1>Transparenzregister Documentation<a class="headerlink" href="#transparenzregister-documentation" title="Permalink to this heading"></a></h1>
|
||||
<p>This is the documentation for the AKI project group on the german transparenzregister and an Analysis there of.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Project planing</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Pflichtenheft.html">Pflichtenheft: Kapitalgesellschaften referenzregister</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#historie-der-dokumentenversion">Historie der Dokumentenversion <a name="historie"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#inhaltsverzeichnis">Inhaltsverzeichnis <a name="inhaltsverzeichnis"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#einleitung">Einleitung <a name="einleitung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#allgemeines">Allgemeines <a name="allgemeines"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#ziel-und-zweck-des-dokuments">Ziel und Zweck des Dokuments <a name="ziel/zweck"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#ausgangssituation">Ausgangssituation <a name="ausgangssituation"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#projektbezug">Projektbezug <a name="projektbezug"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#abkurzungen">Abkürzungen <a name="abkürzungen"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#schnittstellen-bezug-zu-anderen-dokumenten">Schnittstellen/ Bezug zu anderen Dokumenten <a name="schnittstellen"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#konzept-und-rahmenbedingungen">Konzept und Rahmenbedingungen <a name="konzept_und_rahmenbedingung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#ziele-des-anbieters">Ziele des Anbieters <a name="ziele_anbieter"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#ziele-und-nutzen-des-anwenders">Ziele und Nutzen des Anwenders <a name="ziele_anwender"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#benutzer-zielgruppen">Benutzer / Zielgruppen <a name="benutzer/zielgruppen"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#systemvoraussetzungen-optional">Systemvoraussetzungen (Optional) <a name="systemvoraussetzungen"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#ressourcen-optional">Ressourcen (Optional) <a name="ressourcen"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#funktionale-anforderungen">Funktionale Anforderungen <a name="f_anforderung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#muss-ziele"><strong>Muss Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#f100">F100 <a name="f100"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#f110">F110 <a name="f110"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#f120">F120 <a name="f120"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#soll-ziele"><strong>Soll Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#f200">F200 <a name="f200"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#f210">F210 <a name="f210"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#f220">F220 <a name="f220"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#nicht-funktionale-anforderungen">Nicht-Funktionale Anforderungen <a name="nf_anforderung"></a></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#id1"><strong>Muss Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#n100">N100 <a name="n100"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#id2"><strong>Soll Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#n200">N200 <a name="n200"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#n210">N210 <a name="n210"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#kann-ziele"><strong>Kann Ziele</strong></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#n300">N300 <a name="n300"></a></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="Pflichtenheft.html#n310">N310 <a name="n310"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#anforderungsverfolgung-zu-den-spezifikationen">Anforderungsverfolgung zu den Spezifikationen <a name="verfolgung_spezifikation"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#abnahmekriterien-und-vorgehen-zur-ausgangsprufung">Abnahmekriterien und Vorgehen zur Ausgangsprüfung <a name="abnahmekriterien"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#lieferumfang">Lieferumfang <a name="lieferumfang"></a></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Pflichtenheft.html#anhang-ressourcen">Anhang / Ressourcen <a name="anhang/ressourcen"></a></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Meeting Notes:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-03-30.html">Weekly <em>1</em>: 30.03.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-04-13.html">Weekly <em>2</em>: 13.04.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-04.html">Weekly <em>3</em>: 04.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023-05-11.html">Weekly <em>4</em>: 11.05.2023</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="meeting-notes/Meeting_2023_05-25.html">Weekly <em>5</em>: 25.05.2023</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Research</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html">Von der Problemstellung zum Lösungskonzept</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#requirements-engineering-transparenzregister">Requirements Engineering Transparenzregister</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#anforderungen-aus-projektvorstellung">1. Anforderungen aus Projektvorstellung</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#identifikation-von-anforderungen-innerhalb-der-gruppe">2. Identifikation von Anforderungen innerhalb der Gruppe</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#identifikation-von-domanen-zur-losungsfindung">3. Identifikation von Domänen zur Lösungsfindung</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#technische-fachliche-losungen">4. technische/fachliche Lösungen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#priorisierung-von-anforderungen">5. Priorisierung von Anforderungen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/RE_Vom-Problem-zur-Loesung.html#pflichtenheft">6. Pflichtenheft</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html">Daten und Kennzahlen von Unternehmen</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#basisdaten-der-firma">Basisdaten der Firma</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#personen">Personen</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#bewertung-der-grosze-der-kapitalgesellschaft">Bewertung der Größe der Kapitalgesellschaft</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#kennzahlen-bei-aktiengesellschaften">Kennzahlen bei Aktiengesellschaften</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#mogliche-kennzahlen-zur-unternehmensbewertung">Mögliche Kennzahlen zur Unternehmensbewertung</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#erfolgskennzahlen">Erfolgskennzahlen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#finanzkennzahlen">Finanzkennzahlen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#rentabilitatskennzahlen">Rentabilitätskennzahlen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#nichtfinanzielle-kennzahlen"><em>Nichtfinanzielle Kennzahlen</em></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#gewunschte-kennzahlen">Gewünschte Kennzahlen</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/data_and_metrics.html#kurzdefinitionen">Kurzdefinitionen</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#umsatz-erlos">Umsatz (Erlös)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#ebit-earnings-before-interest-and-taxes-gewinn-vor-zinsen-und-steuern-betriebsergebnis-operativer-gewinn">EBIT (Earnings Before Interest and Taxes/Gewinn vor Zinsen und Steuern/Betriebsergebnis/Operativer Gewinn)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#ebit-marge">EBIT-Marge</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#bilanzsumme-gesamtvermogen-gesamtkapital">Bilanzsumme (Gesamtvermögen/Gesamtkapital)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#eigenkapitalquote">Eigenkapitalquote</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#fremdkapitalquote">Fremdkapitalquote</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#verschuldungsgrad">Verschuldungsgrad</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#eigenkapitalrentabilitat-return-on-equity-roe">Eigenkapitalrentabilität (Return on Equity ROE)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#gesamtkapitalumschlag-kapitalumschlag-umschlagshaufigkeit">Gesamtkapitalumschlag (Kapitalumschlag/Umschlagshäufigkeit)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#umsatzrentabilitat-umsatzrendite-umsatzmarge-nettomarge">Umsatzrentabilität (Umsatzrendite/Umsatzmarge/Nettomarge)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/data_and_metrics.html#gesamtkapitalrentabilitat-return-on-investment-roi-kapitalrendite">Gesamtkapitalrentabilität (Return on Investment ROI, Kapitalrendite)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/data_and_metrics.html#fazit">Fazit</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/news_apis.html">Nachrichtenquellen</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#twitter-api-v2"><strong>Twitter API v2</strong></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/news_apis.html#access-levels"><strong>Access Levels</strong></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#newsapi"><strong>NewsAPI</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#bloomberg-api"><strong>Bloomberg API</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#new-york-times-api"><strong>New York Times API</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#presseportal"><strong>PressePortal</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#tagesschau-api-2-0"><strong>Tagesschau API 2.0</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#yahoo-finance-api"><strong>Yahoo finance API</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#google-news-api"><strong>Google News API</strong></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/news_apis.html#sonstiges"><strong>Sonstiges</strong></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="research/resarch-central.html">Research Central</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="research/resarch-central.html#sentiment-analysis">Sentiment Analysis</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="research/resarch-central.html#finbert">FinBert</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">aki_prj23_transparenzregister</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="aki_prj23_transparenzregister.html">aki_prj23_transparenzregister package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="aki_prj23_transparenzregister.html#submodules">Submodules</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="aki_prj23_transparenzregister.black_test.html">aki_prj23_transparenzregister.black_test module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="aki_prj23_transparenzregister.flake8_test.html">aki_prj23_transparenzregister.flake8_test module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="aki_prj23_transparenzregister.html#module-aki_prj23_transparenzregister">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="Pflichtenheft.html" class="btn btn-neutral float-right" title="Pflichtenheft: Kapitalgesellschaften referenzregister" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, AKI PRJ23.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user