Giter Site home page Giter Site logo

lmoresi / pdoc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pdoc3/pdoc

0.0 0.0 0.0 973 KB

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects

Home Page: https://pdoc3.github.io/pdoc/

License: GNU Affero General Public License v3.0

Shell 0.80% Python 81.67% Mako 17.53%

pdoc's Introduction

pdoc

Build Status Code Coverage pdoc3 on PyPI

Auto-generate API documentation for Python projects.

Project website

Documentation

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) and some reST directives.
  • Support for PEP 484 type annotations.
  • pdoc respects __all__ when present.
  • Inheritance used as applicable for inferring docstrings for class members.
  • Support for documenting module, class, and instance variables by traversing ASTs.
  • Automatic cross-linking of referenced identifiers in HTML and PDF.
  • Overriding docstrings with special module-level __pdoc__ dictionary.
  • Built-in development web server for near-instant preview of rendered docstrings.

The above features are explained in more detail in pdoc's documentation (which was generated with pdoc).

pdoc's People

Contributors

burntsushi avatar kernc avatar cortesi avatar mhils avatar hibou57 avatar aomader avatar jvantuyl avatar knadh avatar kchmck avatar nicolaskruchten avatar kyleking avatar jasonb-vbt avatar ialwaysbecoding avatar sjpb avatar lmoresi avatar rkaminsk avatar wq2012 avatar pieterb avatar mbustosorg avatar mhirota-impinj avatar marcwilson avatar jmatzdorff-cpi avatar ionelmc avatar razor-x avatar aurora-beta avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.