Skip to content

Commit

Permalink
Add the missing ramble docs command
Browse files Browse the repository at this point in the history
It simply opens up the doc page, same as what Spack does.
  • Loading branch information
linsword13 committed Dec 27, 2024
1 parent 39345d8 commit f6199b2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions lib/ramble/ramble/cmd/docs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2022-2024 The Ramble Authors
#
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
# <LICENSE-MIT or https://opensource.org/licenses/MIT>, 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/")
2 changes: 1 addition & 1 deletion lib/ramble/ramble/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ def add_subcommand_group(title, commands):
ramble help --all list all commands and options
ramble help <command> 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"]
)
Expand Down

0 comments on commit f6199b2

Please sign in to comment.