Documentación

Buscamos buenas alternativas como Docsify, Docusaurus, VuePress, mdBook, sin embargo preferimos a MkDocs utilizando Material for MkDocs, un potente framework de documentación sobre MkDocs, un generador de sitios estáticos para la documentación de proyectos.

Material for MkDocs organiza de forma eficiente todo el apartado de referencias de ese sitio y del código fuente.

Las dependencias para construir la documentación, se encuentran en el archivo pyproject.toml, que se encuentra en la raiz del proyecto.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

[tool.poetry.group.docs]
optional = true

[tool.poetry.group.docs.dependencies]
mkdocs= "~1.6"
mkdocs-material= "~9.5"
mkdocstrings = {extras = ["python"], version = "~0.26"}
mkdocs-material-extensions= "~1.3"
mkdocs-minify-plugin= "~0.8"
mkdocs-gen-files = "~0.5"
mkdocs-literate-nav = "~0.6"
mkdocs-section-index = "~0.3"
mkdocs-exclude = "~1.0"

Organizar todo el apartado de referencias del código fuente.

1

$ poetry exec docs-gen

Contruir y revisar el sitio para pruebas

1

$ poetry exec docs-serve

Construir este sitio

1

$ poetry exec docs-build 

Lectura recomendada

• Te recomendamos revisar el archivo tools/gen_pages.py
• MkDocs
• MkDocs Material
• mkdocstrings