From 8efbee95b145bb218fb11f0d7c826400be33af8a Mon Sep 17 00:00:00 2001
From: Michael Mitter <michael.mitter@imba.oeaw.ac.at>
Date: Sat, 11 Nov 2023 13:45:22 +0100
Subject: [PATCH] fixed documentation

---
 .github/workflows/build_pages.yml | 1 +
 docs/dataframe_models.md          | 2 +-
 docs/file_parameters_models.md    | 2 +-
 spoc/io.py                        | 2 +-
 spoc/pixels.py                    | 4 ++--
 5 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/build_pages.yml b/.github/workflows/build_pages.yml
index ab0ac1d..4e5c937 100644
--- a/.github/workflows/build_pages.yml
+++ b/.github/workflows/build_pages.yml
@@ -4,6 +4,7 @@ on:
     branches:
       - master
       - docs
+      - pages-build-fix
 permissions:
   contents: write
 jobs:
diff --git a/docs/dataframe_models.md b/docs/dataframe_models.md
index d6d40b0..2cfaea6 100644
--- a/docs/dataframe_models.md
+++ b/docs/dataframe_models.md
@@ -1,3 +1,3 @@
 # Dataframe models
 
-::: spoc.dataframe_models
\ No newline at end of file
+::: spoc.models.dataframe_models
\ No newline at end of file
diff --git a/docs/file_parameters_models.md b/docs/file_parameters_models.md
index ac101e9..aebf87b 100644
--- a/docs/file_parameters_models.md
+++ b/docs/file_parameters_models.md
@@ -1,3 +1,3 @@
 # File parameter models
 
-::: spoc.file_parameter_models
\ No newline at end of file
+::: spoc.models.file_parameter_models
\ No newline at end of file
diff --git a/spoc/io.py b/spoc/io.py
index 6d0333b..15c8a9b 100644
--- a/spoc/io.py
+++ b/spoc/io.py
@@ -88,7 +88,7 @@ def write_fragments(path: str, fragments: Fragments) -> None:
         fragments.data.to_parquet(path, row_group_size=1024 * 1024)
 
     @staticmethod
-    def load_chromosome_sizes(path: str):
+    def load_chromosome_sizes(path: str) -> pd.DataFrame:
         """Load chromosome sizes
 
         Args:
diff --git a/spoc/pixels.py b/spoc/pixels.py
index e3e75db..4d6e8d3 100644
--- a/spoc/pixels.py
+++ b/spoc/pixels.py
@@ -71,7 +71,7 @@ def __init__(
             self._data = None
 
     @staticmethod
-    def from_uri(uri, mode="path"):
+    def from_uri(uri, mode="path") -> "Pixels":
         """Construct pixels from uri.
         Will match parameters based on the following order:
 
@@ -109,7 +109,7 @@ def from_uri(uri, mode="path"):
             uri, load_dataframe=load_dataframe
         )
 
-    def get_global_parameters(self):
+    def get_global_parameters(self) -> PixelParameters:
         """Returns global parameters of pixels
 
         Returns: