Skip to content

Commit e900a0b

Browse files
kattnikattni
authored
Make mkdocs serve/build --strict optional, move locales dir. (#12)
1 parent 0068d26 commit e900a0b

15 files changed

Lines changed: 124 additions & 83 deletions

File tree

‎docs/en/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ LICENSE README.md src
8585

8686
Sidebar links exist, and point to the `beeware-docs-tools` repo. This
8787
confirms that the sidebar content has been loaded, and the `project-name`
88-
has been set in the MkDocs configuration file.
88+
has been set in the MkDocs configuration file, and the version number is
89+
computed and added.
8990

9091
### Link colors
9192

locales/de/LC_MESSAGES/SUMMARY.po renamed to docs/locales/de/LC_MESSAGES/SUMMARY.po

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"

locales/de/LC_MESSAGES/index.po renamed to docs/locales/de/LC_MESSAGES/index.po

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -97,9 +97,9 @@ msgstr ""
9797
#: docs/en/index.md:46
9898
#: docs/en/index.md:54
9999
#: docs/en/index.md:62
100-
#: docs/en/index.md:114
101-
#: docs/en/index.md:126
102-
#: docs/en/index.md:138
100+
#: docs/en/index.md:117
101+
#: docs/en/index.md:129
102+
#: docs/en/index.md:141
103103
msgid "///"
104104
msgstr ""
105105

@@ -184,74 +184,73 @@ msgstr ""
184184
#: docs/en/index.md:111
185185
msgid ""
186186
"If you're not comfortable with English, translations of the Docs Tools are "
187-
"available in Français and Deutsch."
187+
"available in [Français]{1} and [Deutsch]{2}."
188188
msgstr ""
189189

190-
#: docs/en/index.md:116
191-
#: docs/en/index.md:128
192-
#: docs/en/index.md:140
190+
#: docs/en/index.md:119
191+
#: docs/en/index.md:131
192+
#: docs/en/index.md:143
193193
msgid "{% endif %}"
194194
msgstr ""
195195

196-
#: docs/en/index.md:118
196+
#: docs/en/index.md:121
197197
msgid "{% if config.extra.translation_type == \"machine\" %}"
198198
msgstr ""
199199

200-
#: docs/en/index.md:120
200+
#: docs/en/index.md:123
201201
msgid "/// admonition | This is a machine translation!"
202202
msgstr ""
203203

204-
#: docs/en/index.md:122
204+
#: docs/en/index.md:125
205205
msgid ""
206206
"This version of the tutorial has been generated by machine translation. We "
207207
"know this isn't ideal, but we felt that a bad translation was better than no "
208208
"translation at all."
209209
msgstr ""
210210

211-
#: docs/en/index.md:130
211+
#: docs/en/index.md:133
212212
msgid "{% if config.extra.translation_type == \"human\" %}"
213213
msgstr ""
214214

215-
#: docs/en/index.md:132
215+
#: docs/en/index.md:135
216216
msgid "/// admonition | This is a translation!"
217217
msgstr ""
218218

219-
#: docs/en/index.md:134
219+
#: docs/en/index.md:137
220220
msgid ""
221221
"This document is a translation of the English version. The translation has "
222222
"been reviewed by humans, but newer sections may be generated by machine "
223223
"translation, or not translated at all."
224224
msgstr ""
225225

226-
#: docs/en/index.md:142
226+
#: docs/en/index.md:145
227227
msgid "Custom 404 page"
228228
msgstr ""
229229

230-
#: docs/en/index.md:144
230+
#: docs/en/index.md:147
231231
msgid ""
232232
"Add `nopage` to the end of the URL in your browser to verify the 404 page "
233233
"contains two flying bees, and the text "
234234
"\"Brutus can't find what you're looking for\" below."
235235
msgstr ""
236236

237-
#: docs/en/index.md:148
237+
#: docs/en/index.md:151
238238
msgid ""
239239
"*MkDocs builds fail with unrecognized internal links, so you need to "
240240
"manually verify this check by modifying the URL in your browser.*"
241241
msgstr ""
242242

243-
#: docs/en/index.md:151
243+
#: docs/en/index.md:154
244244
msgid "Next Checks"
245245
msgstr ""
246246

247-
#: docs/en/index.md:153
247+
#: docs/en/index.md:156
248248
msgid ""
249249
"The following link should take you to BeeWare Docs Tools Demo Section One. "
250-
"It is included to verify `autoref` linking."
250+
"It is included to verify cross-page linking."
251251
msgstr ""
252252

253-
#: docs/en/index.md:156
253+
#: docs/en/index.md:159
254254
msgid ""
255-
"Navigate to [BeeWare Docs Tools Demo Section One][section-one] for the next "
256-
"checks."
255+
"Navigate to [BeeWare Docs Tools Demo Section One]{1} for the next checks."
257256
msgstr ""

locales/fr/LC_MESSAGES/section_one/index.po renamed to docs/locales/de/LC_MESSAGES/section_one/index.po

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -13,7 +13,7 @@ msgstr ""
1313
"X-Generator: Translate Toolkit 3.15.6\n"
1414

1515
#: docs/en/section_one/index.md:1
16-
msgid "BeeWare Docs Tools Demo Section One { id=\"section-one\" }"
16+
msgid "BeeWare Docs Tools Demo Section One"
1717
msgstr ""
1818

1919
#: docs/en/section_one/index.md:3
@@ -28,9 +28,9 @@ msgstr ""
2828

2929
#: docs/en/section_one/index.md:8
3030
msgid ""
31-
"{% include-markdown \"https://raw.githubusercontent.com/kattni/"
32-
"beeware-docs-tools/refs/heads/tooling/mkdocs/docs/include_content.md\" start="
33-
"\"{1}\" end=\"{2}\" %}"
31+
"{% include-markdown \"https://raw.githubusercontent.com/beeware/"
32+
"beeware-docs-tools/refs/heads/main/docs/include_content.md\" start=\"{1}\" "
33+
"end=\"{2}\" %}"
3434
msgstr ""
3535

3636
#: docs/en/section_one/index.md:14

locales/fr/LC_MESSAGES/section_one/page_two.po renamed to docs/locales/de/LC_MESSAGES/section_one/page_two.po

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,6 +17,10 @@ msgid "BeeWare Docs Tools Demo Section One: Page Two"
1717
msgstr ""
1818

1919
#: docs/en/section_one/page_two.md:3
20+
msgid "Footer and navigation links"
21+
msgstr ""
22+
23+
#: docs/en/section_one/page_two.md:5
2024
msgid ""
2125
"Navigation should render at the bottom of the page; "
2226
"\"BeeWare Docs Tools Demo Section One\" should be on the left, "

locales/de/LC_MESSAGES/section_two/index.po renamed to docs/locales/de/LC_MESSAGES/section_two/index.po

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -36,3 +36,13 @@ msgid ""
3636
"images subdirectories are being properly symlinked for languages other than "
3737
"English."
3838
msgstr ""
39+
40+
#: docs/en/section_two/index.md:14
41+
msgid "`autoref` linking"
42+
msgstr ""
43+
44+
#: docs/en/section_two/index.md:16
45+
msgid ""
46+
"The link provided here should take you to the [Heading font][heading-font] "
47+
"section of the main page. It is included to verify `autoref` linking."
48+
msgstr ""

locales/fr/LC_MESSAGES/SUMMARY.po renamed to docs/locales/fr/LC_MESSAGES/SUMMARY.po

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"

locales/fr/LC_MESSAGES/index.po renamed to docs/locales/fr/LC_MESSAGES/index.po

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -97,9 +97,9 @@ msgstr ""
9797
#: docs/en/index.md:46
9898
#: docs/en/index.md:54
9999
#: docs/en/index.md:62
100-
#: docs/en/index.md:114
101-
#: docs/en/index.md:126
102-
#: docs/en/index.md:138
100+
#: docs/en/index.md:117
101+
#: docs/en/index.md:129
102+
#: docs/en/index.md:141
103103
msgid "///"
104104
msgstr ""
105105

@@ -184,74 +184,73 @@ msgstr ""
184184
#: docs/en/index.md:111
185185
msgid ""
186186
"If you're not comfortable with English, translations of the Docs Tools are "
187-
"available in Français and Deutsch."
187+
"available in [Français]{1} and [Deutsch]{2}."
188188
msgstr ""
189189

190-
#: docs/en/index.md:116
191-
#: docs/en/index.md:128
192-
#: docs/en/index.md:140
190+
#: docs/en/index.md:119
191+
#: docs/en/index.md:131
192+
#: docs/en/index.md:143
193193
msgid "{% endif %}"
194194
msgstr ""
195195

196-
#: docs/en/index.md:118
196+
#: docs/en/index.md:121
197197
msgid "{% if config.extra.translation_type == \"machine\" %}"
198198
msgstr ""
199199

200-
#: docs/en/index.md:120
200+
#: docs/en/index.md:123
201201
msgid "/// admonition | This is a machine translation!"
202202
msgstr ""
203203

204-
#: docs/en/index.md:122
204+
#: docs/en/index.md:125
205205
msgid ""
206206
"This version of the tutorial has been generated by machine translation. We "
207207
"know this isn't ideal, but we felt that a bad translation was better than no "
208208
"translation at all."
209209
msgstr ""
210210

211-
#: docs/en/index.md:130
211+
#: docs/en/index.md:133
212212
msgid "{% if config.extra.translation_type == \"human\" %}"
213213
msgstr ""
214214

215-
#: docs/en/index.md:132
215+
#: docs/en/index.md:135
216216
msgid "/// admonition | This is a translation!"
217217
msgstr ""
218218

219-
#: docs/en/index.md:134
219+
#: docs/en/index.md:137
220220
msgid ""
221221
"This document is a translation of the English version. The translation has "
222222
"been reviewed by humans, but newer sections may be generated by machine "
223223
"translation, or not translated at all."
224224
msgstr ""
225225

226-
#: docs/en/index.md:142
226+
#: docs/en/index.md:145
227227
msgid "Custom 404 page"
228228
msgstr ""
229229

230-
#: docs/en/index.md:144
230+
#: docs/en/index.md:147
231231
msgid ""
232232
"Add `nopage` to the end of the URL in your browser to verify the 404 page "
233233
"contains two flying bees, and the text "
234234
"\"Brutus can't find what you're looking for\" below."
235235
msgstr ""
236236

237-
#: docs/en/index.md:148
237+
#: docs/en/index.md:151
238238
msgid ""
239239
"*MkDocs builds fail with unrecognized internal links, so you need to "
240240
"manually verify this check by modifying the URL in your browser.*"
241241
msgstr ""
242242

243-
#: docs/en/index.md:151
243+
#: docs/en/index.md:154
244244
msgid "Next Checks"
245245
msgstr ""
246246

247-
#: docs/en/index.md:153
247+
#: docs/en/index.md:156
248248
msgid ""
249249
"The following link should take you to BeeWare Docs Tools Demo Section One. "
250-
"It is included to verify `autoref` linking."
250+
"It is included to verify cross-page linking."
251251
msgstr ""
252252

253-
#: docs/en/index.md:156
253+
#: docs/en/index.md:159
254254
msgid ""
255-
"Navigate to [BeeWare Docs Tools Demo Section One][section-one] for the next "
256-
"checks."
255+
"Navigate to [BeeWare Docs Tools Demo Section One]{1} for the next checks."
257256
msgstr ""

locales/de/LC_MESSAGES/section_one/index.po renamed to docs/locales/fr/LC_MESSAGES/section_one/index.po

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -13,7 +13,7 @@ msgstr ""
1313
"X-Generator: Translate Toolkit 3.15.6\n"
1414

1515
#: docs/en/section_one/index.md:1
16-
msgid "BeeWare Docs Tools Demo Section One { id=\"section-one\" }"
16+
msgid "BeeWare Docs Tools Demo Section One"
1717
msgstr ""
1818

1919
#: docs/en/section_one/index.md:3
@@ -28,9 +28,9 @@ msgstr ""
2828

2929
#: docs/en/section_one/index.md:8
3030
msgid ""
31-
"{% include-markdown \"https://raw.githubusercontent.com/kattni/"
32-
"beeware-docs-tools/refs/heads/tooling/mkdocs/docs/include_content.md\" start="
33-
"\"{1}\" end=\"{2}\" %}"
31+
"{% include-markdown \"https://raw.githubusercontent.com/beeware/"
32+
"beeware-docs-tools/refs/heads/main/docs/include_content.md\" start=\"{1}\" "
33+
"end=\"{2}\" %}"
3434
msgstr ""
3535

3636
#: docs/en/section_one/index.md:14

locales/de/LC_MESSAGES/section_one/page_two.po renamed to docs/locales/fr/LC_MESSAGES/section_one/page_two.po

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ msgid ""
33
msgstr ""
44
"Project-Id-Version: PACKAGE VERSION\n"
55
"Report-Msgid-Bugs-To: \n"
6-
"POT-Creation-Date: 2025-08-20 18:40-0400\n"
6+
"POT-Creation-Date: 2025-08-21 23:46-0400\n"
77
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
88
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
99
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,6 +17,10 @@ msgid "BeeWare Docs Tools Demo Section One: Page Two"
1717
msgstr ""
1818

1919
#: docs/en/section_one/page_two.md:3
20+
msgid "Footer and navigation links"
21+
msgstr ""
22+
23+
#: docs/en/section_one/page_two.md:5
2024
msgid ""
2125
"Navigation should render at the bottom of the page; "
2226
"\"BeeWare Docs Tools Demo Section One\" should be on the left, "

0 commit comments

Comments
 (0)