Skip to content

Explicitly listed the four documentation sections on index.rst #8455

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.

Sign up for GitHub

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
bluetech merged 1 commit into from
Mar 18, 2021
Merged

Explicitly listed the four documentation sections on index.rst #8455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion doc/en/builtin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Pytest API and builtin fixtures
================================================


Most of the information of this page has been moved over to :ref:`reference`.
Most of the information of this page has been moved over to :ref:`api-reference`.

For information on plugin hooks and objects, see :ref:`plugins`.

Expand Down
2 changes: 2 additions & 0 deletions doc/en/explanation/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:orphan:

.. _explanation:

Explanation
================

Expand Down
2 changes: 2 additions & 0 deletions doc/en/how-to/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:orphan:

.. _how-to:

How-to guides
================

Expand Down
7 changes: 5 additions & 2 deletions doc/en/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,10 @@ Features
Documentation
-------------

Please see :ref:`Contents <toc>` for full documentation, including installation, tutorials and PDF documents.
* :ref:`Get started <get-started>` - install pytest and grasp its basics just twenty minutes
* :ref:`How-to guides <how-to>` - step-by-step guides, covering a vast range of use-cases and needs
* :ref:`Reference guides <reference>` - includes the complete pytest API reference, lists of plugins and more
* :ref:`Explanation <explanation>` - background, discussion of key topics, answers to higher-level questions


Bugs/Requests
Expand Down Expand Up @@ -128,7 +131,7 @@ Save time, reduce risk, and improve code health, while paying the maintainers of
`Learn more. <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_

Security
^^^^^^^^
~~~~~~~~

pytest has never been associated with a security vulnerability, but in any case, to report a
security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
Expand Down
2 changes: 2 additions & 0 deletions doc/en/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:orphan:

.. _reference:

Reference guides
================

Expand Down
2 changes: 1 addition & 1 deletion doc/en/reference/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _`reference`:
.. _`api-reference`:

API Reference
=============
Expand Down