Improve documentation

[N-Wouda]

Into two parts:

examples/
api/

Then we only have a top-level index.rst file, that lists everything in these folders.

[N-Wouda]

Add more math to docs: we have a lot of places where we historically did math as code (e.g., how stuff is updated in SA and RRT). We have docs that support actual math now, so let's use that instead.

[N-Wouda]

We should perhaps have a dedicated installation page, both with "install using pip" and "install from source".

Edit: this should also mention something about running the tests/example notebooks.

[N-Wouda]

The API reference is mostly complete, but it isn't really clear what some (mostly underused) features are supposed to do. E.g. kwargs to iterate(), op_coupling in selection schemes, and the autofit methods. I think we should highlight this more somehow, perhaps by adding a "short tutorial" and an "advanced topics" page.

[leonlan]

The API reference is mostly complete, but it isn't really clear what some (mostly underused) features are supposed to do. E.g. kwargs to iterate(), op_coupling in selection schemes, and the autofit methods. I think we should highlight this more somehow, perhaps by adding a "short tutorial" and an "advanced topics" page.

I think I can include some of the more advanced features in #106.

• Pass-on the processing times matrix to **kwargs
• Use autofit
• Include local search post-repair (which essentially turns it into iterated local search)

[N-Wouda]

We're currently hosting our docs on RTD, but I eventually want to move that to a dedicated Github pages location. We then have to build everything in a new workflow, but that's pretty easy to set up.

[N-Wouda]

We should also allow running the notebooks on Google Colab or Binder, directly from the documentation. This will make it much easier for people to start using our code.