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

Automatically generate documentation for imports #495

Open
Zizico2 opened this issue Sep 20, 2022 · 2 comments
Open

Automatically generate documentation for imports #495

Zizico2 opened this issue Sep 20, 2022 · 2 comments

Comments

@Zizico2
Copy link

Zizico2 commented Sep 20, 2022

I couldn't find an issue answering this already. Is there any way to generate docs for dependencies automatically? Instead of having to specify all the input files manually.

@mocosun
Copy link

mocosun commented Dec 19, 2022

I have the same question here

@jonathan-k4
Copy link

I ended up doing this...

pushd $PROTOS_DIR > /dev/null
LIST=$(find . -name "*.proto" | cut -c 3- | sort -t '\0' -n)
popd > /dev/null

echo "Generating docs..."
docker run --rm \
	-v $DOCS_DIR:/out:rw \
	-v $PROTOS_DIR:/protos:ro \
	-v $BASE_DIR/templates:/templates:ro \
	-v $API_DIR:/usr/include/google/api:ro \
	pseudomuto/protoc-gen-doc:latest --doc_opt=$DOC_OPTS $LIST

Which as you said, specifies all the input files, but at least not manually.

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

No branches or pull requests

3 participants