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

The online documentation could have a more appealing/modern look #1074

Open
fwitte opened this issue May 31, 2024 · 1 comment · May be fixed by #1131
Open

The online documentation could have a more appealing/modern look #1074

fwitte opened this issue May 31, 2024 · 1 comment · May be fixed by #1131
Assignees

Comments

@fwitte
Copy link
Member

fwitte commented May 31, 2024

I suggest to move away from alabaster or rtd theme, and use furo instead (because I use it for tespy and fluprodia :). We could also think about moving all of oemof's repositories to that template (as far away goal...).

@fwitte fwitte linked a pull request Nov 8, 2024 that will close this issue
@fwitte
Copy link
Member Author

fwitte commented Nov 8, 2024

PR #1131 will deal with this issue. The plan is to leverage the next meeting for an in-person sprint. Instructions to the sprinters:

Preparation

  • fork oemof-solph
  • clone your fork git clone https://github.com/YOURUSERNAME/oemof-solph
  • navigate into the clone cd oemof-solph
  • check out the docs/make-style-modern branch git checkout docs/make-style-modern
  • In a fresh environment install dependencies pip install -e .[dev]

Contribution workflow

  • Change docs source code, create darkmode figures, ...
  • Test if renders correctly by running python -m sphinx docs docs/_build from the root of the clone
  • Open the index.html page from your docs/_build/ path
  • Check result
  • Commit changes if happy
  • With all commits pushed: Open PR on https://github.com/oemof/oemof-solph with target branch docs/make-style-modern

@fwitte fwitte self-assigned this Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant