Skip to content
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

Prepare template documents for furo style docs #1131

Open
wants to merge 43 commits into
base: dev
Choose a base branch
from

Conversation

fwitte
Copy link
Member

@fwitte fwitte commented Nov 8, 2024

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:

  • 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.

@pep8speaks
Copy link

pep8speaks commented Nov 8, 2024

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

Line 100:1: E265 block comment should start with '# '
Line 129:80: E501 line too long (122 > 79 characters)

Line 5:12: W292 no newline at end of file
Line 5:12: W292 no newline at end of file
Line 5:12: W292 no newline at end of file

Comment last updated at 2024-11-27 11:55:40 UTC

@fwitte
Copy link
Member Author

fwitte commented Nov 8, 2024

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

fwitte and others added 24 commits November 21, 2024 15:31
@fwitte
Copy link
Member Author

fwitte commented Nov 24, 2024

@ALL: We need help with the following topics to get this out asap!

  • Is the proposed structure feasible? Are things missing or to be removed?
  • Is the new (shortened) landing page fine?
  • Are the installation information (those on the individual page) clear and do they actually work? What about HiGHS solver?
  • The tutorials need to be set up. We also need at least two advanced tutorials.
  • The showcase examples need to be filled.
  • We have to fix a date + time for the online support meetings Offering monthly consulation hours for users  #1136
  • We need to discuss how to split up the old usage section on the basic concepts and the advanced concepts sections.

@fwitte fwitte removed the request for review from p-snft November 24, 2024 16:27
@@ -0,0 +1,5 @@
# %%[sec_1]
import oemof.solph as solph

Check notice

Code scanning / CodeQL

Unused import Note

Import of 'solph' is not used.
# %%[sec_1]
import oemof.solph as solph
# %%[sec_2]
import oemof.solph as solph

Check notice

Code scanning / CodeQL

Unused import Note

Import of 'solph' is not used.
docs/requirements.txt Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
9 participants