Skip to content

Commit 9bab609

Browse files
committed
DOC: add new page 'how to read these doc' in get started section
This page explains the code block are run in notebook closes #39130
1 parent ee92c2f commit 9bab609

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _overview:
2+
3+
{{ header }}
4+
5+
**********************
6+
How to read these docs
7+
**********************
8+
9+
In these tutorials you will see input code inside code blocks such as:
10+
11+
::
12+
13+
import pandas as pd
14+
pd.DataFrame({'A': [1, 2, 3]})
15+
16+
17+
or:
18+
19+
.. ipython:: python
20+
21+
import pandas as pd
22+
pd.DataFrame({'A': [1, 2, 3]})
23+
24+
25+
26+
The first block is a standard python input, while in the second the `In [1]:` indicates the input is inside a `notebook <https://jupyter.org>`__. It does not make any difference **except the last line will be printed**.
27+
28+
29+
For example:
30+
31+
.. ipython:: python
32+
33+
a = 1
34+
a
35+
36+
is equivalent to:
37+
38+
::
39+
40+
a = 1
41+
print(a)

doc/source/getting_started/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -682,6 +682,7 @@ material is enlisted in the community contributed :ref:`communitytutorials`.
682682

683683
install
684684
overview
685+
how_to_read_these_docs
685686
intro_tutorials/index
686687
comparison/index
687688
tutorials

0 commit comments

Comments
 (0)