Get back the navigation sidebar on the LLDB website

[JDevlieghere]

Summary

This is a little experiment to get back the navigation sidebar on the LLDB website like it used to be: https://web.archive.org/web/20170204135403/http://lldb.llvm.org/

Note that due to a dependency tracking problem you need to

rm -rf tools/lldb/docs/html && ninja docs-lldb-html

to see the updated CSS.

[aprantl]

lldb/docs/_static/lldb.css

27

This is copied & pasted from the old static website.

[aprantl]

lldb/docs/index.rst

73

This doesn't work yet.

[aprantl]

Make Doxygen links in sidebar work.

[aprantl]

Do you think the fact that sphinx doesn't update the css will be a problem on lldb.llvm.org with the way the script is run? (ninja clean does not delete the html directory either).

[aprantl]

I think I addressed most/all of the outstanding bugs.

[aprantl]

Add more context to the diff.

[aprantl]

More tweaks from Jonas & me.

[JDevlieghere]

Hostile take-over of the patch ;-)

[JDevlieghere]

Fix pre-padding

lldb/docs/CMakeLists.txt

else()
   message(STATUS "Could NOT find epydoc")
 endif()
 
 if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html lldb)
+      # Sphinx does not reliably update the custom CSS files, so force
+      # a clean rebuild of the documentation every time.
+      add_custom_target(clean-lldb-html COMMAND "${CMAKE_COMMAND}" -E
+        remove_directory ${CMAKE_CURRENT_BINARY_DIR}/html)
+      add_dependencies(docs-lldb-html clean-lldb-html)
     endif()
   endif()
 endif()

lldb/docs/_static/lldb.css

+div.document {
+  width: 90%;
+}
+
+div.body {
+  max-width: 90%;
+}
+
 table.mapping {
   width: 100%;
 }
 
 table.mapping td {
   width: 50%;
   padding: 5px;
 }
 
 table.mapping td.hed {
   background: #606060;
-  color: white;
+  color: #fefefe;
   text-align: left;
-  border-bottom: 2px #fff solid;
+  border-bottom: 2px #fefefe solid;
   font-weight: bold;
 }
 
 table.mapping td.header {
-  background: #eee;
+  background: #eeeeee;
 }
 
 table.mapping td.content {
   font-family: monospace;
   padding-bottom: 15px;
 }
 
+div.sphinxsidebar h4,
+div.sphinxsidebar p, div.sphinxsidebar p a {
+  font: bold 12px Helvetica, Verdana, sans-serif;
+  color: #fefefe;
+  background: #606060; 
+  margin-bottom: 0;
+  text-transform: uppercase;
+  padding: 7px 0 7px 7px;
+}
+
+div.sphinxsidebar a.reference {
+    text-decoration: none;
+    border-bottom: 1px solid #fefefe;
+}
+
+div.sphinxsidebar li {
+  margin-left: 0px;
+  padding-left: 0px;
+}
+
+div.sphinxsidebar ul {
+    margin: 0px;
+}
+
+div.sphinxsidebar ul,
+div.sphinxsidebar ul a {
+  font: normal 10px Helvetica, Verdana, sans-serif;
+  background: #e9e9e9;
+  display: block;
+  padding: 5px 0;
+  line-height: 17px;
+  border-bottom: 1px solid #fefefe;
+}
+
+div.sphinxsidebar h3 {
+  /* Hide Navigation. */
+  display: none;
+}

lldb/docs/conf.py

 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'haiku'
+html_theme = 'alabaster'
 
 # 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 = {}
+html_theme_options = {
+    'font_size': '11pt'
+}
 
 # 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'
 

lldb/docs/index.rst

 
 LLDB is the default debugger in Xcode on macOS and supports debugging C,
 Objective-C and C++ on the desktop and iOS devices and simulator.
 
 All of the code in the LLDB project is available under the standard
 `LLVM License <http://llvm.org/docs/DeveloperPolicy.html#copyright-license-and-patents>`__,
 an open source "BSD-style" license.
 
-
-Goals & Status
-==============
-
 .. toctree::
+   :hidden:
    :maxdepth: 1
+   :caption: Goals & Status
 
    status/about
    status/goals
    status/features
    status/status
    status/projects
 
-Use & Extension
-===============
-
 .. toctree::
+   :hidden:
    :maxdepth: 1
+   :caption: Use & Extension
 
    use/tutorial
    use/map
    use/formatting
    use/variable
    use/symbolication
    use/symbols
    use/python
    use/python-reference
    use/remote
    use/troubleshooting
    use/architecture
 
-Resources
-=========
-
 .. toctree::
+   :hidden:
    :maxdepth: 1
+   :caption: Resources
 
    resources/download
    resources/source
    resources/build
    resources/test
    resources/bots
    resources/sbapi
 
-API Documentation
-=================
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: API Documentation
+
+   Public Python API Reference <https://lldb.llvm.org/python_reference/index.html>
+   Public C++ API Reference <https://lldb.llvm.org/cpp_reference/namespacelldb.html>
+   Private C++ Reference <https://lldb.llvm.org/cpp_reference/index.html>
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: External Links
 
-* `Public Python API Reference <https://lldb.llvm.org/python_reference/index.html>`_
-* `Public C++ API Reference <https://lldb.llvm.org/cpp_reference/namespacelldb.html>`_
-* `Private C++ Reference <https://lldb.llvm.org/cpp_reference/index.html>`_
-
-External Links
-==============
-
-* `Source Code <http://llvm.org/viewvc/llvm-project/lldb/trunk/>`_
-* `Code Reviews <https://reviews.llvm.org>`_
-* `Bug Reports <https://bugs.llvm.org/>`_
+   Source Code <http://llvm.org/viewvc/llvm-project/lldb/trunk/>
+   Code Reviews <https://reviews.llvm.org>
+   Bug Reports <https://bugs.llvm.org/>