Version added/changed text, console tabs missing from RTD preview builds, dirhtml builds, etc.

[Mike Edmunds]

There are several related issues in the docs._ext.djangodocs Sphinx extension. The symptom is missing content in most html-like Sphinx builds, including ReadTheDocs PR preview builds:

• Missing text for versionadded and versionchanged directives: the html contains an empty <div> where something like "New in Django 6.1" or "Changed in Django development version" should be.
• Missing console tabs: the html does not include Windows console examples when they are available.

This affects the html builder (which RTD uses by default), the dirhtml builder, plus htmlhelp and singlehtml.

The fix is for the djangodocs extension to:

• Register DjangoHTMLTranslator for all html-like builders (solves missing version text)
• Handle all HTML-like builders in visit_console_html() and ConsoleDirective.run() (solves missing console tabs)

[Currently, the extension only handles version and console directives for a custom "djangohtml" builder—used in the docs/Makefile "html" target—and the "json" builder which is used for the docs.djangoproject.com site.]

Also, the custom DjangoStandaloneHTMLBuilder class can and should be removed. Its only function is generating templatebuiltins.js, which is meant to enable client-side hyperlinking of template tags and filters in code examples. But that feature isn't enabled on docs.djangoproject.com and has been broken in local docs builds since Sphinx 6.0 removed jQuery in 2023. It's effectively dead code.

[Mike Edmunds]

​https://github.com/django/django/pull/21440.

[The djangodocs Sphinx extension and theme template files are undocumented, so I think deprecation would not apply to the removed code.]

[Natalia Bidart]

Thank you Mike, this makes sense. Will review the PR soon!

[nessita <124304+nessita@…>]

In 9b1db9c:

Fixed #37150 -- Made djangodocs Sphinx extension work with any html builder.

Changed djangodocs extension to register DjangoHTMLTranslator for any
html-format builder (in the builder-inited hook), rather than a limited
list of builders at startup. That fixes missing content in dirhtml and
standard html builds (including ReadTheDocs PR previews):

• Missing console tabs
• Empty divs for versionadded and versionchanged directives

Removed JS code that depended on jQuery, which hasn't worked since
Sphinx 6.0 dropped jQuery in 2023:

• Unnecessary console tabs click handling. (Console tab behavior is implemented purely in CSS.)
• Client-side hyperlinking of Django template tags and filters in code examples. (This is also not supported on docs.djangoproject.com.)

Removed custom DjangoStandaloneHTMLBuilder and "djangohtml" builder
type. Its sole purpose was to generate the "templatebuiltins.js" file
used for the (non-functional) client-side template filter/tag linking.

Changed docs "make html" target from "djangohtml" to standard "html".

[Natalia <124304+nessita@…>]

In a09323d:

[6.1.x] Fixed #37150 -- Made djangodocs Sphinx extension work with any html builder.

Changed djangodocs extension to register DjangoHTMLTranslator for any
html-format builder (in the builder-inited hook), rather than a limited
list of builders at startup. That fixes missing content in dirhtml and
standard html builds (including ReadTheDocs PR previews):

• Missing console tabs
• Empty divs for versionadded and versionchanged directives

Removed JS code that depended on jQuery, which hasn't worked since
Sphinx 6.0 dropped jQuery in 2023:

• Unnecessary console tabs click handling. (Console tab behavior is implemented purely in CSS.)
• Client-side hyperlinking of Django template tags and filters in code examples. (This is also not supported on docs.djangoproject.com.)

Removed custom DjangoStandaloneHTMLBuilder and "djangohtml" builder
type. Its sole purpose was to generate the "templatebuiltins.js" file
used for the (non-functional) client-side template filter/tag linking.

Changed docs "make html" target from "djangohtml" to standard "html".

Backport of 9b1db9cb2c38c75b8fb0fc64ba5f73a6012e5b2d from main.

[GitHub <noreply@…>]

In bc65586c:

Refs #37150 -- Synced docs/make.bat with docs/Makefile.

[Natalia <124304+nessita@…>]

In 3a5c377:

[6.1.x] Refs #37150 -- Synced docs/make.bat with docs/Makefile.

Backport of bc65586cfb69c0c0c399e40a22494501e0da2008 from main.