Change documentation theme to PyData - Githubissues

pyxem / orix

Analysing crystal orientations and symmetry in Python

https://orix.readthedocs.io

GNU General Public License v3.0

79 stars 45 forks source link

Change documentation theme to PyData #428

Closed hakonanes closed 1 year ago

hakonanes commented 1 year ago

Description of the change

This PR changes our Sphinx documentation theme from Furo to PyData, as suggested in #423.

Almost all changes are cosmetic, i.e. doc contents are only changed slightly in some places.

Progress of the PR

[n/a] Docstrings for all functions
[n/a] Unit tests with pytest for all lines
[n/a] Clean code style by running black via pre-commit
[x] Write "orix" to the right of the logo in the nav bar

For reviewers

[ ] The PR title is short, concise, and will make sense 1 year later.
[ ] New functions are imported in corresponding __init__.py.
[ ] New features, API changes, and deprecations are mentioned in the unreleased section in CHANGELOG.rst.
[ ] Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in .zenodo.json.

hakonanes commented 1 year ago

I'm happy with this and suggest we make a v0.11 release. I'll make a PR pulling everything in develop into main after we've merged this.