@Midnighter created a nice workflow that will publish to pypi on release. We now want to set things up so

1. we use pypi trusted publisher workflows
2. we separate the build and the publish into two sections of the workflow

for reference see how we are doing things for pyosmeta. once we publish to pypi we can then create a trusted workflow using that specific project on pypi.

https://github.com/pyOpenSci/pyosMeta/blob/main/.github/workflows/publish-pypi.yml

once #14 is complete and we know the theme works, the next task will be to publish the theme to pypi. this will then allow us to use it as a remote theme in all of our guidebooks. This depends on #14 being complete however.

We should setup a publish to pypi on Github release using a trusted workflow.

We use MIT in all other repos. let's use it here as well. this would entail adding a LICENSE file to the repo

Right now the readme file has 2i2c. i did use Chris' theme as the base for this to learn!

https://github.com/2i2c-org/sphinx-2i2c-theme

so we want to acknowledge that in the readme as well.

see #2 for a list of repos that we use this theme in now.

Description:

Since the pyos-sphinx-theme is now available on PyPI, we can proceed with migrating the guide to use this package.

Tasks:

1. Migration:

   • Migrate the guide to use the pyos-sphinx-theme package.

2. Clean-Up:

   • Remove all static files associated with the current pydata-sphinx-theme.

3. Testing:

   • Thoroughly test the pyos-sphinx-theme to ensure compatibility and functionality across the documentation.

4. Adjustments:

   • Make any necessary adjustments to the configuration and layout after migration

@sneakers-the-rat suggested some great changes here that i will merge to "ungoof-if-fy" our sphinx theme. we should add those same styles here so they can be applied across all of our books once we create a release!

https://github.com/pyOpenSci/python-package-guide/pull/393/files

this is the css

/* --------------------------------------
De-jumble header items.
See https://github.com/pydata/pydata-sphinx-theme/pull/1784
*/

.bd-header .bd-header__inner {
  padding: 0 1rem;
}

.bd-header .navbar-item {
  height: unset;
  max-height: unset;
}

@media (max-width: 960px) {
  .bd-header .navbar-header-items {
    flex-wrap: wrap;
    row-gap: 0.5rem;
  }
}

.bd-header .navbar-header-items__end,
.bd-header .navbar-header-items__center,
.bd-header .navbar-header-items__start {
  flex-flow: nowrap;
}

.bd-header .navbar-header-items__start {
  width: unset;
}

.bd-header .navbar-header-items__center {
  margin-right: 0.25em !important;
}

.bd-header ul.navbar-nav {
  flex-wrap: wrap;
}

The theme should support the same languages (translations) that the projects using it in order to make sure that any text in the theme itself is also translated when the final document is built.

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!!

This theme will eventually be used across our packaging guide, handbook and peer review guide.
The next step is for someone to test out that the theme works here in this repo.

the tasks for this will be

1. test out the theme locally - do the docs build locally?
2. create a ci workflow that publishes the docs to gh pages using the theme.
3. if that works then we can publish this as a package to pypi (a separate task that i will create now)