From 9542b4f27eb117666be1c5ff278cb0520c0cbf47 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 10 Feb 2020 17:10:45 +0530 Subject: [PATCH 1/6] Revert to default width and padding --- docs/_static/custom.css | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 07c175594..55b0a70fb 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,8 +1,3 @@ -.wy-nav-content { - max-width: 51.5em; - padding: 1em; -} - #virtualenv img { margin-bottom: 6px; } From a5c1bbaa7dffa6b43be75273e0389c6f19c3fb1b Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 10 Feb 2020 17:12:17 +0530 Subject: [PATCH 2/6] Make tables wider than the content --- docs/_static/custom.css | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 55b0a70fb..2b4ae4955 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -2,17 +2,21 @@ margin-bottom: 6px; } -/* override table width restrictions */ +/* Allow table content to wrap around */ .wy-table-responsive table th, .wy-table-responsive table td { - /* !important prevents the common CSS stylesheets from - overriding this as on RTD they are loaded after this stylesheet */ + /* !important because RTD has conflicting stylesheets */ white-space: normal !important; - padding: 6px !important; + padding: 8px 6px !important; } +/* Override table width restrictions */ .wy-table-responsive { overflow: visible !important; } +.wy-table-responsive table { + margin-left: -1em !important; + width: calc(100% + 3em); +} .rst-content table.docutils td ol { margin-bottom: 0; @@ -30,10 +34,6 @@ div[class*="highlight-"] { margin-bottom: 12px; } -table { - margin-left: 20px !important; -} - #release-history p { margin-bottom: 0; margin-top: 0; From bfe886e46ded51982d9b74d183ef9c9c1bf8efc1 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 10 Feb 2020 17:13:38 +0530 Subject: [PATCH 3/6] Tweak whitespace on the release history page --- docs/_static/custom.css | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 2b4ae4955..19032f9a9 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,13 +34,14 @@ div[class*="highlight-"] { margin-bottom: 12px; } +/* Tweak whitespace on the release history page */ #release-history p { - margin-bottom: 0; - margin-top: 0; + margin-bottom: 2px; + margin-top: 2px; } #release-history h3 { - margin-bottom: 6px; + margin-bottom: 12px; } #release-history ul { @@ -53,6 +54,7 @@ div[class*="highlight-"] { #release-history h2 { margin-bottom: 12px; + margin-top: 24px; } .rst-content code { From 8a98829e05557d418e10b95e07f7066795cacf59 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 10 Feb 2020 17:16:47 +0530 Subject: [PATCH 4/6] Tweak inline code snippets --- docs/_static/custom.css | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 19032f9a9..999cf001d 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -57,6 +57,8 @@ div[class*="highlight-"] { margin-top: 24px; } +/* Reduce whitespace on the inline-code snippets and add softer corners */ .rst-content code { - padding: 2px; + padding: 2px 3px; + border-radius: 3px; } From 8aa82dff1abb090224ceb32eb38c8ea3c1863db5 Mon Sep 17 00:00:00 2001 From: Bernat Gabor Date: Mon, 10 Feb 2020 16:08:46 +0000 Subject: [PATCH 5/6] add changelog Signed-off-by: Bernat Gabor --- docs/changelog/1548.doc.rst | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 docs/changelog/1548.doc.rst diff --git a/docs/changelog/1548.doc.rst b/docs/changelog/1548.doc.rst new file mode 100644 index 000000000..7c449870e --- /dev/null +++ b/docs/changelog/1548.doc.rst @@ -0,0 +1,2 @@ +Add link to the `legacy branch documentation `_ for the changelog - +by :user:`jezdez `. From bd39a6ffefec648b39df11e4adacf0b1a4d442a5 Mon Sep 17 00:00:00 2001 From: Bernat Gabor Date: Mon, 10 Feb 2020 16:13:24 +0000 Subject: [PATCH 6/6] fine-tune Signed-off-by: Bernat Gabor --- docs/_static/custom.css | 17 ++++++++--------- docs/changelog/1548.doc.rst | 4 ++-- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 999cf001d..d94135381 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,3 +1,7 @@ +.wy-nav-content { + padding: 1em; +} + #virtualenv img { margin-bottom: 6px; } @@ -9,13 +13,9 @@ padding: 8px 6px !important; } -/* Override table width restrictions */ -.wy-table-responsive { - overflow: visible !important; -} .wy-table-responsive table { - margin-left: -1em !important; width: calc(100% + 3em); + margin-left: 20px !important; } .rst-content table.docutils td ol { @@ -36,12 +36,12 @@ div[class*="highlight-"] { /* Tweak whitespace on the release history page */ #release-history p { - margin-bottom: 2px; - margin-top: 2px; + margin-bottom: 0; + margin-top: 0; } #release-history h3 { - margin-bottom: 12px; + margin-bottom: 6px; } #release-history ul { @@ -54,7 +54,6 @@ div[class*="highlight-"] { #release-history h2 { margin-bottom: 12px; - margin-top: 24px; } /* Reduce whitespace on the inline-code snippets and add softer corners */ diff --git a/docs/changelog/1548.doc.rst b/docs/changelog/1548.doc.rst index 7c449870e..f730ba65e 100644 --- a/docs/changelog/1548.doc.rst +++ b/docs/changelog/1548.doc.rst @@ -1,2 +1,2 @@ -Add link to the `legacy branch documentation `_ for the changelog - -by :user:`jezdez `. +Fine tune the documentation layout: default width of theme, allow tables to wrap around, soft corners for code snippets +- by :user:`pradyunsg`.