🌘 pdoc – 為 Python 專案生成 API 文件
➤ 無需設定,輕鬆為你的 Python 專案生成專業 API 文件
https://pdoc.dev/
pdoc 是一個能自動為 Python 專案生成 API 文件的工具,它能理解專案的模組結構、支援型別註記、交叉連結,並內建即時重載網頁伺服器。此工具無需額外設定,亦支援 numpydoc 或 Google 風格的 docstrings。
+ 太棒了!一直想找個簡單好用的文件生成器,pdoc 聽起來正是我的需求。
+ 支援型別註記和即時重載真的很方便,可以省下不少功夫。
#Python #API 文件 #pdoc
pdoc – Generate API Documentation for Python Projects

pdoc is a simple tool to auto-generate API documentation for Python libraries. It uses your existing docstrings and requires no configuration.

🐍✨ Behold, a groundbreaking revelation in the world of tech: a tool that documents your #Python project with the press of a button! No more manual labor, just pure, unadulterated #automation 🤖💼. Get ready to bask in the glory of auto-generated code documentation, because who needs understanding when you've got pdoc? 📚🙄
https://pdoc.dev/ #CodeDocumentation #TechInnovation #pdoc #HackerNews #ngated
pdoc – Generate API Documentation for Python Projects

pdoc is a simple tool to auto-generate API documentation for Python libraries. It uses your existing docstrings and requires no configuration.

pdoc – Generate API Documentation for Python Projects

pdoc is a simple tool to auto-generate API documentation for Python libraries. It uses your existing docstrings and requires no configuration.

Haha, that was so different. Works exactly as advertised on https://pdoc3.github.io/pdoc/
and the output looks kinda nice immediately

Never mind the missing documentation. Now I am ready to fill the gaps.

#python #pdoc

pdoc – Auto-generate API documentation for Python projects

Auto-generate API documentation for Python projects from docstrings in numpydoc, Google, or plain Markdown format.

OK, #python question: How do I generate docs for an embedded python project that uses a #SWIG generated library? #pydoc #pdoc and the like rightly complain about non-existent modules, but all the information I want is contained in docstrings and type annotations, so it *should* be possible to generate docs right?

Is there a tool for this?

I added a few pages to #Griffe's docs: alternative projects, downstream projects, and built-in/official/third-party extensions.

Very cool projects mentioned in there! #Docspec, #pdoc, #papyri, #quartodoc, etc. And I discovered a few Griffe extensions in the process, it's awesome 🤩

- https://mkdocstrings.github.io/griffe/alternatives/
- https://mkdocstrings.github.io/griffe/downstream-projects/
- https://mkdocstrings.github.io/griffe/extensions/built-in/

Alternatives - Griffe

Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.

Why are the documentations of tools that are meant to create documentations so terrible? #pdoc #sphinx #python

If you are looking for a nice way to document your Python project, you should really have a look at pdoc maintained by the incredible @max - it works, it's convenient and very practical.

Don't be confused by pdoc3 which is a crappy fork and should be discarded.

#opensource #python #documentation #pdoc

GitHub - mitmproxy/pdoc: API Documentation for Python Projects

API Documentation for Python Projects. Contribute to mitmproxy/pdoc development by creating an account on GitHub.

GitHub