Ben Chuanlong Du's Blog

It is never too late to learn.

Markdown Tools Written in Rust

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 …

Write Documentation for Python Packages Using Sphinx

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

Installation

You can install Sphinx and necessary extensions using the following command.

pip3 install sphinx sphinx-autodoc-typehints

Or simply

xinstall sphinx -ic

Since the above commands installs Sphinx to the user's local …

Tips on Darglint

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 …

Tips on mkdocs

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

https://github.com/mkdocs/mkdocs

https://pypi.org/project/mkdocs-blog-plugin/

https://ddrscott.github.io/blog/2018/move-to-mkdocs/

https://github.com/danielfrg/mkdocs-jupyter