change docs theme and simplify navigation back to theme provided navi…

…gation restore conf.py move back to pydata-sphinx-theme
siliconcompiler · May 1, 2024 · 66703a3 · 66703a3
1 parent 94c4415
commit 66703a3
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 92 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,7 +51,6 @@
     'sphinx.ext.imgconverter',
     'sphinx.ext.autosummary',
     "sphinx.ext.linkcode",
-    'sphinx_design',                                  # helps with grid views
     'siliconcompiler.sphinx_ext.dynamicgen',
     'siliconcompiler.sphinx_ext.schemagen',
     'clientservergen',
@@ -81,9 +80,6 @@
 
 html_theme_options = {
     "collapse_navigation": True,
-    # 'logo_only': True,
-    # 'display_version': True,
-    # 'navigation_depth': 4,
     "show_toc_level": 3,   # this automatically displays three levels
     "logo": {
         "image_light": 'sc_logo_with_text.png',
@@ -92,7 +88,7 @@
     "github_url": "https://github.com/siliconcompiler/siliconcompiler",  # these are top right
 
     # Add light/dark mode and documentation version switcher:
-    "navbar_end": ["theme-switcher", "navbar-icon-links"],
+    "navbar_end": ["theme-switcher", "navbar-icon-links"]
 }
 
 # Custom sidebar templates, must be a dictionary that maps document names
@@ -102,9 +98,10 @@
 # defined by theme itself.  Builtin themes are using these templates by
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
-#
-# html_sidebars = {}
 
+html_sidebars = {
+  "index": []
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -138,13 +135,6 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 
-_stdauthor = author
-
-latex_documents = [
-    ('index_pdf', 'siliconcompiler.tex', 'SiliconCompiler',
-        _stdauthor, 'manual'),
-]
-
 latex_elements = {
     'extraclassoptions': 'openany,oneside',  # Don't add blank pages after some chapters
     'preamble': latex_preamble

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,12 +1,3 @@
-.. Silicon Compiler documentation master file, created by
-   sphinx-quickstart on Sun Apr 11 16:42:34 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. This is not the full index page. This will taking to the landing page of docs.silicompiler.com
-   There is a index.rst file for each submenu
-   The content of this page will largely be ignored in pdf generation
-
 ##################################################
 Welcome to SiliconCompiler's Documentation!
 ##################################################
@@ -25,67 +16,26 @@ Welcome to SiliconCompiler's Documentation!
 **Useful Links**:
 :ref:`Installation <installation>` | `GitHub Repo <https://github.com/siliconcompiler/siliconcompiler>`_ | `File an Issue <https://github.com/siliconcompiler/siliconcompiler/issues>`_
 
-.. grid:: 2
-
-    .. grid-item-card::
-
-        The fastest way to get started, after installation, is to walk through a simple demo!
-
-        +++
-
-        .. button-ref:: user_guide/quickstart
-            :expand:
-            :color: secondary
-            :click-parent:
-
-            Quickstart Guide
-
-    .. grid-item-card::
-
-        A more complete introduction for new users, this
-	section is for those who want to use their own designs using pre-defined build flows.
-
-
-        +++
-
-        .. button-ref:: user_guide/index
-            :expand:
-            :color: secondary
-            :click-parent:
-
-            Introductory User Guide
-
-
-    .. grid-item-card::
-
-        This section contains useful lookup information, like flow building blocks, the schema and other API references.
-
-        +++
-
-        .. button-ref:: reference_manual/index
-            :expand:
-            :color: secondary
-            :click-parent:
-
-            Reference Manual
-
-    .. grid-item-card::
 
-        This section is for users who are already familiar with the basics in User Guide and would like to build their own flows or add additional functionality.
+.. include:: user_guide/what_is_sc.rst
 
 
-        +++
+###################################
+Getting started
+###################################
 
-        .. button-ref:: development_guide/index
-            :expand:
-            :color: secondary
-            :click-parent:
+The fastest way to get started, after :ref:`installation <installation>`, is to :ref:`walk through a simple demo! <Quickstart guide>`
 
-            Advanced Guide
+A more complete introduction for new users, the :ref:`Introductory User Guide <User Guide>`
+section is intended for those who want to use their own designs using pre-defined build flows.
 
+:ref:`Reference Manual <References>` section contains useful lookup information,
+like flow building blocks, the schema and other API references.
 
+:ref:`Advanced Guide <Advanced Guide>` is intended for users who are already familiar with the basics in User Guide and would like to build their own flows or add additional functionality.
 
-**Getting Help**
+Help
+----
 
 .. rst-class:: page-break
 

diff --git a/docs/index_pdf.rst b/docs/index_pdf.rst
diff --git a/docs/user_guide/index.rst b/docs/user_guide/index.rst
@@ -10,7 +10,7 @@ This guide provides an overview for users. You will also want to look at API Ref
    :caption: Getting Started
    :maxdepth: 1
 
-   What is SiliconCompiler? <introduction>
+   What is SiliconCompiler? <what_is_sc>
    Installation <installation>
    Quickstart guide <quickstart>
 

diff --git a/docs/user_guide/introduction.rst → docs/user_guide/what_is_sc.rst b/docs/user_guide/introduction.rst → docs/user_guide/what_is_sc.rst
@@ -23,16 +23,16 @@ The SiliconCompiler project is based on a standardized :ref:`Schema <SiliconComp
 
 To simplify flow development, the project incorporates a simple object oriented :ref:`Python API<Core API>`. The API includes abstracted set/get access to the Schema, a flowgraph based parallel programming model, and a suite of utility functions for compilation setup and metric tracking.
 
-.. image:: ../_images/sc_overview.png
+.. image:: /_images/sc_overview.png
    :scale: 90%
    :align: center
 
-The expansive data schema, standardized plug-in interfaces, and built-in dynamic module search functionality enables SiliconCompiler to scale effectively to a large number of tools and PDKs. The open source :ref:`building_blocks` sections in the reference manual serves as a good starting point for folks who want to add their own PDKs and tools.
+The expansive data schema, standardized plug-in interfaces, and built-in dynamic module search functionality enables SiliconCompiler to scale effectively to a large number of tools and PDKs. The reference manual serves as a good starting point for folks who want to add their own PDKs and tools.
 
 
 To further reduce design access barriers, the project also supports a :ref:`client-server <Remote Processing>` execution model that leverages the cloud to: 1) reduce tool installation barriers, 2) reduce the barrier to massively parallel elastic compute, and 3) address the NDA barrier for PDK and EDA tools.
 
-.. image:: ../_images/sc_arch.svg
+.. image:: /_images/sc_arch.svg
 
 Supported Technologies
 ----------------------

diff --git a/requirements.txt b/requirements.txt
@@ -41,8 +41,7 @@ scikit-build >= 0.14.1
 #:docs
 Sphinx == 7.3.7
 pip-licenses == 4.4.0
-pydata-sphinx-theme==0.15.2
-sphinx-design == 0.5.0
+pydata-sphinx-theme == 0.15.2
 
 # Testing dependencies
 #:test