Build documentation#

You can write a Jupyter Book to document your project. The book source code is located in /docs/src and you can refer to the Book Writer Manual for details on the supported features and a syntax cheat sheet.

To build the book you can simply run from the root of your project:

dts docs build

Including reStructuredText in Markdown#

To insert rST into Markdown, you can use the eval-rst directive:

.. note::

   A note written in reStructuredText.

.. include:: ./include-rst.rst


A note written in reStructuredText.

Automatic API generation (advanced)#

It is also possible to automatically generate the API documentation from docstrings written in your source code. You can refer to the official guide for how to do this.