Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx docs #65

Merged
merged 41 commits into from
Sep 18, 2024
Merged

Sphinx docs #65

merged 41 commits into from
Sep 18, 2024

Conversation

RiesBen
Copy link
Contributor

@RiesBen RiesBen commented Aug 21, 2024

This PR, tries to ramp up the sphinx doc, giving more insight into Konnektor and how to use it! :)

Julicancode and others added 30 commits July 9, 2024 13:11
  * analysis:
* minor modifications on cycle analysis (only check for cylce of size 3 per default)
* make delete more performant, by deleting multiple transformations/components at once if wanted.
* adding graph cost and efficiency

  * jnbs:
*Adding text to Example JnB.

network -planners:
* minor refactors
* display fix, correct number of expected edges.
passing variable trough from top to bottom.
- Notebook improvements, more documentation, black formatting
- improving network generator documentation
- vscode -> gitignore
Update visualisation of molecules to 2D
* Update visualisation of molecules to 2D

* parallelization bug fix

* example: adding charge data

* widget scroll sensitivity improvement.

* bug fix clusteredNetworker understands now own default.

* Changes:
  * analysis:
* minor modifications on cycle analysis (only check for cylce of size 3 per default)
* make delete more performant, by deleting multiple transformations/components at once if wanted.
* adding graph cost and efficiency

  * jnbs:
*Adding text to Example JnB.

network -planners:
* minor refactors
* display fix, correct number of expected edges.

* minor text improvments

* Update widget.py

passing variable trough from top to bottom.

* Changes:
- Notebook improvements, more documentation, black formatting
- improving network generator documentation
- vscode -> gitignore

* applied black to code.

* adding pre-commit and dependencies

* fixing konnektor_networks.ipynb.

* fixing konnektor_networks.ipynb.

* fixing konnektor_example.ipynb.

* Update pyproject.toml

* fix networks.ipynb

* fix widget

---------

Co-authored-by: Julicancode <thethreevws@gmail.com>
* parallelization bug fix

* example: adding charge data

* widget scroll sensitivity improvement.

* bug fix clusteredNetworker understands now own default.

* Changes:
  * analysis:
* minor modifications on cycle analysis (only check for cylce of size 3 per default)
* make delete more performant, by deleting multiple transformations/components at once if wanted.
* adding graph cost and efficiency

  * jnbs:
*Adding text to Example JnB.

network -planners:
* minor refactors
* display fix, correct number of expected edges.

* minor text improvments

* Changes:
- Notebook improvements, more documentation, black formatting
- improving network generator documentation
- vscode -> gitignore

* applied black to code.

* adding pre-commit and dependencies

* make ipycytoscape optional.
@RiesBen RiesBen changed the base branch from build_v1 to main September 10, 2024 20:30
@pep8speaks
Copy link

Hello @RiesBen! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 25:1: W293 blank line contains whitespace

@RiesBen RiesBen self-assigned this Sep 11, 2024
@RiesBen RiesBen added documentation Improvements or additions to documentation Konnektor labels Sep 11, 2024
@RiesBen RiesBen added this to the version 1.0 milestone Sep 11, 2024
Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.11%. Comparing base (193a55d) to head (dbd5556).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #65      +/-   ##
==========================================
- Coverage   91.10%   87.11%   -3.99%     
==========================================
  Files          46       49       +3     
  Lines        1293     1545     +252     
==========================================
+ Hits         1178     1346     +168     
- Misses        115      199      +84     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RiesBen RiesBen merged commit f1b77db into main Sep 18, 2024
0 of 4 checks passed
@RiesBen RiesBen deleted the sphinx_docs branch September 18, 2024 07:35
@RiesBen RiesBen changed the title [WIP] Sphinx docs Sphinx docs Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Konnektor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants