-
Notifications
You must be signed in to change notification settings - Fork 0
Refresh the docs #16
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
Merged
Merged
Refresh the docs #16
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e072b98
Rename docs chapter
jnnr 1cf3e6c
Rename chapter to developer guidelines
jnnr a56cb21
Add list of modules
jnnr 72fce0c
Define navbar order
jnnr 2d125a5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 135ae6a
Fix misspelling of file
jnnr df8a506
Fix broken links
jnnr 0d8f3c1
Add note on module docs coming soon
jnnr 534b9db
Fix typo
jnnr 4c85d74
Fix another typo
jnnr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/Guidelines/getting_started.md → docs/Developer_guidelines/getting_started.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Modules | ||
|
|
||
| Currently, the following data modules are available. | ||
|
|
||
| !!! note "More extensive docs are coming soon" | ||
|
|
||
| The modules are currently in active development. A more detailed documentation showing the capability of each module will be coming soon. | ||
|
|
||
| - [module_area_potentials](https://github.com/calliope-project/module_area_potentials) | ||
| - [module_demand_electricity](https://github.com/calliope-project/module_demand_electricity) | ||
| - [module_electricity_grid](https://github.com/calliope-project/module_electricity_grid) | ||
| - [module_geoboundaries](https://github.com/calliope-project/module_geo_boundaries) | ||
| - [module_hydropower](https://github.com/calliope-project/module_hydropower) | ||
| - [module_powerplants](https://github.com/calliope-project/module_powerplants) | ||
| - [module_pv_wind](https://github.com/calliope-project/module_pv_wind) | ||
|
|
||
| If you think that an important topic is not covered by the modules above, feel free to develop your own module! Please read the [developer guidelines](../Developer_guidelines/getting_started.md) to learn how to get started. Our templates and recommended good practices are ready to help you, so your module will work smoothly from the start. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # `clio_tools` API | ||
|
|
||
| Here you can find a collection of useful functions that make integrating our different [components](../About/our_framework.md) easier. | ||
| Here you can find a collection of useful functions that make integrating our different [components](../Background/our_framework.md) easier. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.