-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Update of the 'getting started' pages in the sphinx section of the documentation #31156
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
DOC: Update of the 'getting started' pages in the sphinx section of the documentation #31156
Conversation
import matplotlib.pyplot as plt | ||
# use the pandas main colors | ||
import matplotlib as mpl | ||
mpl.rcParams['axes.prop_cycle'] = mpl.cycler(color=["#150458", "#FFCA00", "#E70488"]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although this looks really fancy to have the plots in pandas colors ;), I would probably leave this out of a beginners tutorial
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
@stijnvanhoey the doc build is required to pass without any warning or error. First, there are some warnings about images:
I suppose this are the images in the accordion on gettings_started/index.rst. And I think they need one level of Then there are also some warnings generated by the examples in the timeseries tutorial:
the first one is coming from
That's a strange warning, but not something you need to be concerned about in this PR. To get CI green here you can add
|
Opened #31205 for the warning |
This looks great! |
|
||
/* Getting started index page */ | ||
|
||
.intro-card { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved some of those (the ones that are not specific to the getting started pages, but are also used on the home page now) to a pandas.css
(in a previous PR), so you can remove here
Question on how to move forward here. |
Merge away - I think to 1.0.2 right? |
Yep. Thanks @stijnvanhoey! |
…ges in the sphinx section of the documentation
… sphinx section of the documentation (#32052) Co-authored-by: Stijn Van Hoey <stijnvanhoey@gmail.com>
This PR provides an update of the getting started pages of the Pandas documentation, following from the discussion in #26831 and the proposal. The update went together with the creation of the new theme and tries to integrate as much as possible with the new layout (using bootstrap elements). This PR focuses on the getting started section and adds new sections to the documentation:
The aim is to move the dsintro and the basics to the general user guide, as both are too extensive for a getting started section. The 10 intro tutorials try to provide an alternative that is more fit to people starting with Pandas.
There is still some work to do (typo's in the tutorials, additional schemas...), but input is certainly welcome and appreciated, I'll continue improving it. See https://stijnvanhoey.github.io/example-pandas-docs/getting-started/getting_started/index.html for a live preview.
Note: (1) a separate PR is prepared for the general sphinx intro page with @jorisvandenbossche, see #31148 (2) some of the layout issues are more general and related to the new sphinx theme and will be tackled there (e.g. spacing around titles and subtitles)
Some pictures:
The intro to the 10 tutorials:

the coming from section :

example of 'remember' section in each tutorial:
