/mkdocs

mkdocs - statical site

Начнем писать документацию

Статичный сайт. За основу беру www.mkdocs.org. Пусть пока будет отдельно в одноименной папке.

  1. mkdocs - это библиотека. Лежит по этому пути: "/usr/local/bin/mkdocs"

код предельно прост:

#!/usr/bin/python
# -*- coding: utf-8 -*-
import re
import sys

from mkdocs.__main__ import cli

if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw?|\.exe)?$', '', sys.argv[0])
    sys.exit(cli())
  1. ок. Едем дальше.
mkdock new my-project

создает папочку с файликами - это сгененированный шаблон сайта (благодаря ранее установленной либе click-man из пакета pip)

Доступные методы можно увидеть, выполнив: mkdocs serve

Сейчас будет copy-paste:

Commands mkdocs new [dir-name] - Create a new project. mkdocs serve - Start the live-reloading docs server. mkdocs build - Build the documentation site. mkdocs help - Print this help message.

Project layout mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.

Building the site That's looking good. You're ready to deploy the first pass of your MkLorum documentation. First build the documentation:

mkdocs build

This will create a new directory, named site. Take a look inside the directory: