From 0a5bdb92800766cd80c91222bd8a24376eee67ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 10 Jan 2024 16:04:39 +0100 Subject: [PATCH 1/5] Update Sphinx extension names. --- doc/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index a2f1d6ad4..74f816618 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -19,10 +19,10 @@ 'sphinx_design', 'sphinx_tabs.tabs', 'sphinx_reredirects', - 'youtube-links', - 'related-links', - 'custom-rst-roles', - 'terminal-output', + 'canonical.youtube-links', + 'canonical.related-links', + 'canonical.custom-rst-roles', + 'canonical.terminal-output', 'sphinx_copybutton', 'sphinxext.opengraph', 'myst_parser', From 36c115b4f42682372e9e96bcb0266a5801c78770 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 10 Jan 2024 16:05:11 +0100 Subject: [PATCH 2/5] Fix code-block copybutton default visibility. --- doc/.sphinx/_static/custom.css | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/.sphinx/_static/custom.css b/doc/.sphinx/_static/custom.css index cad94b74c..e26f4d2b5 100644 --- a/doc/.sphinx/_static/custom.css +++ b/doc/.sphinx/_static/custom.css @@ -187,3 +187,9 @@ details summary { color: var(--color-version-popup); font-weight: bolder; } + +/* Code-block copybutton invisible by default + (overriding Furo config to achieve default copybutton setting). */ +.highlight button.copybtn { + opacity: 0; +} From f2504fe8590031369a57c4e342d25f848bc907b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 10 Jan 2024 16:05:38 +0100 Subject: [PATCH 3/5] Update feedback button color. --- doc/.sphinx/_static/github_issue_links.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/.sphinx/_static/github_issue_links.css b/doc/.sphinx/_static/github_issue_links.css index af4be86ce..db166ed95 100644 --- a/doc/.sphinx/_static/github_issue_links.css +++ b/doc/.sphinx/_static/github_issue_links.css @@ -4,7 +4,7 @@ .github-issue-link { font-size: var(--font-size--small); font-weight: bold; - background-color: #DD4814; + background-color: #D6410D; padding: 13px 23px; text-decoration: none; } From b2552a3d966abc2f6f05f29a02ca7b82636e0f26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 10 Jan 2024 16:16:05 +0100 Subject: [PATCH 4/5] Add search-bar Go button. --- doc/.sphinx/_static/custom.css | 16 ++++++++++++++++ doc/.sphinx/_templates/sidebar/search.html | 7 +++++++ 2 files changed, 23 insertions(+) create mode 100644 doc/.sphinx/_templates/sidebar/search.html diff --git a/doc/.sphinx/_static/custom.css b/doc/.sphinx/_static/custom.css index e26f4d2b5..45f2a9ca0 100644 --- a/doc/.sphinx/_static/custom.css +++ b/doc/.sphinx/_static/custom.css @@ -193,3 +193,19 @@ details summary { .highlight button.copybtn { opacity: 0; } + +/* Mimicking the 'Give feedback' button for UX consistency */ +.sidebar-search-container input[type=submit] { + color: #FFFFFF; + border: 2px solid #D6410D; + padding: var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal); + background: #D6410D; + font-weight: bold; + font-size: var(--font-size--small); + cursor: pointer; +} + +.sidebar-search-container input[type=submit]:hover { + text-decoration: underline; +} + diff --git a/doc/.sphinx/_templates/sidebar/search.html b/doc/.sphinx/_templates/sidebar/search.html new file mode 100644 index 000000000..644a5ef6a --- /dev/null +++ b/doc/.sphinx/_templates/sidebar/search.html @@ -0,0 +1,7 @@ + + From 562248af27c79b59fecf2c5e1f266b759f548738 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 10 Jan 2024 16:16:34 +0100 Subject: [PATCH 5/5] Fix Sphinx/rST warnings. --- doc/howto/report-bugs.rst | 4 +--- doc/intro-to-autoinstall.rst | 4 ++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/howto/report-bugs.rst b/doc/howto/report-bugs.rst index 23402aff3..46831cce1 100644 --- a/doc/howto/report-bugs.rst +++ b/doc/howto/report-bugs.rst @@ -29,6 +29,4 @@ To create a Launchpad bug report based on the contents of a crash report, use th To run ``apport-cli`` in the installer environment, switch to a shell. This way, ``apport`` can not open a browser to for you to complete the report. Instead, it provides a URL for completing the report, which you can do on another computer. -.. note:: - -Issues for the Subiquity autoinstaller are `tracked in Launchpad `_. +.. note:: Issues for the Subiquity autoinstaller are `tracked in Launchpad `_. diff --git a/doc/intro-to-autoinstall.rst b/doc/intro-to-autoinstall.rst index 14cfc4175..3371ff164 100644 --- a/doc/intro-to-autoinstall.rst +++ b/doc/intro-to-autoinstall.rst @@ -17,7 +17,7 @@ any interaction. Differences from `debian-installer` preseeding -============================================ +============================================== *preseeds* are the way to automate an installer based on `debian-installer` (also known as d-i). @@ -43,7 +43,7 @@ There are 2 ways to provide the autoinstall configuration: * Directly on the installation media Autoinstall by way of `cloud-config` ----------------------------------- +------------------------------------ The suggested way of providing autoinstall configuration to the Ubuntu installer is via cloud-init. This allows the configuration to be applied to the installer