Add debug logging to autosectionlabel

[patzm]

Subject: I started using emoji and other non-plain-text content in section headings. I other wonder what the auto-generated section label will be.

• Feature

Purpose

See the subject. For instance, the following heading

|:page_facing_up:| Formatting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

gets rendered (using sphinxemoji) as

Trying to reference it with

:ref:`|:page_facing_up:| Formatting`

fails worked. I guess I did something else wrong. I had no clue then whether it was due to the | or : characters, whether the emoji had already been inserted and the correct reference would have been :ref:`📄 Formatting` , or something else altogether. I also couldn't find anything in the docs 😕. Because the code internally relies on docutils, I didn't want to rabbit hole and think about what the code would actually do.

Output would be for instance:

/some/dir/docs/shared/contribution/code_authoring.rst:40: section "|:page_facing_up:| Formatting" gets labeled as "|:page_facing_up:| formatting"
/some/dir/docs/shared/contribution/code_authoring.rst:50: section "|:pencil2:| Writing new code" gets labeled as "|:pencil2:| writing new code"
/some/dir/docs/shared/contribution/documentation.rst:2: section "Documentation" gets labeled as "documentation"

wrong conclusion

What worked eventually: ```rst :ref:`|:page_facing_up:| formatting` ``` ~note the _lower-case_ `formatting`, not _upper-case_.~

Questions

Soooo: debug logging. Is this the best way to do this? I could configure the verbosity then with -vv(docs).

Should we also add something to the docs? Somehow help other lost souls like myself?

[AA-Turner]

Please target against 5.x and add a CHANGES entry and tests.

A

[patzm]

Done. I also added documentation in 4b31161. Renders as

Changes added ✅.

Can you help me with the tests? I only see tests that look at the generated html or xml output. But this is actually for testing whether the debug logging works. Does that even need a test?

[AA-Turner]

Please target against 5.x

I changed the base but you'll need to rebase to remove all the extra commits.

A

[patzm]

ok I hope that this was the right rebase. Also I hope you do squash merging 😆.

[AA-Turner]

Thanks Martin!

A