Improving UX of API Documentation Site

[dlstadther]

Feel free to ignore this PR if its changes are not desired

Motivation

Ran across this project and its documentation site and wanted to provide something more visually appealing to improve the visual quality of the docs (docs that look nicer and are easier to navigate are more likely to be used). Most python projects I've interacted with use sphinx or mkdocs for static site documentation generation.

Description

• Updated api docs to be created by mkdocs with mkdocstrings.
• Included installation and build notes (next to existing notes for unittest execution).
• Removed pydoc creation/deployment.
• Added start of a helper Makefile.

Testing

See this fork's Github Pages documentation

Local verification

git clone git@github.com:dlstadther/relay-py.git -b mkdocs
cd relay-py
make venv
make serve

(note that mkdocs serve makes some complaints about docstring indentation and missing function/method returntype type-hints, but those will not be addressed by this PR)

[dlstadther]

Hi @steveims . I'm not sure if these SDK projects are still maintained. If so, please see this PR to improve the readability of this repo's Python SDK documentation. However, if the project is deprioritized and this PR is unnecessary in the short term, please feel free to close this PR.

[agodwinrelay]

@steveims @cmarcelk thoughts on merging? Everything LGTM

[steveims]

@agodwinrelay You already have docs working and deployed. And I'm not sure all the implications of this change. For example, docs.yml seems to set git config -- does that overwrite the user's git config? Not sure what else would need to be tuned.

We appreciate the PR -- but given our other list of things to do, I'd leave our docs as is.

[dlstadther]

For example, docs.yml seems to set git config -- does that overwrite the user's git config

docs.yml is a Github Actions file. It has no impact on users' config.

We appreciate the PR -- but given our other list of things to do, I'd leave our docs as is

I understand; it's no problem at all! Feel free to leave open if you want it in the future; otherwise, this PR can be closed.