Skip to content

Interface docs

Flavio Hafnerrequested to merge
interface-docs into main

Fixes #69

  • adds sphinx documentation with a section on the interface, built from an html. The lexer is necessary for syntax highlighting in the built html. The makefile runs the notebook before building the html.
  • updates dependencies for using notebooks in sphinx; plus jupyterlab for using notebooks without IDE
  • adds developer notebook in notebooks/coupling_interface_docs.ipynb

Create docs locally:

cd docs
make html
firefox _build/html/index.html

Notes

  • As long as we work with closed repo, building the docs locally (without a website) should be enough?
  • There are some identation warnings when building the html, I think from the docstrings. I'm ignoring them for now.

Tasks to do

  • add example bid dataframe and derive demand curve from it?
  • trim notebooks/coupling_interface_docs.ipynb?

Merge request reports