PyHa icon indicating copy to clipboard operation
PyHa copied to clipboard

[📝] Autogenerate Documentation

Open npham-dev opened this issue 2 years ago • 3 comments

I added pdoc in a GitHub Action to automatically generate documentation when the main branch changes. Here's a preview on my fork.

NOTE: This will require enabling GitHub Pages in settings so the documentation will automatically be deployed (replace the test branch with "main" instead, example of settings shown below).

image

npham-dev avatar Jan 24 '24 01:01 npham-dev

Seems to be missing the first argument in every function - In this example, the local_scores is not formatted the same way as the others image

JacobGlennAyers avatar Jan 24 '24 01:01 JacobGlennAyers

The returns is also formatted differently

JacobGlennAyers avatar Jan 24 '24 01:01 JacobGlennAyers

My bad I forgot to tell it to use Google-style docstrings (made a new commit, looks like this since it'll take a few minutes to build/deploy:) image

npham-dev avatar Jan 24 '24 01:01 npham-dev