Add aside.topic for Docutils 0.18+

[AA-Turner]

Found when rebuilding the Python documentation with Sphinx 5.

I'm not sure if this is worth a 5.0.1 release or not.

Feature or Bugfix

• Bugfix

A

[tk0miya]

Is the rendered HTML broken if we don't merge this? I'd like to know how important this fix is.

[AA-Turner]

Is the rendered HTML broken if we don't merge this?

Yes, one second for a screenshot

A

[AA-Turner]

Sphinx 4.5.0:

Sphinx 5.0.0:

This branch:

Script:

import shutil
import types
from pathlib import Path

from docutils.parsers.rst.states import Body
from docutils.statemachine import StringList

from sphinx.cmd.make_mode import run_make_mode
from sphinx.ext.autodoc.directive import parse_generated_content


def write(filename, text): Path(filename).write_text(text, encoding="utf-8")


write("conf.py", '''\
html_theme = "classic"
''')

write("index.rst", '''\
***************************************
An introduction to the ipaddress module
***************************************
.. topic:: Overview

   This document aims to provide a gentle introduction to the
   :mod:`ipaddress` module. It is aimed primarily at users that aren't
   already familiar with IP networking terminology, but may also be useful
   to network engineers wanting an overview of how :mod:`ipaddress`
   represents IP network addressing concepts.
''')

shutil.rmtree("_build", ignore_errors=True)
run_make_mode(["html", ".", "_build", "-T", "-W"])

A

[tk0miya]

Thanks. It must be an important bug. So I'm merging this into the 5.0.x branch.

[mgeier]

This fix is still missing for Sphinx's own theme sphinx13.

sphinx/doc/_themes/sphinx13/static/sphinx13.css

Line 375 in af425c0

div.topic {

I think this is a good example for how it is easy to miss fixes in the sphinx13 theme. That's exactly why I suggested to move it to the rest of the built-in themes: #7733
Maybe this is worth reconsidering?

[AA-Turner]

@mgeier -- thank you and mea culpa, I searched within the sphinx/themes directory. #10521 is a fix for 5.0.2.

A

[mgeier]

I wouldn't say it's your fault, because the sphinx13 theme is very easy to miss, that's why I suggested #7733, which would make such things harder to miss in the future.