pdoc3 / Pdoc
Licence: agpl-3.0
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604
Programming Languages
Labels
Projects that are alternatives of or similar to Pdoc
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (+41.23%)
Mutual labels: api-documentation, documentation, docs, documentation-tool, documentation-generator
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+98.51%)
Mutual labels: api-documentation, documentation, documentation-tool, documentation-generator, generator
App
Fast and searchable Ruby docs
Stars: ✭ 47 (-92.22%)
Mutual labels: documentation, docs, documentation-tool, documentation-generator
Drf Autodocs
Ultimately automated DRF documentation rendering(UNMAINTAINED)
Stars: ✭ 82 (-86.42%)
Mutual labels: api-documentation, documentation, documentation-tool, documentation-generator
Redoc
📘 OpenAPI/Swagger-generated API Reference Documentation
Stars: ✭ 15,935 (+2538.25%)
Mutual labels: api-documentation, hacktoberfest, documentation-tool, documentation-generator
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+1417.22%)
Mutual labels: api-documentation, documentation, docs, documentation-tool
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-52.65%)
Mutual labels: documentation, documentation-tool, documentation-generator, generator
Yii2 Apidoc
Yii 2 apidoc extension.
Stars: ✭ 236 (-60.93%)
Mutual labels: api-documentation, hacktoberfest, documentation, generator
Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+4404.64%)
Mutual labels: api-documentation, documentation, docs, documentation-tool
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+612.91%)
Mutual labels: documentation, docs, documentation-tool
Awesome Documentation Tools
🔥 📚 All the tools, processes and resources you need to create an awesome API & Project documentation
Stars: ✭ 138 (-77.15%)
Mutual labels: api-documentation, documentation, documentation-tool
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (-26.82%)
Mutual labels: documentation, docs, generator
chappe
🧑💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.
Stars: ✭ 132 (-78.15%)
Mutual labels: docs, api-documentation, documentation-tool
Hexo Theme Doc
A documentation theme for the Hexo blog framework
Stars: ✭ 222 (-63.25%)
Mutual labels: api-documentation, documentation, documentation-tool
Doc
🦋 Raku documentation (tools and docs)
Stars: ✭ 259 (-57.12%)
Mutual labels: hacktoberfest, documentation, docs
Cordova Docs
Apache Cordova Documentation
Stars: ✭ 315 (-47.85%)
Mutual labels: hacktoberfest, documentation, docs
Circleci Docs
Documentation for CircleCI.
Stars: ✭ 501 (-17.05%)
Mutual labels: hacktoberfest, documentation, docs
Sentry Docs
The new place for the sentry documentation (and tools to build it)
Stars: ✭ 160 (-73.51%)
Mutual labels: hacktoberfest, documentation, docs
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+3097.02%)
Mutual labels: documentation, docs, documentation-tool
Literate.jl
Simple package for literate programming in Julia
Stars: ✭ 272 (-54.97%)
Mutual labels: documentation, documentation-tool, documentation-generator
pdoc
Auto-generate API documentation for Python projects.
Installation
$ pip install pdoc3
Usage
Pdoc will accept a Python module file, package directory or an import path.
$ pdoc your_project
See pdoc --help for more command-line switches and the documentation
for more usage examples.
Features
- Simple usage. Generate sensible API (+ prose) documentation without any special configuration.
- Support for common docstrings formats (Markdown, numpydoc, Google-style docstrings), LaTeX math, and some reST directives.
- Support for PEP 484 and PEP 526 type annotations.
- pdoc respects
__all__when present. - Docstrings for overridden class members are inherited if unspecified.
- Support for documenting module, class, and instance variables by traversing ASTs.
- Automatic cross-linking of referenced identifiers.
- Overriding docstrings generation with special module-level
__pdoc__dictionary. - Easily extended and customized templates.
- Built-in development web server for near-instant preview of rendered docstrings.
The above features are explained in more detail in pdoc's documentation (generated with pdoc).
Development
Check CONTRIBUTING.md for hacking details.
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].