Anchor not created for internal target inside list

[flichtenheld]

I have problems with internal links. One issue that I think I have identified is that links into lists do not work as expected from https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#footnote-12

Test code

Testing Sphinx Confluence Builder
----------------------------------------

.. contents:: Table of Contents

Overview
--------

Some content with `internal link`_.
And a second link: `other values`_.

Other Section
-------------

Some paragraph.

.. _internal link:

Internal link goes here.

Description:

* **value** (string) — value

  .. _other values:

* **other values** (int) — code

  * **0** — foo
  * **1** — bar
  * **2** — baz

* **something else**

"internal link" works fine. But "other values" link does not work. Generated code (for "Other Section" only):

<p>Some paragraph.</p><p><ac:structured-macro ac:name="anchor">
<ac:parameter ac:name="">internal-link</ac:parameter>
</ac:structured-macro><ac:structured-macro ac:name="anchor">
<ac:parameter ac:name="">TestingSphinxConfluenceBuilder-internal-link</ac:parameter>
</ac:structured-macro>Internal link goes here.</p><p>Description:</p><ul>
<li style="margin-top: 10px;">
<p><strong>value</strong> (string) — value</p></li>
<li style="margin-top: 10px;">
<p><strong>other values</strong> (int) — code</p><ul style="margin-top: 10px;">
<li>
<p><strong>0</strong> — foo</p></li>
<li>
<p><strong>1</strong> — bar</p></li>
<li>
<p><strong>2</strong> — baz</p></li>
</ul>
</li>
<li style="margin-top: 10px;">
<p><strong>something else</strong></p></li>
</ul>

I'm using sphinxcontrib-confluencebuilder 2.13.0.

[jdknight]

@flichtenheld, mind trying out this branch to see if it resolves this issue:

pip install git+https://github.com/sphinx-contrib/confluencebuilder.git@delayed-anchor-injection

[jdknight]

Changes (#1125) have been made to help generate more anchor links in documentation. This includes anchors for list items reported. This change has been added into the main branch and should be made available next stable release. This can be tested now by using the development version. Feel free to try it out ahead of time any report any issues you may have.

[flichtenheld]

Thanks. The anchors in lists seem to generally work now.

It is still not as nice as when generating a local HTML documentation due to the anchor being inside the paragraph inside the list item (as opposed to just making the actual list item the anchor). Due to this the browser will not always jump exactly to the start of the list item, but slightly below that. From looking at the code it seems to me this is part of the trade-off of making sure not to generate spurious newlines.

[jdknight]

Out of curiosity, are the link placements lower than expected or is it Confluence's content header panel not respecting the anchor link (e.g. is visible)?

[flichtenheld]

Not sure how exactly to answer this question. I can say the behavior is consistent between Firefox and Chrome, and it looks like this:

[jdknight]

The issue is not necessarily the anchor placement but the implementation of Confluence Cloud's page view. For this content that places a jump to the third bullet:

Reference in a list: `other values`_

#. Curabitur tincidunt eros non auctor commodo.
#. Fusce vestibulum erat id massa vehicula, a suscipit ligula vestibulum.

   .. _other values:

#. Fusce quis nibh quis dui aliquet maximus ac vel felis.
#. Duis vehicula sem non turpis eleifend imperdiet.

Adds an anchor on the third-bullet's paragraph. What I see on Confluence Data Center, the anchor placed appropriately:

And the navigation jumps and (a bit tight) shows the entry:

When testing on Confluence Cloud, the anchor is also placed in the same location:

However, the jump is overlayed by the page's content-header-container (which matches what you are seeing):

This is more of a page view error. I recall Confluence having this issue before and eventually fixing it again; but now I guess it's back.

A bonus I noticed is that Confluence Cloud editor doesn't even jump anchors at all in its smaller/minimal view. 🤦

[jdknight]

v2.14 is now available on PyPI -- marking as closed.