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 CLI docs #6145

Merged
merged 6 commits into from
Apr 30, 2021
Merged

Generate CLI docs #6145

merged 6 commits into from
Apr 30, 2021

Conversation

magik6k
Copy link
Contributor

@magik6k magik6k commented Apr 29, 2021

Based on #2467

@magik6k magik6k requested a review from arajasek as a code owner April 29, 2021 18:04
@jennijuju jennijuju linked an issue Apr 29, 2021 that may be closed by this pull request
Copy link
Contributor

@arajasek arajasek left a 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.

documentation/en/cli-lotus.md Outdated Show resolved Hide resolved
@@ -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"
Copy link
Contributor

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?

Copy link
Contributor Author

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

@magik6k magik6k merged commit e855b80 into master Apr 30, 2021
@magik6k magik6k deleted the feat/cli-doc-gen branch April 30, 2021 10:44
@ZenGround0 ZenGround0 mentioned this pull request May 24, 2021
7 tasks
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

Successfully merging this pull request may close these issues.

[DOC] Docs for all the available cli
3 participants