Finalize a name for this sphinx theme

[choldgraf]

Important note: you will all need to update your conf.py entry for html_theme = "pandas_sphinx_theme" -> html_theme = "pydata_sphinx_theme"

---

We should update the RTD url so that it isn't "pandas" specific - to do that, we'll need to manually update the URL (easiest way is to just delete and re-create the RTD site).

Before we do that - are we happy with the final name? pydata-bootstrap-sphinx-theme?

I think the other obvious option would be just pydata-sphinx-theme. I appreciate the specificity of the former, and the readability of the latter. What do you all think?

[choldgraf]

@jorisvandenbossche can you think of any names other than:

• pydata-bootstrap-sphinx-theme
• pydata-sphinx-theme

And re: these two, I think the two questions to answer are:

1. Do we imagine a different pydata sphinx theme coming into existence that would be unhappy about the name conflict? (this seems unlikely to me)
2. Would NumFocus as "owners" of the pydata brand be unhappy about this (this I'm not as sure about)

[jorisvandenbossche]

To be able to make an actual release, and upload to PyPI (so people can rely on this without needing to install from git master), we need to decide on a name.

This will also break once everybody who is already using the theme, since people will need to update their conf.py (the line html_theme = "pandas_sphinx_theme" will need to start using the new name). So we should do this rename once and forever ;)

So originally the theme was called "pandas-sphinx-theme". Since we want to have it broader than pandas, it was proposed to make this "pydata-sphinx-theme". Personally, my reservation for this was that this sounds as this is thé sphinx theme for pydata projects, while there are of course many themes in use in the community (but in the end I don't mind that much if people prefer this). Therefore I made it a bit more specific to "pydata-bootstrap-sphinx-theme" (a bootstrap theme for the pydata community). But that is a long name ..
We could also make it "bootstrap-sphinx-theme", although this is then very similar and potentially confusing with the existing sphinx-bootstrap-theme.

Alternatively, we could also just pick another "random" name that is not directly using to pandas/pydata/bootstrap in the name, such as .. "alexandria-sphinx-theme" (with a link to the old library in egypt). Or other ideas?

cc @stijnvanhoey @choldgraf (jupyterhub/book) @chrisjsewell (myst) @bryevdv (bokeh) @HTenkanen (Python-GIS-book) @martinRenou (ipycanvas) @stevedodson (eland)

(tagging the users that I know of or found by github search, since you will be affected (need to update conf.py), and might have an opinion on a name ;-))

[jorisvandenbossche]

@choldgraf typed my comment a while ago before I saw yours: regarding "brand" owning by NumFOCUS, that's a good question to which I also don't know the answer, so something to check.

[jorisvandenbossche]

Let's do a quick poll (assuming the pydata brand issue is no problem, we can check in the mean time).

Putting the options in the following comments, and you can use github's "reaction" emoticons to vote (multiple votes allowed, you can also add your own suggestion)

[jorisvandenbossche]

pydata-bootstrap-sphinx-theme

[jorisvandenbossche]

pydata-sphinx-theme

[jorisvandenbossche]

bootstrap-sphinx-theme

[jorisvandenbossche]

alexandria-sphinx-theme

[HTenkanen]

@jorisvandenbossche Thanks for the heads up! If possible, I would vote for something like pydata-sphinx-theme. Imo it's better than something without any linkage to existing eco-system (such as the "alexandria-sphinx-theme"). Leaving out the bootstrap from the name is a good thing I think. I also did not have any problem having the original pandas_sphinx_theme though. Pandas has such a good "brand", so linking this to it wouldn't be a bad thing although I understand the wish for naming this in a way that it would associate to broader ecosystem than Pandas. But all that matters is that this cool theme is available (was getting already a bit bored with rtd-theme although it has served us well). Thanks for making it! 😎

[choldgraf]

I think I also have a slight preference for pydata-sphinx-theme. It is specific but still short enough to quickly type / remember (e.g. I can never remember if it's pydata-bootstrap-sphinx-theme or bootstrap-pydata-sphinx-theme). As long as others in the pydata world are OK with it, I'd be +1 on trying this :-)

[bryevdv]

I really like pydata-sphinx-theme but I think NumFOCUS would appreciate being consulted about the use of "PyData".

[jorisvandenbossche]

Note, given the preference for "pydata-sphinx-theme", I will drop my objections, and I have contacted NumFOCUS about using the name in the meantime (but no answer yet)

[jorisvandenbossche]

OK, I got reply from NumFOCUS that they have no issues with using "pydata" in the name.
So will go ahead with renaming this repo, the package, and making a first release and putting it on PyPI.

[jorisvandenbossche]

OK, package has been renamed, and version 0.1.0 released on PyPI: https://pypi.org/project/pydata-sphinx-theme/ (still need to add a description there :))

Important note: you will all need to update your conf.py entry for html_theme = "pandas_sphinx_theme" -> html_theme = "pydata_sphinx_theme"

[choldgraf]

amazing!

[chrisjsewell]

cheers @jorisvandenbossche 😄

@choldgraf, we now need to go through all our EBP packages, remove the docs/requirements.txt (and its use in the RTD and CircleCI yamls), and add this package to the rtd extras requirement in setup.py

[jorisvandenbossche]

Readthedocs is also updated: https://pydata-sphinx-theme.readthedocs.io/en/latest/
And a conda-forge package is under way: conda-forge/staged-recipes#11088

[jorisvandenbossche]

And available on conda-forge now as well: https://anaconda.org/conda-forge/pydata-sphinx-theme