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

Generate developer docs for Python API #503

Merged
merged 14 commits into from
Jul 4, 2024
Merged

Conversation

sujuka99
Copy link
Contributor

Closes #492

@sujuka99 sujuka99 added the area/documentation Improvements or additions to documentation label Jun 28, 2024
@sujuka99 sujuka99 self-assigned this Jun 28, 2024
@raminqaf
Copy link
Contributor

Is there a way to omit setup_handler and create_pipeline from the API docs?

Besides, it would be nice to have some PyDocs under each method so it is reflected in the docs

image

@disrupted
Copy link
Member

disrupted commented Jul 2, 2024

Is there a way to omit setup_handler and create_pipeline from the API docs?

rather than manually hiding those, I would prefer prefixing them with _ to make them private and then only exporting the public ones.

@disrupted
Copy link
Member

looks great!

@disrupted disrupted self-assigned this Jul 3, 2024
@disrupted disrupted changed the title Generate api docs Generate developer docs for Python API Jul 3, 2024
@disrupted disrupted merged commit c7ceecb into main Jul 4, 2024
8 of 9 checks passed
@disrupted disrupted deleted the docs/generate-api-docs branch July 4, 2024 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate API documentation using mkdocstrings
3 participants