Skip to content

DOC: add new page 'how to read these doc' in get started section #39207

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions doc/source/getting_started/how_to_read_these_docs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. _howtoread:

{{ header }}

**********************
How to read these docs
**********************

In these tutorials you will see input code inside code blocks such as:

::

import pandas as pd
pd.DataFrame({'A': [1, 2, 3]})


or:

.. ipython:: python

import pandas as pd
pd.DataFrame({'A': [1, 2, 3]})



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>`__. In Jupyter Notebook the last line is printed and plots are shown inline.

For example:

.. ipython:: python

a = 1
a

is equivalent to:

::

a = 1
print(a)
1 change: 1 addition & 0 deletions doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -682,6 +682,7 @@ material is enlisted in the community contributed :ref:`communitytutorials`.

install
overview
how_to_read_these_docs
intro_tutorials/index
comparison/index
tutorials