From 028c1de03a88dec15855132a8bb581a3a4399944 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Sat, 26 Jun 2021 20:38:44 +0200 Subject: [PATCH 1/3] docs: add .readthedocs.yml to set Python version and requirements.txt --- .readthedocs.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..81f82c55 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,16 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.8 + install: + - requirements: docs/requirements.txt From 32ae071954b0f1b595f931b6b8ba1953f2b17dc2 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Sat, 26 Jun 2021 20:39:31 +0200 Subject: [PATCH 2/3] docs: pin theme version rtd.io uses a severely outdated theme version with several known bugs by default. Pin to a never version to get the bugfixes. --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 6c5d5d44..f85be1ff 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -sphinx-rtd-theme +sphinx-rtd-theme==0.5.2 From 65c9d05d54a945f4a199a94d0d54d57f038c80f3 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Sat, 26 Jun 2021 20:40:43 +0200 Subject: [PATCH 3/3] docs: drop obselete theme fixes --- docs/_static/css/custom.css | 35 ----------------------------------- 1 file changed, 35 deletions(-) diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index 38458950..b4fd2586 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -8,38 +8,3 @@ .rst-content div[class^='highlight'] pre { overflow: visible; } - - -/* - This fixes the bottom margin of paragraphs inside lists, where margins inside - a single list item would incorrectly be displayed larger than margins between - the list items. - - Upstream fix (not fixed on readthedocs.io yet): - https://github.com/readthedocs/sphinx_rtd_theme/commit/ac20ce75d426efeb40fe2af1f89ea9bad285a45b -*/ -.rst-content .section ol li > p, -.rst-content .section ol li > p:last-child, -.rst-content .section ul li > p, -.rst-content .section ul li > p:last-child { - margin-bottom: 12px; -} -.rst-content .section ol li > p:only-child, -.rst-content .section ol li > p:only-child:last-child, -.rst-content .section ul li > p:only-child, -.rst-content .section ul li > p:only-child:last-child { - margin-bottom: 0rem; -} - -/* - This fixes the bottom margin of nested lists - - Based on upstream fix (not on readthedocs.io yet): - https://github.com/readthedocs/sphinx_rtd_theme/commit/6f0de13baff93f25204aa2cdf0308aae47d71312 -*/ -.rst-content .section ul li > ul, -.rst-content .section ul li > ol, -.rst-content .section ol li > ul, -.rst-content .section ol li > ol { - margin-bottom: 12px; -}