From 96985d824d513d8beaa6a83655dece1c6471a541 Mon Sep 17 00:00:00 2001 From: Vinta Chen Date: Sun, 8 Nov 2026 20:28:15 +0800 Subject: [PATCH] docs: order Documentation intro picks by the new subcategories Co-Authored-By: Claude --- website/data/category_intros/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/data/category_intros/documentation.md b/website/data/category_intros/documentation.md index c0fad335..08754517 100644 --- a/website/data/category_intros/documentation.md +++ b/website/data/category_intros/documentation.md @@ -5,8 +5,8 @@ How to choose: - API docs straight from docstrings, with no configuration: pdoc - Handwritten docs plus an API reference, as HTML, PDF, and more: Sphinx - A searchable Markdown site, with no HTML, CSS, or JavaScript to learn: Material for MkDocs -- Architecture diagrams as code, kept in version control: Diagrams - A Material for MkDocs site, new or existing, on its team's own generator: Zensical +- Architecture diagrams as code, kept in version control: Diagrams pdoc [aims to do one thing and do it well](https://pdoc.dev/docs/pdoc.html#what-is-pdoc): API documentation that follows your module hierarchy, with no configuration. Docstrings are Markdown, and it understands Google and numpydoc styles too. Run `pdoc ./demo.py` or `pdoc my_module_name` for a [preview in your browser that reloads](https://pdoc.dev/docs/pdoc.html#quickstart) when you edit the code, then `pdoc ./demo.py -o ./docs` to export the HTML. Its output is self-contained HTML, and for substantially more complex documentation needs, [pdoc's docs recommend Sphinx](https://pdoc.dev/docs/pdoc.html#limitations).