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

Example section in the README is still refering to the oemof-example repository #953

Closed
uvchik opened this issue Jul 4, 2023 · 4 comments · Fixed by #954 or #975
Closed

Example section in the README is still refering to the oemof-example repository #953

uvchik opened this issue Jul 4, 2023 · 4 comments · Fixed by #954 or #975
Assignees
Labels
Milestone

Comments

@uvchik
Copy link
Member

uvchik commented Jul 4, 2023

...but should refer to the new integrated examples and give a hint how to download them.

@uvchik uvchik added the bug label Jul 4, 2023
@uvchik uvchik added this to the v0.5.1 milestone Jul 4, 2023
@p-snft
Copy link
Member

p-snft commented Jul 6, 2023

I named virtual environments and corrected the link to the examples.

@fwitte: Can you inline the code of the examples in the documentation? Afterwards, this should also be stated in the readme.

@fwitte
Copy link
Member

fwitte commented Jul 6, 2023

Something which will look like this @p-snft, @uvchik:

grafik

@p-snft
Copy link
Member

p-snft commented Jul 6, 2023

This looks great! Thanks for the suggestion.

@fwitte
Copy link
Member

fwitte commented Jul 6, 2023

Okay, I pushed the necessary changes for the first example already. Note on that:

The literalinclude directive can be used with :lines: (line number specifications) or with (:starts-after:/:ends-before:) string sequences. The second one would be much nicer, because we do not have to look at line numbers, but since the literalinclude is in the same file we have some kind of literalincludeception, and that version does not work in this specific setup (https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude). The :pyobject: variant would skip imports and call of the main() function, so no option as well.

Thus, we still need to copy and paste/adjust the section to all other examples.

@p-snft p-snft linked a pull request Sep 11, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment