Tagged articles
2 articles
Page 1 of 1
Test Development Learning Exchange
Test Development Learning Exchange
Mar 26, 2024 · Backend Development

Using pdoc to Generate API Documentation for Python Projects

pdoc is a lightweight Python command‑line tool that automatically extracts docstrings to produce clean HTML API documentation, offering features such as module and package generation, custom templates, markdown export, and a built‑in preview server for rapid documentation workflows.

API documentationCLIDocumentation Generation
0 likes · 5 min read
Using pdoc to Generate API Documentation for Python Projects
Taobao Frontend Technology
Taobao Frontend Technology
Jul 23, 2021 · Fundamentals

How Docs-as-Code and TypeDoc Revolutionize TypeScript Library Documentation

This article explores the motivation, design, and implementation of using Docs-as-Code with TypeDoc to generate and maintain documentation for TypeScript utility libraries, covering annotation conventions, plugin architecture, code organization, flag handling, event mechanisms, reflection generation, and practical plugin customizations.

Docs-as-CodeDocumentation GenerationReflection
0 likes · 22 min read
How Docs-as-Code and TypeDoc Revolutionize TypeScript Library Documentation