From 2fe48f6e2f0dc38671392bd2641b5b0a157b6be8 Mon Sep 17 00:00:00 2001 From: Karol Gugala Date: Thu, 2 Mar 2023 17:03:41 +0100 Subject: [PATCH] Update results theme Signed-off-by: Karol Gugala --- .github/workflows/bench.yml | 2 +- docs/requirements.txt | 7 ++ docs/source/conf.py | 225 ++++++++++-------------------------- docs/source/index.rst | 8 +- 4 files changed, 70 insertions(+), 172 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/bench.yml b/.github/workflows/bench.yml index 64fe762..09e5a96 100644 --- a/.github/workflows/bench.yml +++ b/.github/workflows/bench.yml @@ -106,7 +106,7 @@ jobs: sudo apt-get update sudo apt-get -y install python3 python3-setuptools python3-pip git grep make sudo pip3 install tabulate sphinx jinja2 - sudo pip3 install git+https://github.com/antmicro/sphinx_antmicro_theme.git + sudo pip3 install -r docs/requirements.txt ./table_maker.py --dirs \ benching/cv32e40p_standard_32_false \ benching/cv32e41p_standard_32_false \ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..7c8e777 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,7 @@ +sphinx +sphinx_tabs + +https://github.com/antmicro/sphinx-immaterial/releases/download/tip/sphinx_immaterial-0.0.post1.tip-py3-none-any.whl +https://github.com/antmicro/antmicro-sphinx-utils/archive/main.zip +https://github.com/antmicro/sphinxcontrib-internal/archive/master.zip +https://github.com/return42/linuxdoc/archive/master.zip diff --git a/docs/source/conf.py b/docs/source/conf.py index cfab68b..4730967 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,199 +1,90 @@ # -*- coding: utf-8 -*- # -# Configuration file for the Sphinx documentation builder. +# This file is execfile()d with the current directory set to its containing dir. # -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# 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. +# Note that not all possible configuration values are present in this file. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -from sphinx_antmicro_theme import __version__, get_html_theme_path -theme_path = get_html_theme_path() + "/sphinx_antmicro_theme" - -# -- Project information ----------------------------------------------------- - -project = 'Embench-LiteX tester' -copyright = '2020-2022, Antmicro' -author = 'Antmicro' - -# The short X.Y version -version = '' -# The full version, including alpha/beta/rc tags -release = '' - +# All configuration values have a default; values that are commented out +# serve to show the default. +# +# Updated documentation of the configuration options is available at +# https://www.sphinx-doc.org/en/master/usage/configuration.html -# -- General configuration --------------------------------------------------- +from datetime import datetime -# If your documentation needs a minimal Sphinx version, state it here. -# -needs_sphinx = '1.8' +from antmicro_sphinx_utils.defaults import ( + antmicro_html, + antmicro_latex +) -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ - 'sphinx.ext.githubpages', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', - 'sphinx.ext.extlinks', + 'sphinxcontrib.internal', + 'sphinx_immaterial' ] -dev = 'https://github.com/antmicro/embench-tester/' - -extlinks = { - 'issue' : (dev + 'issues/%s', '#') -} +# If extensions (or modules to document with autodoc) are in another directory, +# 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. +#sys.path.insert(0, os.path.abspath('.')) -numfig = True -todo_include_todos = False +# -- General configuration ----------------------------------------------------- -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +# General information about the project. +project = u'Embench Tester - Dashboard' +basic_filename = u'embench-tester--dashboard' +if 'tags' in globals() and 'internal' in tags: + basic_filename = f'INTERNAL--{basic_filename}' + project = f'{project} | INTERNAL' +authors = u'Antmicro' +copyright = f'{authors}, {datetime.now().year}' -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' -# The master toctree document. -master_doc = 'index' +# This is temporary before the clash between myst-parser and immaterial is fixed +sphinx_immaterial_override_builtin_admonitions = False -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None +numfig = True -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] +# If you need to add extensions just add to those lists +# extensions = default_extensions +# myst_enable_extensions = default_myst_enable_extensions -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +myst_substitutions = { + "project": project +} today_fmt = '%Y-%m-%d' -# -- Options for HTML output ------------------------------------------------- +todo_include_todos=False -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_antmicro_theme' +# -- Options for HTML output --------------------------------------------------- -# 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 = {} - -# 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'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - -html_title = project - -html_logo = theme_path+'/logo-400-html.png' +html_theme = 'sphinx_immaterial' html_last_updated_fmt = today_fmt html_show_sphinx = False -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Embench-LiteXtesterdoc' - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'Embench-LiteXtester.tex', 'Embench-LiteX tester Documentation', - 'Antmicro', 'manual'), -] - +( + html_logo, + html_theme_options, + html_context +) = antmicro_html(pdf_url=f"{basic_filename}.pdf") -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'embench-litextester', 'Embench-LiteX tester Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'Embench-LiteXtester', 'Embench-LiteX tester Documentation', - author, 'Embench-LiteXtester', 'One line description of project.', - 'Miscellaneous'), -] - - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] +html_title = project +( + latex_elements, + latex_documents, + latex_logo, + latex_additional_files +) = antmicro_latex(basic_filename, authors, project) -# -- Extension configuration ------------------------------------------------- +rst_epilog = """ +.. |project| replace:: %s +""" % (project) diff --git a/docs/source/index.rst b/docs/source/index.rst index 599cf7c..e36562d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,13 +1,13 @@ -.. Embench-LiteX tester documentation master file, created by +.. Embench Tester documentation master file, created by sphinx-quickstart on Thu Sep 24 19:18:18 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Embench-LiteX tester's results! -================================================ +Welcome to Embench Tester's results! +==================================== This page presents the `Embench-tester `_ results. -The data was obtained by simulating a `LiteX `_ based SoC design instantiating the tested core. +The data was obtained by simulating an SoC design instantiating the tested core. All the cores where tested in LiteX' standard configuration.