From 750d744e827c4bc2da320294469e6a0918babb10 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Mar 2022 12:25:05 +0100 Subject: [PATCH 1/4] xc7/linux_litex_demo/README: do not use extlink Signed-off-by: Unai Martinez-Corral --- xc7/linux_litex_demo/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xc7/linux_litex_demo/README.rst b/xc7/linux_litex_demo/README.rst index ad77329..e3e95c3 100644 --- a/xc7/linux_litex_demo/README.rst +++ b/xc7/linux_litex_demo/README.rst @@ -36,7 +36,7 @@ Now you can upload the design with: The LiteX design is provided with an Ethernet module that uses the ``192.168.100.100/24`` IPv4 address that needs to be set on your network interface. - You may find these information useful to correctly setup the network interface: :gh:`timvideos/litex-buildenv/wiki/Networking`. + You may find these information useful to correctly setup the network interface: `timvideos/litex-buildenv/wiki/Networking `__. You should observe the following line in the OpenOCD output: From 985095b4f82ce7e69f25c9d0b384e8da54c73d20 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Mar 2022 12:19:13 +0100 Subject: [PATCH 2/4] docs/conf: use Path instead of os Signed-off-by: Unai Martinez-Corral --- docs/conf.py | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 00cd9cc..3c2e2f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,27 +85,17 @@ html_favicon = str(Path(html_static_path[0]) / 'favicon.svg') # -- Collect READMEs from examples ----------------------------------------------------------------- -from collect_readmes import full_name_lut, families, fill_context +from collect_readmes import families, fill_context jinja_contexts = {} -top_dir = os_path.join(os_path.dirname(__file__), '..') +top_dir = Path(__file__).resolve().parent.parent for family in families: - examples = os_scandir(os_path.join(top_dir, family)) + examples = os_scandir(str(top_dir / family)) for example in examples: - if example.is_dir(): - - # get README - path = os_path.join(top_dir, family, example, 'README.rst') - - # skip if file does not exist - if not os_path.isfile(path): - continue - - with open(path) as f: - text = f.read() - - key = '_'.join((family, example.name)) - jinja_contexts[key] = {'blocks': fill_context(text)} + path = top_dir / family / example / 'README.rst' + if example.is_dir() and path.is_file(): + with path.open('r') as frptr: + jinja_contexts['_'.join((family, example.name))] = {'blocks': fill_context(frptr.read())} # -- Sphinx.Ext.InterSphinx ------------------------------------------------------------------------ From eeb6a53f2f54502e4d0a1021586e1715362ea6b5 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Mar 2022 12:03:30 +0100 Subject: [PATCH 3/4] docs: use extension name sphinx_jinja instead of sphinxcontrib.jinja Signed-off-by: Unai Martinez-Corral --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 3c2e2f3..642fea7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,7 +50,7 @@ extensions = [ 'sphinx.ext.extlinks', 'sphinx.ext.intersphinx', 'sphinx_tabs.tabs', - 'sphinxcontrib.jinja', + 'sphinx_jinja', ] # Add any paths that contain templates here, relative to this directory. From 14ff7388ae9606e5ac5cc39d9605d19dd0518d11 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Mar 2022 12:22:38 +0100 Subject: [PATCH 4/4] readthedocs: do not fail on warnings Signed-off-by: Unai Martinez-Corral --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2b62212..4f57057 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -23,7 +23,7 @@ version: 2 sphinx: configuration: docs/conf.py - fail_on_warning: true + fail_on_warning: false python: version: "3.7"