Update docs (#64)

teamtomo · Jul 25, 2024 · 13d35c7 · 13d35c7
1 parent b6ebefa
commit 13d35c7
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -19,3 +19,5 @@ MANIFEST
 
 __pycache__/
 /tests/data/*.star~
+
+site/
diff --git a/docs/examples/single_block.md b/docs/examples/single_block.md
@@ -60,4 +60,4 @@ starfile.write(df, 'modified_particles.star')
 ```
 
 For files containing multiple data blocks, please see the
-[multiple data block](./examples/multi_block.md) example.
+[multiple data block](./multi_block.md) example.
diff --git a/docs/index.md b/docs/index.md
@@ -83,3 +83,18 @@ For more advanced usage please check out the examples.
 ```shell
 pip install starfile
 ```
+---
+
+# API
+
+## starfile.read()
+
+::: starfile.read
+
+## starfile.write()
+
+::: starfile.write
+
+## starfile.to_string()
+
+::: starfile.to_string
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -54,3 +54,9 @@ markdown_extensions:
 
 plugins:
   - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [src]
+          options:
+            docstring_style: numpy
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,3 +19,5 @@ MANIFEST

		__pycache__/
		/tests/data/*.star~

		site/