pyxem / kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns
https://kikuchipy.org
GNU General Public License v3.0
79 stars 30 forks source link

Switch doc theme from Furo to PyData #574

Closed hakonanes closed 1 year ago

hakonanes commented 1 year ago

Description of the change

This PR switches the doc theme from Furo to PyData. While I find Furo more pleasing, I find navigating the API reference more challenging. Having read API references in other packages (Matplotlib, SciPy, PyVista) using the PyData theme, and finding it easier to navigate, I suggest we use the same theme.

The PyData theme has narrower content, so I had to format the tutorial notebooks with a 80 character line length. Since the code allows 88 characters, and this is what Black checks for (can only configure this for both scripts/notebooks, not separately), I removed the notebook check in the pre commit config. The PR check is updated accordingly. Contributors will have to format notebooks themselves, which is mentioned in the contributing guide.

I anticipate this to be the final change before releasing v0.7.0.

Progress of the PR

For reviewers