Skip to main content

Auto doc generator for GitFlic book

Project description

PyGFAutoDoc

v0.1.2

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


Установка

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

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

pip install py_gf_auto_doc

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

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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_gf_auto_doc-0.1.2.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

py_gf_auto_doc-0.1.2-py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page