Skip to content

Commit 9a9acf1

Browse files
authored
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.
1 parent 8ac6dce commit 9a9acf1

File tree

3 files changed

+1
-20
lines changed

3 files changed

+1
-20
lines changed

doc/en/_templates/globaltoc.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,3 @@ <h3>About the project</h3>
2929
{%- endif %}
3030

3131
<hr>
32-
<a href="{{ pathto('genindex') }}">Index</a>
33-
<hr>

doc/en/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@
247247
html_domain_indices = True
248248

249249
# If false, no index is generated.
250-
html_use_index = True
250+
html_use_index = False
251251

252252
# If true, the index is split into individual pages for each letter.
253253
# html_split_index = False

doc/en/index.rst

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ scale to support complex functional testing for applications and libraries.
2727

2828
**PyPI package name**: :pypi:`pytest`
2929

30-
**Documentation as PDF**: `download latest <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
31-
3230

3331
A quick example
3432
---------------
@@ -104,11 +102,6 @@ Bugs/Requests
104102
Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features.
105103

106104

107-
Changelog
108-
---------
109-
110-
Consult the :ref:`Changelog <changelog>` page for fixes and enhancements of each version.
111-
112105
Support pytest
113106
--------------
114107

@@ -141,13 +134,3 @@ Security
141134
pytest has never been associated with a security vulnerability, but in any case, to report a
142135
security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
143136
Tidelift will coordinate the fix and disclosure.
144-
145-
146-
License
147-
-------
148-
149-
Copyright Holger Krekel and others, 2004.
150-
151-
Distributed under the terms of the `MIT`_ license, pytest is free and open source software.
152-
153-
.. _`MIT`: https://github.com/pytest-dev/pytest/blob/main/LICENSE

0 commit comments

Comments
 (0)