-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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 CLI docs #6145
Generate CLI docs #6145
Conversation
Generate lotus command lines documents as text and markdown in folder "lotus/documentation/en".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, 2 non-blockers.
@@ -368,7 +368,13 @@ docsgen-openrpc-worker: docsgen-openrpc-bin | |||
.PHONY: docsgen docsgen-md-bin docsgen-openrpc-bin | |||
|
|||
gen: type-gen method-gen docsgen api-gen | |||
@echo ">>> IF YOU'VE MODIFIED THE CLI, REMEMBER TO ALSO MAKE docsgen-cli" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is doscgen-cli slow? Why not just always run it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not in gen because I'm not sure how to force make to execute one target after another when running in parallel without making one target depend on another - docsgen-cli depends on lotus binaries, which can't build if we're in the middle of generating api code, but we don't want the lotus build to depend on gen
Based on #2467