Structuring Sphinx documentation

后端 未结 3 1235
既然无缘
既然无缘 2021-02-13 18:52

I have started documenting a Python project using Sphinx. It is the first time I use it - I am used to tools which work with a JavaDoc-like syntax, and I have some doubts.

3条回答
  •  栀梦
    栀梦 (楼主)
    2021-02-13 19:15

    I found this autopackage script from a comment here. It generates the necessary .rst files according to the structure of your packages.

    side note: I still feel I am missing something, as I cannot believe that a tool like Sphinx, which is renowned as the most advanced tool for documenting Python, misses the functionality to do basic API documentation. Hence I will leave the question open for a while before accepting my own answer.

提交回复
热议问题