Move CLI API docs to relavant pages#4980
Merged
mrocklin merged 2 commits intodask:masterfrom Jun 22, 2019
Merged
Conversation
TomAugspurger
approved these changes
Jun 21, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently the auto-generated CLI API docs are all centrally located at https://docs.dask.org/en/latest/setup/cli.html#api, even though that page only discusses the
dask-scheduleranddask-workercommands. This PR moves the CLI API docs for individual commands to the corresponding documentation page that discusses the command. I.e.dask-scheduler&dask-workerstay indocs/source/setup/cli.rstdask-sshmoves todocs/source/setup/ssh.rstdask-submit&dask-remotemove todistributed/docs/source/submitting-applications.rst(see Add CLI API docs for dask-remote and dask-submit distributed#2794)