diff --git a/doc/en/_static/pytest-custom.css b/doc/en/_static/pytest-custom.css new file mode 100644 index 00000000000..bc9eef457f1 --- /dev/null +++ b/doc/en/_static/pytest-custom.css @@ -0,0 +1,21 @@ +/* Tweak how the sidebar logo is presented */ +.sidebar-logo { + width: 70%; +} +.sidebar-brand { + padding: 0; +} + +/* The landing pages' sidebar-in-content highlights */ +#features ul { + padding-left: 1rem; + list-style: none; +} +#features ul li { + margin-bottom: 0; +} +@media (min-width: 46em) { + #features { + width: 50%; + } +} diff --git a/doc/en/_templates/globaltoc.html b/doc/en/_templates/globaltoc.html deleted file mode 100644 index 09d970b64ed..00000000000 --- a/doc/en/_templates/globaltoc.html +++ /dev/null @@ -1,31 +0,0 @@ -

Contents

- - - -

About the project

- - - -{%- if display_toc %} -
- {{ toc }} -{%- endif %} - -
diff --git a/doc/en/_templates/relations.html b/doc/en/_templates/relations.html deleted file mode 100644 index 3bbcde85bb4..00000000000 --- a/doc/en/_templates/relations.html +++ /dev/null @@ -1,19 +0,0 @@ -

Related Topics

- diff --git a/doc/en/_templates/sidebar/brand.html b/doc/en/_templates/sidebar/brand.html deleted file mode 100644 index f997c4cca5f..00000000000 --- a/doc/en/_templates/sidebar/brand.html +++ /dev/null @@ -1,7 +0,0 @@ - - - diff --git a/doc/en/_templates/sidebarintro.html b/doc/en/_templates/sidebarintro.html deleted file mode 100644 index ae860c172f0..00000000000 --- a/doc/en/_templates/sidebarintro.html +++ /dev/null @@ -1,5 +0,0 @@ -

About pytest

-

- pytest is a mature full-featured Python testing tool that helps - you write better programs. -

diff --git a/doc/en/_templates/style.html b/doc/en/_templates/style.html deleted file mode 100644 index 400cb75ff97..00000000000 --- a/doc/en/_templates/style.html +++ /dev/null @@ -1,7 +0,0 @@ - diff --git a/doc/en/conf.py b/doc/en/conf.py index 9f5f3787c1e..9558a75f927 100644 --- a/doc/en/conf.py +++ b/doc/en/conf.py @@ -25,7 +25,7 @@ # -- General configuration ------------------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -root_doc = "contents" +root_doc = "index" extensions = [ "pygments_pytest", "sphinx.ext.autodoc", @@ -150,35 +150,19 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "furo" +html_theme_options = {"sidebar_hide_name": True} + +html_static_path = ["_static"] +html_css_files = [ + "pytest-custom.css", +] + html_title = "pytest documentation" html_short_title = f"pytest-{release}" -html_logo = "img/pytest_logo_curves.svg" +html_logo = "_static/pytest1.png" html_favicon = "img/favicon.png" -html_sidebars = { - "index": [ - "sidebar/brand.html", - "sidebar/search.html", - "sidebar/scroll-start.html", - "sidebarintro.html", - "globaltoc.html", - "links.html", - "sidebar/scroll-end.html", - "style.html", - ], - "**": [ - "sidebar/brand.html", - "sidebar/search.html", - "sidebar/scroll-start.html", - "globaltoc.html", - "relations.html", - "links.html", - "sidebar/scroll-end.html", - "style.html", - ], -} - html_use_index = False html_show_sourcelink = False diff --git a/doc/en/contents.rst b/doc/en/contents.rst index 181207203b2..07c0b3ff6b9 100644 --- a/doc/en/contents.rst +++ b/doc/en/contents.rst @@ -1,3 +1,5 @@ +:orphan: + .. _toc: Full pytest documentation diff --git a/doc/en/index.rst b/doc/en/index.rst index 8de3b3993dd..a907d1ff549 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -1,5 +1,3 @@ -:orphan: - .. _features: .. sidebar:: **Next Open Trainings and Events** @@ -13,6 +11,36 @@ pytest: helps you write better programs ======================================= +.. toctree:: + :hidden: + + getting-started + how-to/index + reference/index + explanation/index + example/index + +.. toctree:: + :caption: About the project + :hidden: + + changelog + contributing + backwards-compatibility + sponsor + tidelift + license + contact + +.. toctree:: + :caption: Useful links + :hidden: + + pytest @ PyPI + pytest @ GitHub + Issue Tracker + PDF Documentation + .. module:: pytest The ``pytest`` framework makes it easy to write small, readable tests, and can