[Mesa-dev] [PATCH v2 12/15] docs: Edits to fix toctrees.

Laura Ekstrand laura at jlekstrand.net
Wed May 30 22:53:24 UTC 2018


ReStructured Text toctrees are used to automatically generate the
sidebar.  But all top-level headings get added to it by default.  In
order to workaround this, you must create one and only one
top-level heading for each page.
---
 docs/download.rst  |  2 +-
 docs/faq.rst       |  2 +-
 docs/index.rst     | 42 +++++++++++++++++++++---------------------
 docs/install.rst   |  9 ++++++++-
 docs/intro.rst     |  2 +-
 docs/license.rst   |  3 +++
 docs/lists.rst     |  2 +-
 docs/llvmpipe.rst  |  3 +++
 docs/osmesa.rst    |  2 +-
 docs/releasing.rst |  2 +-
 docs/systems.rst   |  7 +++++--
 11 files changed, 46 insertions(+), 30 deletions(-)

diff --git a/docs/download.rst b/docs/download.rst
index 6317269342..a71f3b5cac 100644
--- a/docs/download.rst
+++ b/docs/download.rst
@@ -1,5 +1,5 @@
 Downloading
-===========
+'''''''''''
 
 Primary Mesa download site:
 `ftp.freedesktop.org <ftp://ftp.freedesktop.org/pub/mesa/>`__ (FTP) or
diff --git a/docs/faq.rst b/docs/faq.rst
index 46c349fc4c..543ef548b6 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -1,5 +1,5 @@
 Mesa Frequently Asked Questions
-===============================
+'''''''''''''''''''''''''''''''
 
 Last updated: 9 October 2012
 
diff --git a/docs/index.rst b/docs/index.rst
index 1894b46a4b..2e3283063d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,14 +3,15 @@
    :caption: Documentation
    :hidden:
 
-   intro
+   Introduction <intro>
+   self
    developers
    systems
    license
-   faq
+   FAQ <faq>
    relnotes
    thanks
-   conformance
+   Conformance <conform>
 
 .. toctree::
    :maxdepth: 1
@@ -19,7 +20,6 @@
 
    download
    install
-   autoconf
    precompiled
 
 .. toctree::
@@ -30,23 +30,7 @@
    lists
    bugs
    webmaster
-   useful-links
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Developer Topics
-   :hidden:
-
-   repository
-   sourcetree
-   utilities
-   helpwanted
-   devinfo
-   codingstyle
-   submittingpatches
-   releasing
-   sourcedocs
-   dispatch
+   Mesa/DRI Wiki <https://dri.freedesktop.org/>
 
 .. toctree::
    :maxdepth: 1
@@ -68,6 +52,22 @@
    application-issues
    viewperf
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Developer Topics
+   :hidden:
+
+   repository
+   sourcetree
+   utilities
+   helpwanted
+   devinfo
+   codingstyle
+   submittingpatches
+   releasing
+   sourcedocs
+   dispatch
+
 
 .. toctree::
    :maxdepth: 1
diff --git a/docs/install.rst b/docs/install.rst
index 8f5920091c..177e393d56 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -1,5 +1,12 @@
 Compiling and Installing
-========================
+''''''''''''''''''''''''
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   Autoconf <autoconf>
+   Meson <meson>
 
 #. `Prerequisites for building <#prereq-general>`__
 
diff --git a/docs/intro.rst b/docs/intro.rst
index 11be79643a..a85a257fc8 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -1,5 +1,5 @@
 Introduction
-============
+''''''''''''
 
 The Mesa project began as an open-source implementation of the
 `OpenGL <https://www.opengl.org/>`__ specification - a system for
diff --git a/docs/license.rst b/docs/license.rst
index e6ffb06623..40387f4dc2 100644
--- a/docs/license.rst
+++ b/docs/license.rst
@@ -1,3 +1,6 @@
+License & Copyright
+'''''''''''''''''''
+
 Disclaimer
 ==========
 
diff --git a/docs/lists.rst b/docs/lists.rst
index da71722cfb..2984b7fcc3 100644
--- a/docs/lists.rst
+++ b/docs/lists.rst
@@ -1,5 +1,5 @@
 Mailing Lists
-=============
+'''''''''''''
 
 There are four Mesa 3D / DRI mailing lists:
 
diff --git a/docs/llvmpipe.rst b/docs/llvmpipe.rst
index b232b8a18f..e88bf3d6a7 100644
--- a/docs/llvmpipe.rst
+++ b/docs/llvmpipe.rst
@@ -1,3 +1,6 @@
+Gallium LLVMPipe Driver
+'''''''''''''''''''''''
+
 Introduction
 ============
 
diff --git a/docs/osmesa.rst b/docs/osmesa.rst
index 570f119b3a..3317b5ed4e 100644
--- a/docs/osmesa.rst
+++ b/docs/osmesa.rst
@@ -1,5 +1,5 @@
 Off-screen Rendering
-====================
+''''''''''''''''''''
 
 Mesa's off-screen interface is used for rendering into user-allocated
 memory without any sort of window system or operating system
diff --git a/docs/releasing.rst b/docs/releasing.rst
index ad7dcb9c38..46aefc5849 100644
--- a/docs/releasing.rst
+++ b/docs/releasing.rst
@@ -1,5 +1,5 @@
 Releasing process
-=================
+'''''''''''''''''
 
 -  `Overview <#overview>`__
 -  `Release schedule <#schedule>`__
diff --git a/docs/systems.rst b/docs/systems.rst
index b05aff0621..d299086f85 100644
--- a/docs/systems.rst
+++ b/docs/systems.rst
@@ -1,5 +1,5 @@
-Supported Systems and Drivers
-=============================
+Platforms & Drivers
+'''''''''''''''''''
 
 Mesa is primarily developed and used on Linux systems. But there's also
 support for Windows, other flavors of Unix and other systems such as
@@ -9,6 +9,9 @@ software drivers.
 The primary API is OpenGL but there's also support for OpenGL ES 1, ES2
 and ES 3, OpenVG, OpenCL, VDPAU, XvMC and the EGL interface.
 
+Supported Systems and Drivers
+=============================
+
 Hardware drivers include:
 
 -  Intel i965, i945, i915. See `Intel's
-- 
2.14.3



More information about the mesa-dev mailing list