diff --git a/docs/_static/skywater-pdk-logo-top.png b/docs/_static/skywater-pdk-logo-top.png new file mode 100644 index 0000000..fe7e334 Binary files /dev/null and b/docs/_static/skywater-pdk-logo-top.png differ diff --git a/docs/_templates/relbar.html b/docs/_templates/relbar.html new file mode 100644 index 0000000..d693e3e --- /dev/null +++ b/docs/_templates/relbar.html @@ -0,0 +1,13 @@ +{% extends '!relbar.html' %} + +{%- block extralinks -%} +{{ super() }} + +
  • business SkyWater
  • +
  • precision_manufacturing Shuttle Program
  • +
  • chat_bubble Chat
  • +
  • campaignAnnouncements
  • +
  • mail Mailing List
  • + + +{%- endblock -%} diff --git a/docs/conf.py b/docs/conf.py index 70129cb..36ba1bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -149,56 +149,24 @@ pygments_style = None # html_theme = "sphinx_symbiflow_theme" +html_logo = "_static/skywater-pdk-logo-top.png" + # 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. -# +# https://sphinx-symbiflow-theme.readthedocs.io/en/latest/customization.html html_theme_options = { - # Specify a list of menu in Header. - # Tuples forms: - # ('Name', 'external url or path of pages in the document', boolean, 'icon name') - # - # Third argument: - # True indicates an external link. - # False indicates path of pages in the document. - # - # Fourth argument: - # Specify the icon name. - # For details see link. - # https://material.io/icons/ - 'header_links': [ - ('Home', 'index', False, 'home'), - ("GitHub", "https://github.com/google/skywater-pdk", True, 'code'), - ("SkyWater", "https://www.skywatertechnology.com/", True, 'link'), - ], + 'nav_title': 'SkyWater SKY130 PDK', - # Customize css colors. - # For details see link. - # https://getmdl.io/customize/index.html - # - # Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue, - # light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo) - 'primary_color': 'light_green', - # Values: Same as primary_color. (Default: pink) - 'accent_color': 'teal', + 'color_primary': 'light-green', + 'color_accent': 'teal', - # Customize layout. - # For details see link. - # https://getmdl.io/components/index.html#layout-section - 'fixed_drawer': True, - 'fixed_header': True, - 'header_waterfall': True, - 'header_scroll': False, + # Set the repo location to get a badge with stats + 'github_url': 'https://github.com/google/skywater-pdk', + 'repo_name': 'google/skywater-pdk', - # Render title in header. - # Values: True, False (Default: False) - 'show_header_title': False, - # Render title in drawer. - # Values: True, False (Default: True) - 'show_drawer_title': True, - # Render footer. - # Values: True, False (Default: True) - 'show_footer': True, + 'globaltoc_depth': 4, + 'globaltoc_collapse': False, # Hide the symbiflow links 'hide_symbiflow_links': True, diff --git a/docs/environment.yml b/docs/environment.yml index cef4cf1..7100f6f 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -16,7 +16,6 @@ name: skywater-pdk-docs channels: - symbiflow -- conda-forge - defaults dependencies: - python=3.8 @@ -26,3 +25,4 @@ dependencies: # Packages installed from PyPI - pip: - -r requirements.txt + - ../scripts/python-skywater-pdk diff --git a/docs/requirements.txt b/docs/requirements.txt index f20b3a6..056d192 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -git+https://github.com/SymbiFlow/sphinx_materialdesign_theme.git#egg=sphinx-symbiflow-theme +git+https://github.com/SymbiFlow/sphinx_symbiflow_theme.git#egg=sphinx-symbiflow-theme docutils sphinx @@ -10,7 +10,7 @@ sphinx-verilog-domain sphinxcontrib-hdl-diagrams # Module diagrams -git+https://github.com/SymbiFlow/symbolator.git#egg=symbolator +#git+https://github.com/SymbiFlow/symbolator.git#egg=symbolator # pycairo # vext.gi