diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index e93cf38..ca80da2 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -1,4 +1,6 @@ -- BeeWare Docs Tools Demo Section One - - [BeeWare Docs Tools Demo Section One](section_one/index.md) - - [Section One - Page Two](section_one/page_two.md) -- [Section Two](section_two/index.md) +- BeeWare Docs Tools Demo section one + - [BeeWare Docs Tools Demo section one](section_one/index.md) + - [Section one - page two](section_one/page_two.md) +- [Section two](section_two/index.md) +- [Section three](section_three/index.md) + - ./section_three/* diff --git a/docs/en/index.md b/docs/en/index.md index 6262081..b0f7a36 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -2,34 +2,43 @@ ## Theme checklist -Things to manually check: +This demo is designed to test the various features of the BeeWare +MkDocs Material theme overrides. Please read through and verify +that everything listed on this and the following pages is present +and functioning as detailed in the description. -### Titlebar +## Titlebar A medium-gray titlebar is on the page. This the theme template has been applied. -### Header and logo icons +## Header icon The header icon top-left has been rendered. This confirms the template can reference external resources. -The logo icon in the left sidebar has been rendered. This confirms the -sidebar will render properly on the target sites. +## Homepage sidebar icon -### Heading font +The logo icon in the left sidebar has been rendered. The logo should be +the width of, and of equal height to, the sidebar. The site title should +be rendered below it in slightly larger font than the rest of the +sidebar, with the version number below it in smaller font. + +This confirms the sidebar will render properly on the target sites. + +## Heading font Headings are rendered in Cutive. This confirms the BeeWare custom CSS theme has been applied. -### Inline Code +## Inline code Inline code is rendered in the same color as the surrounding font. This confirms that the theme has not caused any undesired changes. This is text with `inline code` here and `inline code` here. -### Tabbed Content Code +## Tabbed content code Code is in a contrasting color to the background. Copy button should copy only the commands; the prompt should not be included. @@ -61,7 +70,7 @@ C:\...>git clone https://github.com/beeware/beeware-theme.git /// -### Code copy button behavior +## Code copy button behavior The copy button on the following codeblock should result in `from pathlib import Path` being copied to the clipboard. @@ -81,14 +90,14 @@ docs pyproject.toml requirements.docs.txt LICENSE README.md src ``` -### Sidebar links +## Sidebar links Sidebar links exist, and point to the `beeware-docs-tools` repo. This confirms that the sidebar content has been loaded, and the `project-name` has been set in the MkDocs configuration file, and the version number is computed and added. -### Link colors +## Link colors This link to [the main BeeWare website](https://beeware.org) should be blue in *both* light mode and dark mode. @@ -98,7 +107,7 @@ The links in the left and right sidebars should also be blue in both modes. When scrolling down the page, the active header link in the right sidebar should be light blue in dark mode, and darker blue in light mode. -### Translation Admonition +## Translation admonition The English-language version of this document should show the "Translations are available" admonition below. The French translation should show the "This is @@ -143,7 +152,7 @@ machine translation, or not translated at all. {% endif %} -### Custom 404 page +## Custom 404 page Add `nopage` to the end of the URL in your browser to verify the 404 page contains two flying bees, and the text "Brutus can't find what @@ -152,7 +161,7 @@ you're looking for" below. *MkDocs builds fail with unrecognized internal links, so you need to manually verify this check by modifying the URL in your browser.* -### Next Checks +## Next checks The following link should take you to BeeWare Docs Tools Demo Section One. It is included to verify cross-page linking. diff --git a/docs/en/section_one/index.md b/docs/en/section_one/index.md index 2fbd98a..687ee23 100644 --- a/docs/en/section_one/index.md +++ b/docs/en/section_one/index.md @@ -1,6 +1,14 @@ -# BeeWare Docs Tools Demo Section One +# BeeWare Docs Tools Demo section one -## Include External Markdown from a Local File +## Non-homepage sidebar logo + +The logo icon in the left sidebar should be small on all pages other than the +homepage. The site title and version number should be rendered next to it with +the site title in slightly larger font, and the version number in smaller font. + +This verifies that the theme is being properly applied. + +## Include external markdown from a local file The following section should have only a header, and a paragraph with inline code followed by a code block. There should be no text between the code block and the @@ -9,7 +17,7 @@ local files. -8<- "include_content.md:local-content" -## Include External Markdown from a URL +## Include external markdown from a URL The following section should have only a header, some text and a Markdown list. This verifies that the external include extension is working, and that @@ -19,6 +27,6 @@ This verifies that the external include extension is working, and that https://raw.githubusercontent.com/beeware/beeware-docs-tools/refs/heads/main/docs/include_content.md:remote-content -8<- -## Footer Navigation +## Footer navigation Navigate to *Section One - Page Two* for the final check. diff --git a/docs/en/section_one/page_two.md b/docs/en/section_one/page_two.md index ccab504..fcc9c7a 100644 --- a/docs/en/section_one/page_two.md +++ b/docs/en/section_one/page_two.md @@ -1,4 +1,4 @@ -# BeeWare Docs Tools Demo Section One: Page Two +# BeeWare Docs Tools Demo section one: page two ### Footer and navigation links diff --git a/docs/en/section_three/index.md b/docs/en/section_three/index.md new file mode 100644 index 0000000..4843102 --- /dev/null +++ b/docs/en/section_three/index.md @@ -0,0 +1,5 @@ +# BeeWare Docs Tools Demo section three + +This section and its children are included for sidebar scroll testing. Verify the +scrollbar is navigable on smaller-height displays, that you can scroll the entire +list (Page 01 - Page 12), and that it is not overlapping the footer. diff --git a/docs/en/section_three/page_01.md b/docs/en/section_three/page_01.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_02.md b/docs/en/section_three/page_02.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_03.md b/docs/en/section_three/page_03.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_04.md b/docs/en/section_three/page_04.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_05.md b/docs/en/section_three/page_05.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_06.md b/docs/en/section_three/page_06.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_07.md b/docs/en/section_three/page_07.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_08.md b/docs/en/section_three/page_08.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_09.md b/docs/en/section_three/page_09.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_10.md b/docs/en/section_three/page_10.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_11.md b/docs/en/section_three/page_11.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_three/page_12.md b/docs/en/section_three/page_12.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/en/section_two/index.md b/docs/en/section_two/index.md index 5de8e1f..f1299ea 100644 --- a/docs/en/section_two/index.md +++ b/docs/en/section_two/index.md @@ -1,4 +1,4 @@ -# BeeWare Docs Tools Demo Section Two +# BeeWare Docs Tools Demo section two ### Images subdirectory diff --git a/docs/locales/de/LC_MESSAGES/SUMMARY.po b/docs/locales/de/LC_MESSAGES/SUMMARY.po index 63fea12..0165106 100644 --- a/docs/locales/de/LC_MESSAGES/SUMMARY.po +++ b/docs/locales/de/LC_MESSAGES/SUMMARY.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,17 +13,25 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/SUMMARY.md:1 -msgid "BeeWare Docs Tools Demo Section One" +msgid "BeeWare Docs Tools Demo section one" msgstr "" #: docs/en/SUMMARY.md:1 -msgid "[BeeWare Docs Tools Demo Section One]{1}" +msgid "[BeeWare Docs Tools Demo section one]{1}" msgstr "" #: docs/en/SUMMARY.md:1 -msgid "[Section One - Page Two]{1}" +msgid "[Section one - page two]{1}" msgstr "" #: docs/en/SUMMARY.md:4 -msgid "[Section Two]{1}" +msgid "[Section two]{1}" +msgstr "" + +#: docs/en/SUMMARY.md:5 +msgid "[Section three]{1}" +msgstr "" + +#: docs/en/SUMMARY.md:5 +msgid "./section_three/*.md" msgstr "" diff --git a/docs/locales/de/LC_MESSAGES/index.po b/docs/locales/de/LC_MESSAGES/index.po index e5209d4..4306710 100644 --- a/docs/locales/de/LC_MESSAGES/index.po +++ b/docs/locales/de/LC_MESSAGES/index.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -21,118 +21,132 @@ msgid "Theme checklist" msgstr "" #: docs/en/index.md:5 -msgid "Things to manually check:" +msgid "" +"This demo is designed to test the various features of the BeeWare MkDocs " +"Material theme overrides. Please read through and verify that everything " +"listed on this and the following pages is present and functioning as " +"detailed in the description." msgstr "" -#: docs/en/index.md:7 +#: docs/en/index.md:10 msgid "Titlebar" msgstr "" -#: docs/en/index.md:9 +#: docs/en/index.md:12 msgid "" "A medium-gray titlebar is on the page. This the theme template has been " "applied." msgstr "" -#: docs/en/index.md:12 -msgid "Header and logo icons" +#: docs/en/index.md:15 +msgid "Header icon" msgstr "" -#: docs/en/index.md:14 +#: docs/en/index.md:17 msgid "" "The header icon top-left has been rendered. This confirms the template can " "reference external resources." msgstr "" -#: docs/en/index.md:17 +#: docs/en/index.md:20 +msgid "Homepage sidebar icon" +msgstr "" + +#: docs/en/index.md:22 msgid "" -"The logo icon in the left sidebar has been rendered. This confirms the " -"sidebar will render properly on the target sites." +"The logo icon in the left sidebar has been rendered. The logo should be the " +"width of, and of equal height to, the sidebar. The site title should be " +"rendered below it in slightly larger font than the rest of the sidebar, with " +"the version number below it in smaller font." msgstr "" -#: docs/en/index.md:20 +#: docs/en/index.md:27 +msgid "This confirms the sidebar will render properly on the target sites." +msgstr "" + +#: docs/en/index.md:29 msgid "Heading font" msgstr "" -#: docs/en/index.md:22 +#: docs/en/index.md:31 msgid "" "Headings are rendered in Cutive. This confirms the BeeWare custom CSS theme " "has been applied." msgstr "" -#: docs/en/index.md:25 -msgid "Inline Code" +#: docs/en/index.md:34 +msgid "Inline code" msgstr "" -#: docs/en/index.md:27 +#: docs/en/index.md:36 msgid "" "Inline code is rendered in the same color as the surrounding font. This " "confirms that the theme has not caused any undesired changes." msgstr "" -#: docs/en/index.md:30 +#: docs/en/index.md:39 msgid "This is text with `inline code` here and `inline code` here." msgstr "" -#: docs/en/index.md:32 -msgid "Tabbed Content Code" +#: docs/en/index.md:41 +msgid "Tabbed content code" msgstr "" -#: docs/en/index.md:34 +#: docs/en/index.md:43 msgid "" "Code is in a contrasting color to the background. Copy button should copy " "only the commands; the prompt should not be included." msgstr "" -#: docs/en/index.md:37 +#: docs/en/index.md:46 msgid "" "This confirms that the theme has not caused any undesired changes, as well " "as whether the copy button is working as expected." msgstr "" -#: docs/en/index.md:40 +#: docs/en/index.md:49 msgid "/// tab | macOS" msgstr "" -#: docs/en/index.md:46 -#: docs/en/index.md:54 -#: docs/en/index.md:62 -#: docs/en/index.md:118 -#: docs/en/index.md:130 -#: docs/en/index.md:142 +#: docs/en/index.md:55 +#: docs/en/index.md:63 +#: docs/en/index.md:71 +#: docs/en/index.md:127 +#: docs/en/index.md:139 +#: docs/en/index.md:151 msgid "///" msgstr "" -#: docs/en/index.md:48 +#: docs/en/index.md:57 msgid "/// tab | Linux" msgstr "" -#: docs/en/index.md:56 +#: docs/en/index.md:65 msgid "/// tab | Windows" msgstr "" -#: docs/en/index.md:64 +#: docs/en/index.md:73 msgid "Code copy button behavior" msgstr "" -#: docs/en/index.md:66 +#: docs/en/index.md:75 msgid "" "The copy button on the following codeblock should result in `from pathlib " "import Path` being copied to the clipboard." msgstr "" -#: docs/en/index.md:73 +#: docs/en/index.md:82 msgid "" "The copy button on the following codeblock should result in `ls beeware-docs-" "tools` being copied to the clipboard. The shell prompt and the output should " "not be included." msgstr "" -#: docs/en/index.md:84 +#: docs/en/index.md:93 msgid "Sidebar links" msgstr "" -#: docs/en/index.md:86 +#: docs/en/index.md:95 msgid "" "Sidebar links exist, and point to the `beeware-docs-tools` repo. This " "confirms that the sidebar content has been loaded, and the `project-name` " @@ -140,32 +154,32 @@ msgid "" "computed and added." msgstr "" -#: docs/en/index.md:91 +#: docs/en/index.md:100 msgid "Link colors" msgstr "" -#: docs/en/index.md:93 +#: docs/en/index.md:102 msgid "" "This link to [the main BeeWare website]{1} should be blue in *both* light " "mode and dark mode." msgstr "" -#: docs/en/index.md:96 +#: docs/en/index.md:105 msgid "" "The links in the left and right sidebars should also be blue in both modes." msgstr "" -#: docs/en/index.md:98 +#: docs/en/index.md:107 msgid "" "When scrolling down the page, the active header link in the right sidebar " "should be light blue in dark mode, and darker blue in light mode." msgstr "" -#: docs/en/index.md:101 -msgid "Translation Admonition" +#: docs/en/index.md:110 +msgid "Translation admonition" msgstr "" -#: docs/en/index.md:103 +#: docs/en/index.md:112 msgid "" "The English-language version of this document should show the " "\"Translations are available\" admonition below. The French translation " @@ -174,84 +188,84 @@ msgid "" "translations." msgstr "" -#: docs/en/index.md:108 +#: docs/en/index.md:117 msgid "{% if config.extra.translation_type == \"original\" %}" msgstr "" -#: docs/en/index.md:110 +#: docs/en/index.md:119 msgid "/// admonition | Translations are available" msgstr "" -#: docs/en/index.md:112 +#: docs/en/index.md:121 msgid "" "If you're not comfortable with English, translations of the Docs Tools are " "available in [Français]{1} and [Deutsch]{2}." msgstr "" -#: docs/en/index.md:120 -#: docs/en/index.md:132 -#: docs/en/index.md:144 +#: docs/en/index.md:129 +#: docs/en/index.md:141 +#: docs/en/index.md:153 msgid "{% endif %}" msgstr "" -#: docs/en/index.md:122 +#: docs/en/index.md:131 msgid "{% if config.extra.translation_type == \"machine\" %}" msgstr "" -#: docs/en/index.md:124 +#: docs/en/index.md:133 msgid "/// admonition | This is a machine translation!" msgstr "" -#: docs/en/index.md:126 +#: docs/en/index.md:135 msgid "" "This version of the tutorial has been generated by machine translation. We " "know this isn't ideal, but we felt that a bad translation was better than no " "translation at all." msgstr "" -#: docs/en/index.md:134 +#: docs/en/index.md:143 msgid "{% if config.extra.translation_type == \"human\" %}" msgstr "" -#: docs/en/index.md:136 +#: docs/en/index.md:145 msgid "/// admonition | This is a translation!" msgstr "" -#: docs/en/index.md:138 +#: docs/en/index.md:147 msgid "" "This document is a translation of the English version. The translation has " "been reviewed by humans, but newer sections may be generated by machine " "translation, or not translated at all." msgstr "" -#: docs/en/index.md:146 +#: docs/en/index.md:155 msgid "Custom 404 page" msgstr "" -#: docs/en/index.md:148 +#: docs/en/index.md:157 msgid "" "Add `nopage` to the end of the URL in your browser to verify the 404 page " "contains two flying bees, and the text " "\"Brutus can't find what you're looking for\" below." msgstr "" -#: docs/en/index.md:152 +#: docs/en/index.md:161 msgid "" "*MkDocs builds fail with unrecognized internal links, so you need to " "manually verify this check by modifying the URL in your browser.*" msgstr "" -#: docs/en/index.md:155 -msgid "Next Checks" +#: docs/en/index.md:164 +msgid "Next checks" msgstr "" -#: docs/en/index.md:157 +#: docs/en/index.md:166 msgid "" "The following link should take you to BeeWare Docs Tools Demo Section One. " "It is included to verify cross-page linking." msgstr "" -#: docs/en/index.md:160 +#: docs/en/index.md:169 msgid "" "Navigate to [BeeWare Docs Tools Demo Section One]{1} for the next checks." msgstr "" diff --git a/docs/locales/de/LC_MESSAGES/section_one/index.po b/docs/locales/de/LC_MESSAGES/section_one/index.po index 174163a..c34234a 100644 --- a/docs/locales/de/LC_MESSAGES/section_one/index.po +++ b/docs/locales/de/LC_MESSAGES/section_one/index.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,46 +13,62 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/section_one/index.md:1 -msgid "BeeWare Docs Tools Demo Section One" +msgid "BeeWare Docs Tools Demo section one" msgstr "" #: docs/en/section_one/index.md:3 -msgid "Include External Markdown from a Local File" +msgid "Non-homepage sidebar logo" msgstr "" #: docs/en/section_one/index.md:5 msgid "" +"The logo icon in the left sidebar should be small on all pages other than " +"the homepage. The site title and version number should be rendered next to " +"it with the site title in slightly larger font, and the version number in " +"smaller font." +msgstr "" + +#: docs/en/section_one/index.md:9 +msgid "This verifies that the theme is being properly applied." +msgstr "" + +#: docs/en/section_one/index.md:11 +msgid "Include external markdown from a local file" +msgstr "" + +#: docs/en/section_one/index.md:13 +msgid "" "The following section should have only a header, and a paragraph with inline " "code followed by a code block. There should be no text between the code " "block and the next header. This verifies that the external include extension " "is working with local files." msgstr "" -#: docs/en/section_one/index.md:10 +#: docs/en/section_one/index.md:18 msgid "-8<- \"include_content.md:local-content\"" msgstr "" -#: docs/en/section_one/index.md:12 -msgid "Include External Markdown from a URL" +#: docs/en/section_one/index.md:20 +msgid "Include external markdown from a URL" msgstr "" -#: docs/en/section_one/index.md:14 +#: docs/en/section_one/index.md:22 msgid "" "The following section should have only a header, some text and a Markdown " "list. This verifies that the external include extension is working, and that " "`url_download` is enabled." msgstr "" -#: docs/en/section_one/index.md:18 +#: docs/en/section_one/index.md:26 msgid "" "-8<- https://raw.githubusercontent.com/beeware/beeware-docs-tools/refs/heads/" "main/docs/include_content.md:remote-content -8<-" msgstr "" -#: docs/en/section_one/index.md:22 -msgid "Footer Navigation" +#: docs/en/section_one/index.md:30 +msgid "Footer navigation" msgstr "" -#: docs/en/section_one/index.md:24 +#: docs/en/section_one/index.md:32 msgid "Navigate to *Section One - Page Two* for the final check." msgstr "" diff --git a/docs/locales/de/LC_MESSAGES/section_one/page_two.po b/docs/locales/de/LC_MESSAGES/section_one/page_two.po index 4181d27..cde7a32 100644 --- a/docs/locales/de/LC_MESSAGES/section_one/page_two.po +++ b/docs/locales/de/LC_MESSAGES/section_one/page_two.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,7 +13,7 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/section_one/page_two.md:1 -msgid "BeeWare Docs Tools Demo Section One: Page Two" +msgid "BeeWare Docs Tools Demo section one: page two" msgstr "" #: docs/en/section_one/page_two.md:3 diff --git a/docs/locales/de/LC_MESSAGES/section_three/index.po b/docs/locales/de/LC_MESSAGES/section_three/index.po new file mode 100644 index 0000000..be476d2 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/index.po @@ -0,0 +1,24 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" + +#: docs/en/section_three/index.md:1 +msgid "BeeWare Docs Tools Demo section three" +msgstr "" + +#: docs/en/section_three/index.md:3 +msgid "" +"This section and its children are included for sidebar scroll testing. " +"Verify the scrollbar is navigable on smaller-height displays, that you can " +"scroll the entire list (Page 01 - Page 12), and that it is not overlapping " +"the footer." +msgstr "" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_01.po b/docs/locales/de/LC_MESSAGES/section_three/page_01.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_01.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_02.po b/docs/locales/de/LC_MESSAGES/section_three/page_02.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_02.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_03.po b/docs/locales/de/LC_MESSAGES/section_three/page_03.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_03.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_04.po b/docs/locales/de/LC_MESSAGES/section_three/page_04.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_04.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_05.po b/docs/locales/de/LC_MESSAGES/section_three/page_05.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_05.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_06.po b/docs/locales/de/LC_MESSAGES/section_three/page_06.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_06.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_07.po b/docs/locales/de/LC_MESSAGES/section_three/page_07.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_07.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_08.po b/docs/locales/de/LC_MESSAGES/section_three/page_08.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_08.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_09.po b/docs/locales/de/LC_MESSAGES/section_three/page_09.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_09.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_10.po b/docs/locales/de/LC_MESSAGES/section_three/page_10.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_10.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_11.po b/docs/locales/de/LC_MESSAGES/section_three/page_11.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_11.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_three/page_12.po b/docs/locales/de/LC_MESSAGES/section_three/page_12.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/de/LC_MESSAGES/section_three/page_12.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/de/LC_MESSAGES/section_two/index.po b/docs/locales/de/LC_MESSAGES/section_two/index.po index f201308..4d72eb9 100644 --- a/docs/locales/de/LC_MESSAGES/section_two/index.po +++ b/docs/locales/de/LC_MESSAGES/section_two/index.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,7 +13,7 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/section_two/index.md:1 -msgid "BeeWare Docs Tools Demo Section Two" +msgid "BeeWare Docs Tools Demo section two" msgstr "" #: docs/en/section_two/index.md:3 diff --git a/docs/locales/fr/LC_MESSAGES/SUMMARY.po b/docs/locales/fr/LC_MESSAGES/SUMMARY.po index 63fea12..0165106 100644 --- a/docs/locales/fr/LC_MESSAGES/SUMMARY.po +++ b/docs/locales/fr/LC_MESSAGES/SUMMARY.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,17 +13,25 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/SUMMARY.md:1 -msgid "BeeWare Docs Tools Demo Section One" +msgid "BeeWare Docs Tools Demo section one" msgstr "" #: docs/en/SUMMARY.md:1 -msgid "[BeeWare Docs Tools Demo Section One]{1}" +msgid "[BeeWare Docs Tools Demo section one]{1}" msgstr "" #: docs/en/SUMMARY.md:1 -msgid "[Section One - Page Two]{1}" +msgid "[Section one - page two]{1}" msgstr "" #: docs/en/SUMMARY.md:4 -msgid "[Section Two]{1}" +msgid "[Section two]{1}" +msgstr "" + +#: docs/en/SUMMARY.md:5 +msgid "[Section three]{1}" +msgstr "" + +#: docs/en/SUMMARY.md:5 +msgid "./section_three/*.md" msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/index.po b/docs/locales/fr/LC_MESSAGES/index.po index e5209d4..4306710 100644 --- a/docs/locales/fr/LC_MESSAGES/index.po +++ b/docs/locales/fr/LC_MESSAGES/index.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -21,118 +21,132 @@ msgid "Theme checklist" msgstr "" #: docs/en/index.md:5 -msgid "Things to manually check:" +msgid "" +"This demo is designed to test the various features of the BeeWare MkDocs " +"Material theme overrides. Please read through and verify that everything " +"listed on this and the following pages is present and functioning as " +"detailed in the description." msgstr "" -#: docs/en/index.md:7 +#: docs/en/index.md:10 msgid "Titlebar" msgstr "" -#: docs/en/index.md:9 +#: docs/en/index.md:12 msgid "" "A medium-gray titlebar is on the page. This the theme template has been " "applied." msgstr "" -#: docs/en/index.md:12 -msgid "Header and logo icons" +#: docs/en/index.md:15 +msgid "Header icon" msgstr "" -#: docs/en/index.md:14 +#: docs/en/index.md:17 msgid "" "The header icon top-left has been rendered. This confirms the template can " "reference external resources." msgstr "" -#: docs/en/index.md:17 +#: docs/en/index.md:20 +msgid "Homepage sidebar icon" +msgstr "" + +#: docs/en/index.md:22 msgid "" -"The logo icon in the left sidebar has been rendered. This confirms the " -"sidebar will render properly on the target sites." +"The logo icon in the left sidebar has been rendered. The logo should be the " +"width of, and of equal height to, the sidebar. The site title should be " +"rendered below it in slightly larger font than the rest of the sidebar, with " +"the version number below it in smaller font." msgstr "" -#: docs/en/index.md:20 +#: docs/en/index.md:27 +msgid "This confirms the sidebar will render properly on the target sites." +msgstr "" + +#: docs/en/index.md:29 msgid "Heading font" msgstr "" -#: docs/en/index.md:22 +#: docs/en/index.md:31 msgid "" "Headings are rendered in Cutive. This confirms the BeeWare custom CSS theme " "has been applied." msgstr "" -#: docs/en/index.md:25 -msgid "Inline Code" +#: docs/en/index.md:34 +msgid "Inline code" msgstr "" -#: docs/en/index.md:27 +#: docs/en/index.md:36 msgid "" "Inline code is rendered in the same color as the surrounding font. This " "confirms that the theme has not caused any undesired changes." msgstr "" -#: docs/en/index.md:30 +#: docs/en/index.md:39 msgid "This is text with `inline code` here and `inline code` here." msgstr "" -#: docs/en/index.md:32 -msgid "Tabbed Content Code" +#: docs/en/index.md:41 +msgid "Tabbed content code" msgstr "" -#: docs/en/index.md:34 +#: docs/en/index.md:43 msgid "" "Code is in a contrasting color to the background. Copy button should copy " "only the commands; the prompt should not be included." msgstr "" -#: docs/en/index.md:37 +#: docs/en/index.md:46 msgid "" "This confirms that the theme has not caused any undesired changes, as well " "as whether the copy button is working as expected." msgstr "" -#: docs/en/index.md:40 +#: docs/en/index.md:49 msgid "/// tab | macOS" msgstr "" -#: docs/en/index.md:46 -#: docs/en/index.md:54 -#: docs/en/index.md:62 -#: docs/en/index.md:118 -#: docs/en/index.md:130 -#: docs/en/index.md:142 +#: docs/en/index.md:55 +#: docs/en/index.md:63 +#: docs/en/index.md:71 +#: docs/en/index.md:127 +#: docs/en/index.md:139 +#: docs/en/index.md:151 msgid "///" msgstr "" -#: docs/en/index.md:48 +#: docs/en/index.md:57 msgid "/// tab | Linux" msgstr "" -#: docs/en/index.md:56 +#: docs/en/index.md:65 msgid "/// tab | Windows" msgstr "" -#: docs/en/index.md:64 +#: docs/en/index.md:73 msgid "Code copy button behavior" msgstr "" -#: docs/en/index.md:66 +#: docs/en/index.md:75 msgid "" "The copy button on the following codeblock should result in `from pathlib " "import Path` being copied to the clipboard." msgstr "" -#: docs/en/index.md:73 +#: docs/en/index.md:82 msgid "" "The copy button on the following codeblock should result in `ls beeware-docs-" "tools` being copied to the clipboard. The shell prompt and the output should " "not be included." msgstr "" -#: docs/en/index.md:84 +#: docs/en/index.md:93 msgid "Sidebar links" msgstr "" -#: docs/en/index.md:86 +#: docs/en/index.md:95 msgid "" "Sidebar links exist, and point to the `beeware-docs-tools` repo. This " "confirms that the sidebar content has been loaded, and the `project-name` " @@ -140,32 +154,32 @@ msgid "" "computed and added." msgstr "" -#: docs/en/index.md:91 +#: docs/en/index.md:100 msgid "Link colors" msgstr "" -#: docs/en/index.md:93 +#: docs/en/index.md:102 msgid "" "This link to [the main BeeWare website]{1} should be blue in *both* light " "mode and dark mode." msgstr "" -#: docs/en/index.md:96 +#: docs/en/index.md:105 msgid "" "The links in the left and right sidebars should also be blue in both modes." msgstr "" -#: docs/en/index.md:98 +#: docs/en/index.md:107 msgid "" "When scrolling down the page, the active header link in the right sidebar " "should be light blue in dark mode, and darker blue in light mode." msgstr "" -#: docs/en/index.md:101 -msgid "Translation Admonition" +#: docs/en/index.md:110 +msgid "Translation admonition" msgstr "" -#: docs/en/index.md:103 +#: docs/en/index.md:112 msgid "" "The English-language version of this document should show the " "\"Translations are available\" admonition below. The French translation " @@ -174,84 +188,84 @@ msgid "" "translations." msgstr "" -#: docs/en/index.md:108 +#: docs/en/index.md:117 msgid "{% if config.extra.translation_type == \"original\" %}" msgstr "" -#: docs/en/index.md:110 +#: docs/en/index.md:119 msgid "/// admonition | Translations are available" msgstr "" -#: docs/en/index.md:112 +#: docs/en/index.md:121 msgid "" "If you're not comfortable with English, translations of the Docs Tools are " "available in [Français]{1} and [Deutsch]{2}." msgstr "" -#: docs/en/index.md:120 -#: docs/en/index.md:132 -#: docs/en/index.md:144 +#: docs/en/index.md:129 +#: docs/en/index.md:141 +#: docs/en/index.md:153 msgid "{% endif %}" msgstr "" -#: docs/en/index.md:122 +#: docs/en/index.md:131 msgid "{% if config.extra.translation_type == \"machine\" %}" msgstr "" -#: docs/en/index.md:124 +#: docs/en/index.md:133 msgid "/// admonition | This is a machine translation!" msgstr "" -#: docs/en/index.md:126 +#: docs/en/index.md:135 msgid "" "This version of the tutorial has been generated by machine translation. We " "know this isn't ideal, but we felt that a bad translation was better than no " "translation at all." msgstr "" -#: docs/en/index.md:134 +#: docs/en/index.md:143 msgid "{% if config.extra.translation_type == \"human\" %}" msgstr "" -#: docs/en/index.md:136 +#: docs/en/index.md:145 msgid "/// admonition | This is a translation!" msgstr "" -#: docs/en/index.md:138 +#: docs/en/index.md:147 msgid "" "This document is a translation of the English version. The translation has " "been reviewed by humans, but newer sections may be generated by machine " "translation, or not translated at all." msgstr "" -#: docs/en/index.md:146 +#: docs/en/index.md:155 msgid "Custom 404 page" msgstr "" -#: docs/en/index.md:148 +#: docs/en/index.md:157 msgid "" "Add `nopage` to the end of the URL in your browser to verify the 404 page " "contains two flying bees, and the text " "\"Brutus can't find what you're looking for\" below." msgstr "" -#: docs/en/index.md:152 +#: docs/en/index.md:161 msgid "" "*MkDocs builds fail with unrecognized internal links, so you need to " "manually verify this check by modifying the URL in your browser.*" msgstr "" -#: docs/en/index.md:155 -msgid "Next Checks" +#: docs/en/index.md:164 +msgid "Next checks" msgstr "" -#: docs/en/index.md:157 +#: docs/en/index.md:166 msgid "" "The following link should take you to BeeWare Docs Tools Demo Section One. " "It is included to verify cross-page linking." msgstr "" -#: docs/en/index.md:160 +#: docs/en/index.md:169 msgid "" "Navigate to [BeeWare Docs Tools Demo Section One]{1} for the next checks." msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/section_one/index.po b/docs/locales/fr/LC_MESSAGES/section_one/index.po index 174163a..c34234a 100644 --- a/docs/locales/fr/LC_MESSAGES/section_one/index.po +++ b/docs/locales/fr/LC_MESSAGES/section_one/index.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,46 +13,62 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/section_one/index.md:1 -msgid "BeeWare Docs Tools Demo Section One" +msgid "BeeWare Docs Tools Demo section one" msgstr "" #: docs/en/section_one/index.md:3 -msgid "Include External Markdown from a Local File" +msgid "Non-homepage sidebar logo" msgstr "" #: docs/en/section_one/index.md:5 msgid "" +"The logo icon in the left sidebar should be small on all pages other than " +"the homepage. The site title and version number should be rendered next to " +"it with the site title in slightly larger font, and the version number in " +"smaller font." +msgstr "" + +#: docs/en/section_one/index.md:9 +msgid "This verifies that the theme is being properly applied." +msgstr "" + +#: docs/en/section_one/index.md:11 +msgid "Include external markdown from a local file" +msgstr "" + +#: docs/en/section_one/index.md:13 +msgid "" "The following section should have only a header, and a paragraph with inline " "code followed by a code block. There should be no text between the code " "block and the next header. This verifies that the external include extension " "is working with local files." msgstr "" -#: docs/en/section_one/index.md:10 +#: docs/en/section_one/index.md:18 msgid "-8<- \"include_content.md:local-content\"" msgstr "" -#: docs/en/section_one/index.md:12 -msgid "Include External Markdown from a URL" +#: docs/en/section_one/index.md:20 +msgid "Include external markdown from a URL" msgstr "" -#: docs/en/section_one/index.md:14 +#: docs/en/section_one/index.md:22 msgid "" "The following section should have only a header, some text and a Markdown " "list. This verifies that the external include extension is working, and that " "`url_download` is enabled." msgstr "" -#: docs/en/section_one/index.md:18 +#: docs/en/section_one/index.md:26 msgid "" "-8<- https://raw.githubusercontent.com/beeware/beeware-docs-tools/refs/heads/" "main/docs/include_content.md:remote-content -8<-" msgstr "" -#: docs/en/section_one/index.md:22 -msgid "Footer Navigation" +#: docs/en/section_one/index.md:30 +msgid "Footer navigation" msgstr "" -#: docs/en/section_one/index.md:24 +#: docs/en/section_one/index.md:32 msgid "Navigate to *Section One - Page Two* for the final check." msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/section_one/page_two.po b/docs/locales/fr/LC_MESSAGES/section_one/page_two.po index 4181d27..cde7a32 100644 --- a/docs/locales/fr/LC_MESSAGES/section_one/page_two.po +++ b/docs/locales/fr/LC_MESSAGES/section_one/page_two.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,7 +13,7 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/section_one/page_two.md:1 -msgid "BeeWare Docs Tools Demo Section One: Page Two" +msgid "BeeWare Docs Tools Demo section one: page two" msgstr "" #: docs/en/section_one/page_two.md:3 diff --git a/docs/locales/fr/LC_MESSAGES/section_three/index.po b/docs/locales/fr/LC_MESSAGES/section_three/index.po new file mode 100644 index 0000000..be476d2 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/index.po @@ -0,0 +1,24 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" + +#: docs/en/section_three/index.md:1 +msgid "BeeWare Docs Tools Demo section three" +msgstr "" + +#: docs/en/section_three/index.md:3 +msgid "" +"This section and its children are included for sidebar scroll testing. " +"Verify the scrollbar is navigable on smaller-height displays, that you can " +"scroll the entire list (Page 01 - Page 12), and that it is not overlapping " +"the footer." +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_01.po b/docs/locales/fr/LC_MESSAGES/section_three/page_01.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_01.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_02.po b/docs/locales/fr/LC_MESSAGES/section_three/page_02.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_02.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_03.po b/docs/locales/fr/LC_MESSAGES/section_three/page_03.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_03.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_04.po b/docs/locales/fr/LC_MESSAGES/section_three/page_04.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_04.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_05.po b/docs/locales/fr/LC_MESSAGES/section_three/page_05.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_05.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_06.po b/docs/locales/fr/LC_MESSAGES/section_three/page_06.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_06.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_07.po b/docs/locales/fr/LC_MESSAGES/section_three/page_07.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_07.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_08.po b/docs/locales/fr/LC_MESSAGES/section_three/page_08.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_08.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_09.po b/docs/locales/fr/LC_MESSAGES/section_three/page_09.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_09.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_10.po b/docs/locales/fr/LC_MESSAGES/section_three/page_10.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_10.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_11.po b/docs/locales/fr/LC_MESSAGES/section_three/page_11.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_11.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_three/page_12.po b/docs/locales/fr/LC_MESSAGES/section_three/page_12.po new file mode 100644 index 0000000..7267b49 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/section_three/page_12.po @@ -0,0 +1,12 @@ +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Translate Toolkit 3.15.6\n" diff --git a/docs/locales/fr/LC_MESSAGES/section_two/index.po b/docs/locales/fr/LC_MESSAGES/section_two/index.po index f201308..4d72eb9 100644 --- a/docs/locales/fr/LC_MESSAGES/section_two/index.po +++ b/docs/locales/fr/LC_MESSAGES/section_two/index.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-08-25 22:35+0000\n" +"POT-Creation-Date: 2025-08-25 23:52-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -13,7 +13,7 @@ msgstr "" "X-Generator: Translate Toolkit 3.15.6\n" #: docs/en/section_two/index.md:1 -msgid "BeeWare Docs Tools Demo Section Two" +msgid "BeeWare Docs Tools Demo section two" msgstr "" #: docs/en/section_two/index.md:3 diff --git a/docs/mkdocs.de.yml b/docs/mkdocs.de.yml index 4bb8a2b..68bbe77 100644 --- a/docs/mkdocs.de.yml +++ b/docs/mkdocs.de.yml @@ -1,5 +1,5 @@ INHERIT: config.yml -site_name: BeeWare Demo zu Docs Tools +site_name: BeeWare Werkzeuge für die Dokumentation site_url: https://beeware-docs-tools.readthedocs.io/de/latest/ docs_dir: de diff --git a/docs/mkdocs.en.yml b/docs/mkdocs.en.yml index 7ede816..e5e3b80 100644 --- a/docs/mkdocs.en.yml +++ b/docs/mkdocs.en.yml @@ -1,5 +1,5 @@ INHERIT: config.yml -site_name: BeeWare Docs Tools Demo +site_name: BeeWare Docs Tools site_url: https://beeware-docs-tools.readthedocs.io/en/latest/ docs_dir: en diff --git a/docs/mkdocs.fr.yml b/docs/mkdocs.fr.yml index 117aa7c..b1ba60b 100644 --- a/docs/mkdocs.fr.yml +++ b/docs/mkdocs.fr.yml @@ -1,5 +1,5 @@ INHERIT: config.yml -site_name: BeeWare Démo des outils Docs +site_name: BeeWare Outils Docs site_url: https://beeware-docs-tools.readthedocs.io/fr/latest/ docs_dir: fr diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 3fde876..5a24b74 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -9,6 +9,7 @@ MkDocs repo repos reStructuredText +scrollbar subdirectories subdirectory symlinked diff --git a/pyproject.toml b/pyproject.toml index b8969a4..bc8f629 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,7 +26,6 @@ dependencies = [ "markdown-checker==0.2.5", "mistletoe==1.4.0", "mkdocs-autorefs==1.4.2", - "mkdocs-include-markdown-plugin==7.1.6", "mkdocs-literate-nav==0.6.2", "mkdocs-macros-plugin==1.3.9", "mkdocs-material==9.6.18", diff --git a/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css b/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css index 7b63c18..222bcdf 100644 --- a/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css +++ b/src/beeware_docs_tools/overrides/assets/stylesheets/beeware_theme.css @@ -125,10 +125,6 @@ padding-right: 0; padding-left: 0; } - - .md-header__button[for="__drawer"] { - color: #FFFFFFB3; - } } @media (min-width: 863px) { @@ -316,7 +312,7 @@ color: light-dark(#30314B, #96ACEE) } -/* Unsticky header */ +/* Unsticky header, add margin to deal with sidebar top margin changes */ .md-header { position: unset; } @@ -335,24 +331,56 @@ color: unset; } -/* Version number wrap */ -span.version_number { +/* Site name */ +.site-name { + font-size: 20px; + padding-bottom: 8px; +} + +.small .site-name { + padding-bottom: 0; +} + +/* Sidebar title block */ +.sidebar-title-block { + margin-bottom: 24px; +} + +.small .sidebar-title-block { + height: fit-content; + min-height: 60px; + margin-bottom: 42px; +} + +/* Version number */ +.version-number { overflow-wrap: anywhere; + font-size: 12px; + font-weight: normal; +} + +.small .version-number { + padding-top: 10px; + justify-content: space-between; + display: grid; } /* GitHub sidebar links */ .github-links { font-weight: normal; - margin-top: 0.5rem; - margin-bottom: 0.5rem; } -.github-links:first-of-type { - margin-top: 1rem; +.github-link-block a { + color: light-dark(#084AFF, #526CFE); +} + +.small .github-link-block { + margin-top: 16px; } -.github-links:last-of-type { - margin-bottom: 1rem; +.github-link-block a:last-child .github-links { + margin-top: 8px; + margin-bottom: 16px; } /* Shows the logo in the sidebar */ @@ -360,21 +388,60 @@ span.version_number { display: unset; } -/* Adjusts sidebar logo */ -@media screen and (min-width: 76.2344rem) { +.mobile-site-name { + font-family: Cutive, "serif"; + font-size: 16px; + display: inline-block; + vertical-align: middle; +} + +.mobile-version-number { + font-size: 12px; + display: inline-block; + vertical-align: middle; + padding-top: 4px; + padding-left: 4px; +} + +.mobile-sidebar-drawer { + color: light-dark(#000000, #FFFFFF); + background-color: light-dark(#F8F9FB, #4E4F52); +} + +/* Adjustments for larger displays */ +@media screen and (min-width: 1220px) { .md-nav__title .md-nav__button.md-logo img { height: unset; padding-bottom: 1rem; } + + .md-nav__title.small .sidebar-logo img { + height: 80px !important; + float: left; + padding-left: 4px; + padding-right: 8px; + padding-bottom: 0 !important; + width: 74px; + margin-bottom: 10px; + } + + .mobile-site-name, .mobile-version-number { + display: none; + } } -/* Adjusts sidebar title block, which includes GitHub links */ -@media screen and (max-width: 76.2344rem) { +/* Adjustments for smaller displays */ +@media screen and (max-width: 1219.99px) { .md-nav--primary .md-nav__title[for="__drawer"] { height: initial; white-space: unset; line-height: 1.3; - color: #FFFFFFD3; + color: light-dark(#000000, #FFFFFF); + background-color: light-dark(#F8F9FB, #4E4F52); + } + + .md-nav--primary .md-nav__title .md-nav__icon { + position: relative; } .md-nav--primary .md-nav__title { @@ -388,6 +455,34 @@ span.version_number { .md-nav__title .md-nav__button.md-logo img { padding-bottom: 10px; + height: 60px; + } + + .md-sidebar.md-sidebar--secondary { + top: 66px !important; + } + + .sidebar-logo { + height: 80px !important; + float: left; + padding-left: 4px; + padding-right: 8px; + padding-bottom: 0 !important; + width: 74px; + margin-bottom: 10px; + } + + .sidebar-title-block { + height: fit-content; + min-height: 60px; + margin-bottom: 42px; + } +} + +/* Hide bottom navigation bar below a specific height to regain screen real estate */ +@media screen and (max-height: 640px) { + .md-footer__inner.md-grid { + display: none; } } @@ -397,6 +492,53 @@ body { font-size: 1rem; } +/* Removes padding and margins to regain screen-space on pages with short content. + There is JS setting `top: 68px` on the sidebars that is eating up a huge amount + of space. Overriding `top` causes a significant gap at the bottom between the end + of the sidebar and the footer. Therefore the following margin changes are needed. +*/ +.md-main__inner { + margin-top: 0; + padding-top: 12px; +} + +.md-header { + margin-bottom: 72px; +} + +.md-sidebar { + padding-top: 12px; +} + +.md-content__inner { + padding-top: 8px; + margin-top: -69px; +} + +.md-content__inner::before { + height: 0; +} + +.md-footer { + position: relative; + margin-top: 69px; +} + +@media screen and (min-width: 60em) { + .md-sidebar__scrollwrap { + margin-top: -64px; + } +} + +.md-content { + min-height: 81vh; +} + +/* Fix "Made with" hover link color in light mode */ +html .md-footer-meta.md-typeset a:hover { + color: light-dark(#084AFF, #526CFE) +} + /* Read the Docs elements font size fix */ readthedocs-flyout, readthedocs-notification, @@ -473,3 +615,29 @@ input.md-search__input, .md-search__suggest, .md-search-result__meta { footer.md-footer *, html .md-footer-meta.md-typeset a { color: light-dark(#343A40, #E2E4E9); } + +/* Footer navigation */ +.md-footer__inner { + padding: 0; +} + +.md-footer__inner .md-footer__title .md-ellipsis { + overflow: unset; +} + +.md-footer__link { + margin-bottom: 0; + margin-top: 0.5rem; +} + +.md-footer__title { + font-size: .6rem; +} + +.md-footer__direction { + font-size: .6rem +} + +.md-footer__button { + margin: 0 0 0.2rem 0; +} diff --git a/src/beeware_docs_tools/overrides/partials/header.html b/src/beeware_docs_tools/overrides/partials/header.html index 62d6e3d..b1ddeb8 100644 --- a/src/beeware_docs_tools/overrides/partials/header.html +++ b/src/beeware_docs_tools/overrides/partials/header.html @@ -30,7 +30,6 @@ Donate -
{% include "partials/palette.html" %} @@ -55,9 +54,17 @@ {% endif %}
- +
+ +
+ {{ config.site_name }} +
+
+ {{ config.extra.version }} +
+
diff --git a/src/beeware_docs_tools/overrides/partials/nav.html b/src/beeware_docs_tools/overrides/partials/nav.html index 5df39c2..c3446ff 100644 --- a/src/beeware_docs_tools/overrides/partials/nav.html +++ b/src/beeware_docs_tools/overrides/partials/nav.html @@ -33,26 +33,40 @@ > -