Improve API documentation and setup pdoc

[Techcable]

This PR significantly improves the library's documentation, fixing #3.

I am trying to use pdoc to generate the API documentation.
However, I am having issues with markdown reference links not working correctly.
This needs to be fixed before we can continue.

I also need to set up deployment to gh-pages. We can use the github actions configuration from the pdoc documentation https://pdoc.dev/docs/pdoc.html#deploying-to-github-pages

Pending questions/problems

• Consider using mkdocstrings instead of pdoc - This is a way to include API docs in mkdocs
• Include README.md in the generated documentation
• Setup GitHub actions/automatic deploy

[Techcable]

I have sperated out the documentation improvements from the pdoc setup. I will be merging the documentation improvements to master, keeping the pdoc stuff here.

The docs are in the format I want them to be in, not what pdoc currently accepts. Specifically, I want to be able to use commonmark with rustdoc-syle links.

I am considering fork/rewriting pdoc to support this. Maybe named rspydoc for "rustdoc-style python docs".