add example

rpetit3 · Aug 8, 2024 · c0aae41 · c0aae41
1 parent b8fa99e
commit c0aae41
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/camlhmp/engines/blast.py b/camlhmp/engines/blast.py
@@ -34,6 +34,10 @@ def run_blast(engine: str, subject: str, query: str, min_pident: float, min_cove
 
     Returns:
         list: The parsed BLAST results, raw blast results, and stderr
+
+    Examples:
+        >>> from camlhmp.engines.blast import run_blast
+        >>> run_blast("blastn", "subject.fasta", "query.fasta", 95, 95)
     """
     outfmt = " ".join(BLASTN_COLS)
     cat_type = "zcat" if str(subject).endswith(".gz") else "cat"

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -60,10 +60,10 @@ plugins:
         python:
           paths: [camlhmp]
           options:
-            show_source: true
-            show_symbol_type_heading: false
             show_root_heading: true
             show_root_toc_entry: false
+            show_source: true
+            show_symbol_type_heading: false
 
 extra:
   analytics: