Skip to content

Commit edc55ad

Browse files
committed
Add "Simulation Setup" section
1 parent ffbb306 commit edc55ad

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

paths_cli/cli.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ def get_command(self, ctx, name):
6161
return self._get_command.get(name)
6262

6363
def format_commands(self, ctx, formatter):
64-
sec_order = ['Simulation', 'Analysis', 'Miscellaneous', 'Workflow']
64+
sec_order = ["Simulation Setup", 'Simulation', 'Analysis',
65+
'Miscellaneous', 'Workflow']
6566
for sec in sec_order:
6667
cmds = self._sections.get(sec, [])
6768
rows = []

paths_cli/commands/compile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def compile_(input_file, output_file):
9595

9696
PLUGIN = OPSCommandPlugin(
9797
command=compile_,
98-
section="Miscellaneous",
98+
section="Simulation Setup",
9999
requires_ops=(1, 0),
100100
requires_cli=(0, 3)
101101
)

paths_cli/compiling/_gendocs/docs_generator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def generate_category_rst(self, category_plugin):
5454
rst = f".. _compiling--{category_plugin.label}:\n\n"
5555
rst += f"{cat_info.header}\n{'=' * len(str(cat_info.header))}\n\n"
5656
if cat_info.description:
57-
rst += cat_info.description + "\n\n"
57+
rst += cat_info.description + "The following types are available:\n\n"
5858
rst += ".. contents:: :local:\n\n"
5959
for obj in category_plugin.type_dispatch.values():
6060
rst += self.generate_plugin_rst(

0 commit comments

Comments
 (0)