diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb 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 diff --git a/docs/Makefile b/docs/Makefile index 4cd323885..13b0b08fc 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) @@ -32,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/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 ------------------------------------------------- diff --git a/docs/environment.yml b/docs/environment.yml new file mode 100644 index 000000000..2e1bfffb8 --- /dev/null +++ b/docs/environment.yml @@ -0,0 +1,10 @@ +name: sphinx_f4pga_theme +channels: +- defaults +dependencies: +- python +- pandoc +- pip +- pip: + - -r requirements.txt + - .. 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 +