Added mkdocs

[josephlewis42]

Part of #92

This PR adds initial doc generation to python-scraperlib. You can see them locally by running hatch run docs:serve, screenshot below:

I tried to keep things pretty well documented because piecing together these plugins isn't entirely straightforward.

There are probably a few things to fix, but my goal is to have a good enough start here that a maintainer can start looking at getting these auto-published.

[benoit74]

Hi @josephlewis42, thank you very much for this PR, not easy to review on our side, we'll do our best next week

[benoit74]

Wooo, one month already ... time fly too fast! I will review it tomorrow, very sorry for that delay, not our standard

[benoit74]

Very good work @josephlewis42

I've fixed few things which were "important" to fix from my PoV.

There are other rough edges to polish (mainly our own docstrings which are far from perfect) but this can already be merged since it provides lots of value.

I will move on with the merge and setup readthedocs publishing.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5a002d2) to head (cb91ca2).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #215   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           38        38           
  Lines         2227      2227           
  Branches       426       426           
=========================================
  Hits          2227      2227           

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