Fix readthedocs build error

reichlab · Nov 12, 2024 · c9c09d1 · c9c09d1
1 parent 7c2aa5e
commit c9c09d1
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -142,6 +142,8 @@
     ("py:class", "polars.dataframe.frame.DataFrame"),
     ("py:class", "polars.DataFrame"),
     ("py:class", "polars.lazyframe.frame.LazyFrame"),
+    ("py:class", "cladetime._clade.Clade"),
+    ("py:class", "Clade"),
 ]
 
 

diff --git a/src/cladetime/cladetime.py b/src/cladetime/cladetime.py
@@ -214,7 +214,7 @@ def _get_config(self) -> Config:
 
         return config
 
-    def assign_clades(self, sequence_metadata: pl.LazyFrame, output_file: str | None = None) -> pl.DataFrame:
+    def assign_clades(self, sequence_metadata: pl.LazyFrame, output_file: str | None = None) -> Clade:
         """Assign clades to a specified set of sequences.
 
         For each sequence in a sequence file (.fasta), assign a Nextstrain

diff --git a/src/cladetime/sequence.py b/src/cladetime/sequence.py
@@ -346,7 +346,7 @@ def get_metadata_ids(sequence_metadata: pl.DataFrame | pl.LazyFrame) -> set:
     -------
     set
         A set of
-        :external+ncov:doc:`strains<reference/metadata-fields:column-1-strain>`
+        :external+ncov:doc:`strains<reference/metadata-fields>`
 
     Raises
     ------