Documentation

[N-Wouda]

A big list of (minor) TODOs:

• [x] Create a "how to install" page, both from pip and from source. If from source: explain how to run the examples.
• [x] Create a "how to contribute" page, also detailing how to set-up a local dev environment (including pre-commit + tests). Link to the contributing document on Github.
• [x] Move example dependencies to a new "example" group using poetry. Add jupyter to this group, to make everything self-contained. Describe this in the how to contribute and how to install pages (or link to this somewhere; make sure it's clear).
• [x] Create a "where to file issues" page in the documentation.
• [x] Add mathematical descriptions to the weight-baeed operator selection schemes. These descriptions can be taken from the ALNS features notebook.
• [x] Add mathematical descriptions to SA and RRT. These descriptions can be taken from the ALNS features notebook.

Link to the new pages in the readme here on Github.

[N-Wouda]

I'll see if I can write most of this tomorrow morning.

[N-Wouda]

(the first few points are things we'll be asked about in the JOSS review, so it's probably good to get ahead of that and already write something for)

[N-Wouda]

We should move the examples up, into the examples/ directory where they used to be, and use something like sphinx-collections to move the examples to where they need to be for the docs to build.

Edit: this project uses that tool to copy stuff; have a look there for how to set this up.

[N-Wouda]

There's zero need to use a dependency for copying the examples. Just shutil everything over in the conf.py file.