Generar documentación con mkdocs

Descripción general
MkDocs es un generador de sitio estático rápido y sencillo dirigido a la documentación de proyectos en construcción. Los archivos de documentación están escritos en Markdown, y configurados con un único archivo de configuración YAML.

Instalación
Con el fin de instalar MkDocs que necesitará Python instalado en el sistema, así como el gestor de paquetes de Python, pip . Puede comprobar si ya ha instalado estos de esta manera:

$ python --version Python 2.7.2
$ pip --version pip 1.5.2

MkDocs soporta Python 2.6, 2.7, 3.3, 3.4 y 3.5. En Windows, se recomienda tener instalado Python y PIP con Chocolatey. Instalar el paquete mkdocs utilizando pip: pip install mkdocs Ahora debería tener los comandos mkdocs sobre el sistema. Ejecutar mkdocs --version para comprobar que todo funcione bien.

$ mkdocs --version mkdocs, version 0.15.2

Primeros pasos
Ejecutar la siguiente línea para crear tu primer proyecto de prueba.

$ mkdocs new my-project cd my-project

Vamos a tomar un momento para revisar el proyecto inicial que hemos creado.

El diseño inicial MkDocs hay un único archivo de configuración llamado mkdocs.yml, y una carpeta llamada docs que contendrán los archivos de origen de la documentación. En este momento la carpeta docs solo contiene una sola página de documentación, llamada index.md.
MkDocs viene con un servidor web incorporado que le permite una vista previa de la documentación a medida que se trabaja con ella. Iniciamos el servidor web, asegurándonos de que estamos en el mismo directorio que el archivo de configuración mkdocs.yml, y luego ejecutar el comando mkdocs serve:

$ mkdocs serve Running at: http://127.0.0.1:8000/

Abre http://127.0.0.1:8000/ en su navegador, y verá que se muestra la página de index.

Fuentes: mkdocs