Merge pull request #3119 from grondo/minor-doc-fixes

doc: fix flux-help(1) output and rendering of NODESET.rst
flux-framework · Aug 7, 2020 · 93dcbc9 · 93dcbc9
2 parents e1d9de7 + 6ce244c
commit 93dcbc9
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/doc/man1/flux-exec.rst b/doc/man1/flux-exec.rst
@@ -66,7 +66,7 @@ OPTIONS
 NODESET FORMAT
 ==============
 
-.. literalinclude:: NODESET.rst
+.. include:: NODESET.rst
 
 
 RESOURCES

diff --git a/doc/man1/flux-hwloc.rst b/doc/man1/flux-hwloc.rst
@@ -61,7 +61,7 @@ are
 NODESET FORMAT
 ==============
 
-.. literalinclude:: NODESET.rst
+.. include:: NODESET.rst
 
 
 RESOURCES

diff --git a/etc/gen-cmdhelp.py b/etc/gen-cmdhelp.py
@@ -40,6 +40,8 @@
             line = line.rstrip("\n")
             if ".. flux-help-" in line:
                 include_flag = True
+                if cmd.startswith("flux-"):
+                    cmd = cmd[5:]
                 if ".. flux-help-description: " in line:
                     descr = " ".join(line.split(" ")[2:])
                 if ".. flux-help-command: " in line: