Merge pull request #66 from TUDelftGeodesy/add_api_doc

Add api doc

Author: SarahAlidoost

docs/api_reference.md

@@ -0,0 +1,23 @@
+---
+hide:
+- navigation
+---
+#
+
+Here is the API reference for the `sarxarray` package.
+
+## **SLC stack module**
+
+::: sarxarray.stack.Stack
+
+## **I/O module**
+
+::: sarxarray._io.from_dataset
+
+::: sarxarray._io.from_binary
+
+## **Utility**
+
+::: sarxarray.utils.multi_look
+
+::: sarxarray.utils.complex_coherence

mkdocs.yml

@@ -3,16 +3,17 @@ repo_url: https://github.com/TUDelftGeodesy/sarxarray/
 repo_name: SARXarray
 
 nav:
-  - Getting started: 
+  - Getting started:
     - About SARXarray: index.md
     - Installation: setup.md
-  - Usage: 
+  - Usage:
     - Data loading: data_loading.md
     - Common SLC operations: common_ops.md
     - Other manipulations: manipulations.md
   - Notebook page: notebooks/demo_sarxarray.ipynb
   - Conributing guide: CONTRIBUTING.md
   - Change Log: CHANGELOG.md
+  - API reference: api_reference.md
 
 
 theme:
@@ -40,7 +41,7 @@ theme:
     - navigation.tabs
     - navigation.tabs.sticky
     - content.code.copy
-  
+
 plugins:
 - mkdocs-jupyter:
       include_source: True
@@ -49,16 +50,31 @@ plugins:
     handlers:
       python:
         options:
-          docstring_style: google
+          docstring_style: numpy
           docstring_options:
-            ignore_init_summary: no
-          merge_init_into_class: yes
-          show_submodules: no
+            ignore_init_summary: true
+          merge_init_into_class: true
+          docstring_section_style: list
+          show_submodules: true
+          show_root_heading: true
+          show_source: true
+          heading_level: 3
+          relative_crossrefs: true
+          parameter_headings: false
+          separate_signature: true
+          show_bases: true
+          show_signature_annotations: true
+          show_symbol_type_heading: true
+          signature_crossrefs: true
+          summary: true
+          backlinks: tree
+          scoped_crossrefs: true
 
 markdown_extensions:
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.superfences
+  - pymdownx.highlight
 
 extra:
   generator: false

pyproject.toml

@@ -97,3 +97,6 @@ target-version = "py310"
 
 [tool.ruff.per-file-ignores]
 "tests/**" = ["D"]
+
+[tool.ruff.pydocstyle]
+convention = "numpy"

sarxarray/_io.py

@@ -70,7 +70,7 @@ def from_dataset(ds: xr.Dataset) -> xr.Dataset:
 def from_binary(
     slc_files, shape, vlabel="complex", dtype=np.complex64, chunks=None, ratio=1
 ):
-    """Read a SLC stack or relabted variables from binary files.
+    """Read a SLC stack or related variables from binary files.
 
     Parameters
     ----------

sarxarray/utils.py

@@ -90,7 +90,8 @@ def complex_coherence(
     numerator = mean(R * O`) in a window
     denominator = mean(R * R`) * mean(O * O`) in a window
     coherence = abs( numerator / sqrt(denominator) ),
-    See the equationin chapter 28 in http://doris.tudelft.nl/software/doris_v4.02.pdf
+    See the equation in chapter 28 in [doris
+    documentation](http://doris.tudelft.nl/software/doris_v4.02.pdf)
 
     Parameters
     ----------