Prepare template documents for furo style docs

[fwitte]

Resolve #1074 (docs with appealing look)
Resolve #1132 (docs story line)
Resolve #1141 (beginner tutorials)

Note: #1142 (advanced tutorials) will be added later.

This PR prepares the change of the docs layout to the furo template. The following things have to considered before merging:

• Check for compatibility of the old docs pages to the new template
• Create darkmode replacements for every figure and logo
• Insert darkmode/lightmode responsive figure inclusion code
• Check if the docs actually build on readthedocs

On top of that, I updated the .readthedocs.yml configuration file to use the [dev] dependencies and a more up to date python version and delete the extra readthedocs specific requirements.txt file. It also introduces an announcement banner at the top of every page, where the content can be dynamically changed from the announcement.html file in the root of the announcements branch.

The plan is to crowdsource the necessary updates at the upcoming user-meeting.

Update:

• Check installation instructions @srhbrnds
• complete the tutorials @jfreissmann @maltefritz @p-snft @AntonellaGia
  • Finish the tutorial codes
  • Create icons for the grid view
  • Create plots and integrate them in the tutorial pages
• Update the Support page @fwitte
• Complete the figures for the grids in basic concepts and optimization sections @leroum

[pep8speaks]

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

• In the file docs/conf.py:

Line 130:80: E501 line too long (122 > 79 characters)

Comment last updated at 2025-01-16 07:00:41 UTC

[fwitte]

I added instructions to contribute to this change for the in person meeting in the respective issue #1074

[p-snft]

I feel like we should merge this rather soon so that it does not diverge from the other branches.

[fwitte]

Good idea, should we make a mini sprint soon to collect, what to complete before merging, distributing tasks and implementing the changes?

[maltefritz]

As you may have noticed, we have been busy with other things in the last time. But I agree with you that we need to hurry.

@fwitte: Feel free to suggest a date.

To fix the problem, we need to remove the first assignment to the variable fig on line 101, as it is immediately redefined on line 107 without being used in between. This will eliminate the redundancy and make the code cleaner.

The best way to fix the problem is to remove the unused variable fig. This will clean up the code and eliminate any confusion about the purpose of the variable. Since the variable is not used anywhere in the code, removing it will not affect the existing functionality.

To fix the problem, we need to remove the first assignment to the variable ax on line 101, as it is immediately redefined on line 107 without being used in between. This will eliminate the redundancy and make the code cleaner and more efficient.

To fix the problem, we should remove the unused variable ax. This involves deleting the assignment of ax on line 101. Since ax is not used anywhere in the code, removing it will not affect the functionality of the code.

To fix the problem, we need to remove the assignment of the unused variable fig on line 107. This will clean up the code and eliminate the unnecessary variable. Since the variable is not used anywhere in the code, we can safely delete the entire line without affecting the functionality of the code.

To fix the problem, we should remove the unused variable ax. This will clean up the code and eliminate the warning. Since ax is not used anywhere in the code, we can safely remove its assignment without affecting the functionality of the code.

To fix the problem, we need to remove the unused import statement on line 2. This will eliminate the unnecessary dependency and make the code cleaner and easier to read. The import statement on line 5 should remain as it might be used in the subsequent code.

To fix the problem, we need to remove the redundant import statement on line 5. This will eliminate the unnecessary dependency and make the code cleaner and more readable. No additional methods, imports, or definitions are needed to implement this change.

To fix the problem, we need to remove the unused import statement import oemof.solph as solph on line 2. This will eliminate the unnecessary dependency and make the code cleaner and easier to read.

To fix the problem, we need to remove the redundant import statement on line 5. This will eliminate the unnecessary dependency and make the code cleaner. The best way to fix this issue is to delete the import statement on line 5 without affecting the existing functionality.

[p-snft]

Giving intervals is no longer supported.

Suggested change

	The model time is defined by the number of intervals and the length of intervals. The length of each interval does not have to be the same. This can be defined in two ways:
	1. Define the length of each interval in an array/Series where the number of the elements is the number of intervals.
	2. Define a `pandas.DatetimeIndex` with all time steps that encloses an interval. Be aware that you have to define n+1 time points to get n intervals. For non-leap year with hourly values that means 8761 time points to get 8760 interval e.g. 2018-01-01 00:00 to 2019-01-01 00:00.
	The model time is defined by the number of intervals and the length of intervals. The length of each interval does not have to be the same. The intervals are defined by giving a `pandas.DatetimeIndex` with all time steps that define the intervals. Be aware that you have to define n+1 time points to get n intervals. For non-leap year with hourly values that means 8761 time points to get 8760 interval e.g. 2018-01-01 00:00 to 2019-01-01 00:00.

[p-snft]

Make clear that bus -> bus is possible.

Suggested change

	There are two types of *nodes* : *components* and *buses*. Every Component has to be connected with one or more *buses*. The link between a *component* and a *bus* is called a *flow*.
	There are two types of *nodes* : *components* and *buses*. Every Component has to be connected with one or more *buses*. The link between a *component* and a *bus* (or between * two buses*) is called a *flow*.