Skip to content

Added documentation#126

Merged
V3lop5 merged 28 commits intomainfrom
feature/api-documentation
Mar 3, 2022
Merged

Added documentation#126
V3lop5 merged 28 commits intomainfrom
feature/api-documentation

Conversation

@einfachMel
Copy link
Copy Markdown
Collaborator

@einfachMel einfachMel commented Mar 3, 2022

Fixes #95

This PR ...

adds new documentation and finalize it for now.


Checklist

Checklist for Contributors

  • Documentation updated?

Checklist for Reviewers

  • Read PR description
  • Check linked issue
  • Check CI/CD (build, automated tests, linting, preview build)
  • Check documentation changes
  • Add labels to PR

@einfachMel einfachMel requested a review from V3lop5 March 3, 2022 12:58
@einfachMel einfachMel added the documentation Improvements or additions to documentation label Mar 3, 2022
Added installation for solver
Renamed usage to userguide
@github-actions

This comment has been minimized.

@V3lop5 V3lop5 changed the title Feature/api documentation Added documentation Mar 3, 2022
@github-actions

This comment has been minimized.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

Merging #126 (3183e73) into main (b81619c) will increase coverage by 5.54%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #126      +/-   ##
==========================================
+ Coverage   79.42%   84.96%   +5.54%     
==========================================
  Files         104      104              
  Lines        2522     2528       +6     
==========================================
+ Hits         2003     2148     +145     
+ Misses        519      380     -139     
Flag Coverage Δ
pytest 84.96% <100.00%> (+5.54%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
ensysmod/schemas/user.py 100.00% <ø> (ø)
ensysmod/schemas/base_ref_component_region.py 100.00% <100.00%> (ø)
ensysmod/schemas/dataset.py 100.00% <100.00%> (ø)
ensysmod/schemas/dataset_permission.py 100.00% <100.00%> (ø)
ensysmod/schemas/energy_commodity.py 100.00% <100.00%> (ø)
ensysmod/schemas/energy_component.py 100.00% <100.00%> (ø)
ensysmod/schemas/energy_conversion.py 100.00% <100.00%> (ø)
ensysmod/schemas/energy_conversion_factor.py 100.00% <100.00%> (ø)
ensysmod/schemas/energy_model.py 100.00% <100.00%> (ø)
ensysmod/schemas/energy_model_parameter.py 100.00% <100.00%> (ø)
... and 19 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b81619c...3183e73. Read the comment docs.

# Conflicts:
#	requirements-dev.txt
@github-actions github-actions bot temporarily deployed to PR-126-Preview March 3, 2022 15:39 Destroyed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 3, 2022

Unit Test Results

    1 files  ±0      1 suites  ±0   3m 3s ⏱️ +12s
417 tests ±0  401 ✔️ ±0  16 💤 ±0  0 ±0 

Results for commit 314d19d. ± Comparison against base commit 0bdffc5.

@github-actions github-actions bot temporarily deployed to PR-126-Preview March 3, 2022 15:49 Destroyed
@V3lop5 V3lop5 merged commit eb2c94a into main Mar 3, 2022
@V3lop5 V3lop5 deleted the feature/api-documentation branch March 3, 2022 22:08
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation and User Guide

4 participants