邂逅 pydoc

zhaozj2021-02-16  114

Thank you first, I asked a question in the QQ group: "I want Pydoc to generate a directory document, which function does it?" I can't answer it now.

However, I checked the Pydoc's information, there is no much thing in Manual (in fact, it has been very clear, it may be used to it, I feel that it is not full), carry forward my consistent style directly to see Source.Pydoc Too classic, actually used to generate the tool of the Python document, based on the comment starting with the document, httoc -p 8070 haha, look at the browser http: // localhost: 8070 / actually is a Python module document, very complete, Because he is directly generated from the source file. After you can save the Source to find modules and packages, because he automatically generates a good connection, the layout is also good, the only beauty is a bit ugly, but planned Yes, this will not force it.

When the translation style is time, I don't understand what is called DOCString, and now I know, it can be used to generate documentation.:)

Look at the description of the official document, but it seems that it is not coming, I will try it.

PYPI: Epydoc 2.1

A tool for generating API documentation for Python modules, based on their docstrings. Epydoc supports two output formats (HTML and PDF), and four markup languages ​​for docstrings (Epytext, Javadoc, ReStructuredText, and plaintext).

转载请注明原文地址:https://www.9cbs.com/read-13360.html

New Post(0)