Skip to content
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.

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

update docs to true pdoc, integrate into github actions #55

Open
jacobdadams opened this issue Sep 29, 2023 · 0 comments
Open

update docs to true pdoc, integrate into github actions #55

jacobdadams opened this issue Sep 29, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@jacobdadams
Copy link
Member

Current docs use pdoc3, a questionably-maintained fork of pdoc itself. pdoc is showing the instance variables set by __init__, and I need to figure out how to remove those from the docs for readability (visually they look like methods and are kind of confusing).

Also, pdoc has an example github action to publish docs, automating the doc process.

@jacobdadams jacobdadams added the enhancement New feature or request label Sep 29, 2023
@jacobdadams jacobdadams self-assigned this Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant