Fix/example section in the readme is still refering to the oemof example repository #954
Conversation
Examples for solph are no longer in a separate repository.
It's no longer impossible to have both packages, oemof and oemof.solph, installed. So the documentation should no longer claim it to be impossible.
|
Looking at oemof/oemof-examples#84, we should really have this fix done. |
|
Maybe also discontinue the examples Repo? Or refer to the correct locations from there? |
…fering-to-the-oemof-example-repository
The example had no __name__ == "__main__" protector, so it was run on import. Ths lead to a failure in building docs on systems without cbc installed.
There sems to be an issue with newer versions in combination with the rdt theme.
I would also discontinue it. In the current form, it has no added value. |
|
I (temporarily) activated this branch on RTD so that you can see how the examples render in the solph documentation. I really like it and consider this PR done. |
|
I can have a look on like Sunday if it is sufficient |
Sure. My plan is to create the release middle of next week. |
Fixed. The links now point to the examples in the same documentation. |
Wow I can commit the changes @p-snft suggested, who is the author then? Co-authored-by: Patrik Schönfeldt <patrik.schoenfeldt@dlr.de>
p-snft
deleted the
fix/example-section-in-the-readme-is-still-refering-to-the-oemof-example-repository
branch
Example section in the README was still referring to the oemof-example repository. This PR fixes that. Secondly, the quality of the integration of the examples into the documentation is improved.