Mesa (master): docs: inline contents.rst into index.rst

[GitLab Mirror]

Module: Mesa
Branch: master
Commit: 893a30eacc68b7add6430e3fa3ef59ef5ca306f1
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=893a30eacc68b7add6430e3fa3ef59ef5ca306f1

Author: Erik Faye-Lund <erik.faye-lund at collabora.com>
Date:   Fri Nov 20 14:29:00 2020 +0100

docs: inline contents.rst into index.rst

The idea of having a single file containing the ToC is not really how
things are done in Sphinx, and kinda makes it harder to structure
documentation more naturally. This was just something I did to mirror
what we used to do for the old HTML-only version of the docs, to ease
the transition and to de-clutter index.rst.

Now that the transition is far behind us, and index.rst is much cleaner,
we can finally start inlining this.

In the long run, I expect most of these to be moved to separate "chapter
articles" that summarize what these topics are, and thus disappear from
here.

Reviewed-by: Eric Anholt <eric at anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>

---

 docs/conf.py      |   2 +-
 docs/contents.rst | 105 ----------------------------------------------------
 docs/index.rst    | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 3 files changed, 107 insertions(+), 108 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 2092c0a2117..89e99713ccd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -79,7 +79,7 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = [ "contents.rst" ]
+exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
diff --git a/docs/contents.rst b/docs/contents.rst
deleted file mode 100644
index d8041cc1dbf..00000000000
--- a/docs/contents.rst
+++ /dev/null
@@ -1,105 +0,0 @@
-.. toctree::
-   :maxdepth: 1
-   :caption: Documentation
-   :hidden:
-
-   self
-   history
-   developers
-   systems
-   license
-   faq
-   relnotes
-   thanks
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Download and Install
-   :hidden:
-
-   download
-   install
-   precompiled
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Need help?
-   :hidden:
-
-   lists
-   bugs
-
-.. toctree::
-   :maxdepth: 1
-   :caption: User Topics
-   :hidden:
-
-   shading
-   egl
-   opengles
-   envvars
-   osmesa
-   debugging
-   perf
-   extensions
-   application-issues
-   viewperf
-   xlibdriver
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Drivers
-   :hidden:
-
-   drivers/d3d12
-   drivers/freedreno
-   drivers/llvmpipe
-   drivers/openswr
-   drivers/v3d
-   drivers/vc4
-   drivers/vmware-guest
-   drivers/zink
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Developer Topics
-   :hidden:
-
-   repository
-   sourcetree
-   utilities
-   helpwanted
-   devinfo
-   codingstyle
-   submittingpatches
-   releasing
-   release-calendar
-   sourcedocs
-   dispatch
-   gallium/index
-   android
-   Linux Kernel Drivers <https://www.kernel.org/doc/html/latest/gpu/>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Testing
-   :hidden:
-
-   conform
-   ci/index
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Links
-   :hidden:
-
-   OpenGL Website <https://www.opengl.org>
-   DRI Website <https://dri.freedesktop.org>
-   Developer Blogs <https://planet.freedesktop.org>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Hosted by:
-   :hidden:
-
-   freedesktop.org <https://www.freedesktop.org>
diff --git a/docs/index.rst b/docs/index.rst
index bf1cfb237af..6b3ef7b3774 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,3 @@
-.. include:: contents.rst
-
 Introduction
 ============
 
@@ -29,3 +27,109 @@ and other operating systems.
 .. _EGL: https://www.khronos.org/egl/
 .. _Direct Rendering Infrastructure: https://dri.freedesktop.org/
 .. _X.org: https://x.org
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Documentation
+   :hidden:
+
+   self
+   history
+   developers
+   systems
+   license
+   faq
+   relnotes
+   thanks
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Download and Install
+   :hidden:
+
+   download
+   install
+   precompiled
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Need help?
+   :hidden:
+
+   lists
+   bugs
+
+.. toctree::
+   :maxdepth: 1
+   :caption: User Topics
+   :hidden:
+
+   shading
+   egl
+   opengles
+   envvars
+   osmesa
+   debugging
+   perf
+   extensions
+   application-issues
+   viewperf
+   xlibdriver
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Drivers
+   :hidden:
+
+   drivers/d3d12
+   drivers/freedreno
+   drivers/llvmpipe
+   drivers/openswr
+   drivers/v3d
+   drivers/vc4
+   drivers/vmware-guest
+   drivers/zink
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Developer Topics
+   :hidden:
+
+   repository
+   sourcetree
+   utilities
+   helpwanted
+   devinfo
+   codingstyle
+   submittingpatches
+   releasing
+   release-calendar
+   sourcedocs
+   dispatch
+   gallium/index
+   android
+   Linux Kernel Drivers <https://www.kernel.org/doc/html/latest/gpu/>
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Testing
+   :hidden:
+
+   conform
+   ci/index
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Links
+   :hidden:
+
+   OpenGL Website <https://www.opengl.org>
+   DRI Website <https://dri.freedesktop.org>
+   Developer Blogs <https://planet.freedesktop.org>
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Hosted by:
+   :hidden:
+
+   freedesktop.org <https://www.freedesktop.org>