英文:
MkDocs with auto generated References
问题
我正在构建一个TensorFlow模型，有大量具有适当文档字符串的函数和模块。
由于广泛需求，我安装了mkdocs，文档似乎非常容易编写。
然而，我不想手动编写此包中所有模块的整个API参考。我正在使用mkdocstrings，但我找不到一种自动化所有这些并将它们存储在mkdocs的引用部分的方法，就像您在像numpy/pandas之类的文档站点中看到的那样。
我尝试了pdoc3，但它只解决了一个问题。
mkgendocs是我希望能够使用的东西，但这需要另一个配置文件！我遵循了这篇文章，但对我来说没有效果。
有关如何将所有API文档字符串自动生成为mkdocs中的API参考页面的建议/资源吗？对于Sphinx来说太高级，抱歉。我正在努力让我的团队撰写更多文档，所以我需要一些易于使用的东西，MkDocs目前看起来是最好的选择。
英文:
I am building a TensorFlow model and have a ton of functions and modules that have proper docstrings.
I installed mkdocs due to popular demand and the documentation does appear to be very easy to write.
Nevertheless, I don't want to manually write up the entire API reference of all my modules inside this package. I am using mkdocstrings but I am unable to find a way to automate all of these and store them in the references section in mkdocs as you see with any documentation sites like numpy/pandas.
​
I tried pdoc3, but it only solves 1 problem for me.
mkgendocs was something I was hoping it would work, but this requires another config file! I followed this post but it was not working for me.
​
Any suggestions/resources on how I can autogenerate all my API docstrings into an api references page in mkdocs? Sphinx is too advanced to work with sorry. I am trying to get my team to document more so I need something easy to use and MkDocs looks like the best option currently.
答案1
得分: 1
以下是翻译好的部分：
"The solution is described in this recipe for mkdocstrings:
https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages"
英文:
The solution is described in this recipe for mkdocstrings:
https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
通过集体智慧和协作来改善编程学习和解决问题的方式。致力于成为全球开发者共同参与的知识库，让每个人都能够通过互相帮助和分享经验来进步。
评论