Repository navigation
fix(docs): wlasne ograniczniki include-markdown zamiast kolidujacych z Django - #720
Merged
Merged
Conversation
…z Django
`mkdocs build --strict` padal na `deweloper/plan-import-list-if-liveops.md`:
wtyczka include-markdown uzywa domyslnie ogranicznikow `{% %}` -- dokladnie
tych samych, co Django. Dokument cytowal szablon
`{% include "long_running/operation_details.html" %}`, wiec wtyczka wziela
cytat za polecenie i probowala wciagnac plik, ktorego w `docs/` nie ma
(lezy w `src/long_running/templates/`). Build konczyl sie BuildError-em.
Escape'owanie szesciu wystapien tylko odsunelo by nastepne: dokumentacja
BPP z natury cytuje szablony Django. Zamiast tego wtyczka dostaje wlasne
ograniczniki `{! !}`, ktore z niczym nie koliduja. Jedyne prawdziwe uzycie
wtyczki (`o-projekcie/historia.md`, wciagajace HISTORY.md) przepisane na
nowa skladnie -- zweryfikowane lokalnie: build przechodzi, a strona historii
nadal ma pelna tresc HISTORY.md.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mkdocs build --strictpadał nadev— wyszło przy okazji #719.Przyczyna
Wtyczka
include-markdownużywa domyślnie ograniczników{% %}— dokładnie tych samych, co Django. Dokumentdeweloper/plan-import-list-if-liveops.md(z #717) cytuje szablon:Wtyczka wzięła cytat za polecenie i spróbowała wciągnąć plik, którego w
docs/nie ma — leży wsrc/long_running/templates/. Build kończył sięBuildError.Takich cytatów jest w
docs/deweloper/sześć. Build przewracał się na pierwszym alfabetycznie i nie pokazywał reszty.Dlaczego nie escape
Escape'owanie sześciu wystąpień odsunęłoby tylko następne: dokumentacja BPP z natury cytuje szablony Django, a autor planu nie ma powodu podejrzewać, że opisanie szablonu psuje stronę dokumentacji. Wtyczka dostaje więc własne ograniczniki
{! !}, które z niczym nie kolidują.Jedyne prawdziwe użycie wtyczki w całej dokumentacji (
o-projekcie/historia.md, wciągająceHISTORY.md) przepisane na nową składnię.Weryfikacja
Lokalnie, dokładnie tak jak CI (
uv run --with-requirements docs/requirements.txt --no-project mkdocs build --strict):Aborted with a BuildError!Documentation built in 1.34 seconds, exit 0site/o-projekcie/historia/index.htmlma 738 KB i pełną treśćHISTORY.md— czyli dyrektywa nadal działa, a nie została po cichu zignorowanaBez newsfragmentu: to naprawa konfiguracji budowania dokumentacji, nie zmiana widoczna dla użytkownika BPP.
🤖 Generated with Claude Code