[bug][low_priority] Referencing footnote as [^1] renders as [2] on HTML

[najuzilu]

The finite_markov-MyST.md lecture references a footnote as [^1] which renders as [2] on HTML. When you have a chance @mtiley could you confirm if you get the same thing? I'll work on a test case following Chris' suggestions.

[chrisjsewell]

You know that the label name (in this case “1”) has no bearing on the number in the HTML though? Footnotes in the HTML are numbered by reference order: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#footnotes, so I’m guessing/hopeing that this is the 2nd footnote to be referenced?

[najuzilu]

That's what I thought. The lecture uses [^1] as default so I left it that way (see below). But when it is rendered it shows up as [2]. However, it is the only footnote reference in the document.

When I change it to something else like [^2] or [^foobar] it renders fine (see below).

[chrisjsewell]

Ah fair enough! Yeh go ahead with the PR thanks

[mmcky]

I think this is something we need to fix in the myst_parser. @chrisjsewell can I transfer this issue to myst_parser for tracking?

[chrisjsewell]

This should be fixed in executablebooks/MyST-Parser#123, as metioned in #16 you should try running this project with pip install myst-parser==0.8.0a3 which is an alpha release generated directly from this branch.

[najuzilu]

I created a new env, ran pip install myst-parser==0.8.0a3 and now I get this error:
Could not import extension myst_parser (exception: No module named 'myst_parser').

Hm... strange because when I run conda list it's there:

@mtiley could you try this too just in case?

[chrisjsewell]

Do you also have Sphinx in that Conda list? I think You’re calling sphinx-build from your root env, and should actually run pip install myst-parser[sphinx]==0.8.0a3

[Harveyt47]

Hi @chrisjsewell I did pip install myst-parser[sphinx]==0.8.0a3 in my MyST-NB file and then attempted to build the qe-example.

I got these errors.

pkg_resources.ContextualVersionConflict: (myst-parser 0.8.0a3 (/home/harveyt47/anaconda3/envs/qe-book/lib/python3.8/site-packages), Requirement.parse('myst-parser~=0.8'), {'myst-nb'})```

raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'myst-parser~=0.8' distribution was not found and is required by myst-nb

Do I have to have 'myst-parser~=0.8' installed in order to make the build?

[chrisjsewell]

Heya, well my first question would be, is there a reason that you would want to use 0.8.0a3, given that 0.8.1 is now available? https://github.com/ExecutableBookProject/MyST-Parser/releases

[Harveyt47]

I see, I was just following this issue to try and fix the footnotes. I'll give 0.8.1 a try and see if that fixes the footnote and build issue. Thanks @chrisjsewell

[chrisjsewell]

No worries, btw I believe this is still an issue, and it’s something to do with how docutils interprets https://github.com/ExecutableBookProject/MyST-Parser/blob/a084975f02c0b4a9141f75878f78b48afa9f9b5a/myst_parser/docutils_renderer.py#L567

Maybe using refnode["refname"] = str(target) would fix