napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
9 stars 37 forks source link

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

Closed lucyleeow closed 2 months ago

lucyleeow commented 3 months ago

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 commented 3 months ago

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 👍🏻