Skip to content

[FEATURE] Improve rtd documentation #274

@birgits

Description

@birgits

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

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions