Skip to content

DOC: Minimal getting started page #21313

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

Merged
merged 2 commits into from
Oct 9, 2021
Merged
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
14 changes: 14 additions & 0 deletions doc/_static/mpl.css
Original file line number Diff line number Diff line change
Expand Up @@ -231,3 +231,17 @@ table.property-table td {
/* fix width to width of cheatsheet */
width: 210px;
}

/* Two columns for install code blocks */
div.twocol {
padding-left: 0;
padding-right: 0;
display: flex;
gap: 20px;
}

div.twocol > div {
flex-grow: 1;
padding: 0;
margin: 0;
}
54 changes: 54 additions & 0 deletions doc/users/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Getting started
===============

Installation
------------

.. container:: twocol

.. container::

Install using pip:

.. code-block:: bash

pip install matplotlib

.. container::

Install using conda:

.. code-block:: bash

conda install matplotlib

Further details are available in the :doc:`Installation Guide </users/installing>`.


Draw a first plot
-----------------

Here is a minimal example plot you can try out:

.. plot::
:include-source:
:align: center

import matplotlib.pyplot as plt
import numpy as np

x = np.linspace(0, 2 * np.pi, 200)
y = np.sin(x)

fig, ax = plt.subplots()
ax.plot(x, y)
plt.show()


Where to go next
----------------

- Check out :doc:`Plot types </plot_types/index>` to get an overview of the
types of plots you can create with Matplotlib.
- Learn Matplotlib from the ground up in the
:doc:`Quick-start guide </tutorials/introductory/usage>`.
1 change: 1 addition & 0 deletions doc/users/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Usage guide
../plot_types/index.rst
../tutorials/index.rst
../gallery/index.rst
getting_started.rst
explain.rst
../faq/index.rst
../api/index.rst
Expand Down