jackoconnordev commented 6 months ago

Description

This fixes code blocks on www.djangoproject.com/start page not displaying with correct Python indentation (and includes my best guess at correct PEP8 styling).

Fixes https://github.com/django/djangoproject.com/issues/1453

Fix

The DjHTML code indenter was automatically changing the indentation for the code blocks which were colorised by {% pygment 'python' %}. This led to incorrectly formatted Python code which would neither pass a Python interpreter's indentation checks or conform to PEP8.

The DjHTML indenter can be temporarily turned off for certain lines by making use of {# fmt:off #} and {# fmt:on #}. This is the method I think works best in this specific use-case. See https://github.com/rtts/djhtml#fmtoff-and-fmton.

\

 vs fmt:off

The DjHTML indentation can also be stopped from being applied by using <pre> tags. However, the <pre> tags cause lots of extra vertical whitespace on the website so I feel just disabling the formatter is the better way to go.

If pre tags are included within the pygment block then they get treated as plain text instead of markup. If pre tags wrap the pygment block then the newlines at the end of the open and close pygment lines lead to the increased vertical white space since whitespace is preserved