What is the relationship between docutils and Sphinx?

前端 未结 3 2013
野性不改
野性不改 2021-01-31 09:19

There seems to be a plethora of documentation tools for Python. Another one that I\'ve run across is epydoc. It seems like Sphinx is the de facto standard, because it\'s used to

3条回答
  •  南旧
    南旧 (楼主)
    2021-01-31 09:48

    It seems like Epydoc is, if not dead, at least pining for the fjords.

    Sphynx with the sphinx-apidoc command and the autodoc extension looks to be the most popular option for API docs at this time.

    Good examples are:

    • requests (src)
    • boto (src)

    See: Should we use Epydoc, Sphinx or something else for documenting Python APIs? (SO5579198)

    Sphinx encourages a more narrative style than tools in the javadoc mold, but maybe this is a good thing?

提交回复
热议问题