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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Improve rtd documentation #274

Open
4 of 13 tasks
birgits opened this issue Jul 25, 2022 · 4 comments · May be fixed by #298
Open
4 of 13 tasks

[FEATURE] Improve rtd documentation #274

birgits opened this issue Jul 25, 2022 · 4 comments · May be fixed by #298
Assignees
@khelfen @maike93he
Labels
enhancement medium_priority

Comments

@birgits
Copy link
Collaborator

birgits commented Jul 25, 2022 •
edited
Loading

The readthedocs documentation needs some improvements and additions:

  • It should be automatically checked if links work correctly (compare Add github action to check links #201)
  • Examples in the documentation should be automatically checked (could e.g. be converted to notebook that is integrated into documentation and tests)
    • Minimum working examples
    • Usage details
  • New plotly plot options should be added here
  • Add electromobility to usage details and features in detail
    • Add information on how to retrieve SimBEV and TracBEV data
    • Add information on electromobility class
    • Add information on how charging processes are allocated to charging stations (could also be further explained in docstring of distribute_charging_demand function)
  • Add jupyter notebook examples
    • Basic example
    • Plotting example
    • EV example
@birgits birgits mentioned this issue Jul 25, 2022
Closed
6 tasks
@maike93he maike93he mentioned this issue Aug 22, 2022
Open
6 tasks
@mltja
Copy link
Member

mltja commented Aug 23, 2022

Maybe the examples of the documentation can be checked with doctest?

Using ding0_test_network_2 for the examples in Getting Started.

maike93he added a commit that referenced this issue Sep 9, 2022
@maike93he
Merge branch 'dev' of github.com:openego/eDisGo into feature/#274-imp…
eb78d1b 
…rove-rtd-doc
@maike93he maike93he linked a pull request Sep 9, 2022 that will close this issue
Open
6 tasks
@birgits
Copy link
Collaborator Author

birgits commented Sep 11, 2022

@maike93he where did you implement checking the links and examples in the documentation? I would like to have a look at it.

@maike93he
Copy link
Collaborator

Added you @birgits as a reviewer for the two pull requests regarding links and examples check in doc.

maike93he added a commit that referenced this issue Jan 11, 2023
@maike93he
Merge branch 'dev' of github.com:openego/eDisGo into feature/#274-imp…
9ffb792 
…rove-rtd-doc
maike93he added a commit that referenced this issue Jan 11, 2023
@maike93he
Merge branch 'dev' of github.com:openego/eDisGo into feature/#274-imp…
af0d48c 
…rove-rtd-doc
@birgits birgits mentioned this issue May 23, 2024
Open
6 tasks
@birgits
Copy link
Collaborator Author

birgits commented May 23, 2024

Parts of this are implemented in PR #292. The PR, however, needs to be cleaned up and current dev merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@khelfen khelfen

@maike93he maike93he

Labels
enhancement medium_priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/#274 improve rtd doc openego/eDisGo
4 participants
@birgits @khelfen @maike93he @mltja