New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Export the API documentation (e.g. as readthedocs) #23

Open

Bonifatius94 opened this issue Nov 19, 2020 · 0 comments

Labels

Owner

Bonifatius94 commented Nov 19, 2020

Issue:

there is currently no API documentation available

Suggested Solution:

solving issue Make the chesslib lintable when being imported in Python projects #22
find ways to export the lintable API documentation from Make the chesslib lintable when being imported in Python projects #22 as website, pdf document, etc.
add a link to the documentation in the README file
add GitHub workflow jobs for generating the documentation output

Bonifatius94 added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment