Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jojoelfe committed Jul 23, 2024
1 parent b6ebefa commit c33ffad
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ MANIFEST

__pycache__/
/tests/data/*.star~

site/
2 changes: 1 addition & 1 deletion docs/examples/single_block.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
15 changes: 15 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,9 @@ markdown_extensions:

plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [src]
options:
docstring_style: numpy

0 comments on commit c33ffad

Please sign in to comment.