Skip to content

Commit 8972ddf

Browse files
DOC: Creating top-level user guide section, and moving pages inside (#24677)
1 parent c588437 commit 8972ddf

21 files changed

+62
-41
lines changed

doc/source/index.rst.template

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -131,25 +131,7 @@ See the package overview for more detail about what's in the library.
131131
cookbook
132132
dsintro
133133
basics
134-
text
135-
options
136-
indexing
137-
advanced
138-
computation
139-
missing_data
140-
groupby
141-
merging
142-
reshaping
143-
timeseries
144-
timedeltas
145-
categorical
146-
integer_na
147-
visualization
148-
style
149-
io
150-
enhancingperf
151-
sparse
152-
gotchas
134+
user_guide/index
153135
r_interface
154136
ecosystem
155137
comparison_with_r
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/source/enhancingperf.rst renamed to doc/source/user_guide/enhancingperf.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -783,15 +783,15 @@ significant performance benefit. Here is a plot showing the running time of
783783
computation. The two lines are two different engines.
784784

785785

786-
.. image:: _static/eval-perf.png
786+
.. image:: ../_static/eval-perf.png
787787

788788

789789
.. note::
790790

791791
Operations with smallish objects (around 15k-20k rows) are faster using
792792
plain Python:
793793

794-
.. image:: _static/eval-perf-small.png
794+
.. image:: ../_static/eval-perf-small.png
795795

796796

797797
This plot was created using a ``DataFrame`` with 3 columns each containing
File renamed without changes.
File renamed without changes.

doc/source/user_guide/index.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{{ header }}
2+
3+
.. _user_guide:
4+
5+
==========
6+
User Guide
7+
==========
8+
9+
The User Guide covers all of pandas by topic area. Each of the subsections
10+
introduces a topic (such as "working with missing data"), and discusses how
11+
pandas approaches the problem, with many examples throughout.
12+
13+
Users brand-new to pandas should start with :ref:`10min`.
14+
15+
Further information on any specific method can be obtained in the
16+
:ref:`api`.
17+
18+
.. toctree::
19+
:maxdepth: 2
20+
21+
io
22+
indexing
23+
advanced
24+
merging
25+
reshaping
26+
text
27+
missing_data
28+
categorical
29+
integer_na
30+
visualization
31+
computation
32+
groupby
33+
timeseries
34+
timedeltas
35+
style
36+
options
37+
enhancingperf
38+
sparse
39+
gotchas

doc/source/indexing.rst renamed to doc/source/user_guide/indexing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1392,15 +1392,15 @@ Performance of :meth:`~pandas.DataFrame.query`
13921392
``DataFrame.query()`` using ``numexpr`` is slightly faster than Python for
13931393
large frames.
13941394

1395-
.. image:: _static/query-perf.png
1395+
.. image:: ../_static/query-perf.png
13961396

13971397
.. note::
13981398

13991399
You will only see the performance benefits of using the ``numexpr`` engine
14001400
with ``DataFrame.query()`` if your frame has more than approximately 200,000
14011401
rows.
14021402

1403-
.. image:: _static/query-perf-small.png
1403+
.. image:: ../_static/query-perf-small.png
14041404

14051405
This plot was created using a ``DataFrame`` with 3 columns each containing
14061406
floating point values generated using ``numpy.random.randn()``.
File renamed without changes.

0 commit comments

Comments
 (0)