GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → mitmproxy → Pdoc

mitmproxy / Pdoc

Licence: unlicense
API Documentation for Python Projects

Programming Languages

python
139335 projects - #7 most used programming language
python3
1442 projects

Labels

apidocumentationdocsdocumentation-toolapi-documentationdocumentation-generator

Projects that are alternatives of or similar to Pdoc

Drf Autodocs
Ultimately automated DRF documentation rendering(UNMAINTAINED)
Stars: ✭ 82 (-90.39%)
Mutual labels:  api, api-documentation, documentation, documentation-tool, documentation-generator
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+974.33%)
Mutual labels:  api, api-documentation, documentation, docs, documentation-tool
Pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604 (-29.19%)
Mutual labels:  api-documentation, documentation, docs, documentation-tool, documentation-generator
Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+3089.68%)
Mutual labels:  api-documentation, documentation, docs, documentation-tool
Hexo Theme Doc
A documentation theme for the Hexo blog framework
Stars: ✭ 222 (-73.97%)
Mutual labels:  api, api-documentation, documentation, documentation-tool
Awesome Documentation Tools
🔥 📚 All the tools, processes and resources you need to create an awesome API & Project documentation
Stars: ✭ 138 (-83.82%)
Mutual labels:  api, api-documentation, documentation, documentation-tool
App
Fast and searchable Ruby docs
Stars: ✭ 47 (-94.49%)
Mutual labels:  documentation, docs, documentation-tool, documentation-generator
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+40.56%)
Mutual labels:  api-documentation, documentation, documentation-tool, documentation-generator
Pico8 Api
Unofficial PICO-8 API with a lovely design ! ::
Stars: ✭ 115 (-86.52%)
Mutual labels:  api, documentation, docs
Jsdoc
An API documentation generator for JavaScript.
Stars: ✭ 12,555 (+1371.86%)
Mutual labels:  api, documentation, docs
Literate.jl
Simple package for literate programming in Julia
Stars: ✭ 272 (-68.11%)
Mutual labels:  documentation, documentation-tool, documentation-generator
Jsdoc Baseline
An experimental, extensible template for JSDoc.
Stars: ✭ 51 (-94.02%)
Mutual labels:  api, documentation, docs
Spectaql
Autogenerate static GraphQL API documentation
Stars: ✭ 198 (-76.79%)
Mutual labels:  api, documentation, documentation-generator
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-66.47%)
Mutual labels:  documentation, documentation-tool, documentation-generator
Cljdoc
📚 A central documentation hub for the Clojure community
Stars: ✭ 416 (-51.23%)
Mutual labels:  api, documentation, docs
chappe
🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.
Stars: ✭ 132 (-84.53%)
Mutual labels:  docs, api-documentation, documentation-tool
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+2163.77%)
Mutual labels:  documentation, docs, documentation-tool
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+404.81%)
Mutual labels:  documentation, docs, documentation-tool
Redoc
📘 OpenAPI/Swagger-generated API Reference Documentation
Stars: ✭ 15,935 (+1768.11%)
Mutual labels:  api-documentation, documentation-tool, documentation-generator
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (-66.35%)
Mutual labels:  api, documentation, docs
View All Similar Projects ➔

pdoc

pdoc documentation CI Status Code Coverage PyPI Version Supported Python Versions

API Documentation for Python Projects.

Example

pdoc -o ./html pdoc generates this website: pdoc.dev/docs.

Installation

pip install pdoc

pdoc is compatible with Python 3.7 and newer.

Usage

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.

Features

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

  • Documentation is plain Markdown. There are no added special syntax rules.
  • 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 JS-free 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!

Contributing

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

Dev Guide

Also, please feel free to join our developer Slack!

Slack Developer Chat

pdoc vs. pdoc3

This project is not associated with "pdoc3", which often falsely assumes our name. Quoting @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, 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 and is currently maintained by Maximilian Hils.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].