diff --git a/lib/ramble/ramble/cmd/docs.py b/lib/ramble/ramble/cmd/docs.py new file mode 100644 index 000000000..9f28050ea --- /dev/null +++ b/lib/ramble/ramble/cmd/docs.py @@ -0,0 +1,17 @@ +# Copyright 2022-2024 The Ramble Authors +# +# Licensed under the Apache License, Version 2.0 or the MIT license +# , at your +# option. This file may not be copied, modified, or distributed +# except according to those terms. + +import webbrowser + +description = "open Ramble documentation in a web browser" +section = "help" +level = "short" + + +def docs(parser, args): + webbrowser.open("https://ramble.readthedocs.io/") diff --git a/lib/ramble/ramble/main.py b/lib/ramble/ramble/main.py index b563e4bd6..c03e38c1b 100644 --- a/lib/ramble/ramble/main.py +++ b/lib/ramble/ramble/main.py @@ -295,7 +295,7 @@ def add_subcommand_group(title, commands): ramble help --all list all commands and options ramble help help on a specific command ramble help --spec help on the application specification syntax - ramble docs open https://ramble.rtfd.io/ in a browser + ramble docs open https://ramble.readthedocs.io/ in a browser """.format( help=section_descriptions["help"] )