Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/lulav/pdoc below:

lulav/pdoc: :arrow_right: Auto-generate API documentation for Python projects

• Pricing

Auto-generate API documentation for Python projects.

Project website

Documentation

Pdoc will accept a Python module file, package directory or an import path.

$ pdoc --template-dir pdoc/pdoc/citros_templates/ --pdf your_package.your_module > docs/your_module.md

See pdoc --help for more command-line switches and the documentation for more usage examples.

• 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).

Check CONTRIBUTING.md for hacking details.

🐍 ➡️ 📜 Auto-generate API documentation for Python projects

• Python 80.8%
• Mako 19.2%

You can’t perform that action at this time.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4