Merge pull request #3 from PhilippImhof/pr-483

Pr 483

Author: cobordism

manim/utils/tex.py

@@ -103,37 +103,28 @@ def prepend_to_preamble(self, txt):
         ----------
         txt : :class:`str`
             String containing the text to be added, e.g. ``\\usepackage{siunitx}``
-        Returns
-        -------
-        None
         """
         self.preamble = txt + "\n" + self.preamble
         self.rebuild()
 
     def add_to_preamble(self, txt):
-        """Adds txt to the TeX template preamble just before \begin{document}
+        """Adds txt to the TeX template preamble just before \\begin{document}
 
         Parameters
         ----------
         txt : :class:`str`
             String containing the text to be added, e.g. ``\\usepackage{hyperref}``
-        Returns
-        -------
-        None
         """
         self.preamble += "\n" + txt
         self.rebuild()
 
     def add_to_document(self, txt):
-        """Adds txt to the TeX template just after \begin{document}
+        """Adds txt to the TeX template just after \\begin{document}, e.g. ``\\boldmath``
 
         Parameters
         ----------
         txt : :class:`str`
             String containing the text to be added.
-        Returns
-        -------
-        None
         """
         self.post_doc_commands += "\n" + txt + "\n"
         self.rebuild()
@@ -145,6 +136,7 @@ def get_texcode_for_expression(self, expression):
         ----------
         expression : :class:`str`
             The string containing the expression to be typeset, e.g. ``$\\sqrt{2}$``
+
         Returns
         -------
         :class:`str`
@@ -161,6 +153,7 @@ def get_texcode_for_expression_in_env(self, expression, environment):
             The string containing the expression to be typeset, e.g. ``$\\sqrt{2}$``
         environment : :class:`str`
             The string containing the environment in which the expression should be typeset, e.g. ``align*``
+
         Returns
         -------
         :class:`str`

manim/utils/tex_file_writing.py

@@ -28,15 +28,15 @@ def tex_to_svg_file(expression, environment=None, tex_template=None):
     ----------
     expression : :class:`str`
         String containing the TeX expression to be rendered, e.g. ``\\sqrt{2}`` or ``foo``
-    environment : :class:`str`
+    environment : Optional[:class:`str`], optional
         The string containing the environment in which the expression should be typeset, e.g. ``align*``
-        Optional. If not set, the expression will be rendered in text mode.
-    tex_template : :class:`TexTemplate`
-        Template class used to typesetting.
-        Optional. If not set, the default template will be used.
+    tex_template : Optional[:class:`TexTemplate`], optional
+        Template class used to typesetting. If not set, use default template set via `config["tex_template"]`
+
     Returns
     -------
-    Path to generated SVG file.
+    :class:`str`
+        Path to generated SVG file.
     """
     if tex_template is None:
         tex_template = config["tex_template"]
@@ -47,24 +47,26 @@ def tex_to_svg_file(expression, environment=None, tex_template=None):
     return convert_to_svg(dvi_file, tex_template.output_format)
 
 
-def generate_tex_file(expression, environment, tex_template):
+def generate_tex_file(expression, environment=None, tex_template=None):
     """Takes a tex expression (and an optional tex environment),
     and returns a fully formed tex file ready for compilation.
 
     Parameters
     ----------
     expression : :class:`str`
         String containing the TeX expression to be rendered, e.g. ``\\sqrt{2}`` or ``foo``
-    environment : :class:`str`
+    environment : Optional[:class:`str`], optional
         The string containing the environment in which the expression should be typeset, e.g. ``align*``
-        Optional. If not set, the expression will be rendered in text mode.
-    tex_template : :class:`TexTemplate`
-        Template class used to typesetting.
-        Optional. If not set, the default template will be used.
+    tex_template : Optional[:class:`TexTemplate`], optional
+        Template class used to typesetting. If not set, use default template set via `config["tex_template"]`
+
     Returns
     -------
-    Generated TeX file ready for compilation
+    :class:`string`
+        Path to generated TeX file 
     """
+    if tex_template is None:
+        tex_template = config["tex_template"]
     if environment is not None:
         output = tex_template.get_texcode_for_expression_in_env(expression, environment)
     else:
@@ -87,14 +89,15 @@ def tex_compilation_command(tex_compiler, output_format, tex_file, tex_dir):
         String containing the compiler to be used, e.g. ``pdflatex`` or ``lualatex``
     output_format : :class:`str`
         String containing the output format generated by the compiler, e.g. ``.dvi`` or ``.pdf``
-        Optional. If not set, the expression will be rendered in text mode.
     tex_file : :class:`str`
         File name of TeX file to be typeset.
     tex_dir : :class:`str`
         Path to the directory where compiler output will be stored.
+
     Returns
     -------
-    Path to generated output file.
+    :class:`str`
+        Compilation command according to given parameters
     """
     if tex_compiler in {"latex", "pdflatex", "luatex", "lualatex"}:
         commands = [
@@ -140,10 +143,11 @@ def compile_tex(tex_file, tex_compiler, output_format):
         String containing the compiler to be used, e.g. ``pdflatex`` or ``lualatex``
     output_format : :class:`str`
         String containing the output format generated by the compiler, e.g. ``.dvi`` or ``.pdf``
-        Optional. If not set, the expression will be rendered in text mode.
+
     Returns
     -------
-    Path to generated output file.
+    :class:`str`
+        Path to generated output file in desired format (DVI, XDV or PDF).
     """
     result = tex_file.replace(".tex", output_format)
     result = Path(result).as_posix()
@@ -173,13 +177,15 @@ def convert_to_svg(dvi_file, extension, regen_if_exists=False, page=1):
         File name of the input file to be converted.
     extension : :class:`str`
         String containing the file extension and thus indicating the file type, e.g. ``.dvi`` or ``.pdf``
-    regen_if_exists : `bool`
-        Setting if SVG has to be regenerated even if it already exists. Optional, defaulting to False.
-    page : `int`
-        Page to be converted if input file is multi-page. Optional, defaulting to 1.
+    regen_if_exists : Optional[:class:`bool`], optional
+        Setting if SVG has to be regenerated even if it already exists. 
+    page : Optional[:class:`int`], optional
+        Page to be converted if input file is multi-page.
+
     Returns
     -------
-    Path to generated SVG file."""
+    :class:`str`
+        Path to generated SVG file."""
     result = dvi_file.replace(extension, ".svg")
     result = Path(result).as_posix()
     dvi_file = Path(dvi_file).as_posix()