Merge pull request #1088 from choldgraf/api

updating API page
jupyter · Aug 19, 2019 · 2e0baa2 · 2e0baa2
2 parents bcb4066 + 59e21a4
commit 2e0baa2
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 14 deletions.
diff --git a/docs/source/api/preprocessors.rst b/docs/source/api/preprocessors.rst
@@ -2,6 +2,7 @@ Preprocessors
 =============
 
 .. module:: nbconvert.preprocessors
+   :noindex:
 
 .. seealso::
 
@@ -19,23 +20,42 @@ Preprocessors
 Specialized preprocessors
 -------------------------
 
+Converting and extracting figures
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. autoclass:: ConvertFiguresPreprocessor
 
 .. autoclass:: SVG2PDFPreprocessor
 
 .. autoclass:: ExtractOutputPreprocessor
 
+Converting text
+~~~~~~~~~~~~~~~
+
 .. autoclass:: LatexPreprocessor
 
+.. autoclass:: HighlightMagicsPreprocessor
+
+Metadata and header control
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: ClearMetadataPreprocessor
+
 .. autoclass:: CSSHTMLHeaderPreprocessor
 
-.. autoclass:: HighlightMagicsPreprocessor
+Removing cells, inputs, and outputs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: ClearOutputPreprocessor
 
 .. autoclass:: RegexRemovePreprocessor
 
+.. autoclass:: TagRemovePreprocessor
+
+Executing Notebooks
+~~~~~~~~~~~~~~~~~~~
+
 .. autoclass:: ExecutePreprocessor
     :members:
 
-.. autofunction:: coalesce_streams
+.. autofunction:: coalesce_streams
diff --git a/nbconvert/exporters/templateexporter.py b/nbconvert/exporters/templateexporter.py
@@ -257,7 +257,7 @@ def __init__(self, config=None, **kw):
         extra_loaders : list[of Jinja Loaders]
             ordered list of Jinja loader to find templates. Will be tried in order
             before the default FileSystem ones.
-        template : str (optional, kw arg)
+        template_file : str (optional, kw arg)
             Template to use when exporting.
         """
         super(TemplateExporter, self).__init__(config=config, **kw)

diff --git a/nbconvert/preprocessors/tagremove.py b/nbconvert/preprocessors/tagremove.py
@@ -12,17 +12,25 @@
 
 class TagRemovePreprocessor(ClearOutputPreprocessor):
     """
-    Removes cells from a notebook that have tags that designate they are to be
-    removed prior to exporting the notebook.
-
-    Traitlets:
-    ----------
-    remove_cell_tags: removes cells tagged with these values
-    remove_all_output_tags: removes entire output areas on cells
-                            tagged with these values
-    remove_single_output_tags: removes individual output objects on
-                               outputs tagged with these values
-    remove_input_tags: removes inputs tagged with these values
+    Removes inputs, outputs, or cells from a notebook that
+    have tags that designate they are to be removed prior to exporting
+    the notebook.
+
+    Traitlets
+    ---------
+    remove_cell_tags
+        removes cells tagged with these values
+
+    remove_all_output_tags
+        removes entire output areas on cells
+        tagged with these values
+
+    remove_single_output_tags
+        removes individual output objects on
+        outputs tagged with these values
+
+    remove_input_tags
+        removes inputs tagged with these values
 
     """