A Modern Doc Template for your Python Project 💅

This website was build with:

• mkdocs.org
• mkdocs-material
• pymdown

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

Getting Started

Head over the getting started guide

Cool stuff

Code Highlights

See here for doc

print("Hello World!")

Admonition

See here for doc

Hello There

General Kenobi!

Hello There

General Kenobi!

Error

Boom!

Latex

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(\mathbf{v}, \mathbf{h}) = -\sum_{i,j}w_{ij}v_i h_j - \sum_i b_i v_i - \sum_j c_j h_j \]

\[\begin{align} p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\ p(h_j=1|\mathbf{v}) & = \sigma\left(\sum_i w_{ij}v_i + c_j\right) \end{align}\]