Adding automated documentation for PyCPD

[gattia]

• Updated docstrings of files so they are complete
• Added Makefile to root directory that allows easy running of pre-specified commands (build, doc, test, etc.)
• Updated README to explain optional usage of make for multiple use cases
• Added command to Makefile to automatically build docs to /docs subfolder
  • The docs are built using pdoc3 which is extremely straightforward:
    • https://pdoc3.github.io/pdoc/
• Added github action script to ./github/workflows/docs.yml that should auto compile docs on new push to master.
  • The github action should then publish these docs on the repositories github pages.
  • Details about the workflow are at these two links:
    • https://pdoc.dev/docs/pdoc.html#deploying-to-github-pages
    • https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml

@siavashk can you please go to the settings tab on the repository & enable GitHub Actions and GitHub Pages. This should enable the setup GitHub Actions to automatically compile the docs & publish on push to master. There might be some bugs in doing that, if there are I am happy to look into them.

Once this is complete, then we have all requirements for the manuscript submission to JOSS and I will make that submission.

If you pull this branch to your local computer you should be able to open .../pycpd/docs/pycpd/index.html in your browser to preview the documentation.

[siavashk]

Should be done. Let me know if you need anything else on my end.