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

Enable autodocs for python client library API documentation #7082

Merged
merged 3 commits into from
Apr 9, 2024

Conversation

tanmayv25
Copy link
Contributor

The changes uses sphinx autosummary to recursively pick extract the documentation from the tritonclient package.

@jbkyang-nvi jbkyang-nvi changed the title Eanable autodocs for python client library API documentation Enable autodocs for python client library API documentation Apr 8, 2024
@tanmayv25 tanmayv25 requested a review from jbkyang-nvi April 8, 2024 21:50
Copy link
Contributor

@jbkyang-nvi jbkyang-nvi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@tanmayv25 tanmayv25 merged commit 7186920 into main Apr 9, 2024
3 checks passed
@tanmayv25 tanmayv25 deleted the tanmayv-api-docs branch April 9, 2024 19:51
@@ -30,6 +30,7 @@ FROM ubuntu:22.04
RUN apt-get update -q=2 \
&& apt-get install -y --no-install-recommends \
build-essential \
curl \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, update copyright

@@ -108,6 +108,7 @@ examples/jetson/concurrency_and_dynamic_batching/README
:caption: Client

client/README
_reference/tritonclient_api.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright


#PROTOBUFFILES = $(wildcard ../triton/proto/*.proto)

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
clean:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright

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

Successfully merging this pull request may close these issues.

4 participants