Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Story 1 - Minimaler API-Viewer #5

Closed
2 tasks done
lars-reimann opened this issue May 14, 2021 · 2 comments
Closed
2 tasks done

Story 1 - Minimaler API-Viewer #5

lars-reimann opened this issue May 14, 2021 · 2 comments
Assignees
@leonschmitz @Vengos
Labels
enhancement 💡 New feature or request

Comments

@lars-reimann
Copy link
Member

lars-reimann commented May 14, 2021 •
edited
Loading

To do:

Links TreeView-Artige Anzeige aller Module, Klassen und Methoden aus dem API.
Rechts daneben die Parameter der links selektierten Methode. Idealerweise untereinander gelayoutet, um den Platz besser auszunutzen.
Es sollen nur die Methoden / Funktionen / Konstruktoren selektierbar sein, denn es geht nur um Elemente, die Parameter haben.

Anforderungen:

  • Es muss auch bei großer Struktur noch übersichtlich sein.
  • Soll auch auf Laptop und iPad des Kunden nutzbar sein, Handys sind kein Thema.
  • Soll im Browser laufen und damit auch zB auf dem Handy oder Ipad. Also Layout, das auch mit wenig Platz auskommt.

Abnahmekriterium: Scikit learn library als Beispiel-API. Beliebig durch das APi naviegieren können.

Man muss eine Möglichkeit haben, dem Tool zu sagen, wo die zu analysierende Bibliothek liegt. Von dort aus soll der Viewer selbst die Analyse und Präsentation erledigen. -> Als erster Schritt dürfen wir annehmen, dass der Input als JSON-Datei vorliegt. (Technischer Input: Es gibt ein Tool, das die Bibliothek parst und als JSON zur Verfügung stellt.)
@lars-reimann lars-reimann added the enhancement 💡 New feature or request label May 14, 2021
@lars-reimann lars-reimann added this to the Sprint 2 milestone May 14, 2021
@lars-reimann lars-reimann modified the milestones: Sprint 2, Sprint 3 Jun 26, 2021
@lars-reimann lars-reimann modified the milestones: Sprint 3, Sprint 4 Jul 2, 2021
@lars-reimann
Copy link
Member Author

lars-reimann commented Jul 16, 2021 •
edited
Loading

Die referenzierten Tasks sind beide fertig, steht bei dieser Story sonst noch etwas aus oder kann sie auch geschlossen werden? Wenn es noch weitere Tasks gibt, diese bitte verlinken.

@lars-reimann lars-reimann added story and removed story labels Jul 17, 2021
@leonschmitz
Copy link
Contributor

Ich bin Freitag nur noch nicht dazu gekommen mir einen Überblick zu verschaffen. Ich erledige das gleich.

