A Modern Doc Template for your Python Project 💅

This website was build with:

Features

out of the box amazing good looking website thanks to mkdocs.org and mkdocs-material
a wide array of cool features, such as code highlight, admonition, latex rendering and more thanks to pymdown
FastApi cool terminal rendering
auto documentation for code thanks to mkdocstrings
automatic build thanks to github action, see the CI/CD page

See here for doc

print("Hello World!")

See here for doc

Hello There

General Kenobi!

Hello There

General Kenobi!

Error

Boom!

See here for doc

Inline

$p (x | y) = \frac{p (y | x) p (x)}{p (y)}$ , $p (x | y) = \frac{p (y | x) p (x)}{p (y)}$ .

Block

E (v, h) = - \sum_{i, j} w_{i j} v_{i} h_{j} - \sum_{i} b_{i} v_{i} - \sum_{j} c_{j} h_{j}

\begin{aligned} p (v_{i} = 1 | h) & = σ (\sum_{j} w_{i j} h_{j} + b_{i}) \\ p (h_{j} = 1 | v) & = σ (\sum_{i} w_{i j} v_{i} + c_{j}) \end{aligned}