diff --git a/doc/conf.py b/doc/conf.py index 9992c582e6b68..e61fb876643d0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -128,7 +128,7 @@ source_encoding = "utf-8" # The main toctree document. -root_doc = "contents" +root_doc = "index" # General information about the project. project = "scikit-learn" @@ -245,13 +245,6 @@ "pygment_light_style": "tango", "pygment_dark_style": "monokai", "logo": { - # TODO: we should put "link": "index" here, but it is not currently working - # because the navbar-logo component is using hasdoc() to determine if the link - # is an internal link or an external url, while html_additional_pages do not - # seem to pass hasdoc(). See - # https://github.com/pydata/pydata-sphinx-theme/issues/1647 - # If this cannot be fixed we can consider vendoring the navbar-logo component - # and fixing it ourselves. "alt_text": "scikit-learn homepage", "image_relative": "logos/scikit-learn-logo-small.png", "image_light": "logos/scikit-learn-logo-small.png", @@ -373,6 +366,8 @@ # redirects dictionary maps from old links to new links redirects = { "documentation": "index", + "contents": "index", + "preface": "index", "auto_examples/feature_selection/plot_permutation_test_for_classification": ( "auto_examples/model_selection/plot_permutation_tests_for_classification" ), diff --git a/doc/contents.rst b/doc/index.rst similarity index 67% rename from doc/contents.rst rename to doc/index.rst index f37aad8c5547b..afe15ae4f044f 100644 --- a/doc/contents.rst +++ b/doc/index.rst @@ -1,17 +1,10 @@ -.. include:: includes/big_toc_css.rst -.. include:: tune_toc.rst +.. title:: Index -.. Places global toc into the sidebar - -:globalsidebartoc: True - -================= -Table Of Contents -================= - -.. Define an order for the Table of Contents: +.. Define the overall structure, that affects the prev-next buttons and the order + of the sections in the top navbar. .. toctree:: + :hidden: :maxdepth: 2 Install diff --git a/doc/preface.rst b/doc/preface.rst deleted file mode 100644 index 447083a3a8136..0000000000000 --- a/doc/preface.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. This helps define the TOC ordering for "about us" sections. Particularly - useful for PDF output as this section is not linked from elsewhere. - -.. Places global toc into the sidebar - -:globalsidebartoc: True - -.. _preface_menu: - -.. include:: includes/big_toc_css.rst -.. include:: tune_toc.rst - -======================= -Welcome to scikit-learn -======================= - -| - -.. toctree:: - :maxdepth: 2 - - install - faq - support - related_projects - about - testimonials/testimonials - whats_new - roadmap - governance - -|