lars-reimann pushed a commit that referenced this issue Mar 19, 2023
@dependabot
build(deps): Bump mkdocs-glightbox from 0.3.1 to 0.3.2 in /docs (#1294)
8564418 
Bumps [mkdocs-glightbox](https://github.com/Blueswen/mkdocs-glightbox)
from 0.3.1 to 0.3.2.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Blueswen/mkdocs-glightbox/releases">mkdocs-glightbox's
releases</a>.</em></p>
<blockquote>
<h2>mkdocs-glightbox-0.3.2</h2>
<ul>
<li>Supported image without extension (<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/13">#13</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/blueswen/mkdocs-glightbox/blob/main/CHANGELOG">mkdocs-glightbox's
changelog</a>.</em></p>
<blockquote>
<p>mkdocs-glightbox-0.3.2 (2023-03-19)</p>
<pre><code>* Supported image without extension
([#13](blueswen/mkdocs-glightbox#13))
</code></pre>
<p>mkdocs-glightbox-0.3.1 (2022-11-22)</p>
<pre><code>* Supported lightbox slide effect customization
([#8](blueswen/mkdocs-glightbox#8))
* Supported synchronized lightbox caption dark mode with Material for
MkDocs ([#7](blueswen/mkdocs-glightbox#7))
* Supported glightbox built-in gallery feature
([#11](blueswen/mkdocs-glightbox#11))
* Supported skip image in the anchor tag
</code></pre>
<p>mkdocs-glightbox-0.3.0 (2022-09-29)</p>
<pre><code>* Fixed width and height setting in config not working bug
* Supported specific skip class
([#5](blueswen/mkdocs-glightbox#5))
* Supported glightbox built-in caption with title and description
([#4](blueswen/mkdocs-glightbox#4))
* Fixed page jitter when lightbox closing issue using Material for
MkDocs
* Add white background for lightbox images to prevent the displaying
issue of the transparent image on black background
</code></pre>
<p>mkdocs-glightbox-0.2.1 (2022-08-10)</p>
<pre><code>* Updated readme
</code></pre>
<p>mkdocs-glightbox-0.2.0 (2022-08-10)</p>
<pre><code>* Added support for disabling glightbox with image class or
page meta ([#2](blueswen/mkdocs-glightbox#2))
</code></pre>
<p>mkdocs-glightbox-0.1.7 (2022-07-26)</p>
<pre><code>* Fixed
[#1](blueswen/mkdocs-glightbox#1): Ignore
Emojis
</code></pre>
<p>mkdocs-glightbox-0.1.6 (2022-07-16)</p>
<pre><code>* Fixed some options not working bug
</code></pre>
<p>mkdocs-glightbox-0.1.5 (2022-07-16)</p>
<pre><code>* Fixed mkdocs-material header + sidebar vanishing issue when
opening lightbox (Inspired from
biati-digital/glightbox#22)
* Fixed mkdocs-material content shrinking causing footer offset issue
when open lightbox
* Supported compatible with mkdocs-material Instant loading feature
</code></pre>
<p>mkdocs-glightbox-0.1.4 (2022-06-12)</p>
<pre><code>* Fixed assets location bug
</code></pre>
<p>mkdocs-glightbox-0.1.3 (2022-06-10)</p>
<pre><code>* First release
</code></pre>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/0c0a5805d8682318e4303299a5e42e637eca4afe"><code>0c0a580</code></a>
Support image without extension (<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/13">#13</a>)</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/32b013fa2f9492478bb08b0a88afc63221618168"><code>32b013f</code></a>
Create .github/FUNDING.yml</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/604f9349d5a16fa6f0a3e7e40fef89c1ec35569f"><code>604f934</code></a>
Add building whl</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/104b17ab7fe6dd0a7ab474529e651004e93a99ab"><code>104b17a</code></a>
Update docs</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/da38c2b56b37335ead7387223ee7525a4a2a1244"><code>da38c2b</code></a>
update docs</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/67222b518aa402f904ecbddfc2d6916239ddc77e"><code>67222b5</code></a>
update branch name and add workflow_dispatch</li>
<li>See full diff in <a
href="https://github.com/Blueswen/mkdocs-glightbox/compare/v0.3.1...v0.3.2">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocs-glightbox&package-manager=pip&previous-version=0.3.1&new-version=0.3.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
lars-reimann pushed a commit that referenced this issue Apr 25, 2023
@dependabot
build(deps): Bump mkdocs-glightbox from 0.3.2 to 0.3.4 in /docs (#1328)
1c050ae 
Bumps [mkdocs-glightbox](https://github.com/Blueswen/mkdocs-glightbox)
from 0.3.2 to 0.3.4.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Blueswen/mkdocs-glightbox/releases">mkdocs-glightbox's
releases</a>.</em></p>
<blockquote>
<h2>mkdocs-glightbox-0.3.3</h2>
<ul>
<li>Refactored processing logic with regex (<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/14">#14</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/blueswen/mkdocs-glightbox/blob/main/CHANGELOG">mkdocs-glightbox's
changelog</a>.</em></p>
<blockquote>
<p>mkdocs-glightbox-0.3.4 (2023-04-25)</p>
<pre><code>* Fixed regex bug: quote issue and empty alt issue
([#14](blueswen/mkdocs-glightbox#14)
[#19](blueswen/mkdocs-glightbox#19))
</code></pre>
<p>mkdocs-glightbox-0.3.3 (2023-04-20)</p>
<pre><code>* Refactored processing logic with regex
([#14](blueswen/mkdocs-glightbox#14))
</code></pre>
<p>mkdocs-glightbox-0.3.2 (2023-03-19)</p>
<pre><code>* Supported image without extension
([#13](blueswen/mkdocs-glightbox#13))
</code></pre>
<p>mkdocs-glightbox-0.3.1 (2022-11-22)</p>
<pre><code>* Supported lightbox slide effect customization
([#8](blueswen/mkdocs-glightbox#8))
* Supported synchronized lightbox caption dark mode with Material for
MkDocs ([#7](blueswen/mkdocs-glightbox#7))
* Supported glightbox built-in gallery feature
([#11](blueswen/mkdocs-glightbox#11))
* Supported skip image in the anchor tag
</code></pre>
<p>mkdocs-glightbox-0.3.0 (2022-09-29)</p>
<pre><code>* Fixed width and height setting in config not working bug
* Supported specific skip class
([#5](blueswen/mkdocs-glightbox#5))
* Supported glightbox built-in caption with title and description
([#4](blueswen/mkdocs-glightbox#4))
* Fixed page jitter when lightbox closing issue using Material for
MkDocs
* Add white background for lightbox images to prevent the displaying
issue of the transparent image on black background
</code></pre>
<p>mkdocs-glightbox-0.2.1 (2022-08-10)</p>
<pre><code>* Updated readme
</code></pre>
<p>mkdocs-glightbox-0.2.0 (2022-08-10)</p>
<pre><code>* Added support for disabling glightbox with image class or
page meta ([#2](blueswen/mkdocs-glightbox#2))
</code></pre>
<p>mkdocs-glightbox-0.1.7 (2022-07-26)</p>
<pre><code>* Fixed
[#1](blueswen/mkdocs-glightbox#1): Ignore
Emojis
</code></pre>
<p>mkdocs-glightbox-0.1.6 (2022-07-16)</p>
<pre><code>* Fixed some options not working bug
</code></pre>
<p>mkdocs-glightbox-0.1.5 (2022-07-16)</p>
<pre><code>* Fixed mkdocs-material header + sidebar vanishing issue when
opening lightbox (Inspired from
biati-digital/glightbox#22)
* Fixed mkdocs-material content shrinking causing footer offset issue
when open lightbox
* Supported compatible with mkdocs-material Instant loading feature
</code></pre>
<p>mkdocs-glightbox-0.1.4 (2022-06-12)</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/d6ccc055ef408f83b86e2499d217bb2549069d66"><code>d6ccc05</code></a>
Add regex test case</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/380ea0f48c110ebf7866b76a94da28a8ec3f1740"><code>380ea0f</code></a>
Fix regex bug: quote issue and empty alt issue (<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/14">#14</a>
<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/19">#19</a>)</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/04e57fab71395041dd51481470f94f7219e74d0a"><code>04e57fa</code></a>
Update docs</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/d662a3446af869f80a1ebfe12de02093916f7775"><code>d662a34</code></a>
Refactor processing logic with regex (<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/14">#14</a>)</li>
<li>See full diff in <a
href="https://github.com/Blueswen/mkdocs-glightbox/compare/v0.3.2...v0.3.4">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocs-glightbox&package-manager=pip&previous-version=0.3.2&new-version=0.3.4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
lars-reimann pushed a commit that referenced this issue Nov 29, 2023
@dependabot
build(deps): Bump mkdocs-glightbox from 0.3.4 to 0.3.5 in /docs (#1457)
1018680 
Bumps [mkdocs-glightbox](https://github.com/Blueswen/mkdocs-glightbox)
from 0.3.4 to 0.3.5.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Blueswen/mkdocs-glightbox/releases">mkdocs-glightbox's
releases</a>.</em></p>
<blockquote>
<h2>mkdocs-glightbox-0.3.5</h2>
<ul>
<li>Supported compatibility with the privacy plugin of Material for
MkDocs insiders (<a
href="https://redirect.github.com/Blueswen/mkdocs-glightbox/issues/25">#25</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/blueswen/mkdocs-glightbox/blob/main/CHANGELOG">mkdocs-glightbox's
changelog</a>.</em></p>
<blockquote>
<p>mkdocs-glightbox-0.3.5 (2023-11-18)</p>
<pre><code>* Supported compatibility with the privacy plugin of Material
for MkDocs insiders
([#25](blueswen/mkdocs-glightbox#25))
</code></pre>
<p>mkdocs-glightbox-0.3.4 (2023-04-25)</p>
<pre><code>* Fixed regex bug: quote issue and empty alt issue
([#14](blueswen/mkdocs-glightbox#14)
[#19](blueswen/mkdocs-glightbox#19))
</code></pre>
<p>mkdocs-glightbox-0.3.3 (2023-04-20)</p>
<pre><code>* Refactored processing logic with regex
([#14](blueswen/mkdocs-glightbox#14))
</code></pre>
<p>mkdocs-glightbox-0.3.2 (2023-03-19)</p>
<pre><code>* Supported image without extension
([#13](blueswen/mkdocs-glightbox#13))
</code></pre>
<p>mkdocs-glightbox-0.3.1 (2022-11-22)</p>
<pre><code>* Supported lightbox slide effect customization
([#8](blueswen/mkdocs-glightbox#8))
* Supported synchronized lightbox caption dark mode with Material for
MkDocs ([#7](blueswen/mkdocs-glightbox#7))
* Supported glightbox built-in gallery feature
([#11](blueswen/mkdocs-glightbox#11))
* Supported skip image in the anchor tag
</code></pre>
<p>mkdocs-glightbox-0.3.0 (2022-09-29)</p>
<pre><code>* Fixed width and height setting in config not working bug
* Supported specific skip class
([#5](blueswen/mkdocs-glightbox#5))
* Supported glightbox built-in caption with title and description
([#4](blueswen/mkdocs-glightbox#4))
* Fixed page jitter when lightbox closing issue using Material for
MkDocs
* Add white background for lightbox images to prevent the displaying
issue of the transparent image on black background
</code></pre>
<p>mkdocs-glightbox-0.2.1 (2022-08-10)</p>
<pre><code>* Updated readme
</code></pre>
<p>mkdocs-glightbox-0.2.0 (2022-08-10)</p>
<pre><code>* Added support for disabling glightbox with image class or
page meta ([#2](blueswen/mkdocs-glightbox#2))
</code></pre>
<p>mkdocs-glightbox-0.1.7 (2022-07-26)</p>
<pre><code>* Fixed
[#1](blueswen/mkdocs-glightbox#1): Ignore
Emojis
</code></pre>
<p>mkdocs-glightbox-0.1.6 (2022-07-16)</p>
<pre><code>* Fixed some options not working bug
</code></pre>
<p>mkdocs-glightbox-0.1.5 (2022-07-16)</p>
<pre><code>* Fixed mkdocs-material header + sidebar vanishing issue when
opening lightbox (Inspired from
biati-digital/glightbox#22)
</code></pre>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/fa9cbbe7ff93335055a49269a2965ff10b724f6a"><code>fa9cbbe</code></a>
Support compatibility with the privacy plugin of Material for MkDocs
insiders...</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/7d1d9417673b7c13ab6f188e6dda925c2beef8cf"><code>7d1d941</code></a>
Add error test case</li>
<li>See full diff in <a
href="https://github.com/Blueswen/mkdocs-glightbox/compare/v0.3.4...v0.3.5">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocs-glightbox&package-manager=pip&previous-version=0.3.4&new-version=0.3.5)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@leonschmitz leonschmitz

@Vengos Vengos

Labels
enhancement 💡 New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lars-reimann @leonschmitz @Vengos