search

py-econometrics / pyfixest

Fast High-Dimensional Fixed Effects Regression in Python following fixest-syntax
https://py-econometrics.github.io/pyfixest/pyfixest.html
MIT License
129 stars 29 forks source link

Examples Layout Docs #541

Open juanitorduz opened 1 month ago

juanitorduz commented 1 month ago

I could imagine many new examples coming up :) . The current layout makes this hard as they will fill the header right?

image

Is there any Quarto layout to let us have a "gallery view like" https://scikit-learn.org/stable/auto_examples/index.html ?

s3alfisc commented 1 month ago

Yes, I fully agree that it doesn't look amazing and that there are many more example notebooks to be written (e.g. I'd like to have a side by side comparison of r-fixest and py-fixest as @Wenzhi-Ding had suggested at one point).

Adding a side bar should definitely be possible - the quartodoc documentation, which is of course written in quartodoc (😄) has a nice sidebar panel. There also is an example section with more example pages. Let me know in case you spot one that you particularly like! =)

s3alfisc commented 1 month ago

Btw, with which tool are the scikit-learn docs build? Is it sphinx?

juanitorduz commented 1 month ago

Btw, with which tool are the scikit-learn docs build? Is it sphinx?

I think so... I will try to see if we can get something similar in Quarto.

For example, looking into https://quarto.org/docs/gallery/#websites I found this example https://docs.modular.com/mojo/notebooks/ or https://ibis-project.org/ (I like this latter)