From 73fd000ff4487486f1cdff05d1e09075c5b8749c Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sat, 19 Sep 2020 14:27:00 -0700 Subject: [PATCH 1/3] docs: Fixing requirements.txt * Install sphinx-verilog-domain. * Update for the sphinxcontrib-verilog-diagrams name change. * Use the SymbiFlow version of Symbolator. Signed-off-by: Tim 'mithro' Ansell --- docs/requirements.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d63f78d..37e7980 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,11 +4,13 @@ docutils sphinx sphinx-autobuild +# Verilog domain +sphinx-verilog-domain # Verilog diagrams using Yosys + netlistsvg -git+https://github.com/SymbiFlow/sphinxcontrib-verilog-diagrams.git#egg=sphinxcontrib-verilog-diagrams +sphinxcontrib-hdl-diagrams # Module diagrams -symbolator +git+https://github.com/SymbiFlow/symbolator.git#egg=symbolator # pycairo # vext.gi From d19cd14395679c59751f77d17aa70b72536f9122 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sat, 19 Sep 2020 14:36:30 -0700 Subject: [PATCH 2/3] docs: Fix name in the extensions list. Signed-off-by: Tim 'mithro' Ansell --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 31fb98f..ecc4c9d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,7 +64,7 @@ extensions = [ 'sphinx.ext.mathjax', 'sphinx.ext.napoleon', 'sphinx.ext.todo', - 'sphinxcontrib_verilog_diagrams', + 'sphinxcontrib_hdl_diagrams', ] # Add any paths that contain templates here, relative to this directory. From 94015f5cc69e5a3a14e79fdc713b0eee36739df9 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sat, 19 Sep 2020 14:37:28 -0700 Subject: [PATCH 3/3] docs: Fix html_context values. Signed-off-by: Tim 'mithro' Ansell --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index ecc4c9d..08ba291 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -83,10 +83,10 @@ master_doc = 'index' on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if not on_rtd: html_context = { - "display_github": True, # Integrate GitHub - "github_user": "mithro", # Username - "github_repo": "python-sphinx-verilog", # Repo name - "github_version": "master", # Version + "display_github": True, # Integrate GitHub + "github_user": "google", # Username + "github_repo": "skywater-pdk", # Repo name + "github_version": "master", # Version "conf_py_path": "/doc/", } else: