Footnote appears in all following objects after the first appearance

[anthonyhtyao]

Hi, I'm not sure this is related to pytkdocs or mkdocstrings.

Describe the bug
If a footnote is added to one of python objects, the footnote will appear in every object after that one in the same documentation page.

To Reproduce
Here is an example to reproduce

# example.py
def C():
    """This is C
    """
    pass

def B():
    """This is B[^1]

    [^1]: This is footnote
    """
    pass

def A():
    """This is A
    """
    pass

# mkdocs.yml
site_name: Footnote
theme:
  name: "material"
plugins:
  - search
  - mkdocstrings:
      default_handler: python
markdown_extensions:
  - footnotes

Expected behavior
The footnote is supposed to appear only under function B

Screenshots
However, footnote appears under function B and C

[pawamoy]

Hi @anthonyhtyao, thank you for the bug report 🙂

I'll mark this as confirmed, your screenshot is enough evidence. As for the bug in itself, I guess it's because we re-use the same Markdown instance to convert multiple docstrings, and the foot notes must be stored somewhere in this instance. The solution would then be to clear the foot notes from the instance before converting other docstrings.

[oprypin]

This issue is actually more complex than this, because, even if you reset the list of footnotes, their reference IDs will still be shared. If you happen to put two different functions that both have a footnote named [^1] (not related though), the page will be generated with both of them having the id #fn:1

[pawamoy]

Hey @anthonyhtyao, so this has been partially fixed by @oprypin (thanks ❤️), partially because you'll still need to use different IDs for footnotes in docstrings that will be rendered in the same Markdown page. I'll link to the docs section once it's deployed.

[oprypin]

I sent out a complete fix - "once and for all", as I say. #199

[pawamoy]

0.14.0b1 is out! Try it out and tell us if it works better 🙂

[anthonyhtyao]

It works.
Thanks a lot for improving this