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

Jump to bottom

Add note about autogeneration of plugin docs #395

Merged
merged 2 commits into from
Apr 12, 2024
Merged

Add note about autogeneration of plugin docs #395

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44a5838
Add note about autogeneration of plugin docs
melissawm Apr 7, 2024
c14e69b
Rephrase npe2 docs instructions and add info about Makefile
melissawm Apr 7, 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
10 changes: 10 additions & 0 deletions docs/developers/contributing/documentation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,16 @@ want to contribute. The paths are listed in parentheses below.
- [**Getting started**](getting-started) (in [`napari/docs/tutorials/fundamentals`](https://github.com/napari/docs/tree/main/docs/tutorials/fundamentals)):
these documents are a mix of tutorials and how-tos covering the fundamentals of installing and working with napari for beginners

```{admonition} Plugin documentation
:class: tip

Some of the source files for the [Plugin documentation](plugins-index) are
autogenerated from sources in the [napari/npe2](https://github.com/napari/npe2)
repository. These files' names start with an underscore `_` and will be
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we add an example, "e.g., _npe2_contributions.md"

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or even add that these added files all live in docs/plugins/ (I think this is right?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hesitant to mention filenames and location because these may change and keeping this document up-to-date may be difficult (for example we recently moved a bunch of files under the plugins folder). But I think mentioning they are under "plugins" is reasonable indeed.

generated when the documentation is built and the [`prep_docs.py`](https://github.com/napari/docs/blob/main/docs/_scripts/prep_docs.py)
melissawm marked this conversation as resolved.
Show resolved Hide resolved
script is run. You should not edit them directly.
melissawm marked this conversation as resolved.
Show resolved Hide resolved
```

The [**Examples gallery**](gallery) sources are in the [main `napari/napari` repository](https://github.com/napari/napari/tree/main/examples)
and show code examples of how to use napari.

Expand Down
Loading