如何自定义sphinx.application.Sphinx.connect事件？

Question

我是Sphinx的初学者，我想了解操作机制。以下内容来自此link。

from sphinx.application import Sphinx

def html_page_context(app, pagename, templatename, context, doctree):
    ...

def setup(app: Sphinx):
    # event:
    # from sphinx.events import core_events
    # https://www.sphinx-doc.org/en/master/extdev/appapi.html#event-html-page-context
    # https://www.sphinx-doc.org/en/1.0/ext/appapi.html#event-html-page-context
    app.connect(event='html-page-context', callback=html_page_context)

我的问题是他怎么知道如何编写此函数（def html_page_context() ...）？

我在文档（ref1和ref2]中进行了研究，并解释了其功能的参数应该是，但是我怎么知道如何在此功能中编写detail？

当然，我可以参考它并进行调试以了解发生了什么。 （但是如果没有其他引用，仅存在本机代码该怎么办。）

给男人一条鱼，你就给他喂一天；教他如何钓鱼，您将一生喂饱他。请教我如何钓鱼。

我希望回答者可以告诉我：

该事件是否存在默认功能？

是：

1. 脚本的位置从哪里来？
2. 你怎么知道？ （是否有任何技能，例如，了解问题的钩子，或者您是开发人员之一？）

否：

• 是否有任何建议来知道如何编写内容。 （不引用其他作者的意见，仅提供本机源代码）

我知道有些问题具有某种主观性，但是我很乐意接受他们愿意传播的任何“智慧明珠”，]！>

我是Sphinx的初学者，我想了解操作机制。以下内容来自此链接。从sphinx.application导入Sphinx def html_page_context（app，pagename，...

Answer 1

我明白了，答案是