[lldb/infra] Revamp lldb.llvm.org

This patch brings a fresh coat of paint to the LLDB website.

This uses the `furo` theme from the suggested theme list, adds some
changes to the css to make it use the full browser window width and
removes the table of contents since the theme generates it automatically.

This patch also rewrites the tables for "GDB to LLDB command map" to
convert them from raw HTML to native inlined code blocks.

To generate the website, make sure you install the theme first with
`pip install furo`, enable sphinx in the cmake invocation` then run
`ninja docs-lldb-html`

Discourse: https://discourse.llvm.org/t/rfc-revamping-lldbs-website

Differential Revision: https://reviews.llvm.org/D158323

Signed-off-by: Med Ismail Bennani <[email protected]>

Author: medismailben

lldb/docs/_static/lldb.css

@@ -57,6 +57,16 @@
         )
     extensions.append("sphinx_automodapi.automodapi")
 
+    try:
+        import furo
+    except ModuleNotFoundError:
+        print(
+            f"install sphinx furo theme with {sys.executable} -m pip install furo"
+        )
+    # The theme to use for HTML and HTML Help pages.  See the documentation for
+    # a list of builtin themes.
+    html_theme = "furo"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -131,23 +141,19 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
+html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-    "font_size": "11pt",
-    # Don't generate any links to GitHub.
-    "github_button": "false",
-}
+html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "The LLDB Debugger"
+html_title = "🐛 LLDB"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None
@@ -166,10 +172,6 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-html_context = {
-    "css_files": ["_static/lldb.css"],
-}
-
 html_extra_path = [".htaccess"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

lldb/docs/conf.py

@@ -1,9 +1,6 @@
 Building
 ========
 
-.. contents::
-   :local:
-
 Getting the Sources
 -------------------
 

lldb/docs/resources/build.rst

@@ -1,9 +1,6 @@
 Caveats
 =======
 
-.. contents::
-   :local:
-
 .. _python_caveat:
 
 Python

lldb/docs/resources/caveats.rst

@@ -7,9 +7,6 @@ general architecture.
 
 LLDB has many code groupings that makeup the source base:
 
-.. contents::
-   :local:
-
 API
 ---
 

lldb/docs/resources/overview.rst

@@ -4,9 +4,6 @@ Open Projects
 The following is a mostly unordered set of the ideas for improvements to the
 LLDB debugger. Some are fairly deep, some would require less effort.
 
-.. contents::
-   :local:
-
 Speed up type realization in lldb
 ---------------------------------
 

lldb/docs/resources/projects.rst

@@ -1,9 +1,6 @@
 Testing
 =======
 
-.. contents::
-   :local:
-
 Test Suite Structure
 --------------------
 

lldb/docs/resources/test.rst

@@ -1,9 +1,6 @@
 Frame and Thread Format
 =======================
 
-.. contents::
-   :local:
-
 LLDB has a facility to allow users to define the format of the information that
 generates the descriptions for threads and stack frames. Typically when your
 program stops at a breakpoint you will get two lines that describes why your

lldb/docs/use/formatting.rst

@@ -1,9 +1,6 @@
 Tracing with Intel Processor Trace
 ==================================
 
-.. contents::
-  :local:
-
 Intel PT is a technology available in modern Intel CPUs that allows efficient
 tracing of all the instructions executed by a process.
 LLDB can collect traces and dump them using its symbolication stack.