Skip to content

Update CLI runner documentation#113

Open
josephmckinsey wants to merge 1 commit intomainfrom
jm/document_helics_cli
Open

Update CLI runner documentation#113
josephmckinsey wants to merge 1 commit intomainfrom
jm/document_helics_cli

Conversation

@josephmckinsey
Copy link
Contributor

  • Adds mkdocs-click to the pyproject.toml docs dependencies
  • Uses mkdocs-click to display autogenereated helics CLI documentation, and removes the old copy-pasted --help commands.
  • Adds more content to the helics run CLI doc-string and argument help strings.

You should be able to see the changes if you do mkdocs serve and go to the CLI interface section. You can also see the updated documentation at helics run --help.

@josephmckinsey josephmckinsey requested a review from nightlark March 6, 2025 00:16
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.

1 participant