add

baseplate-admin · May 6, 2024 · fe33a89 · fe33a89
1 parent c048f21
commit fe33a89
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/docs/resvg.rst b/docs/resvg.rst
@@ -3,10 +3,13 @@ Resvg Module
 
 .. currentmodule:: resvg_py.svg_to_base64
 
-.. function:: svg_to_base64(svg:str,width:int|None=None,height:int|None=None,zoom:int|None=None,dpi:int|None=None,resources_dir:width:str|None=None,languages:list[str]|None=None,font_size:float|None=None,font_family:str|None=None,serif_family:str|None=None,sans_serif_family:str|None=None,cursive_family:str|None=None,fantasy_family:str|None=None,monospace_family:str|None=None,font_files:list[str]|None=None,font_dirs:list[str]|None=None,shape_rendering:"optimize_speed"|"crisp_edges"|"geometric_precision"="geometric_precision",text_rendering:"optimize_speed"|"optimize_legibility"|"geometric_precision"="optimize_legibility",image_rendering:"optimize_quality"|"optimize_speed"="optimize_quality",background:str|None=None) -> str
+.. function:: svg_to_base64(svg_str:str,svg_path:str,width:int|None=None,height:int|None=None,zoom:int|None=None,dpi:int|None=None,resources_dir:width:str|None=None,languages:list[str]|None=None,font_size:float|None=None,font_family:str|None=None,serif_family:str|None=None,sans_serif_family:str|None=None,cursive_family:str|None=None,fantasy_family:str|None=None,monospace_family:str|None=None,font_files:list[str]|None=None,font_dirs:list[str]|None=None,shape_rendering:"optimize_speed"|"crisp_edges"|"geometric_precision"="geometric_precision",text_rendering:"optimize_speed"|"optimize_legibility"|"geometric_precision"="optimize_legibility",image_rendering:"optimize_quality"|"optimize_speed"="optimize_quality",background:str|None=None) -> str
 
-    :param svg: A string containing valid svg.
-    :type svg: string
+    :param svg_str: A string containing valid svg.
+    :type svg_str: string
+
+    :param svg_path: A path to a valid svg.
+    :type svg_str: string
 
     :param width: An Integer containing the pixels size for width.
     :type width: int or None

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -30,7 +30,7 @@ We can convert it to `PNG` by:
         </svg>
     """
 
-    print(resvg_py.svg_to_base64(svg_string)) 
+    print(resvg_py.svg_to_base64(svg_string=svg_string)) 
 
 
 This should return the following **PNG** image (check using inspect element):
@@ -51,7 +51,7 @@ We can also do something like this :
 
     svg = ... # path to svg file
 
-    print(resvg_py.svg_to_base64(svg)) 
+    print(resvg_py.svg_to_base64(svg_path=svg))