From 84d5796f08720fcdc6b55cd775940a640b99b0c3 Mon Sep 17 00:00:00 2001 From: Laurent Date: Fri, 2 Feb 2024 09:10:00 +0000 Subject: [PATCH] (pyproject.toml) move doc deps inside their own `project.optional-dependencies` + add `black` formatter, required by mkdocstrings to format signatures --- pyproject.toml | 9 ++++++--- requirements.docs.txt | 1 + requirements.lock | 22 ++++++++++++++++++++++ 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 659fdca..2efff74 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,6 +42,12 @@ conversion = [ "requests>=2.26.0", "tqdm>=4.62.3", ] +doc = [ + "black>=24.1.1", # required by mkdocs to format the signatures + "mkdocs-material>=9.5.6", + "mkdocstrings[python]>=0.24.0", + "mkdocs-literate-nav>=0.6.1", +] [build-system] requires = ["hatchling"] @@ -56,9 +62,6 @@ dev-dependencies = [ "docformatter>=1.7.5", "pytest>=8.0.0", "coverage>=7.4.1", - "mkdocs-material>=9.5.6", - "mkdocstrings[python]>=0.24.0", - "mkdocs-literate-nav>=0.6.1", ] diff --git a/requirements.docs.txt b/requirements.docs.txt index 1c4775a..c237838 100644 --- a/requirements.docs.txt +++ b/requirements.docs.txt @@ -3,3 +3,4 @@ mkdocs-material==9.5.6 mkdocstrings==0.24.0 mkdocstrings-python==1.8.0 mkdocs-literate-nav==0.6.1 +black>=24.1.1 diff --git a/requirements.lock b/requirements.lock index 2d3c76d..0d4d992 100644 --- a/requirements.lock +++ b/requirements.lock @@ -14,10 +14,13 @@ annotated-types==0.6.0 appdirs==1.4.4 async-timeout==4.0.3 attrs==23.2.0 +babel==2.14.0 bitsandbytes==0.42.0 +black==24.1.1 certifi==2023.11.17 charset-normalizer==3.3.2 click==8.1.7 +colorama==0.4.6 datasets==2.16.1 diffusers==0.25.1 dill==0.3.7 @@ -25,8 +28,10 @@ docker-pycreds==0.4.0 filelock==3.13.1 frozenlist==1.4.1 fsspec==2023.10.0 +ghp-import==2.1.0 gitdb==4.0.11 gitpython==3.1.41 +griffe==0.40.0 huggingface-hub==0.20.3 idna==3.6 importlib-metadata==7.0.1 @@ -34,10 +39,20 @@ invisible-watermark==0.2.0 jaxtyping==0.2.25 jinja2==3.1.3 loguru==0.7.2 +markdown==3.5.2 markupsafe==2.1.4 +mergedeep==1.3.4 +mkdocs==1.5.3 +mkdocs-autorefs==0.5.0 +mkdocs-literate-nav==0.6.1 +mkdocs-material==9.5.6 +mkdocs-material-extensions==1.3.1 +mkdocstrings==0.24.0 +mkdocstrings-python==1.8.0 mpmath==1.3.0 multidict==6.0.4 multiprocess==0.70.15 +mypy-extensions==1.0.0 networkx==3.2.1 numpy==1.26.3 nvidia-cublas-cu12==12.1.3.1 @@ -54,9 +69,12 @@ nvidia-nvjitlink-cu12==12.3.101 nvidia-nvtx-cu12==12.1.105 opencv-python==4.9.0.80 packaging==23.2 +paginate==0.5.6 pandas==2.2.0 +pathspec==0.12.1 pillow==10.2.0 piq==0.8.0 +platformdirs==4.2.0 prodigyopt==1.0 protobuf==4.25.2 psutil==5.9.8 @@ -64,10 +82,13 @@ pyarrow==15.0.0 pyarrow-hotfix==0.6 pydantic==2.6.0 pydantic-core==2.16.1 +pygments==2.17.2 +pymdown-extensions==10.7 python-dateutil==2.8.2 pytz==2023.4 pywavelets==1.5.0 pyyaml==6.0.1 +pyyaml-env-tag==0.1 regex==2023.12.25 requests==2.31.0 safetensors==0.4.2 @@ -90,6 +111,7 @@ typing-extensions==4.9.0 tzdata==2023.4 urllib3==2.2.0 wandb==0.16.2 +watchdog==3.0.0 xxhash==3.4.1 yarl==1.9.4 zipp==3.17.0