Merge pull request #253 from antmicro/umarcor/doc/add-logo-and-favicon

docs: add logo and favicon, update colors, copyright and authors

docs/_static/favicon.svg

@@ -0,0 +1 @@
+<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M4 13.564L8.175 16v-4.877L4 8.688v4.876zm0-5.659V3.028l4.175 2.435v4.877L4 7.905zm4.852 2.435l3.841-2.241-3.841-2.241v4.482zm-.339-5.463l4.18-2.439L8.513 0l-4.18 2.438 4.18 2.439z" fill="#10CFC9"/></svg>

docs/_static/logo.svg

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   width="288.41299"
+   height="83.888"
+   viewBox="0 0 288.41299 83.888"
+   fill="none"
+   version="1.1"
+   id="svg13"
+   sodipodi:docname="logo.svg"
+   inkscape:version="1.1.1 (3bf5ae0d25, 2021-09-20)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview15"
+     pagecolor="#505050"
+     bordercolor="#ffffff"
+     borderopacity="1"
+     inkscape:pageshadow="0"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="1"
+     showgrid="false"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:zoom="2.0675422"
+     inkscape:cx="144.37432"
+     inkscape:cy="42.562613"
+     inkscape:window-width="1920"
+     inkscape:window-height="1017"
+     inkscape:window-x="1912"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg13" />
+  <path
+     fill-rule="evenodd"
+     clip-rule="evenodd"
+     d="m 218.704,67.436 c -3.225,0 -6.271,-0.627 -9.137,-1.881 a 23.737,23.737 0 0 1 -7.524,-5.173 25.78,25.78 0 0 1 -5.106,-7.726 c -1.21,-2.956 -1.814,-6.113 -1.814,-9.472 0,-3.36 0.604,-6.495 1.814,-9.406 1.254,-2.911 2.956,-5.464 5.106,-7.659 a 22.92,22.92 0 0 1 7.658,-5.173 c 2.956,-1.254 6.136,-1.88 9.54,-1.88 3.717,0 7.166,0.716 10.346,2.15 3.18,1.432 5.845,3.47 7.995,6.113 l -5.241,5.24 c -1.388,-1.97 -3.247,-3.471 -5.576,-4.501 -2.329,-1.075 -4.837,-1.613 -7.524,-1.613 -3.225,0 -6.069,0.717 -8.532,2.15 -2.419,1.389 -4.3,3.337 -5.643,5.845 -1.344,2.508 -2.016,5.42 -2.016,8.733 0,3.315 0.672,6.248 2.016,8.801 1.388,2.508 3.247,4.48 5.576,5.912 2.329,1.433 4.971,2.15 7.927,2.15 3.135,0 5.823,-0.56 8.062,-1.68 2.284,-1.164 4.031,-2.866 5.24,-5.105 0.758,-1.433 1.279,-3.067 1.562,-4.904 h -14.998 v -7.055 h 23.245 v 1.075 c 0,5.599 -1.008,10.257 -3.023,13.974 -1.971,3.718 -4.681,6.494 -8.129,8.33 -3.449,1.837 -7.39,2.755 -11.824,2.755 z M 123.412,19.737 109.848,49.969 v 4.703 h 22.304 v 12.092 h 7.591 V 54.672 h 6.584 v -6.92 h -6.584 V 35.995 h -7.591 v 11.757 h -12.95 l 12.944,-28.015 z m 39.423,29.291 v 17.736 h -7.726 V 19.737 h 17.467 c 2.956,0 5.599,0.605 7.928,1.814 2.374,1.21 4.232,2.911 5.576,5.106 1.388,2.194 2.083,4.77 2.083,7.726 0,2.956 -0.695,5.531 -2.083,7.726 -1.344,2.194 -3.202,3.896 -5.576,5.105 -2.329,1.21 -4.972,1.814 -7.928,1.814 z m 0,-6.718 h 9.338 c 1.613,0 3.024,-0.313 4.233,-0.94 1.254,-0.672 2.239,-1.59 2.956,-2.755 0.716,-1.21 1.075,-2.62 1.075,-4.232 0,-1.613 -0.359,-3.001 -1.075,-4.166 a 7.019,7.019 0 0 0 -2.956,-2.754 c -1.209,-0.672 -2.62,-1.008 -4.233,-1.008 h -9.338 z m 100.99,-22.573 -19.349,47.027 h 8.196 l 3.615,-9.07 h 20.212 l 3.583,9.07 h 8.331 L 269.199,19.737 Z m 10.02,31.24 -7.407,-18.75 -7.473,18.75 z M 86.199,20.368 h 25.382 l -3.162,7.054 h -22.22 v 12.765 h 16.498 l -3.162,7.054 H 86.199 V 67.395 H 78.473 V 20.369 h 7.726 z"
+     fill="#1226aa"
+     id="path2"
+     style="fill:#ffffff;fill-opacity:1" />
+  <g
+     clip-path="url(#clip0_311_258)"
+     fill="#1226aa"
+     id="g6"
+     transform="translate(-121.678,-25.111)"
+     style="fill:#ffffff;fill-opacity:1">
+    <path
+       d="M 121.677,96.199 144.306,109 V 83.456 L 121.677,70.655 Z m 0,-29.683 V 40.972 l 22.629,12.801 v 25.544 z m 26.232,12.801 20.772,-11.751 -20.772,-11.754 z m -1.8,-28.662 22.572,-12.771 -22.572,-12.773 -22.573,12.773 22.573,12.77 z"
+       id="path4"
+       style="fill:#ffffff;fill-opacity:1" />
+  </g>
+  <defs
+     id="defs11">
+    <clipPath
+       id="clip0_311_258">
+      <path
+         fill="#ffffff"
+         transform="translate(121.678,25.11)"
+         d="M 0,0 H 47.003 V 83.889 H 0 Z"
+         id="path8" />
+    </clipPath>
+  </defs>
+</svg>

