Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

mdBook

mdBook is a utility to create modern online books from Markdown files.

crowbook

Crowbook's aim is to allow you to write a book in Markdown without worrying about formatting …

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

The Rust RFC Book - Feature Name: More API Documentation Conventions

Making Useful Documentation Comments

Documentation

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

MkDocs

sphinx

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

Tips and Traps

1. It is suggested that you avoid using darglint directly, but instead you can use flake8 which will automatically call darglint if it exists.

2. Improperly escaped \n causes darglint …