Prepare template documents for furo style docs #1131
Conversation
|
Hello @fwitte! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:
Comment last updated at 2024-12-09 11:53:25 UTC |
|
I added instructions to contribute to this change for the in person meeting in the respective issue #1074 |
… into docs/make-style-modern
… into docs/make-style-modern
… into docs/make-style-modern
… into docs/make-style-modern
…o docs/make-style-modern
…/make-style-modern
…s/make-style-modern
…s/make-style-modern
|
@ALL: We need help with the following topics to get this out asap!
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -0,0 +1,5 @@ | |||
| # %%[sec_1] | |||
| import oemof.solph as solph | |||
Check notice
Code scanning / CodeQL
Unused import Note
| # %%[sec_1] | ||
| import oemof.solph as solph | ||
| # %%[sec_2] | ||
| import oemof.solph as solph |
Check notice
Code scanning / CodeQL
Unused import Note
|
For styling please refer to: https://pradyunsg.me/furo/reference/admonitions/ |
Resolve #1074 (docs with appealing look)
Resolve #1132 (docs story line)
Resolve #1141 (beginner tutorials)
Resolve #1142 (advanced tutorials)
This PR prepares the change of the docs layout to the furo template. The following things have to considered before merging:
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 specificrequirements.txtfile. It also introduces an announcement banner at the top of every page, where the content can be dynamically changed from theannouncement.htmlfile in the root of theannouncementsbranch.The plan is to crowdsource the necessary updates at the upcoming user-meeting.