docs/collect_readmes.py

@@ -102,7 +102,7 @@ def handle_img(block):
 
     ret = {}
     ret['type'] = 'image'
-    ret['uri'] = os.path.join(*block['uri'].split('/')[3:])
+    ret['uri'] = '_static/' + os.path.join(*block['uri'].split('/')[3:])
     ret['align'] = block.get('align', 'center')
     ret['width'] = block.get('width', '100%')
 

docs/conf.py

@@ -29,16 +29,17 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
+from os import path as os_path, scandir as os_scandir
-import sys
+from sys import path as sys_path
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys_path.insert(0, os_path.abspath('.'))
 
 # -- Project information -----------------------------------------------------
 
-project = u'F4PGA examples'
+project = 'F4PGA examples'
-authors = u'F4PGA Authors'
+authors = 'F4PGA Authors'
-copyright = authors + u', 2020 - 2022'
+copyright = f'{authors}, 2020 - 2022'
 
 # -- General configuration ---------------------------------------------------
 
@@ -60,16 +61,13 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-
 html_show_sourcelink = True
 
 html_theme = 'sphinx_symbiflow_theme'
 
 html_theme_options = {
-    'github_url' : 'https://github.com/chipsalliance/F4PGA-examples',
+    'repo_name': 'chipsalliance/f4pga-examples',
+    'github_url' : 'https://github.com/chipsalliance/f4pga-examples',
     'globaltoc_collapse': True,
     'color_primary': 'indigo',
     'color_accent': 'blue',
@@ -78,24 +76,27 @@ html_theme_options = {
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
+
+html_logo = str(Path(html_static_path[0]) / 'logo.svg')
+html_favicon = str(Path(html_static_path[0]) / 'favicon.svg')
 
 # -- Collect READMEs from examples --------------------------------------------
 
 from collect_readmes import full_name_lut, families, fill_context
 
 jinja_contexts = {}
-top_dir = os.path.join(os.path.dirname(__file__), '..')
+top_dir = os_path.join(os_path.dirname(__file__), '..')
 for family in families:
-    examples = os.scandir(os.path.join(top_dir, family))
+    examples = os_scandir(os_path.join(top_dir, family))
     for example in examples:
         if example.is_dir():
 
             # get README
-            path = os.path.join(top_dir, family, example, 'README.rst')
+            path = os_path.join(top_dir, family, example, 'README.rst')
 
             # skip if file does not exist
-            if not os.path.isfile(path):
+            if not os_path.isfile(path):
                 continue
 
             with open(path) as f:

docs/requirements.txt

@@ -1,5 +1,5 @@
 sphinx
-docutils==0.17
+docutils
 git+https://github.com/SymbiFlow/sphinx_symbiflow_theme.git@chips#egg=sphinx-symbiflow-theme
 sphinx-tabs
 sphinx-jinja

docs/running-examples.rst

@@ -14,7 +14,7 @@ Arty board
 #. Connect the board to your computer using the Ethernet cable
    (only if you want to test the LiteX Linux Example)
 
-.. image:: images/arty-usb-ethernet.png
+.. image:: _static/images/arty-usb-ethernet.png
    :width: 49%
    :align: center
 
@@ -23,7 +23,7 @@ Basys 3 board
 
 Connect the Basys3 Board to your computer using the USB cable:
 
-.. image:: images/basys3-usb.png
+.. image:: _static/images/basys3-usb.png
    :width: 49%
    :align: center
 
@@ -32,13 +32,13 @@ Zybo-Z7 board
 
 Connect the Zybo-Z7 Board to your computer using the USB cable:
 
-.. image:: images/zyboz7-usb.png
+.. image:: _static/images/zyboz7-usb.png
    :width: 49%
    :align: center
 
 Insert the SD card in the dedicated slot:
 
-.. image:: images/zyboz7-sdcard.png
+.. image:: _static/images/zyboz7-sdcard.png
    :width: 49%
    :align: center
 
@@ -209,7 +209,7 @@ Make sure to have :ref:`prepared the SD correctly<prepare-sd>`.
 
 #. Set the jumper J5 to SD.
 
-   .. image:: images/zyboz7-jmp.png
+   .. image:: _static/images/zyboz7-jmp.png
       :width: 49%
       :align: center