scientific-python / specs

Scientific Python Ecosystem Coordination (SPEC) documents
https://scientific-python.org/specs/
BSD 3-Clause "New" or "Revised" License
55 stars 44 forks source link

SPEC on Sphinx doc? #162

Open pllim opened 1 year ago

pllim commented 1 year ago

I vaguely remember discussion about a common Sphinx theme. Was it supposed to be a SPEC or is it something else?

stefanv commented 1 year ago

It may make sense to write a brief SPEC on "Unified theming" for the community.

The theme you are thinking of is pydata-sphinx-theme, and for websites we use the scientific-python-hugo-theme.

rossbar commented 1 year ago

It may make sense to write a brief SPEC on "Unified theming" for the community.

This would be great. In my experience there's been some unstructured, unofficial effort to keep the landing pages for the numpy, scipy, and pandas docs roughly consistent (e.g. using sphinx-design with a 2x2 card layout). I think there's value in doing so, but of course projects can+should be free to style documentation as they please. Anything that improves the communication across projects re: general theming considerations would be great.

bsipocz commented 1 year ago

This would be great. In my experience there's been some unstructured, unofficial effort to keep the landing pages for the numpy, scipy, and pandas docs roughly consistent

and I plan to jump on that wagon with astroquery, and also with astroml. The latter will happen hopefully in the next week or two 😅. So count me in for a spec for this.