Sphinx Docs

[tweak-wtf]

Description

This PR improves on docstrings, builds sphinx documentation and serves them on https://ynput.github.io/LabLib .

• adds workflow for building the docs and hosts them on GH Pages by serving its static html on branch gh-pages
  • auto-compiles README.md to rst using pandoc

Testing Notes

• workflow target branch should be changed to main before merging
• steps to build docs:
  • run start.ps1 set-env
    • that's what the $PYTHONPATH is for, else the sphinx conf.py doesn't find lablib
  • cd .\docs\
  • poetry run make html
• find html file in .\docs\_build\html\

closes #15

[tweak-wtf]

i'm wondering whether i should already set up GitHub Actions for building the docs.
what do u say @jakubjezek001 ?

[jakubjezek001]

I could not resolve this with on windows with my poetry lock, but this is not a problem since once I had removed it it had been recreated again correctly.

[jakubjezek001]

i'm wondering whether i should already set up GitHub Actions for building the docs. what do u say @jakubjezek001 ?

If you know how to, then lets do it! :D

[tweak-wtf]

i'm wondering whether i should already set up GitHub Actions for building the docs. what do u say @jakubjezek001 ?

If you know how to, then lets do it! :D

yeeees. was just waiting for ur go :D

[tweak-wtf]

let's disable the type annotations in the built docs

[tweak-wtf]

lemme check out how to suggest formatting/linting issues with GH actions. i'll explore this on a different PR