improve and update brainrender installation docs - Githubissues

brainglobe / brainglobe.github.io

brainglobe.info website

https://brainglobe.info/

Creative Commons Attribution 4.0 International

10 stars 8 forks source link

improve and update brainrender installation docs #107

Closed alessandrofelder closed 11 months ago

alessandrofelder commented 11 months ago

Description

What is this PR

[ ] Bug fix
[ ] Addition of a new feature
[x] Other

Why is this PR needed?

For the upcoming release of brainrender we move to NEP 29.

What does this PR do?

Updates and future-proofs the brainrender install docs to the upcoming release
Mention in the installation docs that some Windows users need pyside2 from conda
Mention in the installtion docs that videos need ffmpeg installed

References

Closes #106 Closes #102

Partially addresses https://github.com/brainglobe/brainrender/issues/253

How has this PR been tested?

Inspection of locally built website.

Is this a breaking change?

Nope.

Does this PR require an update to the documentation?

NA

Checklist:

[x] The code has been tested locally (manually)
[NA] Tests have been added to cover all new functionality (unit & integration)
[NA] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit