Syntax for targets about myst-parser HOT 2 CLOSED

For more context, targets are handled by docutils.transforms.references.PropagateTargets, which
propagate empty internal targets to the next element.

<document source="">
    <target ids="target" names="target">
    <section ids="header-1" names="header\ 1">
        <target ids="target2" names="target2">
        <paragraph>

<document source="">
    <target refid="target">
    <section ids="header target" names="header target">
        <target refid="target2">
        <paragraph ids="target2" names="target2">

So you can actually use it for more than headers (although that's their main use), e.g.

(target_fig)=

```{figure} example.jpg
Caption
```

{ref}`target_fig`

The issue with doing # My header name ={mytargetname} is that you'll end up with something like:

<header>
    <rawtext>
        My header name
   <target>
        mytargetname

Then, when you convert to the docutils tree, you have to work out how to reposition the target up above the header.

from myst-parser.

Makes sense to me - I didn't realize it was in-built to Sphinx to grab the next thing, in that case I agree we should keep it before the headers

from myst-parser.