From 9a9acf13f89da7578d0b16b48e92ea09102eb755 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Tue, 24 May 2022 10:23:39 +0200 Subject: [PATCH] Declutter doc entry page (#9969) - Remove the index page https://docs.pytest.org/en/7.1.x/genindex.html Such an index is reasonable in books but not so much in HTML pages. IMHO the integrated search is much more user-friendly and sufficient. - Remove the PDF link from the entry page. The PDF is already linked in the sidebar. I anticipate that getting the PDF documentation is not a major concern for users. - Remove the sections "Changelog" and "License" from the entry page. These section only contain links to the respective pages. These topics are purely technical. They should be easily accessible (which they still are through sidebar section "About the project"), but they don't need additional advertisement through a dedicated section on the entry page. --- doc/en/_templates/globaltoc.html | 2 -- doc/en/conf.py | 2 +- doc/en/index.rst | 17 ----------------- 3 files changed, 1 insertion(+), 20 deletions(-) diff --git a/doc/en/_templates/globaltoc.html b/doc/en/_templates/globaltoc.html index 9bd144903..09d970b64 100644 --- a/doc/en/_templates/globaltoc.html +++ b/doc/en/_templates/globaltoc.html @@ -29,5 +29,3 @@ {%- endif %}
-Index -
diff --git a/doc/en/conf.py b/doc/en/conf.py index 1adc3493a..5aedd2d32 100644 --- a/doc/en/conf.py +++ b/doc/en/conf.py @@ -247,7 +247,7 @@ html_sidebars = { html_domain_indices = True # If false, no index is generated. -html_use_index = True +html_use_index = False # If true, the index is split into individual pages for each letter. # html_split_index = False diff --git a/doc/en/index.rst b/doc/en/index.rst index 03a39aaaa..8b4528ddf 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -27,8 +27,6 @@ scale to support complex functional testing for applications and libraries. **PyPI package name**: :pypi:`pytest` -**Documentation as PDF**: `download latest `_ - A quick example --------------- @@ -104,11 +102,6 @@ Bugs/Requests Please use the `GitHub issue tracker `_ to submit bugs or request features. -Changelog ---------- - -Consult the :ref:`Changelog ` page for fixes and enhancements of each version. - Support pytest -------------- @@ -141,13 +134,3 @@ 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 `_. Tidelift will coordinate the fix and disclosure. - - -License -------- - -Copyright Holger Krekel and others, 2004. - -Distributed under the terms of the `MIT`_ license, pytest is free and open source software. - -.. _`MIT`: https://github.com/pytest-dev/pytest/blob/main/LICENSE