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.

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

Add info on how plugin docs from npe2 are deployed #391

Closed
lucyleeow opened this issue Apr 6, 2024 · 1 comment · Fixed by #395
Closed

Add info on how plugin docs from npe2 are deployed #391

lucyleeow opened this issue Apr 6, 2024 · 1 comment · Fixed by #395
Labels
content Ideas for new or improved content

Comments

@lucyleeow
Copy link
Collaborator

docs_deployment.md is very useful but we don't have info on how the plugin docs from npe2 are deployed.

@melissawm do you know how it works?

@melissawm
Copy link
Member

Yes - there is a little note here about this: https://napari.org/dev/developers/contributing/documentation/index.html#organization-of-the-documentation

The actual building of the autogenerated .md files is done in https://github.com/napari/docs/blob/main/docs/_scripts/prep_docs.py

I can add a better description in the contributing documentation guide 👍🏻

@melissawm melissawm added the content Ideas for new or improved content label Apr 6, 2024
psobolewskiPhD pushed a commit that referenced this issue Apr 12, 2024
# References and relevant issues
Closes #391 

# Description
Adds a note about how the plugin docs are generated from npe2 templates
through the prep_docs.py script.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Ideas for new or improved content
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants