链接到Github中的python函数
我正在用链接到Github中的python函数,python,python-3.x,github,github-flavored-markdown,Python,Python 3.x,Github,Github Flavored Markdown,我正在用.md文件记录python库中的函数,当我提到函数时,我想链接到代码库中的函数。然而,到目前为止,我能做的最好的事情是 [logout()](https://github.com/my-username/my-repository/blob/83gxn83g84gnxi4wgfnxwuxnfguw4/path/to/filename.py#L122) 它链接到函数开始的文件中的行号。但是,如果功能发生变化,则此链接不再有效。因此,我想直接链接到当前repo分支中的python函数。这不
.md
文件记录python库中的函数,当我提到函数时,我想链接到代码库中的函数。然而,到目前为止,我能做的最好的事情是
[logout()](https://github.com/my-username/my-repository/blob/83gxn83g84gnxi4wgfnxwuxnfguw4/path/to/filename.py#L122)
它链接到函数开始的文件中的行号。但是,如果功能发生变化,则此链接不再有效。因此,我想直接链接到当前repo分支中的python函数。这不是已经链接到了特定的提交(因此很健壮?)@IzaakvanDongen正是我的观点。我想链接到repo分支中的函数,而不是特定的commit,因为函数将发生更改。我们遇到过类似的问题,最好的办法是使用文档生成软件(Sphinx或mkdocs)。啊哈,明白了
:)
。虽然我还不知道答案,但我担心如果您想编写健壮的API文档,最好使用专门用于此目的的工具,例如。我不认为GitHub有办法做到这一点(然而——看起来它可能已经在地平线上了),这不是已经链接到一个特定的提交(因此很健壮?)@IzaakvanDongen正是我的观点。我想链接到repo分支中的函数,而不是特定的commit,因为函数将发生更改。我们遇到过类似的问题,最好的办法是使用文档生成软件(Sphinx或mkdocs)。啊哈,明白了:)
。虽然我还不知道答案,但我担心如果您想编写健壮的API文档,最好使用专门用于此目的的工具,例如。我不认为GitHub有办法做到这一点(然而——看起来它可能已经在地平线上了)