Skip to content

Commit ffc22d0

Browse files
jaimergpjni
andauthored
Add docs about the new napari-base structure (#457)
# References and relevant issues <!-- What relevant resources were used in the creation of this PR? If this PR addresses an existing issue on the repo, please link to that issue here as "Closes #(issue-number)". If this PR adds docs for a napari PR please add a "Depends on <napari PR link>" --> # Description <!-- What does this pull request (PR) do? Does it add new content, improve/fix existing context, improve/fix workflow/documentation build/deployment or something else? <!-- If relevant, please include a screenshot or a screen capture in your content change: "An image is worth a thousand words!" --> <!-- You can use https://www.cockos.com/licecap/ or similar to create animations. --> <!-- You can also see a preview of the documentation changes you are submitting by clicking on "Details" to the right of the "Check the rendered docs here!" check on your PR.--> Describes the actions taken at conda-forge/napari-feedstock#63 <!-- Final Checklist - If images included: I have added [alt text](https://webaim.org/techniques/alttext/) If workflow, documentation build or deployment change: - My PR is the minimum possible work for the desired functionality - I have commented my code, to let others know what it does --> --------- Co-authored-by: Juan Nunez-Iglesias <[email protected]>
1 parent 5a99911 commit ffc22d0

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/developers/coredev/packaging.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This is all automated by the `conda-forge` infrastructure (see [previous example
2626
We only need to check that the metadata in the recipe has been adjusted for the new release.
2727
Pay special attention to the runtime dependencies and version strings!
2828

29-
> We keep a copy of the feedstock's recipe in the `napari/packaging` repo, which is updated manually whenever a change to `setup.cfg` is detected.
29+
> We keep a copy of the feedstock's recipe in the `napari/packaging` repo, which is updated manually whenever a change to `pyproject.toml` is detected.
3030
> Check the file `conda-recipe/meta.yaml` and make sure its `outputs` contents are synced to the `napari-feedstock` copy.
3131
3232
Once the conda-forge CI is passing and the PR is approved and merged, the final packages will be built on the default branch and uploaded to the `conda-forge` channel.
@@ -36,6 +36,22 @@ Due to the staging steps and CDN synchronization delays, the conda packages can
3636
Check {doc}`release` for more details about the conda-forge release process and maintenance tasks.
3737
```
3838

39+
#### conda packaging split
40+
41+
We provide three different outputs in the conda package recipe:
42+
43+
- `napari-base`: This is the package that ships the actual source and data. The runtime
44+
requirements only include the basic functionality. This package is recommended as a
45+
dependency for plugins and other projects. Most end users will prefer the `napari`
46+
package, below, but this one may be useful for those wanting a more minimal
47+
environment.
48+
- `napari`: This output is what most users want. It depends on `napari-base`, and adds optional yet
49+
recommended dependencies for (performant) GUI usage, like the plugin manager or numba. Note that
50+
the Qt backend is _not_ included.
51+
- `napari-menu`: Depends on `napari`, and ships the menuinst JSON file, in case you want a desktop
52+
shortcut to start the application easily. This is included as part of the bundled installers for
53+
convenience.
54+
3955
### conda packages in the `napari` channel
4056

4157
The `napari` project also has a `napari` channel in anaconda.org.

0 commit comments

Comments
 (0)