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.
This commit is contained in:
Tim Hoffmann 2022-05-24 10:23:39 +02:00 committed by GitHub
parent 8ac6dce2c7
commit 9a9acf13f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 1 additions and 20 deletions

View File

@ -29,5 +29,3 @@
{%- endif %} {%- endif %}
<hr> <hr>
<a href="{{ pathto('genindex') }}">Index</a>
<hr>

View File

@ -247,7 +247,7 @@ html_sidebars = {
html_domain_indices = True html_domain_indices = True
# If false, no index is generated. # 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. # If true, the index is split into individual pages for each letter.
# html_split_index = False # html_split_index = False

View File

@ -27,8 +27,6 @@ scale to support complex functional testing for applications and libraries.
**PyPI package name**: :pypi:`pytest` **PyPI package name**: :pypi:`pytest`
**Documentation as PDF**: `download latest <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
A quick example A quick example
--------------- ---------------
@ -104,11 +102,6 @@ Bugs/Requests
Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features. Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features.
Changelog
---------
Consult the :ref:`Changelog <changelog>` page for fixes and enhancements of each version.
Support pytest Support pytest
-------------- --------------
@ -141,13 +134,3 @@ Security
pytest has never been associated with a security vulnerability, but in any case, to report a 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>`_. security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
Tidelift will coordinate the fix and disclosure. 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