Make technical documentstion from data sets
Project description
pubdoc
Публикация документации
Возможности
- Работа в ОС семейства:
Linux
,Mac OS X
,Windows
; - Подерживается публикация на:
Установка и обновление
- Установить Python версии не ниже 3.6;
- Установить пакет d2doc из PyPI командой:
pip install d2doc
- Для обновления пакета необходимо воспользоваться командой:
pip install -U d2doc
Использование скрипта
Usage: pubdoc.py [OPTIONS] COMMAND [ARGS]...
Options:
--log-level TEXT Log level [CRITICAL, FATAL, ERROR, WARNING, DEBUG, INFO,
NOTSET]
--help Show this message and exit.
Commands:
dokuwiki
Публикация на DokuWiki
Команда dokuwiki
Usage: pubdoc dokuwiki [OPTIONS]
Options:
-t, --target TEXT Dokuwiki url. [required]
--username TEXT Dokuwiki username. [required]
--password TEXT Dokuwiki password. [required]
-n, --namespace TEXT Dokuwiki namespace. [required]
-d, --data-dir PATH Input data dir. [required]
-m, --data-dir-mask TEXT Files mask for option '--data-dir'.
--help Show this message and exit.
Пример использования скрипта в Linux
pubdoc dokuwiki \
--target 'https://bla.bla.com' \
--username 'Логин' \
--password 'Пароль' \
--namespace 'Проект 1:Техническая документация' \
--data-dir './testdocs' \
--data-dir-mask '**/*.md'
Пример использования скрипта в Linux c использованием переменных среды
export PUBDOC_DOKUWIKI_TARGET='https://bla.bla.com'
export PUBDOC_DOKUWIKI_USERNAME='Логин'
export PUBDOC_DOKUWIKI_PASSWORD='Пароль'
export PUBDOC_DOKUWIKI_NAMESPACE='Проект 1:Техническая документация'
export PUBDOC_DOKUWIKI_DATA_DIR='./testdocs'
export PUBDOC_DOKUWIKI_DATA_DIR_MASK='**/*.md'
export PUBDOC_LOG_LEVEL='DEBUG'
pubdoc dokuwiki
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pubdoc-0.5.2.tar.gz
(4.8 kB
view hashes)
Built Distribution
pubdoc-0.5.2-py3-none-any.whl
(18.5 kB
view hashes)