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

SPEC on Sphinx doc? #162

Open
pllim opened this issue Sep 29, 2022 · 3 comments
Open

SPEC on Sphinx doc? #162

pllim opened this issue Sep 29, 2022 · 3 comments

Comments

@pllim
Copy link
Contributor

pllim commented Sep 29, 2022

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

@stefanv
Copy link
Member

stefanv commented Sep 29, 2022

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
Copy link
Member

rossbar commented Sep 29, 2022

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
Copy link
Member

bsipocz commented Sep 30, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants