From 5ab08f08c3d31ca4cca76026ffb49262f8b7747d Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 14:04:54 -0500 Subject: [PATCH 1/7] Adding missing `.readthedocs.yml` config file. Signed-off-by: Tim 'mithro' Ansell --- .readthedocs.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..5e3adc29a --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,26 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +build: + os: ubuntu-lts-latest + tools: + # Need to use mambaforge as miniconda runs out of memory on rtd. + python: latest + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt + - method: pip + path: . + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +#formats: +#- htmlzip From 5847fccc062863d42c04cc2851cc22e00604e1fd Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 14:32:13 -0500 Subject: [PATCH 2/7] Force the bash shell. (Otherwise `source` doesn't work.) Signed-off-by: Tim 'mithro' Ansell --- docs/Makefile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Makefile b/docs/Makefile index 4cd323885..ec7dde510 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -11,6 +11,8 @@ SPHINXPROJ = SphinxContribHDLDiagramsDocs SOURCEDIR = . BUILDDIR = _build +SHELL := /usr/bin/bash + # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) From 24a2d6405a5832fba53f3df0d9af7033ab12b888 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 14:39:47 -0500 Subject: [PATCH 3/7] Adding missing `environment.yml` file. (And fixing the Makefile.) Signed-off-by: Tim 'mithro' Ansell --- docs/Makefile | 2 +- docs/environment.yml | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/environment.yml diff --git a/docs/Makefile b/docs/Makefile index ec7dde510..13b0b08fc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -34,7 +34,7 @@ env: ./env/Miniconda3-latest-Linux-x86_64.sh -p $(PWD)/env -b -f source env/bin/activate; conda config --system --add envs_dirs $(PWD)/env/envs source env/bin/activate; conda config --system --add pkgs_dirs $(PWD)/env/pkgs - source env/bin/activate; conda env update --name base --file ../environment.yml + source env/bin/activate; conda env update --name base --file $(PWD)/environment.yml .PHONY: env diff --git a/docs/environment.yml b/docs/environment.yml new file mode 100644 index 000000000..acc204841 --- /dev/null +++ b/docs/environment.yml @@ -0,0 +1,8 @@ +name: sphinx_f4pga_theme +channels: +- defaults +dependencies: +- python +- pip +- pip: + - -r requirements.txt From d17958e88e2cdd764ae3cdf135d1e438d57e1a04 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 14:59:02 -0500 Subject: [PATCH 4/7] Ignore `env` directory. 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 7ab5eea48..bd6dfecaf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,7 +64,7 @@ # 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 = ["_build", "Thumbs.db", ".DS_Store"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "env"] # -- Options for HTML output ------------------------------------------------- From 4cf0b78f9c8226a1d046bd05d4421a96d3a66e9d Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 15:02:13 -0500 Subject: [PATCH 5/7] Add missing pandoc dependency and install local package. Signed-off-by: Tim 'mithro' Ansell --- docs/environment.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/environment.yml b/docs/environment.yml index acc204841..2e1bfffb8 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -3,6 +3,8 @@ channels: - defaults dependencies: - python +- pandoc - pip - pip: - -r requirements.txt + - .. From c61503e28cf3415a1bf047f1956820fcc3cc8ae4 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 15:08:29 -0500 Subject: [PATCH 6/7] Fix #24. Something weird is going on between Markdown and Sphinx causing links of `#` to error. Hence, I just removed them. Signed-off-by: Tim 'mithro' Ansell --- docs/markdown.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/markdown.md b/docs/markdown.md index ec731d5ed..47c69261a 100644 --- a/docs/markdown.md +++ b/docs/markdown.md @@ -17,7 +17,7 @@ tempor. **Sed suscipit**, orci non pretium pretium, quam mi gravida metus, vel venenatis justo est condimentum diam. Maecenas non ornare justo. Nam a ipsum -eros. [Nulla aliquam](#) orci sit amet nisl posuere malesuada. Proin aliquet +eros. [Nulla aliquam]() orci sit amet nisl posuere malesuada. Proin aliquet nulla velit, quis ultricies orci feugiat et. `Ut tincidunt sollicitudin` tincidunt. Aenean ullamcorper sit amet nulla at interdum. @@ -53,7 +53,7 @@ tincidunt. Aenean ullamcorper sit amet nulla at interdum. > **Sed aliquet**, neque at rutrum mollis, neque nisi tincidunt nibh, vitae faucibus lacus nunc at lacus. Nunc scelerisque, quam id cursus sodales, lorem - [libero fermentum](#) urna, ut efficitur elit ligula et nunc. + [libero fermentum]() urna, ut efficitur elit ligula et nunc. > > Mauris dictum mi lacus, sit amet pellentesque urna vehicula fringilla. Ut sit amet placerat ante. Proin sed elementum nulla. Nunc vitae sem odio. @@ -171,8 +171,8 @@ Cras arcu libero Morbi eget `dapibus felis`. Vivamus *`venenatis porttitor`* tortor sit amet rutrum. Class aptent taciti sociosqu ad litora torquent per conubia nostra, -per inceptos himenaeos. [`Pellentesque aliquet quam enim`](#), eu volutpat urna -rutrum a. +per inceptos himenaeos. [`Pellentesque aliquet quam enim`](), eu volutpat +urna rutrum a. Nam vehicula nunc `:::js return target` mauris, a ultricies libero efficitur sed. Sed molestie imperdiet consectetur. Vivamus a pharetra leo. Pellentesque @@ -254,4 +254,4 @@ sit amet laoreet nibh. eleifend rutrum. Donec vitae suscipit est. - \ No newline at end of file + From 754fcbe3d4ef7dd29e4c6d34e3575a830052d051 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sun, 17 Mar 2024 15:23:55 -0500 Subject: [PATCH 7/7] Disable Jekyll for GitHub pages. Signed-off-by: Tim 'mithro' Ansell --- .nojekyll | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .nojekyll diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb