Api documentation

[knutole]

Adds API documentation to Github Pages

• See issue #20
• Using https://pdoc.dev
• Created Github Pages workflow for documentation
• Moved Pieces, Captures and StockfishException to bottom of file for better readability of documentation.
• Added usage examples to relevant functions.
• Could consider cleaning up README.md as well, but that's probably beyond the scope of this PR.
• See test of Github Pages here: https://knutole.github.io/stockfish (though not updated with all latests changes, need to run locally to see those).

Github Pages

• Run pdoc to test locally: pdoc -d google stockfish/models.py

• Requires enabling Github Pages on master for docs/ path:

  

• Failures in deploying to Github Pages below is due to missing permission to deploy to GP with branch on pull_request (for testing). Tested on my own repo, and it works is permissions are set.

[github-actions[bot]]

Coverage report

The coverage rate went from 96.75% to 94.03% :arrow_down: The branch rate is 89%.

97.95% of new lines are covered.

Diff Coverage details (click to unfold)

### stockfish/models.py `97.95%` of new lines are covered (`94.03%` of the complete file). Missing lines: `1016`

[knutole]

Thanks @kieferro, appreciated! Please remember to enable the necessary Github Pages settings before merge. 👍

[knutole]

@knutole Looks good, thanks for adding this (and updating the descriptions for some of the functions). Github says the branch had an error being deployed, not sure why it says this though.

This is probably the Github Pages permissions that need to be set. See description of PR on top for how to set this.

[knutole]

@kieferro Seems Github Pages are not enabled.

[kieferro]

@knutole Thanks, I merged first and have rerun the workflow. Everything should be fine now.