Skip to content

Commit 4a19533

Browse files
committed
Renamed Install to Getting started; moved notes to index
1 parent bfbf733 commit 4a19533

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

doc/en/_templates/globaltoc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
22

33
<ul>
44
<li><a href="{{ pathto('index') }}">Home</a></li>
5-
<li><a href="{{ pathto('getting-started') }}">Install</a></li>
5+
<li><a href="{{ pathto('getting-started') }}">Get started</a></li>
66
<li><a href="{{ pathto('contents') }}">Contents</a></li>
77
<li><a href="{{ pathto('reference') }}">API Reference</a></li>
88
<li><a href="{{ pathto('example/index') }}">Examples</a></li>

doc/en/getting-started.rst

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
1-
Installation and Getting Started
1+
Get Started
22
===================================
33

4-
**Pythons**: Python 3.6, 3.7, 3.8, 3.9, PyPy3
5-
6-
**Platforms**: Linux and Windows
7-
8-
**PyPI package name**: `pytest <https://pypi.org/project/pytest/>`_
9-
10-
**Documentation as PDF**: `download latest <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
11-
12-
``pytest`` is a framework that makes building simple and scalable tests easy. Tests are expressive and readable—no boilerplate code required. Get started in minutes with a small unit test or complex functional test for your application or library.
13-
144
.. _`getstarted`:
155
.. _`installation`:
166

177
Install ``pytest``
188
----------------------------------------
199

10+
``pytest`` requires: Python 3.6, 3.7, 3.8, 3.9, or PyPy3.
11+
2012
1. Run the following command in your command line:
2113

2214
.. code-block:: bash
@@ -35,7 +27,7 @@ Install ``pytest``
3527
Create your first test
3628
----------------------------------------------------------
3729

38-
Create a simple test function with just four lines of code:
30+
Create a new file called ``test_sample.py``, containing a function, and a test:
3931

4032
.. code-block:: python
4133
@@ -47,7 +39,7 @@ Create a simple test function with just four lines of code:
4739
def test_answer():
4840
assert func(3) == 5
4941
50-
That’s it. You can now execute the test function:
42+
The test
5143

5244
.. code-block:: pytest
5345

doc/en/index.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,19 @@ pytest: helps you write better programs
1313

1414
.. module:: pytest
1515

16-
The ``pytest`` framework makes it easy to write small tests, yet
17-
scales to support complex functional testing for applications and libraries.
16+
The ``pytest`` framework makes it easy to write small, readable tests, and can
17+
scale to support complex functional testing for applications and libraries.
1818

19-
An example of a simple test:
19+
20+
**Pythons**: ``pytest`` requires: Python 3.6, 3.7, 3.8, 3.9, or PyPy3.
21+
22+
**PyPI package name**: `pytest <https://pypi.org/project/pytest/>`_
23+
24+
**Documentation as PDF**: `download latest <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
25+
26+
27+
A quick example
28+
---------------
2029

2130
.. code-block:: python
2231
@@ -56,7 +65,7 @@ To execute it:
5665
============================ 1 failed in 0.12s =============================
5766
5867
Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used.
59-
See :ref:`Getting Started <getstarted>` for more examples.
68+
See :ref:`Get started <getstarted>` for a basic introduction to using pytest.
6069

6170

6271
Features

0 commit comments

Comments
 (0)