Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mitmproxy/pdoc

API Documentation for Python Projects
https://github.com/mitmproxy/pdoc

api api-documentation docs docstring docstrings documentation documentation-generator documentation-tool pdoc python python3

Last synced: about 1 month ago
JSON representation

API Documentation for Python Projects

Lists

README 

        


pdoc





pdoc documentation

CI Status

Code Coverage

autofix.ci: yes

PyPI Version

Supported Python Versions




API Documentation for Python Projects.



# Example



`pdoc -o ./html pdoc` generates this website: [pdoc.dev/docs](https://pdoc.dev/docs/pdoc.html).



# Installation

```shell

pip install pdoc

```



pdoc is compatible with Python 3.8 and newer.



# Usage



```shell

pdoc your_python_module

# or

pdoc ./my_project.py

```



Run `pdoc pdoc` to see pdoc's own documentation, 

run `pdoc --help` to view the command line flags, 

or check our [hosted copy of the documentation](https://pdoc.dev/docs/pdoc.html).



# Features



pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well.  



* Documentation is plain [Markdown](https://pdoc.dev/docs/pdoc.html#markdown-support).

* First-class support for type annotations and all other modern Python 3 features.

* Builtin web server with live reloading.

* Customizable HTML templates.

* Understands numpydoc and Google-style docstrings.

* Standalone HTML output without additional dependencies.

  

Under the hood...



* `pdoc` will automatically link identifiers in your docstrings to their corresponding documentation.

* `pdoc` respects your `__all__` variable when present.

* `pdoc` will traverse the abstract syntax tree to extract type annotations and docstrings from constructors as well.

* `pdoc` will automatically try to resolve type annotation string literals as forward references.

* `pdoc` will use inheritance to resolve type annotations and docstrings for class members. 

  

If you have substantially more complex documentation needs, we recommend using [Sphinx](https://www.sphinx-doc.org/)!



## Contributing



As an open source project, pdoc welcomes contributions of all forms.



[![Dev Guide](https://shields.mitmproxy.org/badge/dev_docs-CONTRIBUTING.md-blue)](https://github.com/mitmproxy/pdoc/blob/main/CONTRIBUTING.md)



Also, please feel free to join our developer Slack!



[![Slack Developer Chat](https://shields.mitmproxy.org/badge/slack-mitmproxy-E01563.svg)](http://slack.mitmproxy.org/)



## pdoc vs. pdoc3



This project is not associated with "pdoc3", which often falsely assumes our name.

Quoting [@BurntSushi](https://github.com/BurntSushi), the original author of pdoc:



> I'm pretty disgusted that someone has taken a project I built, relicensed it, 

> [attempted to erase its entry on the Python Wiki](https://wiki.python.org/moin/DocumentationTools?action=diff&rev1=36&rev2=37), 

> released it under effectively the same name and, worst of all, associated it with Nazi symbols.

> 

> *Source: https://github.com/pdoc3/pdoc/issues/64*



In contrast, the pdoc project strives to uphold a healthy community where everyone is treated with respect.

Everyone is welcome to contribute as long as they adhere to basic civility. We expressly distance ourselves from the use

of Nazi symbols and ideology.



----



The pdoc project was originally created by [Andrew Gallant](https://github.com/BurntSushi) 

and is currently maintained by [Maximilian Hils](https://github.com/mhils).