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 2025-01-16 07:00:41 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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
For styling please refer to: https://pradyunsg.me/furo/reference/admonitions/ |
This is consistent with the names of the other directories (all plural).
| @@ -0,0 +1,7 @@ | |||
| # %%[sec_1] | |||
| import oemof.solph as solph | |||
Check notice
Code scanning / CodeQL
Unused import Note
| import oemof.solph as solph | ||
|
|
||
| # %%[sec_2] | ||
| import oemof.solph as solph |
Check notice
Code scanning / CodeQL
Unused import Note
| @@ -0,0 +1,7 @@ | |||
| # %%[sec_1] | |||
| import oemof.solph as solph | |||
Check notice
Code scanning / CodeQL
Unused import Note
| import oemof.solph as solph | ||
|
|
||
| # %%[sec_2] | ||
| import oemof.solph as solph |
Check notice
Code scanning / CodeQL
Unused import Note
| @@ -0,0 +1,7 @@ | |||
| # %%[sec_1] | |||
| import oemof.solph as solph | |||
Check notice
Code scanning / CodeQL
Unused import Note
| import oemof.solph as solph | ||
|
|
||
| # %%[sec_2] | ||
| import oemof.solph as solph |
Check notice
Code scanning / CodeQL
Unused import Note
Tox tests did not run without: It tried to run
`python -I -m pip install pytest-cov './{[testenv]deps}'`,
which does not make sense. looks like "deps" needs to be defined.
docs/support.rst
Outdated
| If you have a question and you cannot attend an online meeting you can also | ||
| post your question to the `openmod forum <https://forum.openmod.org/>`__. Make | ||
| sure to use the :code:`oemof` tag for your submission. |
There was a problem hiding this comment.
As this is the solph documentation, we should advice to use oemof-solph for the tag.
docs/support.rst
Outdated
|
|
||
| User forum | ||
| ========== | ||
|
|
||
| (openmod) | ||
| If you have a question and you cannot attend an online meeting you can also |
There was a problem hiding this comment.
I think, the forum is the first resource and if you prefer personal contact, we also have a consultation hour. (Forum posts can be answered asynchronously and answers can also help others.)
|
|
||
| .. code-block:: console | ||
|
|
||
| conda install -c conda-forge coincbc |
There was a problem hiding this comment.
I think, there cbc is not conda-installable on Windows systems.
Co-authored-by: Patrik Schönfeldt <[email protected]>
|
One bigger task remaining is:
Right now the structure of the old
I would like to restructure that a little bit:
What do you think? |
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:
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.