Metadata-Version: 2.1
Name: py-gf-auto-doc
Version: 0.1.2
Summary: Auto doc generator for GitFlic book
Author-email: Vladimir Chistov <wchistow@yandex.ru>
Project-URL: Homepage, https://gitflic.ru/project/wchistow/py-gf-auto-doc
Project-URL: Bug Tracker, https://gitflic.ru/project/wchistow/py-gf-auto-doc/issue
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# PyGFAutoDoc
## v0.1.2

Автоматический генератор документации
в формате GitFlic-книги для проектов на Python.

---

## Установка

> **Внимание!** Версия Python должна быть 3.10 или выше.

Введите в терминале:

```sh
pip install py_gf_auto_doc
```

---

## Использование

Формат использования:

```sh
python -m py_gf_auto_doc [-h]
                         --dir | -d <каталог Python-проекта>
                         --out_dir | -o <каталог для сохранения документации>
```

> **Внимание!** Если каталог `out_dir` не существует,
> возбуждается исключение `FileNotFoundError`.
