From 1be2f1a903d54599b241b6f6e43a39f3a3635802 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sat, 9 Apr 2016 22:34:59 +0300 Subject: [PATCH] Update docs: describe command-line scripts Describe ml-initdb.py and ml-import.py. --- docs-ru/command_line.rst | 25 +++++++++++++++++++++++++ docs-ru/index.rst | 1 + docs/command_line.rst | 24 ++++++++++++++++++++++++ docs/index.rst | 1 + 4 files changed, 51 insertions(+) create mode 100644 docs-ru/command_line.rst create mode 100644 docs/command_line.rst diff --git a/docs-ru/command_line.rst b/docs-ru/command_line.rst new file mode 100644 index 0000000..5f5081a --- /dev/null +++ b/docs-ru/command_line.rst @@ -0,0 +1,25 @@ + +Скрипты командной строки +======================== + + +.. contents:: + :local: + + +ml-initdb.py +------------ + +Инициализирует базу данных и импортирует список жанров. Этот скрипт не +очень-то нужен, так как следующий скрипт делает всё указанное. + + +ml-import.py +------------ + +Инициализирует базу данных, импортирует список жанров и список файлов +INPX, перечисленных в командной строке. При повторных запусках не +переинициализирует БД и не переимпортирует жанры; так же не +переимпортирует уже проимпортированные книги, но импортирует в БД новые. + +.. vim: set tw=72 : diff --git a/docs-ru/index.rst b/docs-ru/index.rst index 1e0d038..af0727e 100644 --- a/docs-ru/index.rst +++ b/docs-ru/index.rst @@ -18,6 +18,7 @@ Contents: :maxdepth: 2 before_begin + command_line Indices and tables diff --git a/docs/command_line.rst b/docs/command_line.rst new file mode 100644 index 0000000..03bb75a --- /dev/null +++ b/docs/command_line.rst @@ -0,0 +1,24 @@ + +Command-line scripts +==================== + + +.. contents:: + :local: + + +ml-initdb.py +------------ + +Initialize database and import genres list. Doesn't really needed as +the next script does all that too. + + +ml-import.py +------------ + +Initialize database, import genres list and import a list of INPX files +listed in the command line. On subsequent runs doesn't destroy DB or +reimport genres; it also skips already import books but import new ones. + +.. vim: set tw=72 : diff --git a/docs/index.rst b/docs/index.rst index ecf2633..f404b71 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ Contents: :maxdepth: 2 before_begin + command_line Indices and tables -- 2.39.2