From c5ec12e391ec1fb421cf368166d5e36bcba34a7c Mon Sep 17 00:00:00 2001 From: Artur Barseghyan Date: Thu, 12 Sep 2024 01:39:20 +0200 Subject: [PATCH] Up docs (#74) --- README.rst | 28 ++++++++++++------------- examples/requirements/dev.in | 2 +- examples/requirements/style_checkers.in | 1 + 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index dc594790..ee6ae5f2 100644 --- a/README.rst +++ b/README.rst @@ -169,7 +169,7 @@ Latest stable version from PyPI .. code-block:: sh - pip install faker-file[all] + pip install faker-file'[all]' **Only core** @@ -183,79 +183,79 @@ Latest stable version from PyPI .. code-block:: sh - pip install faker-file[common] + pip install faker-file'[common]' **With DOCX support** .. code-block:: sh - pip install faker-file[docx] + pip install faker-file'[docx]' **With EPUB support** .. code-block:: sh - pip install faker-file[epub] + pip install faker-file'[epub]' **With images support** .. code-block:: sh - pip install faker-file[images] + pip install faker-file'[images]' **With PDF support** .. code-block:: sh - pip install faker-file[pdf] + pip install faker-file'[pdf]' **With MP3 support** .. code-block:: sh - pip install faker-file[mp3] + pip install faker-file'[mp3]' **With XLSX support** .. code-block:: sh - pip install faker-file[xlsx] + pip install faker-file'[xlsx]' **With ODS support** .. code-block:: sh - pip install faker-file[ods] + pip install faker-file'[ods]' **With ODT support** .. code-block:: sh - pip install faker-file[odt] + pip install faker-file'[odt]' **With data augmentation support** .. code-block:: sh - pip install faker-file[data-augmentation] + pip install faker-file'[data-augmentation]' **With GoogleCloudStorage support** .. code-block:: sh - pip install faker-file[gcs] + pip install faker-file'[gcs]' **With AzureCloudStorage support** .. code-block:: sh - pip install faker-file[azure] + pip install faker-file'[azure]' **With AWSS3Storage support** .. code-block:: sh - pip install faker-file[s3] + pip install faker-file'[s3]' Or development version from GitHub ---------------------------------- diff --git a/examples/requirements/dev.in b/examples/requirements/dev.in index 69f0c89b..5fe815d2 100644 --- a/examples/requirements/dev.in +++ b/examples/requirements/dev.in @@ -1,2 +1,2 @@ --r django_3_2.in +-r django_4_2.in -r deployment.in diff --git a/examples/requirements/style_checkers.in b/examples/requirements/style_checkers.in index 15cc35d0..4143c38a 100644 --- a/examples/requirements/style_checkers.in +++ b/examples/requirements/style_checkers.in @@ -4,6 +4,7 @@ ruff isort>=5.11.5 doc8 pre-commit +pydoclint pydocstyle pyflakes pylint