Host documentation on github pages #6
Description
Documentation of this tool is currently sparse. Outside the README.md, there isn't a clear setup guide for new users, or anything by way of developer documentation. This should be remedied if this project is to be taken seriously.
Ideally, docstrings should all be updated to match a format that can be parsed into online documentation. sphinx.ext.autodoc could be used for this. Preferably within a GitHub Actions pipeline, in order to keep documentation current at all times, with versions tagged by release tag.
However, as autodoc imports the modules to be implemented, many of the same problems encountered in testing under Actions are likely to be encountered. For example, tkinter complains about the lack of an X display, likely exiting the process, and pynput isn't happy at all for similar reasons.
Some code modification may be possible to detect when running under autodoc? Some research is required as to what are the best practices for this.