scientific-python / summit-2024

1 stars 0 forks source link

update the "writing documentation" guide #16

Closed drammock closed 5 months ago

drammock commented 6 months ago

https://learn.scientific-python.org/development/guides/docs/

This passage in particular needs some help:

For theme, you have several good options. The clean, light-weight Furo theme is shown above. Many scientific packages choose the sphinx-py-data theme, which is also a good choice (no dark mode, though).

(gets the name of pydata-sphinx-theme wrong, and is also wrong about dark mode)

Ideally though I think the examples should use PST instead of Furo, since PST uptake is pretty broad among the core packages now