Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README now new documentation website is available #203

Merged
merged 3 commits into from
Feb 7, 2024
Merged

Update README now new documentation website is available #203

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53964e5
Update README now new documentation website is available
GenevieveBuckley Feb 2, 2024
52a146f
Update README.md
GenevieveBuckley Feb 5, 2024
d308b22
Update README.md
GenevieveBuckley Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ This plugin is built on [`naparimovie`](https://github.com/guiwitz/naparimovie)

This plugin remains under development and contributions are very welcome, please open an issue to discuss potential improvements.

You can read the documentation at [https://napari.org/napari-animation](https://napari.org/napari-animation)

## Installation

### PyPI
Expand Down Expand Up @@ -75,6 +77,7 @@ To activate the GUI, select **napari-animation: wizard** from the *plugins menu*
</p>

### Scripting

**napari-animation** can also be run programatically, allowing for reproducible, scripted creation of animations.

```python
Expand All @@ -98,13 +101,14 @@ animation.animate('demo.mov', canvas_only=False)
```

## Examples
Examples can be found in our [Examples gallery](https://napari-animation.github.io/gallery) folder. Simple examples for both interactive and headless

Examples can be found in our [Examples gallery](https://napari.org/napari-animation/gallery), generated from [our example scripts](https://github.com/napari/napari-animation/tree/main/examples). Simple examples for both interactive and headless
use of the plugin follow.

## Contributing

Contributions are very welcome and a detailed contributing guide is coming soon.
In the meantime, clone this repository and install it in editable mode using `pip`.
In the meantime, clone this repository and install it in editable mode using `pip`.
GenevieveBuckley marked this conversation as resolved.
Show resolved Hide resolved
We recommend using a virtual environment, for example `conda`.


Expand Down Expand Up @@ -138,7 +142,13 @@ in your environment as follows:

## Documentation

The documentation for napari-animation is built with [Sphinx](https://www.spinx-doc.org). After installing the documentation dependencies with
The documentation is available at [https://napari.org/napari-animation](https://napari.org/napari-animation)

The documentation for napari-animation is built with [Sphinx](https://www.spinx-doc.org).
GenevieveBuckley marked this conversation as resolved.
Show resolved Hide resolved

### Building docs locally

After installing the documentation dependencies with

```sh
pip install ".[doc]"
Expand All @@ -152,6 +162,13 @@ make docs

Open up the `docs/_build/index.html` file in your browser, and you'll see the home page of the docs being displayed.

### Deploying docs

The napari-animation documentation is automatically built and deployed to the website
whenever the main branch is updated, or a new release is tagged.
This is controlled by the [deploy_docs.yml](https://github.com/napari/napari-animation/blob/main/.github/workflows/deploy_docs.yml) github actions script.

You can also manually trigger a documenation re-build and deployment [from the github actions tab](https://github.com/napari/napari-animation/actions/workflows/deploy_docs.yml).

## License

Expand Down
Loading