Merge pull request #57 from arewm/noepilog

add directive to ignore epilog when parsing

Author: dpryan79

sphinxarg/ext.py

@@ -235,6 +235,7 @@ class ArgParseDirective(Directive):
                        prog=unchanged, path=unchanged, nodefault=flag,
                        nodefaultconst=flag, filename=unchanged,
                        manpage=unchanged, nosubcommands=unchanged, passparser=flag,
+                       noepilog=unchanged, nodescription=unchanged,
                        markdown=flag, markdownhelp=flag)
 
     def _construct_manpage_specific_structure(self, parser_info):
@@ -248,29 +249,38 @@ def _construct_manpage_specific_structure(self, parser_info):
             SEE ALSO
             BUGS
         """
+        items = []
         # SYNOPSIS section
         synopsis_section = nodes.section(
             '',
             nodes.title(text='Synopsis'),
             nodes.literal_block(text=parser_info["bare_usage"]),
             ids=['synopsis-section'])
+        items.append(synopsis_section)
         # DESCRIPTION section
-        description_section = nodes.section(
-            '',
-            nodes.title(text='Description'),
-            nodes.paragraph(text=parser_info.get(
-                'description', parser_info.get(
-                    'help', "undocumented").capitalize())),
-            ids=['description-section'])
-        nested_parse_with_titles(
-            self.state, self.content, description_section)
-        if parser_info.get('epilog'):
+        if 'nodescription' not in self.options:
+            description_section = nodes.section(
+                '',
+                nodes.title(text='Description'),
+                nodes.paragraph(text=parser_info.get(
+                    'description', parser_info.get(
+                        'help', "undocumented").capitalize())),
+                ids=['description-section'])
+            nested_parse_with_titles(
+                self.state, self.content, description_section)
+            items.append(description_section)
+        if parser_info.get('epilog') and 'noepilog' not in self.options:
             # TODO: do whatever sphinx does to understand ReST inside
             # docstrings magically imported from other places. The nested
             # parse method invoked above seem to be able to do this but
             # I haven't found a way to do it for arbitrary text
-            description_section += nodes.paragraph(
-                text=parser_info['epilog'])
+            if description_section:
+                description_section += nodes.paragraph(
+                    text=parser_info['epilog'])
+            else:
+                description_section = nodes.paragraph(
+                    text=parser_info['epilog'])
+                items.append(description_section)
         # OPTIONS section
         options_section = nodes.section(
             '',
@@ -285,15 +295,13 @@ def _construct_manpage_specific_structure(self, parser_info):
                 options_section += nodes.paragraph()
                 options_section += nodes.subtitle(text=action_group['title'])
                 options_section += self._format_optional_arguments(action_group)
-        items = [
-            # NOTE: we cannot generate NAME ourselves. It is generated by
-            # docutils.writers.manpage
-            synopsis_section,
-            description_section,
-            # TODO: files
-            # TODO: see also
-            # TODO: bugs
-        ]
+
+        # NOTE: we cannot generate NAME ourselves. It is generated by
+        # docutils.writers.manpage
+        # TODO: items.append(files)
+        # TODO: items.append(see also)
+        # TODO: items.append(bugs)
+
         if len(options_section.children) > 1:
             items.append(options_section)
         if 'nosubcommands' not in self.options:
@@ -462,15 +470,15 @@ def run(self):
         markDownHelp = False
         if 'markdownhelp' in self.options:
             markDownHelp = True
-        if 'description' in result:
+        if 'description' in result and 'nodescription' not in self.options:
             if markDownHelp:
                 items.extend(renderList([result['description']], True))
             else:
                 items.append(self._nested_parse_paragraph(result['description']))
         items.append(nodes.literal_block(text=result['usage']))
         items.extend(print_action_groups(result, nested_content, markDownHelp))
         items.extend(print_subcommands(result, nested_content, markDownHelp))
-        if 'epilog' in result:
+        if 'epilog' in result and 'noepilog' not in self.options:
             items.append(self._nested_parse_paragraph(result['epilog']))
 
         # Traverse the returned nodes, modifying the title IDs as necessary to avoid repeats