From 6ab461f460a8165f3d580b302ada4351d1128157 Mon Sep 17 00:00:00 2001 From: Daniele Procida Date: Tue, 16 Mar 2021 20:26:05 +0000 Subject: [PATCH] Explicitly listed the four documentation sections on index.rst --- doc/en/builtin.rst | 2 +- doc/en/explanation/index.rst | 2 ++ doc/en/how-to/index.rst | 2 ++ doc/en/index.rst | 7 +++++-- doc/en/reference/index.rst | 2 ++ doc/en/reference/reference.rst | 2 +- 6 files changed, 13 insertions(+), 4 deletions(-) diff --git a/doc/en/builtin.rst b/doc/en/builtin.rst index d4d06af15..ad6efd657 100644 --- a/doc/en/builtin.rst +++ b/doc/en/builtin.rst @@ -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`. diff --git a/doc/en/explanation/index.rst b/doc/en/explanation/index.rst index 518fac999..53910f1eb 100644 --- a/doc/en/explanation/index.rst +++ b/doc/en/explanation/index.rst @@ -1,5 +1,7 @@ :orphan: +.. _explanation: + Explanation ================ diff --git a/doc/en/how-to/index.rst b/doc/en/how-to/index.rst index 35b112994..3629591aa 100644 --- a/doc/en/how-to/index.rst +++ b/doc/en/how-to/index.rst @@ -1,5 +1,7 @@ :orphan: +.. _how-to: + How-to guides ================ diff --git a/doc/en/index.rst b/doc/en/index.rst index 102426d46..098b5f181 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -87,7 +87,10 @@ Features Documentation ------------- -Please see :ref:`Contents ` for full documentation, including installation, tutorials and PDF documents. +* :ref:`Get started ` - install pytest and grasp its basics just twenty minutes +* :ref:`How-to guides ` - step-by-step guides, covering a vast range of use-cases and needs +* :ref:`Reference guides ` - includes the complete pytest API reference, lists of plugins and more +* :ref:`Explanation ` - background, discussion of key topics, answers to higher-level questions Bugs/Requests @@ -128,7 +131,7 @@ Save time, reduce risk, and improve code health, while paying the maintainers of `Learn more. `_ 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 `_. diff --git a/doc/en/reference/index.rst b/doc/en/reference/index.rst index fbff0978e..3b2b7b372 100644 --- a/doc/en/reference/index.rst +++ b/doc/en/reference/index.rst @@ -1,5 +1,7 @@ :orphan: +.. _reference: + Reference guides ================ diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 4c5e668d2..d9968b8ab 100644 --- a/doc/en/reference/reference.rst +++ b/doc/en/reference/reference.rst @@ -1,4 +1,4 @@ -.. _`reference`: +.. _`api-reference`: API Reference =============