Work on: pyos sphinx-theme: Build out pyos-sphinx-theme repo

[lwasser]

At pyOpenSci we have 3 sphinx books that we use to create online content for peer review, our

• Handbook
• Packaging guide + tutorials.
• Peer review guide

each book has customizations that we need to move to different other books. It would be much easier if we could have a pyos sphinx theme to use and call for each that builds on top of the pydata-sphinx-theme we are already using and adds custom styles, etc for pyOpenSci!

I started this repo to create that theme however i really don't know a lot about creating themes. what is here may not work.

If someone could help as a starting place with getting the theme working and perhaps creating a list of things that people could do to help build it out at sprints that would be wonderful!!

[vsalvino]

@lwasser I just learned about pyOpenSci at PyCon. Excellent work :) I happen to know a bit about sphinx themes and would love to help! BUT I'm not familiar with pyOpenSci as a whole. Here's what I'm thinking...

• Can you screenshot/highlight a couple areas of these websites that are custom, that you'd like to see as part of the sphinx theme?
• If there are any files in particular that should be shared between the themes (i.e. CSS file, templates, logo)... could you link to those specifically?

I can start out with:

• A boilerplate sphinx theme, that extends pydata-sphinx-theme
• I'll add the custom CSS etc. from the repo(s).
• I'm assuming it would be OK to completely replace everything in this repository, with the new sphinx theme?

[lwasser]

hey @vsalvino 👋🏻 !! Wow - thank you so so much. that would be incredible! i can definitely help provide that information:

• you can use the repo here which is our package guide as an example of things we customize!

• we customize each repo with a logo for light and dark mode in the conf.py. if you can add image resources to a theme.

• We include / vendor fonts so we aren't interfacing with google fonts online (which tracks users and we want to avoid for privacy reasons).

• we'd like to use matomo analytics in each sphinx book as well.

• these are our custom styles that we want to update in only one place instead of in each repo individually (we use this theme in 3 online books that we have now!

and then any custom conf.py settings in the package guide repo that we can port to a theme rather than having to set them in each book would be wonderful. i don't know enough about sphinx themes to know what exactly we can and can't customize but the goal is to extend the pydata_sphinx_theme as you mention.

your help on this would be wonderful if you still have bandwidth. i'm heading back home and won't be around for the sprints tomorrow but i can support online as needed (in between when i'm traveling!).

does this help? 🙌🏻

[vsalvino]

This is super helpful, thanks! I left on Sunday but was going to work on this on free time throughout the week. I think I have everything I need.

P.S. My specialties are Django, Wagtail, Sphinx, Sass/CSS, some JavaScript, and all things web-hosting/server related. Feel free to tag me if you ever need a helping hand on any of those topics in the future!

[lwasser]

@vsalvino thank you so much! we really appreciate the help. i was out at a meeting so i'm just getting back / catching up on things. i will attach your handle to this issue!! please reach out if you have questions!!

[lwasser]

@all-contributors please add @vsalvino for review

[allcontributors[bot]]

@lwasser

I've put up a pull request to add @vsalvino! :tada:

[vsalvino]

Thanks :) I haven't contributed anything yet... but am working on it slowly but surely!

[lwasser]

No worries. Also please don't feel pressured by my messages! I'm just catching up on issues today