Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated plot summary #661

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

eatwhatyoukill
Copy link

Fix #325: Add Season Summary Visualization example; output can be generated with sphinx-build
image

@theOehrly
Copy link
Owner

Hi, this looks pretty cool 👍 I'm pretty busy right now though, so it might take a few more days until I get around to reviewing this, just FYI :)

@theOehrly
Copy link
Owner

Ok, so everything seems to be working fine. This is how the plot is rendered in the documentation right now:

grafik

(Screenshot is cut off at the bottom, don't worry about that.)

First, compare with https://docs.fastf1.dev/gen_modules/examples_gallery/plot_results_tracker.html#sphx-glr-gen-modules-examples-gallery-plot-results-tracker-py
You'll note that you can introduce section breaks for explanatory parts. Have a look at the source for this example here:
https://github.com/theOehrly/Fast-F1/blob/master/examples/plot_results_tracker.py

It would be nice to have this a bit more "tutorial/documentation style" instead of it just being a long script. You can insert longer explanatory section if you like and if you feel like this could benefit new users and help them understand the code more easily.

Second, you can see that the graph is rendered smaller and the axis labels are missing every second driver. Maybe you can persuade plotly/sphinx to render this a bit larger so that there is space for all axis labels.

Have you tried building the documentation locally? That would be helpful for you, so that you can quickly test how everything looks. Here is a short guide for setting up the documentation build locally: https://docs.fastf1.dev/contributing/documenting_fastf1.html#documenting-fastf1

Feel free to ask if you have any questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] Inspiration for additional examples
2 participants