Merge Demo and examples

fury-gl / fury

FURY - Free Unified Rendering in pYthon.

https://fury.gl

Other

227 stars 165 forks source link

Merge Demo and examples #769

Closed skoudoro closed 1 year ago

skoudoro commented 1 year ago

This PR merge demo and examples in one folder.

To simplify the maintenance, 2 new files has been added:

docs/examples/_valid_examples.toml : this script let you organize all examples in categories, etc...
docs/source/ext/prepare_gallery.py: a new sphinx extension that will permit to revamp our examples folder in sphinx-gallery input format.

After merging this PR, all PR containing an example might need to be rebased and follow the standard

Garyfallidis commented 1 year ago

Hi @skoudoro. This is good. The section needs to be called tutorials on the website.

One a side note. Can you disable the automatic tool that breaks function' parameters to one for each line?. It makes code harder to look and requires much more scrolling.

Garyfallidis commented 1 year ago

@Mk996 this PR simplifies the tutorials quite a bit and changes the mechanism. Please have a look at this PR to know what has changed that can affect your work.