Use a gallery for the example notebooks

[AA-Turner]

cc: @MridulS @DominicWC

This converts the list of example notebooks to a 'gallery' preview that looks slightly nicer. The titles of some of the notebooks were very long, so I took liberties to rename them.

A

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (a547d08) 72.64% compared to head (6ab3b4d) 72.64%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1321   +/-   ##
=======================================
  Coverage   72.64%   72.64%           
=======================================
  Files          78       78           
  Lines       13028    13028           
=======================================
  Hits         9464     9464           
  Misses       3564     3564           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[DominicWC]

Would it be possible to add every single Notebook from the "Consumption Savings" folder in the examples section of hark into the documentation?
Or at least the most fully developed ones? Ideally we'd have a full document for every single model HARK includes, but it seems weird to have some of the most helpful documentation for new HARK learners buried away in the source code with no easy way to access it.

[MridulS]

Ideally we'd have a full document for every single model HARK includes, but it seems weird to have some of the most helpful documentation for new HARK learners buried away in the source code with no easy way to access it.

For this bit we should improve our inline docs in the code. That would make our reference section much cleaner and users are expected to look at the API reference instead of us creating examples for every single model.

[DominicWC]

If we want users to look at the API reference then we'd want to structure it more like NumPy's with a written description of all the aspects of a function, and examples of it being used, rather than just using AutoDocs.

[MridulS]

If we want users to look at the API reference then we'd want to structure it more like NumPy's with a written description of all the aspects of a function, and examples of it being used, rather than just using AutoDocs.

I agree, numpy is also just autodocs. It's just their inline docs are much better :D