diff --git a/.gitignore b/.gitignore index b3c6eb3..400e18c 100644 --- 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 index c9e1116..95bc31a 100644 --- 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 index b101670..bb123fb 100644 --- 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 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index ed1848e..58078ff 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,3 +54,9 @@ markdown_extensions: plugins: - search + - mkdocstrings: + handlers: + python: + paths: [src] + options: + docstring_style: numpy \ No newline at end of file