Further doc updates

[jack-fs]

This PR will contain additional documentation updates and address comments from #53

[jack-fs]

CI tests are failing due to unrelated issues as documented in #55. Tests and linting pass on my machine.

This PR now involves:

• substantial updates to the documentation of
  • dependence.py
  • evaluators.py
  • model_evaluation.py
• proof-reading and editing of many other sections of documentation;
• new Makefile docs target for html docs, for convenience;
• no substantial code changes; and
• new sphinx documentation for the simulations module.

Most comments in #53 would involve substantial actual code changes, so should probably be addressed separately

[dsteinberg]

This is great Jack! You've put in a lot of great work!

I only have one comment in this review about cv. Otherwise some things to consider:

• Include the README in the docs front page (as we did in aboleth) so users are given a nicer front page other than just the API reference
• host the docs on readthedocs, and make a hook in the CI that rebuilds these docs and uploads it to readthedocs

Otherwise I'll leave it to Simon and Al :-)

[dsteinberg]

nice

[dsteinberg]

It may be worth mentioning that if this is of type int, it results in KFold(n_splits=cv) as per scitkit-learn's interface

[jack-fs]

• Update model_evaluation.crossval_model docs
• Add README to sphinx docs
• Publish on readthedocs: https://causal-inspection.readthedocs.io
  • Automatic doc builds on pull requests can be configured as here. This requires some degree of permissions. It seems possible to set up CI manually using GitHub actions, but we would need to be able to store a webhook token as a secret in the repo, which requires admin access