Add CLI docs, and generation script#2
Open
multimeric wants to merge 1 commit into3dem:mainfrom
Open
Conversation
Author
|
Here's an example of how this looks in the docs |
Member
|
Let's discuss in 3dem/relion#912. |
Author
|
Okay. Is there someone I should ping in that issue? |
Member
|
I am writing a reply there. |
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
2 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.
This PR adds auto-generated CLI docs, which are created from the actual binaries themselves. The purpose of this is to make the CLI more accessible to users. It's hard to determine if relion actually has a CLI at all from online tutorials and manuals, and beyond that, most of the options aren't documented either. I've included the script I used to generate the .rst file, in case it needs to be re-run in the future if/when CLI options change.