Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.1 KB

File metadata and controls

32 lines (19 loc) · 1.1 KB

Documentation Tools Guide

Quick Reference

Tool Primary Use When to Use Complexity
MkDocs Documentation site generation Project setup and updates ★★☆
MkDocstrings API documentation generation Code documentation ★★☆
Interrogate Docstring coverage checking Pre-commit ★☆☆
MDFormat Markdown formatting Pre-commit ★☆☆

This is a placeholder. Will add simplified explanations and examples of the documentation tools from technologies/documentation/

MkDocs

What It Does

This is a placeholder. Will add concise explanation with examples

Basic Usage

This is a placeholder. Will add basic usage examples

More tools will be added here...

Tool Comparison

This is a placeholder. Will add comparison of when to use each tool

Further Reading

This is a placeholder. Will add links to detailed documentation